Edit

Share via

Update-AzManagementGroupHierarchySetting

Module:
Az.Resources Module

Updates Hierarchy Settings under the current tenant

Syntax

GroupOperations (Default) 

Update-AzManagementGroupHierarchySetting
    [-GroupName] <String>
    [-Authorization <Boolean>]
    [-DefaultManagementGroup <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ParentGroupObject 

Update-AzManagementGroupHierarchySetting
    [-GroupName] <String>
    [-Authorization <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Update-AzManagementGroupHierarchySetting cmdlet updates the hierarchy settings under the current tenant. Requiring Authorization and setting the DefaultManagementGroup that new groups get created under can be updated.

Examples

Example 1: Update the Hierarchy Setting for Authorization Requirement for Group Creation

Update-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 -Authorization True

Id          : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default
Type        : Microsoft.Management/managementGroups/settings
Name        : default
TenantId    : 00001111-aaaa-2222-bbbb-3333cccc4444
RequireAuthorizationForGroupCreation : true
DefaultManagementGroup :

Example 2: Update the Hierarchy Setting that the default Management Group new Groups get placed under

Update-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 -DefaultManagementGroup TestGroup

Id          : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default
Type        : Microsoft.Management/managementGroups/settings
Name        : default
TenantId    : 00001111-aaaa-2222-bbbb-3333cccc4444
RequireAuthorizationForGroupCreation : false
DefaultManagementGroup : TestGroup

Example 3: Create both Hierarchy Settings

Update-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 -Authorization True -DefaultManagementGroup TestGroup

Id          : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default
Type        : Microsoft.Management/managementGroups/settings
Name        : default
TenantId    : 00001111-aaaa-2222-bbbb-3333cccc4444
RequireAuthorizationForGroupCreation : true
DefaultManagementGroup : TestGroup

Parameters

-Authorization

Indicate whether RBAC access is required upon group creation under the root Management Group. True means user will require Microsoft.Management/managementGroups/write action on the root Management Group. Default setting is false.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RequireAuthorizationForGroupCreation

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultManagementGroup

Expand the output to list the children of the management group

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DefaultMG

Parameter sets

GroupOperations
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GroupName

Management Group Id

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:GroupId

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

PSHierarchySettings

PSHierarchySettings