Update-AzManagementGroup
Updates a Management Group
Syntax
Update-AzManagementGroup
-GroupName <String>
[-DisplayName <String>]
[-ParentId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzManagementGroup
-InputObject <PSManagementGroup>
[-DisplayName <String>]
[-DefaultProfile <IAzureContextContainer>]
-ParentObject <PSManagementGroup>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzManagementGroup
-InputObject <PSManagementGroup>
[-DisplayName <String>]
[-ParentId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzManagementGroup
-GroupName <String>
[-DisplayName <String>]
[-DefaultProfile <IAzureContextContainer>]
-ParentObject <PSManagementGroup>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-AzManagementGroup cmdlet updates the ParentId or DisplayName for a Management Group.
Examples
Example 1: Update a Management Group's Display Name
Update-AzManagementGroup -GroupName "TestGroup" -DisplayName "New Display Name"
Id : /providers/Microsoft.Management/managementGroups/TestGroup
Type : /providers/Microsoft.Management/managementGroups
Name : TestGroup
TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0
DisplayName : New Display Name
UpdatedTime : 2/1/2018 12:03:37 PM
UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9
ParentId : /providers/Microsoft.Management/managementGroups/6b2064b9-34bd-46e6-9092-52f2dd5f7fc0
ParentName : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0
ParentDisplayName : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0
Example 2: Update a Management Group's Parent
Update-AzManagementGroup -GroupName "TestGroup" -ParentId "/providers/Microsoft.Management/managementGroups/TestGroupParent"
Id : /providers/Microsoft.Management/managementGroups/TestGroup
Type : /providers/Microsoft.Management/managementGroups
Name : TestGroup
TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0
DisplayName : TestGroup
UpdatedTime : 2/1/2018 12:03:37 PM
UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9
ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent
ParentName : TestGroupParent
ParentDisplayName : TestGroupParent
Example 3: Update a Management Group by piping PSManagementGroup Object
Get-AzManagementGroup -GroupName "TestGroup" | Update-AzManagementGroup -DisplayName "TestDisplayName" -ParentId "/providers/Microsoft.Management/managementGroups/TestGroupParent"
Id : /providers/Microsoft.Management/managementGroups/TestGroup
Type : /providers/Microsoft.Management/managementGroups
Name : TestGroup
TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0
DisplayName : TestDisplayName
UpdatedTime : 2/1/2018 12:03:37 PM
UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9
ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent
ParentName : TestGroupParent
ParentDisplayName : TestGroupParent
Example 4: Update a Management Group's parent using the ParentObject
$parentObject = Get-AzManagementGroup -GroupName "TestGroupParent"
Update-AzManagementGroup -GroupName "TestGroup" -ParentObject $parentObject
Id : /providers/Microsoft.Management/managementGroups/TestGroup
Type : /providers/Microsoft.Management/managementGroups
Name : TestGroup
TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30
DisplayName : TestGroupDisplayName
UpdatedTime : 2/1/2018 11:16:12 AM
UpdatedBy : 14307de0-5e6f-46cf-b2ba-64a062964d30
ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent
ParentName : TestGroupParent
ParentDisplayName : TestGroupParent
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplayName
Display Name of the management group
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GroupName
Management Group Id
Type: | String |
Aliases: | GroupId |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Input Object from the Get call
Type: | PSManagementGroup |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ParentId
Parent Id of the management group
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ParentObject
Input Object from the Get call
Type: | PSManagementGroup |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for