Skip to content

Update 'IsAdmin' flag to use correct syntax 'Admin' #5242

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
Jan 8, 2018

Conversation

lfoust
Copy link
Contributor

@lfoust lfoust commented Jan 8, 2018

The first example uses a flag -IsAdmin which does not exist. Updated to the correct syntax.

Description

The first example has a syntax error which uses the flag 'IsAdmin'. If a user copies and pastes this code they will end up with an error from powershell that the param 'IsAdmin' does not exist. Updated to the correct syntax which is just '-Admin'


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

  • [X ] Title of the pull request is clear and informative.
  • [X ] 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.
  • [X ] The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • [NA ] Pull request includes test coverage for the included changes.
  • [ X] 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

  • [ NA] 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.
  • [ NA] Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

  • [ NA] Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • [ NA] 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.
  • [ NA] Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

The first example uses a flag -IsAdmin which does not exist. Updated to the correct syntax.
@azuresdkci
Copy link

Can one of the admins verify this patch?

@maddieclayton
Copy link
Contributor

@azuresdkci Test this please

@maddieclayton
Copy link
Contributor

@lfoust Thank you for your contribution!

@maddieclayton maddieclayton merged commit 68a9061 into Azure:preview Jan 8, 2018
@lfoust lfoust deleted the patch-1 branch January 23, 2018 20:22
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.

4 participants