Updated help for ASRRMcmdlets

[CFreemanwa]

Description

---

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.

[azuresdkci]

Can one of the admins verify this patch?

[markcowl]

@CFreemanwa Please follow the instructions here: for regenerating the dll-Help.xml file associated with these changes.https://github.com/Azure/azure-powershell/blob/dev/documentation/platyPSHelp-documentation.md

LMK if there are any issues with this.

[markcowl]

@azuresdkci add to whitelist

[markcowl]

@avneeshrai Can you review?

[markcowl]

@CFreemanwa It looks liek the new help is missing for cmdlet Get-AzureRmSiteRecoveryNetwork. Can you make sure this is added?

[CFreemanwa]

@markcowl I'm not sure why it wasn't included. It is in the list of updated files.

[markcowl]

@CFreemanwa It apprently didn't make it in to the dll-Help.xml update, can you take a look?

[bsiva]

Its actually the other way around. Recovery Plan Groups are groupings under the recovery plan. There could be multiple Recovery plan groups in a recovery plan. I'd prefer we call it "Recovery Plan" and "Recovery Plan Group" as those are the nouns for these constructs. The class definition has ASR prefixed to distinguish this as an Azure Site Recovery (ASR) construct.

[bsiva]

An instance of an array seems confusing. This is an array of ASRProtectionEntity instances to remove

[bsiva]

The ASR replication protected item to be test failed over

[bsiva]

The ASR replication protected item to be failed over

[bsiva]

settings

[bsiva]

An instance of an array seems confusing. This is an array of ASRProtectionEntity instances to add

[cormacpayne]

@CFreemanwa Hey Charles, quick update: I'm currently working on a pull request (#3655) that will get rid of all of the XML help in this repository. This will move our partners and external contributors to update the markdown help from now on (and the XML help will be generated during the build).

As a result, I'm going to close this PR (since the XML file you are updating won't exist, and I regenerated all of the markdown files in the repository to make sure they were up to date with the latest changes in the code, so there may be merge conflicts), but please feel free to reopen this PR (or a new one) with the changes to the markdown when that PR is merged. I will also be including documentation that covers how to properly regenerated the markdown files using the platyPS module (which I will point you to).

Please let me know if you have any other questions!