Skip to content

Replaced RouteTables and Routes with generated #4689

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 3 commits into from
Oct 9, 2017

Conversation

EvgenyAgafonchikov
Copy link
Contributor

@EvgenyAgafonchikov EvgenyAgafonchikov commented Sep 29, 2017

Description

[Draft version to discuss possible generation improvements etc.]


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.


namespace Microsoft.Azure.Commands.Network.Automation
{
[Cmdlet("Get", "AzureRmRouteConfig", SupportsShouldProcess = true), OutputType(typeof(PSRoute))]
Copy link
Member

Choose a reason for hiding this comment

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

@EvgenyAgafonchikov GET cmdlets shouldn't support ShouldProcess; I would update the generator to reflect this.

namespace Microsoft.Azure.Commands.Network.Automation
{

[Cmdlet(VerbsCommon.Set, "AzureRmRouteTable"), OutputType(typeof(PSRouteTable))]
Copy link
Member

Choose a reason for hiding this comment

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

@EvgenyAgafonchikov this cmdlet should support ShouldProcess

@cormacpayne
Copy link
Member

@EvgenyAgafonchikov one last thing, the markdown files for the corresponding cmdlets you made the ShouldProcess changes to will need to be updated so they have the correct set of parameters (the markdown for the cmdlet you removed ShouldProcess from still has Confirm and WhatIf, and the cmdlet you added it to does not have those parameters).

@cormacpayne
Copy link
Member

@EvgenyAgafonchikov ping

@markcowl markcowl changed the base branch from preview to release-4.4.1 October 7, 2017 23:55
@cormacpayne cormacpayne merged commit 6190f88 into Azure:release-4.4.1 Oct 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants