Adding Virtual Network Usage cmdlet #4159

EvgenyAgafonchikov · 2017-06-20T11:57:17Z

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.

I have read the contribution guidelines.
If changes were made to any cmdlet, the XML help was regenerated using the platyPSHelp module.
If any large changes are made to a service, they are reflected in the respective change log.

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 · 2017-06-20T11:57:22Z

@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

shahabhijeet · 2017-06-23T19:45:31Z

src/ResourceManager/Network/Commands.Network/VirtualNetwork/VirtualNetworkListUsageMethod.cs

+            Mandatory = true,
+            ValueFromPipelineByPropertyName = true)]
+        [ValidateNotNullOrEmpty]
+        public string Name { get; set; }


@EvgenyAgafonchikov what does Name parameter mean here?

Name is name of the Virtual Network to perform operation on. Added help messages to avoid confusion.

shahabhijeet · 2017-06-23T19:45:52Z

src/ResourceManager/Network/Commands.Network/help/Add-AzureRmRouteFilterRuleConfig.md

@@ -35,6 +35,8 @@ The Add-AzureRmRouteFilterRuleConfig cmdlet adds a route filter rule to an Azure



+


@EvgenyAgafonchikov remove extra line breaks

@shahabhijeet, *.md files line breaks are added during the process of help autogeneration. Could you please clarify, should I manually update autogenerated files or keep them as is in this case?

@EvgenyAgafonchikov platyPS will sometimes add these blank lines (I haven't determined why yet), so you can go ahead and revert the changes that add unnecessary lines that are autogenerated.

shahabhijeet · 2017-06-23T19:49:00Z

src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkUsageList.md

+```
+PS C:\> Get-AzureRmVirtualNetworkUsageList -ResourceGroupName test -Name usagetest
+
+Get-AzureRmVirtualNetworkUsageList -ResourceGroupName test -Name usagetest


@EvgenyAgafonchikov can you provide an example of how to use this particular cmdlet when a list if returned
Give a full example something along the line of
$vNetUsageList = Get-AzureRmVirtualNetworkUsageList -ResourceGroupName test -Name usagetest
Because the name has the noun list, but all you are doing is returning 1 PSVirtualNetworkUsage rather the expectation is it should return IEnumerable

Updated cmdlet to return List<PSVirtualNetworkUsage> explicitly.
The example output sample contains list of two PSVirtualNetworkUsage items now

cormacpayne · 2017-06-27T00:02:08Z

src/ResourceManager/Network/Commands.Network/VirtualNetwork/VirtualNetworkListUsageMethod.cs

+            HelpMessage = "The resource group name.")]
+        [ValidateNotNullOrEmpty]
+        public string ResourceGroupName { get; set; }
+        [Parameter(


@EvgenyAgafonchikov nit: can we put a blank line between the two parameters?

cormacpayne · 2017-06-27T16:30:06Z

src/ResourceManager/Network/Commands.Network/Models/PSVirtualNetworkUsage.cs

+{
+    public partial class PSVirtualNetworkUsage
+    {
+        public string Id;


@EvgenyAgafonchikov nit: for each of these properties, can we add the get and set methods to be consistent with the other model classes?

public string Id { get; set; }

cormacpayne · 2017-06-27T16:33:13Z

src/ResourceManager/Network/Commands.Network/VirtualNetwork/VirtualNetworkListUsageMethod.cs

+                var vVirtualNetworkModel = Mapper.Map<CNM.PSVirtualNetworkUsage>(vVirtualNetwork);
+                vnetUsageList.Add(vVirtualNetworkModel);
+            }
+            WriteObject(vnetUsageList);


@EvgenyAgafonchikov this should be WriteObject(vnetUsageList, true) (which sets the enumerateCollection parameter to true) so that the list you have constructed writes each object to the output stream rather than writes the array as a whole object to the stream

cormacpayne · 2017-06-27T16:34:33Z

src/ResourceManager/Network/Commands.Network/help/Add-AzureRmRouteFilterRuleConfig.md

@@ -35,6 +35,8 @@ The Add-AzureRmRouteFilterRuleConfig cmdlet adds a route filter rule to an Azure



+


@EvgenyAgafonchikov platyPS will sometimes add these blank lines (I haven't determined why yet), so you can go ahead and revert the changes that add unnecessary lines that are autogenerated.

cormacpayne · 2017-06-27T16:34:52Z

src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayBackendHealth.md

@@ -37,6 +37,8 @@ The Get-AzureRmApplicationGatewayBackendHealth cmdlet gets application gateway b



+
+


@EvgenyAgafonchikov same comment about removing the extra blank lines in this file

cormacpayne · 2017-06-27T16:35:23Z

src/ResourceManager/Network/Commands.Network/help/Test-AzureRmNetworkWatcherConnectivity.md

@@ -38,6 +38,8 @@ The Test-AzureRmNetworkWatcherConnectivity cmdlet returns connectivity informati



+


@EvgenyAgafonchikov same comment about removing the blank lines in this file

EvgenyAgafonchikov · 2017-06-27T17:28:34Z

@cormacpayne , I've processed recent comments, please have a look once CI pass

cormacpayne · 2017-06-27T18:14:53Z

On-demand: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1707/

shahabhijeet · 2017-06-28T05:26:28Z

@EvgenyAgafonchikov looks good, should be good to go, once all @cormacpayne feedback is addressed.

msftclas added the cla-already-signed label Jun 20, 2017

azuresdkci added the needs-review label Jun 20, 2017

azuresdkci assigned shahabhijeet Jun 20, 2017

cormacpayne added the Do Not Merge 🚫 label Jun 20, 2017

cormacpayne changed the title ~~[Do not merge yet: depends on SDK publishing] Adding Virtual Network Usage cmdlet~~ Adding Virtual Network Usage cmdlet Jun 20, 2017

shahabhijeet suggested changes Jun 23, 2017

View reviewed changes

shahabhijeet added needs-revision and removed needs-review labels Jun 23, 2017

EvgenyAgafonchikov force-pushed the vnetusage branch from 6b00118 to 190e20e Compare June 26, 2017 12:34

EvgenyAgafonchikov added needs-review and removed Do Not Merge 🚫 needs-revision labels Jun 26, 2017

EvgenyAgafonchikov force-pushed the vnetusage branch 2 times, most recently from e6b049c to 012f5c7 Compare June 26, 2017 16:48

EvgenyAgafonchikov added 2 commits June 27, 2017 10:28

Adding Virtual Network Usage cmdlet

aa7bd12

Processed PR comments, improved cmdlet output

bfc8381

EvgenyAgafonchikov force-pushed the vnetusage branch from 012f5c7 to bfc8381 Compare June 27, 2017 07:29

cormacpayne suggested changes Jun 27, 2017

View reviewed changes

Processing PR comments

a5cf44d

DeepakRajendranMsft approved these changes Jun 27, 2017

View reviewed changes

shahabhijeet approved these changes Jun 28, 2017

View reviewed changes

cormacpayne approved these changes Jun 28, 2017

View reviewed changes

cormacpayne merged commit b739d15 into Azure:preview Jun 28, 2017

		@@ -35,6 +35,8 @@ The Add-AzureRmRouteFilterRuleConfig cmdlet adds a route filter rule to an Azure

		@@ -37,6 +37,8 @@ The Get-AzureRmApplicationGatewayBackendHealth cmdlet gets application gateway b

		@@ -38,6 +38,8 @@ The Test-AzureRmNetworkWatcherConnectivity cmdlet returns connectivity informati

Adding Virtual Network Usage cmdlet #4159

Adding Virtual Network Usage cmdlet #4159

Uh oh!

Conversation

EvgenyAgafonchikov commented Jun 20, 2017 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

msftclas commented Jun 20, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EvgenyAgafonchikov commented Jun 27, 2017

Uh oh!

cormacpayne commented Jun 27, 2017

Uh oh!

shahabhijeet commented Jun 28, 2017

Uh oh!

Uh oh!

EvgenyAgafonchikov commented Jun 20, 2017 •

edited by azuresdkci

Loading