Skip to content

Implemeted Usage cmdlet for Network; Added usage tests #4009

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 5 commits into from
Jun 4, 2017

Conversation

EvgenyAgafonchikov
Copy link
Contributor

@EvgenyAgafonchikov EvgenyAgafonchikov commented May 22, 2017

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

@msftclas
Copy link

@EvgenyAgafonchikov,
Thanks for your contribution as a Microsoft full-time employee or intern. You do not need to sign a CLA.
Thanks,
Microsoft Pull Request Bot

@azuresdkci
Copy link

Can one of the admins verify this patch?

@EvgenyAgafonchikov
Copy link
Contributor Author

@markcowl could you please clarify is this part required now:

If changes were made to any cmdlet, the XML help was regenerated using the platyPSHelp module.

It looks like there is no XML help file in Network module now. Was something moved/restructured?

@markcowl
Copy link
Member

@EvgenyAgafonchikov Help is now all in markdown - the xml file is created at runtime. See: https://github.com/Azure/azure-powershell/blob/preview/documentation/help-generation.md

@EvgenyAgafonchikov EvgenyAgafonchikov changed the title [Do not merge. Test mode] Implemeted Usage cmdlet for Network; Added usage tests Implemeted Usage cmdlet for Network; Added usage tests May 24, 2017
# Get-AzureRmNetworkUsage

## SYNOPSIS
{{Fill in the Synopsis}}
Copy link
Member

Choose a reason for hiding this comment

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

You have to actually fill these in with proper values

namespace Microsoft.Azure.Commands.Network.Automation
{
[Cmdlet(VerbsCommon.Get, "AzureRmNetworkUsage")]
public partial class GetAzureRmNetworkUsage : NetworkBaseCmdlet
Copy link
Member

Choose a reason for hiding this comment

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

Need an OutputType attribute, with the proper OutputType

@markcowl
Copy link
Member

@DeepakRajendranMsft can you please review/approve?

PS C:\> Get-AzureRmNetworkUsage -Location westcentralus
```

Gets resources usage data in westcentralus region
Copy link
Member

Choose a reason for hiding this comment

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

Please show a representation of the output of the cmdlet


namespace Microsoft.Azure.Commands.Network.Automation
{
[Cmdlet(VerbsCommon.Get, "AzureRmNetworkUsage"), OutputType(typeof(PSUsage))]
Copy link
Member

Choose a reason for hiding this comment

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

What does the output of this cmdlet look like on screen? Please see the help comments below and include this. You will want to make sure that the most relevant information is displayed, and extraneous information is not.

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, I've updated documentation. Could you please have a look?

@DeepakRajendranMsft
Copy link
Contributor

@markcowl @EvgenyAgafonchikov i have approved the changes

markcowl
markcowl previously approved these changes Jun 4, 2017
<ViewSelectedBy>
<TypeName>Microsoft.Azure.Commands.Network.Models.PSUsage</TypeName>
</ViewSelectedBy>
<ListControl>
Copy link
Member

Choose a reason for hiding this comment

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

The ddefault here should be a table view - with only 3 columns, this makes the display much easier. Users can always use the list view by piping through fl

@markcowl
Copy link
Member

markcowl commented Jun 4, 2017

@azuresdkci add to whitelist

@markcowl
Copy link
Member

markcowl commented Jun 4, 2017

@markcowl markcowl changed the base branch from preview to release-4.1.0 June 4, 2017 00:11
@markcowl markcowl merged commit 7674d70 into Azure:release-4.1.0 Jun 4, 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.

5 participants