New-AzManagementGroup
Creates a Management Group
Syntax
GroupOperations (Default)
New-AzManagementGroup
[-GroupName] <String>
[-DisplayName <String>]
[-ParentId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ParentGroupObject
New-AzManagementGroup
[-GroupName] <String>
-ParentObject <PSManagementGroup>
[-DisplayName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzManagementGroup cmdlet creates a management group with name GroupName . The DisplayName and ParentId can also be set when creating a new Management Group.
Examples
Example 1: Create a Management Group
New-AzManagementGroup -GroupName "TestGroup"
Id : /providers/Microsoft.Management/managementGroups/TestGroup
Type : /providers/Microsoft.Management/managementGroups
Name : TestGroup
TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444
DisplayName : TestGroup
UpdatedTime : 2/1/2018 11:06:27 AM
UpdatedBy : 00001111-aaaa-2222-bbbb-3333cccc4444
ParentId : /providers/Microsoft.Management/managementGroups/00001111-aaaa-2222-bbbb-3333cccc4444
ParentName : 00001111-aaaa-2222-bbbb-3333cccc4444
ParentDisplayName : 00001111-aaaa-2222-bbbb-3333cccc4444
Creation of a new group with DisplayName and ParentId set to null. The DisplayName will be same as the GroupName and the parent of the group will be the tenant.
Example 2: Create a Management Group with a display name
New-AzManagementGroup -GroupName "TestGroup" -DisplayName "TestGroupDisplayName"
Id : /providers/Microsoft.Management/managementGroups/TestGroup
Type : /providers/Microsoft.Management/managementGroups
Name : TestGroup
TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444
DisplayName : TestGroup
UpdatedTime : 2/1/2018 11:06:27 AM
UpdatedBy : 00001111-aaaa-2222-bbbb-3333cccc4444
ParentId : /providers/Microsoft.Management/managementGroups/00001111-aaaa-2222-bbbb-3333cccc4444
ParentName : 00001111-aaaa-2222-bbbb-3333cccc4444
ParentDisplayName : 00001111-aaaa-2222-bbbb-3333cccc4444
In this case, the parent of the group will be the tenant and the DisplayName will be set to the value given.
Example 3: Create a Management Group with a parent and a display name
New-AzManagementGroup -GroupName "TestGroup" -DisplayName "TestGroupDisplayName" -ParentId "/providers/Microsoft.Management/managementGroups/TestGroupParent"
Id : /providers/Microsoft.Management/managementGroups/TestGroup
Type : /providers/Microsoft.Management/managementGroups
Name : TestGroup
TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444
DisplayName : TestGroupDisplayName
UpdatedTime : 2/1/2018 11:16:12 AM
UpdatedBy : 00001111-aaaa-2222-bbbb-3333cccc4444
ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent
ParentName : TestGroupParent
ParentDisplayName : TestGroupParent
Example 4: Create a Management Group with a parent (using a parent object)
$parentObject = Get-AzManagementGroup -GroupName "TestGroupParent"
New-AzManagementGroup -GroupName "TestGroup" -ParentObject $parentObject
Id : /providers/Microsoft.Management/managementGroups/TestGroup
Type : /providers/Microsoft.Management/managementGroups
Name : TestGroup
TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444
DisplayName : TestGroupDisplayName
UpdatedTime : 2/1/2018 11:16:12 AM
UpdatedBy : 00001111-aaaa-2222-bbbb-3333cccc4444
ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent
ParentName : TestGroupParent
ParentDisplayName : TestGroupParent
Parameters
-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
-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
-DisplayName
Display Name of the management group
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
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
-ParentId
Parent Id of the management group
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GroupOperations
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ParentObject
Parent Object
Parameter properties
Parameter sets
ParentGroupObject
Position: Named 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 .
None
Outputs