New-AzureRmSqlServer Help Example 1

[jonathanmedd]

Description

New-AzureRmSqlServer Help Example 1 is currently written as follows:

New-AzureRmSqlServer -ResourceGroupName "ResourceGroup01" -Location "Central US" -ServerName "Server01" -ServerVersion "12.0"
ResourceGroupName : resourcegroup01
ServerName : server01
Location : Australia East
SqlAdministratorLogin : adminLogin
SqlAdministratorPassword :
ServerVersion : 12.0
Tags :

This command creates a version 12 Azure SQL Database server.

The above help example has three issues:

1. It is missing the Mandatory parameter SqlAdministratorCredentials
2. The ServerName parameter value should not contain an uppercase character, i.e. should be 'server01', not 'Server01'
3. The output Location is Australia East, the input Location is Central US

Attempting to use the example as is generates the following two errors:

New-AzureRmSqlServer : Cannot process command because of one or more missing mandatory parameters: SqlAdministratorCredentials.

New-AzureRmSqlServer : 40645: Servername "Server01" cannot be empty or null. It can only be made up of lowercase letters 'a'-'z', the numbers 0-9 and the hyphen. The hyphen may not lead or trail in the name.

This PR updates Example 1 to include mandatory parameter SqlAdministratorCredentials, modifies the ServerName parameter value to be lowercase and updates the output Location to match the input Location.

---

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.

• I have read the contribution guidelines.
• If changes were made to any cmdlet, the XML help was regenerated using the platyPSHelp module.
• If any large changes are made to a service, they are reflected in the respective change log.

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.

[azurecla]

Hi @jonathanmedd, I'm your friendly neighborhood Azure Pull Request Bot (You can call me AZPRBOT). Thanks for your contribution!

In order for us to evaluate and accept your PR, we ask that you sign a contribution license agreement. It's all electronic and will take just minutes. I promise there's no faxing. https://cla.azure.com.

TTYL, AZPRBOT;

[azuresdkci]

Can one of the admins verify this patch?

[azurecla]

@jonathanmedd, Thanks for signing the contribution license agreement so quickly! Actual humans will now validate the agreement and then evaluate the PR.

Thanks, AZPRBOT;

[cormacpayne]

@akromm hey Adam, would you mind reviewing this PR?

[cormacpayne]

@azuresdkci add to whitelist

[cormacpayne]

LGTM