Skip to content

Fix usability bugs in Get-AzureRmOperationalInsightsSearchResults #3343

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

Conversation

pilor
Copy link
Contributor

@pilor pilor commented Jan 3, 2017

  1. Default Top parameter to 10 if it is not present
  2. Don't emit an error object if there was no error
  3. Improve default formatting of result objects

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 PassThrough 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.

1.  Default Top parameter to 10 if it is not present
2.  Introduce 2 parameter sets to make usage and documentation more
clear
3.  Don't emit an error object if there was no error
4.  Improve default formatting of result objects
@azurecla
Copy link

azurecla commented Jan 3, 2017

Hi @pilor, I'm your friendly neighborhood Azure Pull Request Bot (You can call me AZPRBOT). Thanks for your contribution!


It looks like you're working at Microsoft (cheggert). If you're full-time, we DON'T require a contribution license agreement.



If you are a vendor, DO please sign the electronic contribution license agreement. It will take 2 minutes and there's no faxing! https://cla.azure.com.

TTYL, AZPRBOT;

@shahabhijeet
Copy link
Contributor

shahabhijeet commented Jan 6, 2017

@pilor we need a sign off from your team. I cannot find anyone in our list of contacts for operational insights.

The change looks good to me. Signing off.

@pilor
Copy link
Contributor Author

pilor commented Jan 6, 2017

@shahabhijeet Codeflow CR from the team is here: http://codeflow/Dashboard/review/display/cheggert-67bc6c2b7fa746c09b616772f1594ccc

I'll get someone to also comment in this pull request as a sign-off

@lwang2016
Copy link
Member

The change looks good to me. Signing off.

@shahabhijeet shahabhijeet merged commit ae94f1b into Azure:dev Jan 9, 2017
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