Skip to content

Add LocationCompleter to Compute cmdlets #4749

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Oct 25, 2017
Merged

Add LocationCompleter to Compute cmdlets #4749

merged 5 commits into from
Oct 25, 2017

Conversation

maddieclayton
Copy link
Contributor

@maddieclayton maddieclayton commented Oct 9, 2017 •
edited by azuresdkci
Loading

Description

Add the Location completer to the -Location parameter for all Compute cmdlets with the correct providers.

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.

@maddieclayton maddieclayton assigned markcowl and unassigned cormacpayne Oct 9, 2017
hyonholee
hyonholee reviewed Oct 10, 2017
View reviewed changes
src/ResourceManager/Compute/Commands.Compute/VirtualMachineSizes/GetAzureVMSizeCommand.cs Outdated
@@ -35,7 +36,7 @@ public class GetAzureVMSizeCommand : VirtualMachineSizeBaseCmdlet
Position = 0,
ParameterSetName = ListVirtualMachineSizeParamSet,
ValueFromPipelineByPropertyName = true,
HelpMessage = "The location name.")]
HelpMessage = "The location name."), LocationCompleter(new string[] { "Microsoft.Compute/locations/vmSizes" })]
Copy link
Contributor

Choose a reason for hiding this comment

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

Move LocationCompleter() to [ValidateNotNullOrEmpty] like NewAzureVMCommand.cs

hyonholee
hyonholee reviewed Oct 10, 2017
View reviewed changes
src/ResourceManager/Compute/Commands.Compute/Usage/GetAzureVMUsageCommand.cs Outdated
@@ -30,7 +31,7 @@ public class GetAzureVMUsageCommand : VirtualMachineUsageBaseCmdlet
Mandatory = true,
Position = 0,
ValueFromPipelineByPropertyName = true,
HelpMessage = "The location name.")]
HelpMessage = "The location name."), LocationCompleter(new string[] { "Microsoft.Compute/locations/usages" })]
Copy link
Contributor

Choose a reason for hiding this comment

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

Move LocationCompleter() to [ValidateNotNullOrEmpty] like NewAzureVMCommand.cs

hyonholee
hyonholee reviewed Oct 10, 2017
View reviewed changes
src/ResourceManager/Compute/Commands.Compute/AvailabilitySets/NewAzureAvailabilitySetCommand.cs Outdated
@@ -46,7 +47,7 @@ public class NewAzureAvailabilitySetCommand : AvailabilitySetBaseCmdlet
Mandatory = true,
Position = 2,
ValueFromPipelineByPropertyName = true,
HelpMessage = "The location.")]
HelpMessage = "The location."), LocationCompleter(new string[] { "Microsoft.Compute/availabilitySets" })]
Copy link
Contributor

Choose a reason for hiding this comment

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

Move LocationCompleter() to [ValidateNotNullOrEmpty] like NewAzureVMCommand.cs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I moved all of the LocationCompleter attributes out to a new set of brackets for uniformity - let me know if this looks good to you.

hyonholee
hyonholee reviewed Oct 10, 2017
View reviewed changes
src/ResourceManager/Compute/Commands.Compute/Extension/DSC/SetAzureVMDscExtensionCommand.cs Outdated
@@ -170,7 +171,7 @@ public class SetAzureVMDscExtensionCommand : VirtualMachineExtensionBaseCmdlet
[Parameter(
Mandatory = false,
ValueFromPipelineByPropertyName = true,
HelpMessage = "Location of the resource.")]
HelpMessage = "Location of the resource."), LocationCompleter(new string[] { "Microsoft.Storage/storageAccounts" })]
Copy link
Contributor

Choose a reason for hiding this comment

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

Move LocationCompleter() to [ValidateNotNullOrEmpty] like NewAzureVMCommand.cs

hyonholee
hyonholee reviewed Oct 10, 2017
View reviewed changes
...ceManager/Compute/Commands.Compute/Extension/Diagnostics/SetAzureRmVMDiagnosticsExtension.cs Outdated
@@ -104,7 +105,7 @@ public string DiagnosticsConfigurationPath
Mandatory = false,
Position = 7,
ValueFromPipelineByPropertyName = true,
HelpMessage = "The location.")]
HelpMessage = "The location."), LocationCompleter(new string[] { "Microsoft.Storage/storageAccounts" })]
Copy link
Contributor

Choose a reason for hiding this comment

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

Move LocationCompleter() to [ValidateNotNullOrEmpty] like NewAzureVMCommand.cs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No [ValidateNotNullOrEmpty] attribute here, so I moved the LocationCompleter out on its own.

hyonholee
hyonholee reviewed Oct 10, 2017
View reviewed changes
src/ResourceManager/Compute/Commands.Compute/Extension/SetAzureVMExtensionBaseCmdlet.cs Outdated
@@ -54,7 +55,7 @@ public class SetAzureVMExtensionBaseCmdlet : VirtualMachineExtensionBaseCmdlet
[Parameter(
Mandatory = false,
ValueFromPipelineByPropertyName = true,
HelpMessage = "The location.")]
HelpMessage = "The location."), LocationCompleter(new string[] { "Microsoft.Compute/virtualMachines" })]
Copy link
Contributor

Choose a reason for hiding this comment

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

Move LocationCompleter() to [ValidateNotNullOrEmpty] like NewAzureVMCommand.cs

hyonholee
hyonholee reviewed Oct 10, 2017
View reviewed changes
...eManager/Compute/Commands.Compute/Extension/SqlServer/SetAzureVMSqlServerExtensionCommand.cs Outdated
@@ -93,7 +94,7 @@ public class SetAzureSqlServerExtensionCommand : VirtualMachineExtensionBaseCmdl
Mandatory = false,
Position = 8,
ValueFromPipelineByPropertyName = true,
HelpMessage = "Location of the resource.")]
HelpMessage = "Location of the resource."), LocationCompleter(new string[] { "Microsoft.Compute/virtualMachines" })]
Copy link
Contributor

Choose a reason for hiding this comment

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

Move LocationCompleter() to [ValidateNotNullOrEmpty] like NewAzureVMCommand.cs

hyonholee
hyonholee reviewed Oct 10, 2017
View reviewed changes
src/ResourceManager/Compute/Commands.Compute/Images/GetAzureVMImageCommand.cs Outdated
@@ -37,7 +38,7 @@ public class GetAzureVMImageCommand : VirtualMachineImageBaseCmdlet
ValueFromPipelineByPropertyName = true)]
[Parameter(ParameterSetName = GetVMImageDetailParamSetName,
Mandatory = true,
ValueFromPipelineByPropertyName = true)]
ValueFromPipelineByPropertyName = true), LocationCompleter(new string[] { "Microsoft.Compute/locations/publishers" })]
Copy link
Contributor

Choose a reason for hiding this comment

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

Move LocationCompleter() to [ValidateNotNullOrEmpty] like NewAzureVMCommand.cs

@hyonholee
Copy link
Contributor

Thanks, LGTM.

@maddieclayton
Copy link
Contributor Author

Optimistic on demand run here: https://azuresdkci.westus2.cloudapp.azure.com/view/PowerShell/job/powershell-demand/32/

@markcowl markcowl removed their assignment Oct 25, 2017
@maddieclayton maddieclayton merged commit 8644d02 into Azure:preview Oct 25, 2017
@maddieclayton maddieclayton deleted the LocationCompleterNetwork branch October 25, 2017 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hyonholee hyonholee hyonholee left review comments

@markcowl markcowl markcowl approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@maddieclayton @hyonholee @markcowl @azuresdkci @cormacpayne @azdevxps