Skip to content

New-AzureRmAppServicePlan Help Example 1 #3591

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 1 commit into from
Mar 7, 2017

Conversation

jonathanmedd
Copy link
Contributor

@jonathanmedd jonathanmedd commented Mar 7, 2017

Description

Help Example 1 for New-AzureRmAppServicePlan is the following:

New-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "MyServicePlan" -Location "West US" -Sku "Basic" -NumberofWorkers 2 -WorkerSize "Small"

If you use this example the following error is generated since the Sku parameter does not exist:

New-AzureRmAppServicePlan : A parameter cannot be found that matches parameter name 'Sku'.

This PR replaces the Sku parameter in the example with the correct parameter name Tier. Note that this was already corrected in the Markdown file for the cmdlet.

Have also tidied up other inconsistencies between the Markdown and XML help files for this cmdlet, such as the name of the AppServicePlan, use of the word Sku and the accompanying text so that they match.


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.

…sistencies between markdown and XML help files
@msftclas
Copy link

msftclas commented Mar 7, 2017

@jonathanmedd,
Thanks for your contribution.
To ensure that the project team has proper rights to use your work, please complete the Contribution License Agreement at https://cla.microsoft.com.

It will cover your contributions to all Microsoft-managed open source projects.
Thanks,
Microsoft Pull Request Bot

@msftclas
Copy link

msftclas commented Mar 7, 2017

@jonathanmedd, thanks for signing the contribution license agreement. We will now validate the agreement and then the pull request.

Thanks, Microsoft Pull Request Bot

@markcowl markcowl merged commit d1e4ba7 into Azure:dev Mar 7, 2017
@jonathanmedd jonathanmedd deleted the New-AzureRmAppServicePlan branch March 8, 2017 15:50
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