Skip to content

Remove-AzureRmAppServicePlan Help Example 1 #3643

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 2 commits into from
Mar 17, 2017

Conversation

jonathanmedd
Copy link
Contributor

@jonathanmedd jonathanmedd commented Mar 17, 2017

Description

Help Example 1 for Remove-AzureRmAppServicePlan contains an incorrect parameter name for the name of the App Service Plan. If run as is, will generate the following error:

Remove-AzureRmAppServicePlan : A parameter cannot be found that matches parameter name 'AppServicePlanName'.

There are also inconsistencies between the markdown and XML files for the cmdlet Remove-AzureRmAppServicePlan, specifically:

  1. The App Service Plan names do not match
  2. The parameters AppServicePlanName and ResourceGroupName are in different orders

This PR changes the parameter AppServicePlanName to Name. It also resolves the above inconsistencies.

Additionally, I have changed the name of the App Service Plan from ContosoAppServPlan to ContosoASP to match the name in the recently merged PRs #3591 #3597 and #3605 so that someone following through the examples from New, Get, Set, Remove will see a consistent name of the plan to work with.


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.

@msftclas
Copy link

@jonathanmedd,
Thanks for having already signed the Contribution License Agreement. Your agreement was validated by Microsoft. We will now review your pull request.
Thanks,
Microsoft Pull Request Bot

@cormacpayne
Copy link
Member

@jonathanmedd thanks for another contribution, Jonathan!

LGTM

@cormacpayne cormacpayne merged commit 985f2cb into Azure:dev Mar 17, 2017
@jonathanmedd jonathanmedd deleted the Remove-AzureRmAppServicePlan branch March 22, 2017 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants