-
Notifications
You must be signed in to change notification settings - Fork 4k
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
Conversation
@EvgenyAgafonchikov, |
Can one of the admins verify this patch? |
7d1ba83
to
8110bb2
Compare
8110bb2
to
e7ce6d9
Compare
@markcowl could you please clarify is this part required now:
It looks like there is no XML help file in Network module now. Was something moved/restructured? |
@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 |
168dc44
to
e7ce6d9
Compare
# Get-AzureRmNetworkUsage | ||
|
||
## SYNOPSIS | ||
{{Fill in the Synopsis}} |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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
@DeepakRajendranMsft can you please review/approve? |
PS C:\> Get-AzureRmNetworkUsage -Location westcentralus | ||
``` | ||
|
||
Gets resources usage data in westcentralus region |
There was a problem hiding this comment.
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))] |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
@markcowl @EvgenyAgafonchikov i have approved the changes |
<ViewSelectedBy> | ||
<TypeName>Microsoft.Azure.Commands.Network.Models.PSUsage</TypeName> | ||
</ViewSelectedBy> | ||
<ListControl> |
There was a problem hiding this comment.
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
@azuresdkci add to whitelist |
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
Testing Guidelines
Cmdlet Signature Guidelines
ShouldProcess
and haveSupportShouldProcess=true
specified in the cmdlet attribute. You can find more information onShouldProcess
here.OutputType
attribute if any output is produced - if the cmdlet produces no output, it should implement aPassThru
parameter.Cmdlet Parameter Guidelines