Skip to content

Switch to swagger generated SDK for operational insights powershell commands #3961

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 6 commits into from
May 18, 2017
Merged

Conversation

xizha162
Copy link
Contributor

@xizha162 xizha162 commented May 12, 2017

Description

  1. Resubmitting the PR for switching to swagger generated .Net SDK client for OperationalInsights powershell commands since we will soon retire Hydra SDK. There are no API behavior change. Mostly syntax change.
  2. Added a small change to include retentionInDays parameter for workspace operations.

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.

@xizha162 xizha162 requested a review from haitch May 15, 2017 20:23
haitch
haitch previously approved these changes May 15, 2017
@xizha162
Copy link
Contributor Author

@shahabhijeet Fixed the build error from last week and Haitao also signed off. Could you take a look now? There was minimal functional change. The main change is just switching to operational insight SDK 0.18 which is based on swagger now.

Copy link
Member

@markcowl markcowl left a comment

Choose a reason for hiding this comment

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

One minor change and need to pass the on demand run, other wise LGTM

public string Sku { get; set; }

[Parameter(Position = 4, Mandatory = false, ValueFromPipelineByPropertyName = true,
HelpMessage = "The resource tags for the workspace.")]
public Hashtable Tags { get; set; }

[Parameter(Position = 5, Mandatory = false, ValueFromPipelineByPropertyName = true,
Copy link
Member

Choose a reason for hiding this comment

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

Please remove the position property from this parameter. > 4 positional parameters is too many.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@markcowl , fixed by removing the position parameter.

@xizha162
Copy link
Contributor Author

@markcowl , @shahabhijeet , I addressed the comments. Please take a look and sign off if no other issues. Thank you very much!

@markcowl
Copy link
Member

on demand run here: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1594/

LGTM once this passes

@cormacpayne cormacpayne merged commit 3c56e78 into Azure:preview May 18, 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.

7 participants