Skip to content

[Compute] Update-AzureRmVmss update for patch operation #4912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 7, 2017

Conversation

hyonholee
Copy link
Contributor

@hyonholee hyonholee commented Nov 2, 2017

Description


This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

General Guidelines

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
  • The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • Pull request includes test coverage for the included changes.
  • PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

  • New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
  • Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

  • Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
  • Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

Copy link
Member

@markcowl markcowl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not at all what we discussed. Adding a complex parameter that containspatch properties is precisely what should not be done to make this cmdlet usable.

Please add in the simple parameters we agreed to in the review.

@markcowl markcowl assigned hyonholee and unassigned markcowl Nov 2, 2017
Mandatory = false,
ValueFromPipelineByPropertyName = false,
ValueFromPipeline = true)]
[AllowNull]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you allowing null for all of these parmeters? This allows someone to set the parameter to $null. What is the reasoning behind this? Are you trying to enable removing this setting in the patch scenario?

ParameterSetName = "DefaultParameter",
Mandatory = false)]
[ValidateNotNullOrEmpty]
public int? SkuCapacity { get; set; }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the parameter that is used for scaling? What is the reason for using a nullable type with the 'ValidateNotNullOrEmpty' attribute.. We should just use the non-nullable type, if this value cannot be null.

ValueFromPipeline = true)]
[AllowNull]
public VirtualMachineScaleSetUpdate VirtualMachineScaleSetUpdate { get; set; }

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These parameter sets are incorrect.

The intention shoudl be to

  1. Allow identifying the VMSS by resource group + resource name
  2. Allow piping in a VMSS via the pipeline and updating the parameters.

In both of these cases, ideally you would allow either patching individual properties (if they provide additional parameters), or simply writing the VMSS object.

Firther, It is not clear how the user creates a VisrtualMachienScaleSetUpdate parameter,a s this doesn't appear to be the ouput of any other cmdlet.

@markcowl markcowl changed the base branch from preview to release-5.0.0 November 2, 2017 23:26
string resourceGroupName = this.ResourceGroupName;
string vmScaleSetName = this.VMScaleSetName;
BuildPatchObject();
if (this.VirtualMachineScaleSet == null)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand this execution logic. This prevenets users from piping scale sets into this cmdlet for PATCH.

The logic we discussed was that if any of the PATCH propertires were set, we would use PATCH, otherwise PUT

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

piping scenario works as expected even it calls PUT. (There is no difference between PUT and PATCH for CRP.)

The piping scenario is included in the test.

$vmss2 = $vmss | Update-AzureRmVmss -ResourceGroupName $rgname -Name $vmssName -SkuCapacity 4;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is not the piping scenario. Why would I pass in resource group name and VMscaleset name when piping? The piping scenario would be:

$vmss2 | Update-AzureRmVmss -SkuCapacity 4

Also, I thought part of thsi was that the PATCH was faster than the put.

@markcowl
Copy link
Member

markcowl commented Nov 6, 2017

Copy link
Member

@markcowl markcowl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is failing with the following Static Analysis issue:

Parameter PauseTimeBetweenBatches of cmdlet Update-AzureRmVmss does not follow the enforced naming convention of using a singular noun for a parameter name.

You can copy the line from the report into the suppressions file here: https://github.com/Azure/azure-powershell/blob/preview/tools/StaticAnalysis/Exceptions/SignatureIssues.csv

@markcowl
Copy link
Member

markcowl commented Nov 6, 2017

@hyonholee There is a static cnalysis failure, you can update the suppressions file here: https://github.com/Azure/azure-powershell/blob/preview/tools/StaticAnalysis/Exceptions/SignatureIssues.csv

@markcowl
Copy link
Member

markcowl commented Nov 6, 2017

@markcowl markcowl merged commit 9096af2 into Azure:release-5.0.0 Nov 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants