Skip to content

Update Remove-AzureRmVMDiagnosticsExtension.md #4059

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
Jun 17, 2017

Conversation

yantang-msft
Copy link
Contributor

@yantang-msft yantang-msft commented May 31, 2017

Update the incorrect PS command example

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.

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.

Update the incorrect PS command example
@@ -25,7 +25,7 @@ You must pass the output of this cmdlet to the Update-AzureRmVM cmdlet to implem

### Example 1: Remove the Diagnostics extension from a virtual machine
```
PS C:\>Remove-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" | Update-AzureRmVM
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yantang-msft the description below says:

The command passes the result to the Update-AzureRmVM cmdlet by using the pipeline operator. That command updates the virtual machine.

Any reason why you want to remove the piping to the Update-AzureRmVM cmdlet?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The remove command itself is enough. Update-AzureVM is needed for V1 vm, but not V2 vm. Running the current sample command will give such error:
Update-AzureRmVM : The input object cannot be bound to any parameters for the command either because the command does not take pipeline input or the input and its properties do not match any of the
parameters that take pipeline input.

@cormacpayne
Copy link
Member

@singhkays Hey Kay, would you mind taking a look at this pull request? I'm not sure if the examples needs to be updated or not - it looks good in its current state, in my opinion.

@markcowl markcowl dismissed cormacpayne’s stale review June 17, 2017 23:22

Verified that piping to update is unnecessary

@markcowl markcowl merged commit 0aa0e79 into preview Jun 17, 2017
@markcowl markcowl deleted the yantang-msft-patch-1 branch July 13, 2017 00:56
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.

5 participants