Skip to content

Azure Machine Learning WebServicesRP new API version (Re-submit) #3860

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 9 commits into from
May 2, 2017

Conversation

NonStatic2014
Copy link
Contributor

@NonStatic2014 NonStatic2014 commented Apr 28, 2017

Description

Azure Machine Learning WebServicesRP new API version

Original PR: #3796


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.

Copy link
Member

@cormacpayne cormacpayne left a comment

Choose a reason for hiding this comment

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

@NonStatic2014 a couple of clarifying comments

VerbsCommon.Add,
"AzureRmMlWebServiceRegionalProperty",
SupportsShouldProcess = true)]
[OutputType(typeof(void))]
Copy link
Member

Choose a reason for hiding this comment

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

@NonStatic2014 please change the output type to WebService since that is what you are writing to the output stream

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. Forget change it when addressing another comment before.

public string Name { get; set; }

[Parameter(
Mandatory = false,
Copy link
Member

Choose a reason for hiding this comment

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

@NonStatic2014 is there a default region if one is not provided?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not really. It is a necessary input for this cmdlet.


[Parameter(Mandatory = true, HelpMessage = "The name of the web service")]
[ValidateNotNullOrEmpty]
public string Name { get; set; }
Copy link
Member

Choose a reason for hiding this comment

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

@NonStatic2014 I think Name and ResourceGroupName should have the ValueFromPipelineByPropertyName attribute so you are able to pipe the result of Get-AzureRmMlWebService to this cmdlet. Does that seem like a scenario that a user may use this cmdlet for?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not always. Name and ResourceGroupName are also necessary input for Get- cmdlet. So I would expect user input them here.

Copy link
Member

Choose a reason for hiding this comment

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

@NonStatic2014 it's a simple piping scenario that would prevent the user from having to type the same set of parameters twice. For example:

Get-AzureRmMlWebService -Name Foo -ResourceGroupName RGFoo | Add-AzureRmMlWebServiceRegionalProperty

@hovsepm
Copy link
Contributor

hovsepm commented Apr 28, 2017

@azuresdkci retest this please

@markcowl
Copy link
Member

markcowl commented May 1, 2017

@azuresdkci retest this please

markcowl
markcowl previously approved these changes May 2, 2017
@markcowl markcowl dismissed cormacpayne’s stale review May 2, 2017 05:49

Discussed offline changes are ok

@markcowl
Copy link
Member

markcowl commented May 2, 2017

@markcowl markcowl merged commit 97e8416 into Azure:preview May 2, 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.

6 participants