Azure RM Dns Bug Fixes and Update to Help File

[corinagum]

1. [No work item#] Update to Help File
2. [No work item#] Fix -Confirm parameter to accept $false & remove -Force
3. Bug 6412699 PowerShell Error: can’t convert …DnsRecordSet to type …DnsRecordSet
4. Bug 3172031 PowerShell should warn if record name suffix matches zone name
5. Bug 5600833 PowerShell New/Remove-AzureRmDnsRecordSet supports SOA
6. Bug 6059441 PowerShell should expose NumRecordSets and MaxNumRecordSets

This checklist is used to make sure that common issues in a pull request are covered by the creator. You can find a more complete discussion of PowerShell cmdlet best practices here.

Below in Overall Changes, check off the boxes that apply to your PR. Within each of the categories that you select, make sure that you can check off all of the boxes.

Overall Changes

• [ x ] MANDATORY - General changes
• [ x ] MANDATORY - Add/remove/edit test(s)
• [ x ] Add/remove/edit cmdlet(s)
• [ x ] Add/remove/edit parameter(s)
• Edit pipeline parameters

General

• Title of the PR is clear and informative
• There are a small number of commits that each have an informative message
• If it applies, references the bug/issue that the PR fixes
• All files have the Microsoft copyright header
• Cmdlets refer to management libraries through nuget references - no dlls are checked in
• The PR does not introduce breaking changes (unless a major version change occurs in the assembly and module)

Tests

• PR includes test coverage for the included changes
• Tests must use xunit, and should either use Moq to mock management client calls, or use the scenario test framework
• PowerShell scripts used in tests must not use hard-coded values for location
• 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 existing resources
• Tests should not use App.config files for settings
• Tests should use the built-in PowerShell functions for generating random names when unique names are necessary - this will store names in the test recording
• Tests should use Start-Sleep to pause rather than Thread.Sleep

Cmdlet Signature

• Cmdlet name uses an approved PowerShell verb - use the enums for VerbsCommon, VerbsCommunication, VerbsLifecycle, VerbsOther whenever possible
• Cmdlet noun name uses the AzureRm prefix for management cmdlets, and the Azure prefix for data plane cmdlets
• Cmdlet specifies the OutputType attribute if any output is produced; if the cmdlet produces no output, it should implement a PassThrough parameter
• If the cmdlet makes changes or has side effects, it should implement ShouldProcess and have SupportShouldProcess = true specified in the cmdlet attribute. See a discussion about correct ShouldProcess implementation here
• Cmdlets should derive from AzureRmCmdlet for management cmdlets, and AzureDataCmdlet for data cmdlets
• If multiple parameter sets are implemented, the cmdlet should specify a DefaultParameterSetName in its cmdlet attribute

Parameters

• Cmdlets should have no more than four positional parameters
• Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets
• 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
• Parameters should be explicitly marked as Mandatory or not, and should contain a HelpMessage
• No parameter is of type object.
  • Management cmdlets should have the following parameters and aliases:
    • ResourceGroupName with (optional) alias to ResourceGroup type string marked as [ValueFromPipelineByPropertyName]
    • Name with alias to ResourceName type string marked as [ValueFromPipelineByPropertyName]
    • Location (if appropriate) type string
    • Tag, type HashTable

Parameters and the Pipeline

• Complex parameters should take values from the pipeline when possible, and certainly when they match the output type of another cmdlet
• Only one parameter should use ValueFromPipeline per parameter set; parameters from different parameter sets may have this attribute, but should not be convertible
• No parameter is of type object
• Each management cmdlet should have a parameter set that takes ResourceGroupName and Name from the pipeline by property value
• For a given resource type, it should be possible to pipe the output of Get and New cmdlets to the input of Set, Update, Remove and other action cmdlets for that resource

[azurecla]

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

It looks like you're working at Microsoft (v-cojaco). If you're full-time, we DON'T require a contribution license agreement.

If you are a vendor, DO please sign the electronic contribution license agreement. It will take 2 minutes and there's no faxing! https://cla.azure.com.

TTYL, AZPRBOT;

[azuresdkci]

Can one of the admins verify this patch?

[azurecla]

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

Thanks, AZPRBOT;

[markcowl]

remove, this will cause failures, ass it is on .gitignore

[markcowl]

@azuresdkci add to whitelist

[corinagum]

All comments have been addressed and I will push to pull request after running tests one more time. Thank you!

[markcowl]

This is a breaking change. The advice for this breaking change is to leave the parameeter add the [Obsolete(...)] attribute to the property, and not use it in cmdlet execution. This gives users time to adapt to the change.

[markcowl]

@corinajacobson Sorry, I had forgotten about the breaking change policy, so missed this last time - weh should leave the Force parameters, not use them, and makr them as obsolete - this gives users a chance to update their scripts.

[jtuliani]

@markcowl Does the breaking change policy apply to services in Preview?

[markcowl]

@jtuliani Right now there is no preview for powershell. WHen there is, it will not, but for now, there is only one way for customers to get azure powershell

[markcowl]

on demand run here:http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1135/

LGTM once the build passes

[jtuliani]

@markcowl The Azure DNS service is in Preview. As with other Azure Previews, we clearly state that it is provided without SLA, and without Azure Support, should not be used for production workloads, and is subject to a 50% billing discount.

To me, 'Preview' includes every part of the service, including the PowerShell cmdlets and CLI. I therefore don't think the breaking change policy should apply (indeed, we have made other breaking changes during Preview, although we prefer not to of course).

[corinagum]

Looks like tests have passed! Please let me know if I can do anything else to help out.

[markcowl]

@jtuliani Unfortunately, we don't have any current way of differentiating the preview from the stable modules in azure powershell. Expect some discussion of new policy in this area over the next couple of weeks.