Powershell for Management Groups #5421

rajshah11 · 2018-02-01T13:11:33Z

Description

This PR includes cmdlets and tests for Management Groups.

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.

Bring preview branch up to date

Update preview branch after 5.0.0 release

…handling.

…ures.

…Subscription where SubscriptionId was accidentally SubscriptonId.

… for a RP.

… to auto register.

… into powershell-for-groupsrp

cormacpayne

@rajshah11 a few initial comments to take a look at

cormacpayne · 2018-02-01T16:46:22Z

setup/azurecmdfiles.wxi

@@ -2,4224 +2,256 @@
 <Include xmlns="http://schemas.microsoft.com/wix/2006/wi">
    <Fragment>
        <DirectoryRef Id="PowerShellFolder">
-            <Component Id="cmp146D4BC76FE0B2425722E32B160714B3" Guid="*">


@rajshah11 it looks like the wix file was incorrectly generated -- you will need to do a full build and then generate this file. Information about generating the wxi file can be found here.

cormacpayne · 2018-02-01T16:47:13Z

src/ResourceManager/ManagementGroups/AzureRM.ManagementGroups.psd1

+# ProcessorArchitecture = ''
+
+# Modules that must be imported into the global environment prior to importing this module
+RequiredModules = @(@{ModuleName = 'AzureRM.Profile'; ModuleVersion = '4.0.0'; })


@rajshah11 please make sure to pull the latest changes from the preview branch. The latest version of AzureRM.Profile that your module should be referencing is 4.2.0

cormacpayne · 2018-02-01T16:48:17Z

src/ResourceManager/ManagementGroups/AzureRM.ManagementGroups.psd1

+        # IconUri = ''
+
+        # ReleaseNotes of this module
+        ReleaseNotes = '* Add support for online help


@rajshah11 you can leave the ReleaseNotes field blank for now -- we will update it before this is released

@rajshah11 ping on this comment

Done. Thanks!

cormacpayne · 2018-02-01T16:49:29Z

src/ResourceManager/ManagementGroups/Commands.ManagementGroups.Test/Properties/AssemblyInfo.cs

+// You can specify all the values or you can default the Build and Revision Numbers 
+// by using the '*' as shown below:
+// [assembly: AssemblyVersion("1.0.*")]
+[assembly: AssemblyVersion("1.0.0.0")]


@rajshah11 for consistency, AssemblyVersion and AssemblyFileVersion should match the version of your module (0.0.1)

Done. Thanks!

cormacpayne · 2018-02-01T16:50:44Z

...ourceManager/ManagementGroups/Commands.ManagementGroups/Cmdlets/GetAzureRmManagementGroup.cs

+    /// <summary>
+    /// Get-AzureRmManagementGroup Cmdlet
+    /// </summary>
+    [Cmdlet(VerbsCommon.Get,"AzureRmManagementGroup", DefaultParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet, SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium), OutputType(typeof(string))]


@rajshah11 please remove the ConfirmImpact property

Done. Thanks!

cormacpayne · 2018-02-01T21:49:21Z

src/ResourceManager/ManagementGroups/Commands.ManagementGroups/Commands.ManagementGroups.csproj

+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <ItemGroup>
+    <Reference Include="Hyak.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">


@rajshah11 please import the Common.Dependencies.targets file, like so. This will allow you to remove almost all of the packages you are referencing in this file.

Done. Thanks!!

cormacpayne · 2018-02-01T21:49:47Z

src/ResourceManager/ManagementGroups/Commands.ManagementGroups/Commands.ManagementGroups.csproj

+      <Link>AzureRM.ManagementGroups.psd1</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Include="app.config" />


@rajshah11 please remove this reference to app.config

cormacpayne · 2018-02-01T21:50:00Z

src/ResourceManager/ManagementGroups/Commands.ManagementGroups/Commands.ManagementGroups.csproj

+  </ItemGroup>
+  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Import Project="..\packages\Microsoft.Bcl.Build.1.0.14\tools\Microsoft.Bcl.Build.targets" Condition="Exists('..\packages\Microsoft.Bcl.Build.1.0.14\tools\Microsoft.Bcl.Build.targets')" />
+  <Target Name="EnsureBclBuildImported" BeforeTargets="BeforeBuild" Condition="'$(BclBuildImported)' == ''">


@rajshah11 you can remove this Bcl target

cormacpayne · 2018-02-01T21:50:43Z

src/ResourceManager/ManagementGroups/Commands.ManagementGroups/Properties/AssemblyInfo.cs

+// You can specify all the values or you can default the Build and Revision Numbers 
+// by using the '*' as shown below:
+// [assembly: AssemblyVersion("1.0.*")]
+[assembly: AssemblyVersion("1.0.0.0")]


@rajshah11 same comment about keeping this values in line with the module version

cormacpayne · 2018-02-01T21:56:29Z

src/ResourceManager/ManagementGroups/Commands.ManagementGroups/packages.config

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<packages>
+  <package id="Hyak.Common" version="1.0.2" targetFramework="net452" />


@rajshah11 similarly to your .csproj file, you can remove all of the common packages (it should be everything but the Microsoft.Azure.Management.ResourceManager package)

cormacpayne · 2018-02-01T22:04:59Z

@rajshah11 Hey Raj, the build is currently failing because it cannot find version 1.7.0-preview of Microsoft.Azure.Management.ResourceManager. You can do one of two things:

(1) If your changes are merged into the .NET SDK repository and the package is ready to be published, you can publish it to NuGet

(2) Create a signed NuGet package that you can place in tools/LocalFeed and use for testing until the package is pushed to NuGet

…nto powershell-for-groupsrp

cormacpayne

@rajshah11 a few more comments to take a look at. Also,

(1) Make sure to update the TestMappings.json file to include an entry for your tests

(2) Once the Microsoft.Azure.Management.ResourceManager SDK is published with your changes, we should look at reverting the changes you made to external projects that update the version of this SDK used

cormacpayne · 2018-02-12T16:28:33Z

src/ResourceManager/ManagementGroups/AzureRM.ManagementGroups.psd1

+        # IconUri = ''
+
+        # ReleaseNotes of this module
+        ReleaseNotes = '* Add support for online help


@rajshah11 ping on this comment

cormacpayne · 2018-02-12T16:29:59Z

src/ResourceManager/ManagementGroups/AzureRM.ManagementGroups.psd1

+    - Run Get-Help with the -Online parameter to open the online help in your default Internet browser'
+
+        # External dependent modules of this module
+        # ExternalModuleDependencies = ''


@rajshah11 if you updated your version of the PowerShellGet module to 1.6.0, you'll be able to update this module to include the Prerelease property, which you will want to set to preview. Here is an example of a module doing this.

Done. Thanks.

cormacpayne · 2018-02-12T16:32:43Z

...gementGroups/Commands.ManagementGroups.Test/ScenarioTests/GetAzureRmManagementGroupTests.ps1

+
+function Test-ListManagementGroups
+{
+    $response = Get-AzureRmManagementGroup


@rajshah11 for all of the below tests, please be sure the necessary setup is included in the tests (i.e., if anything needs to be created before Get-AzureRmManagementGroup is called, that should be included). This makes it easier for others to record these tests if needed.

Done. Thanks!

cormacpayne · 2018-02-12T16:33:35Z

...entGroups/Commands.ManagementGroups.Test/ScenarioTests/RemoveAzureRmManagementGroupTests.ps1

+
+function Test-RemoveManagementGroup
+{
+    $response = Remove-AzureRmManagementGroup -GroupName TestPSNewGroup3


@rajshah11 same comment about necessary test setup

Done. Thanks!

cormacpayne · 2018-02-12T16:34:10Z

...entGroups/Commands.ManagementGroups.Test/ScenarioTests/UpdateAzureRmManagementGroupTests.ps1

+
+function Test-UpdateManagementGroup
+{
+    $response = Update-AzureRmManagementGroup -GroupName TestPSNewGroup3


@rajshah11 same comment about including the necessary test setup for the below tests

Done. Thanks!

cormacpayne · 2018-02-12T16:48:49Z

...ceManager/ManagementGroups/Commands.ManagementGroups/Cmdlets/RemoveAzureRmManagementGroup.cs

+    [Cmdlet(VerbsCommon.Remove, "AzureRmManagementGroup",
+         DefaultParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet,
+         SupportsShouldProcess = true), OutputType(typeof(bool))]
+    public class RemoveAzureRmManagementGroup : AzureManagementGroupsCmdletBase


@rajshah11 this cmdlet should support the InputObject parameter set, so that a user could pipe the output of Get-AzureRmManagementGroup to this cmdlet

Done. Thanks

cormacpayne · 2018-02-12T16:49:09Z

...nagementGroups/Commands.ManagementGroups/Cmdlets/RemoveAzureRmManagementGroupSubscription.cs

+                {
+                    if (context.Subscription.Id != SubscriptionId.ToString())
+                    {
+                        Utility.AzureManagementGroupAutoRegisterSubscription(SubscriptionId.ToString(), context);


@rajshah11 same comment about if this is necessary

@cormacpayne Replied above

cormacpayne · 2018-02-12T16:49:26Z

...nagementGroups/Commands.ManagementGroups/Cmdlets/RemoveAzureRmManagementGroupSubscription.cs

+    [Cmdlet(VerbsCommon.Remove, "AzureRmManagementGroupSubscription",
+         DefaultParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet,
+         SupportsShouldProcess = true), OutputType(typeof(bool))]
+    public class RemoveAzureRmManagementGroupSubscription : AzureManagementGroupAutoRegisterCmdletBase


@rajshah11 same comment about supporting the InputObject parameter set

We don't have a Get for subscription in a group. I don't think piping should be supported here. Correct me if I am wrong. Thanks

cormacpayne · 2018-02-12T17:10:40Z

...ceManager/ManagementGroups/Commands.ManagementGroups/Cmdlets/UpdateAzureRmManagementGroup.cs

+namespace Microsoft.Azure.Commands.ManagementGroups.Cmdlets
+{
+    [Cmdlet("Update", "AzureRmManagementGroup", DefaultParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSManagementGroupNoChildren))]
+    public class UpdateAzureRmManagementGroup : AzureManagementGroupsCmdletBase


@rajshah11 same comment about supporting the InputObject parameter set

Done. Thanks

cormacpayne · 2018-02-12T17:11:30Z

src/ResourceManager/ManagementGroups/Commands.ManagementGroups/Commands.ManagementGroups.csproj

+  </ItemGroup>
+  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Import Project="..\..\..\..\tools\Common.Dependencies.targets" />
+  <Import Project="..\packages\Microsoft.Bcl.Build.1.0.14\tools\Microsoft.Bcl.Build.targets" Condition="Exists('..\packages\Microsoft.Bcl.Build.1.0.14\tools\Microsoft.Bcl.Build.targets')" />


@rajshah11 you should be able to remove this import

Removed. Thanks

rajshah11 · 2018-02-14T12:44:08Z

@cormacpayne made all the changes and the build is passing too. Just FYI we have moved out of the ResourceManager SDK for a SDK of our own. I have reverted the package references changes and made the new changes accordingly

This reverts commit 5544b22, reversing changes made to ed41937.

This reverts commit f5332f5.

maddieclayton · 2018-02-14T23:54:50Z

Closing in favor of the new PR

markcowl and others added 19 commits November 2, 2017 17:28

Merge pull request #370 from markcowl/uptodate

3491fd3

Bring preview branch up to date

Merge pull request #372 from cormacpayne/preview-5.0.0

72c05ab

Update preview branch after 5.0.0 release

Powershell cmdlets for groupsrp

f2bb59b

Updated cmdlets

2f2cd19

Added comments

663f57f

Removing missing file from Commands.ManagementGroups.csproj.

0b41002

Updating Cmdlets to work with the latest SDK changes.

65e53b4

Management Groups:Updating cmdlets to have better formatting + error …

918ba9c

…handling.

Management Group: Forgot to separate out PSParentGroupInfo.cs

bd83303

Management Group: Changing GroupId to be GroupName.

08dfd2e

Management Group: Forgot to include this one in bd83303.

ffa8892

Management Group: Adding better null checking for various data struct…

5d9a0eb

…ures.

Adding help files.

5ac42e0

Management Groups: Fixing typo for (Add|Remove)-AzureRmMangementGroup…

3605bfd

…Subscription where SubscriptionId was accidentally SubscriptonId.

Adding support for cmdlets to precheck registration and auto register…

87933a9

… for a RP.

Modifying the (Add|Remove)-AzureRmManagementGroupSubscription cmdlets…

b4b7312

… to auto register.

Merge branch 'preview' of https://github.com/rajshah11/azure-powershell…

6b4722a

… into powershell-for-groupsrp

Updated cmdlets

cfffa98

Adding Tests and minor changes to cmdlets

c831a32

azuresdkci added the needs-review label Feb 1, 2018

azuresdkci assigned markcowl Feb 1, 2018

Adding license headers

398ce3e

cormacpayne suggested changes Feb 1, 2018

View reviewed changes

cormacpayne added needs-revision and removed needs-review labels Feb 1, 2018

cormacpayne assigned rajshah11 and unassigned markcowl Feb 1, 2018

rajshah11 added 2 commits February 1, 2018 16:09

Made changes suggested in the PR

abf4409

Merge branch 'preview' of https://github.com/Azure/azure-powershell i…

5b9b60c

…nto powershell-for-groupsrp

Raj Shah added 6 commits February 7, 2018 10:05

Add description to EventHub md to fix buid

326050d

Merge branch 'preview' of https://github.com/Azure/azure-powershell i…

10259e1

…nto powershell-for-groupsrp

Updated installer files

814ccae

Added autoregistration of other subs to 2 cmdlets

ada44cb

Update Resource Manager in all projects

9656d0b

Minor Spec Change

af07119

cormacpayne changed the base branch from preview to mgmt-group-preview February 9, 2018 23:28

cormacpayne suggested changes Feb 12, 2018

View reviewed changes

cormacpayne added needs-revision and removed needs-review labels Feb 12, 2018

cormacpayne assigned rajshah11 and unassigned cormacpayne Feb 12, 2018

Raj Shah added 5 commits February 12, 2018 10:59

Changes after moving managementgroups out of the resource sdk

b1528a2

sdk update, new test, comments on the PR

aef5cba

Remove Bcl from test

7109670

Update installer file

7df4572

Change namespace for Test

ed41937

MiYanni assigned cormacpayne and unassigned rajshah11 Feb 14, 2018

MiYanni added needs-review and removed needs-revision labels Feb 14, 2018

azdevxps and others added 5 commits February 14, 2018 09:47

initial changes

500221d

merge

5544b22

Revert "merge"

ae6c884

This reverts commit 5544b22, reversing changes made to ed41937.

Update Resource Manager in all projects

f5332f5

Revert "Update Resource Manager in all projects"

8afb799

This reverts commit f5332f5.

rajshah11 mentioned this pull request Feb 14, 2018

Powershell for ManagementGroups #5536

Merged

13 tasks

maddieclayton closed this Feb 14, 2018

Powershell for Management Groups #5421

Powershell for Management Groups #5421

Uh oh!

Conversation

rajshah11 commented Feb 1, 2018 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

This PR includes cmdlets and tests for Management Groups.

Uh oh!

cormacpayne left a comment

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!

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!

cormacpayne commented Feb 1, 2018

Uh oh!

cormacpayne left a comment

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!

Choose a reason for hiding this comment

rajshah11 commented Feb 1, 2018 •

edited by azuresdkci

Loading

rajshah11 Feb 13, 2018 •

edited

Loading