[ARM] Bump version of `azure-mgmt-managementgroups` from `0.2.0` to `1.0.0` (Track 2 SDK) and add new sub commands for management-group #20942

git-thomasdolan · 2022-01-10T22:12:34Z

Description

Update the SDK version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0.
Add a new command subgroup az account management-group entities
Add a new command subgroup az account management-group hierarchy-settings
Add a new command subgroup az account management-group tenant-backfill
Add a new command az account management-group subscription show
Add a new command az account management-group subscription show-sub-under-mg
Add a new command az account management-group check-name-availability

Testing Guide

Check if "GroupName" is valid.
cmd: az account management-group check-name-availability -n GroupName
Show the details of a subscription "subName" under a management group "GroupName"
cmd: az account management-group subscription show -n GroupName -s subName
Get the subscription(s) under a management group "GroupName"
cmd: az account management-group subscription show -n GroupName
Get the Backfill Status for the current tenant
cmd: az account management-group tenant-backfill get
Start Backfilling Subscriptions for the current tenant
cmd: az account management-group tenant-backfill start
List all entities for the authenticated user
cmd: az account management-group entities list
Get all hierarchy settings under the "RootMG" tenant
cmd: az account management-group hierarchy-settings list-n RootMG
Create a hierarchy setting to require write permissions on the "RootMG" tenant to create a new Management Group under it
cmd: az account management-group hierarchy-settings create -n RootMG -r True
Create a hierarchy setting to set "defaultGroup" as the new MG groups get created under in the "RootMG" tenant
cmd: az account management-group hierarchy-settings create -n RootMG -m /providers/Microsoft.Management/managementGroups/DefaultGroup
Update the hierarchy setting to require write permissions on the "RootMG" tenant to create a new Management Group under
cmd: az account management-group hierarchy-settings update-n RootMG -r True
Update the hierarchy setting to set "defaultGroup" as the new MG groups get created under in the "RootMG" tenant
cmd: az account management-group hierarchy-settings update -n RootMG -m /providers/Microsoft.Management/managementGroups/DefaultGroup
Delete the hierarchy settings for the "RootMG" tenant
cmd: az account management-group hierarchy-settings delete -n RootMG

History Notes

[ARM] az account management-group entities: Add a new command group to support entities (Management Groups and Subscriptions) operations for the authenticated user
[ARM] az account management-group hierarchy-settings: Add a new command group to support operations on hierarchy settings defined at the management group level
[ARM] az account management-group tenant-backfill: Add a new command group to support backfilling subscriptions for the tenant
[ARM] az account management-group subscription show: Get the details of a given subscription under a given management group
[ARM] az account management-group subscription show-sub-under-mg: Show what subscription is under a given management group
[ARM] az account management-group check-name-availability: Check if a management group name is valid and available

This checklist is used to make sure that common guidelines for a pull request are followed.

The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.

ghost · 2022-01-10T22:12:38Z

Thank you for your contribution git-thomasdolan! We will review the pull request and get back to you soon.

yonzhan · 2022-01-10T22:36:03Z

managementgroups

zhoxing-ms · 2022-01-11T07:22:19Z

ERROR: ************* Module azure.cli.command_modules.resource._exception_handler
src/azure-cli/azure/cli/command_modules/resource/_exception_handler.py:10:4: E0611: No name 'ErrorResponseException' in module 'azure.mgmt.managementgroups.models' (no-name-in-module)
src/azure-cli/azure/cli/command_modules/resource/_exception_handler.py:10:4: E0611: No name 'ErrorResponseException' in module 'azure.mgmt.managementgroups.models' (no-name-in-module)

@git-thomasdolan Hi, in the track 2 SDK, please replace from azure.mgmt.managementgroups.models import ErrorResponseException with from azure.core.exceptions import HttpResponseError to fix the CI issue

zhoxing-ms · 2022-01-11T07:44:10Z

@git-thomasdolan In addition, since the version 1.0.0 of azure-mgmt-managementgroups is Track 2 SDK, there will be a large number of breaking changes in the SDK, you need to add corresponding compatible logic to account management-group xxx related commands.
For how to migrate Track 2 SDK, you can refer to #17783 (comment)

Then you need to re-run all the tests which include account management-group xxx command in module resource through live mode, so as to update the api-version in yaml file which no longer matches the actual value in SDK after upgrading the SDK version.

src/azure-cli/azure/cli/command_modules/resource/custom.py

…ive mode

src/azure-cli/azure/cli/command_modules/resource/commands.py

…hecks

git-thomasdolan · 2022-01-22T01:05:19Z

@zhoxing-ms I have the update method use the begin_create_or_update method in the SDK, after that it was able to pass the tests. If that is okay, then this is ready for review. The Azure Portal also seems to use the PUT method instead of PATCH when I checked so this would be consistent with Azure Portal

src/azure-cli/azure/cli/command_modules/resource/commands.py

git-thomasdolan · 2022-02-09T03:05:51Z

Hi @zhoxing-ms, we fixed the parentId parameter issue in our API Controller code and now the PATCH MG route works. It is passing all the unit tests but now it is failing the credential scan. Do you know what causes this?

zhoxing-ms · 2022-02-09T06:42:33Z

@git-thomasdolan This is a problem caused by credscan package Microsoft.Security.CredScan upgrade. We have submitted a PR #21230 to pin it

zhoxing-ms · 2022-02-09T07:02:11Z

/azp run

azure-pipelines · 2022-02-09T07:02:27Z

Azure Pipelines successfully started running 2 pipeline(s).

git-thomasdolan · 2022-02-09T18:08:17Z

Can this be reviewed again now that all the tests have passed?

src/azure-cli/azure/cli/command_modules/resource/_help.py

zhoxing-ms · 2022-02-10T09:24:20Z

src/azure-cli/azure/cli/command_modules/resource/commands.py

+    with self.command_group('account management-group hierarchy-settings', resource_hierarchy_settings_sdk, client_factory=cf_hierarchy_settings) as g:
+        g.custom_command('list', 'cli_hierarchy_settings_list')
+        g.custom_command('create', 'cli_hierarchy_settings_create')
+        g.custom_command('delete', 'cli_hierarchy_settings_delete')


Do we need to consider add confirmation=True for the delete command?

zhoxing-ms

@git-thomasdolan I see that there are some new commands in this PR. Could you please refer to the specification of this doc format-pr-description write what needs to be written into the history notes into the PR description

git-thomasdolan · 2022-02-16T00:28:15Z

Is my updated title/description okay? I wasn't sure if it was correct from the guideline you linked. I referred to some previous PRs for some help

zhoxing-ms · 2022-02-16T07:22:19Z

[ARM] Update the SDK version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0.

@git-thomasdolan Bumping SDK version doesn't need to be written into history notes, so please remove this item

[ARM] Add a new command subgroup az account management-group entities
[ARM] Add a new command subgroup az account management-group hierarchy-settings
[ARM] Add a new command subgroup az account management-group tenant-backfill
[ARM] Add a new command az account management-group subscription show
[ARM] Add a new command az account management-group subscription show-sub-under-mg
[ARM] Add a new command az account management-group check-name-availability

Please describe the specific features of the new commands and command groups
Such as:

[ARM] account management-group tenant-backfill: Add new command groups to support backfill tenant subscription operations

zhoxing-ms · 2022-02-18T08:23:43Z

...azure-cli/azure/cli/command_modules/resource/tests/hybrid_2019_03_01/test_managmentgroups.py

-            managementgroup_create["properties"]["tenantId"])
+            managementgroup_create["tenantId"])
        self.assertEqual(
-            managementgroup_create["properties"]["details"]["parent"]["name"],
-            managementgroup_create["properties"]["tenantId"])
-        self.assertIsNotNone(managementgroup_create["properties"]["tenantId"])


Why delete ["properties"]?

The json formatting changed when updating the API version, removing [properties]

zhoxing-ms · 2022-02-18T08:26:17Z

@git-thomasdolan Could you please address those conflicts?

azure-pipelines · 2022-02-18T18:51:00Z

Commenter does not have sufficient privileges for PR 20942 in repo Azure/azure-cli

git-thomasdolan · 2022-02-22T05:26:45Z

@zhoxing-ms Can you re-run the pipeline? The new title started with a space so it caused the tests to fail. I don't have permissions to re-run

jiasli · 2023-11-14T02:53:15Z

src/azure-cli/azure/cli/command_modules/resource/_help.py

+helps['account management-group tenant-backfill get'] = """
+type: command
+short-summary: Get the backfill status for a tenant.
+long-summary: Get the backfill status for a tenant.


long-summary should provide additional information, instead of being a duplicate of short-summary. See #6426 (comment).

Updated version number for azure-mgmt-managementgroups sdk

3a1f85e

ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Jan 10, 2022

yonzhan requested review from kairu-ms and jsntcy January 10, 2022 22:36

yonzhan assigned kairu-ms Jan 10, 2022

yonzhan added this to the Jan 2022 (2022-02-08) milestone Jan 10, 2022

git-thomasdolan mentioned this pull request Jan 10, 2022

Adding the az managementgroup extension for Management Groups Azure/azure-cli-extensions#4198

Closed

3 tasks

yonzhan requested a review from zhoxing-ms January 10, 2022 23:18

yonzhan assigned zhoxing-ms and unassigned kairu-ms Jan 10, 2022

zhoxing-ms changed the title ~~Updated version number for azure-mgmt-managementgroups sdk~~ {Compute} Bump version for azure-mgmt-managementgroups SDK Jan 11, 2022

zhoxing-ms changed the title ~~{Compute} Bump version for azure-mgmt-managementgroups SDK~~ {Compute} Bump version for azure-mgmt-managementgroups (Track 2 SDK) Jan 11, 2022

zhoxing-ms changed the title ~~{Compute} Bump version for azure-mgmt-managementgroups (Track 2 SDK)~~ {Compute} Bump version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0 (Track 2 SDK) Jan 11, 2022

git-thomasdolan added 2 commits January 11, 2022 13:23

Updated exception handler file to resolve errors in pipeline

3471e76

Re-ran some tests in live mode

2f7690c

git-thomasdolan commented Jan 12, 2022

View reviewed changes

src/azure-cli/azure/cli/command_modules/resource/custom.py Show resolved Hide resolved

Modified the update method for managementgroups and re-ran tests in l…

f6bcc41

…ive mode

git-thomasdolan commented Jan 13, 2022

View reviewed changes

src/azure-cli/azure/cli/command_modules/resource/commands.py Outdated Show resolved Hide resolved

git-thomasdolan added 3 commits January 20, 2022 22:33

Ran tests in latest and 2019_03_01 Profile

734090e

Re-ran tests in live mode under test_resource

d20bc4e

Updated management-group so that it now passes the style and linter c…

3d88232

…hecks

git-thomasdolan marked this pull request as ready for review January 22, 2022 01:05

zhoxing-ms reviewed Jan 23, 2022

View reviewed changes

src/azure-cli/azure/cli/command_modules/resource/commands.py Outdated Show resolved Hide resolved

zhoxing-ms changed the title ~~{Compute} Bump version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0 (Track 2 SDK)~~ {ARM} Bump version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0 (Track 2 SDK) Jan 25, 2022

zhoxing-ms removed this from the Jan 2022 (2022-02-08) milestone Jan 27, 2022

Ran a test in policyinsights

e48fcd1

git-thomasdolan requested a review from zhoxing-ms February 10, 2022 00:41

zhoxing-ms reviewed Feb 10, 2022

View reviewed changes

src/azure-cli/azure/cli/command_modules/resource/_help.py Outdated Show resolved Hide resolved

zhoxing-ms reviewed Feb 10, 2022

View reviewed changes

src/azure-cli/azure/cli/command_modules/resource/_help.py Outdated Show resolved Hide resolved

zhoxing-ms reviewed Feb 10, 2022

View reviewed changes

src/azure-cli/azure/cli/command_modules/resource/_help.py Outdated Show resolved Hide resolved

zhoxing-ms reviewed Feb 10, 2022

View reviewed changes

Made changes based on the PR comments

6a4431b

git-thomasdolan requested a review from zhoxing-ms February 10, 2022 20:41

zhoxing-ms approved these changes Feb 11, 2022

View reviewed changes

zhoxing-ms changed the title ~~{ARM} Bump version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0 (Track 2 SDK)~~ [ARM] Bump version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0 (Track 2 SDK) Feb 11, 2022

zhoxing-ms requested changes Feb 11, 2022

View reviewed changes

git-thomasdolan requested a review from zhoxing-ms February 11, 2022 22:12

zhoxing-ms reviewed Feb 18, 2022

View reviewed changes

zhoxing-ms changed the title ~~[ARM] Bump version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0 (Track 2 SDK)~~ [ARM] Bump version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0 (Track 2 SDK) and add new sub commands for management-group Feb 18, 2022

Merge branch 'dev' into dev

49339b7

zhoxing-ms approved these changes Feb 22, 2022

View reviewed changes

zhoxing-ms merged commit 03932ec into Azure:dev Feb 22, 2022

jiasli reviewed Nov 14, 2023

View reviewed changes

jiasli mentioned this pull request Nov 14, 2023

{ARM} Remove duplicate help messages #27836

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ARM] Bump version of `azure-mgmt-managementgroups` from `0.2.0` to `1.0.0` (Track 2 SDK) and add new sub commands for management-group #20942

[ARM] Bump version of `azure-mgmt-managementgroups` from `0.2.0` to `1.0.0` (Track 2 SDK) and add new sub commands for management-group #20942

git-thomasdolan commented Jan 10, 2022 •

edited by zhoxing-ms

Loading

ghost commented Jan 10, 2022

yonzhan commented Jan 10, 2022

zhoxing-ms commented Jan 11, 2022

zhoxing-ms commented Jan 11, 2022 •

edited

Loading

git-thomasdolan commented Jan 22, 2022 •

edited

Loading

git-thomasdolan commented Feb 9, 2022

zhoxing-ms commented Feb 9, 2022

zhoxing-ms commented Feb 9, 2022

azure-pipelines bot commented Feb 9, 2022

git-thomasdolan commented Feb 9, 2022

zhoxing-ms Feb 10, 2022

git-thomasdolan Feb 10, 2022

zhoxing-ms left a comment

git-thomasdolan commented Feb 16, 2022

zhoxing-ms commented Feb 16, 2022 •

edited

Loading

zhoxing-ms Feb 18, 2022

git-thomasdolan Feb 18, 2022

zhoxing-ms commented Feb 18, 2022

azure-pipelines bot commented Feb 18, 2022

git-thomasdolan commented Feb 22, 2022

jiasli Nov 14, 2023

[ARM] Bump version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0 (Track 2 SDK) and add new sub commands for management-group #20942

[ARM] Bump version of azure-mgmt-managementgroups from 0.2.0 to 1.0.0 (Track 2 SDK) and add new sub commands for management-group #20942

Conversation

git-thomasdolan commented Jan 10, 2022 • edited by zhoxing-ms Loading

ghost commented Jan 10, 2022

yonzhan commented Jan 10, 2022

zhoxing-ms commented Jan 11, 2022

zhoxing-ms commented Jan 11, 2022 • edited Loading

git-thomasdolan commented Jan 22, 2022 • edited Loading

git-thomasdolan commented Feb 9, 2022

zhoxing-ms commented Feb 9, 2022

zhoxing-ms commented Feb 9, 2022

azure-pipelines bot commented Feb 9, 2022

git-thomasdolan commented Feb 9, 2022

zhoxing-ms Feb 10, 2022

Choose a reason for hiding this comment

git-thomasdolan Feb 10, 2022

Choose a reason for hiding this comment

zhoxing-ms left a comment

Choose a reason for hiding this comment

git-thomasdolan commented Feb 16, 2022

zhoxing-ms commented Feb 16, 2022 • edited Loading

zhoxing-ms Feb 18, 2022

Choose a reason for hiding this comment

git-thomasdolan Feb 18, 2022

Choose a reason for hiding this comment

zhoxing-ms commented Feb 18, 2022

azure-pipelines bot commented Feb 18, 2022

git-thomasdolan commented Feb 22, 2022

jiasli Nov 14, 2023

Choose a reason for hiding this comment

[ARM] Bump version of `azure-mgmt-managementgroups` from `0.2.0` to `1.0.0` (Track 2 SDK) and add new sub commands for management-group #20942

[ARM] Bump version of `azure-mgmt-managementgroups` from `0.2.0` to `1.0.0` (Track 2 SDK) and add new sub commands for management-group #20942

git-thomasdolan commented Jan 10, 2022 •

edited by zhoxing-ms

Loading

zhoxing-ms commented Jan 11, 2022 •

edited

Loading

git-thomasdolan commented Jan 22, 2022 •

edited

Loading

zhoxing-ms commented Feb 16, 2022 •

edited

Loading