Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. management
  5. getManagementGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.management.getManagementGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the details of the management group.

Azure REST API version: 2021-04-01.

Other available API versions: 2023-04-01.

Using getManagementGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getManagementGroup(args: GetManagementGroupArgs, opts?: InvokeOptions): Promise<GetManagementGroupResult>
function getManagementGroupOutput(args: GetManagementGroupOutputArgs, opts?: InvokeOptions): Output<GetManagementGroupResult>
Copy
def get_management_group(expand: Optional[str] = None,
                         filter: Optional[str] = None,
                         group_id: Optional[str] = None,
                         recurse: Optional[bool] = None,
                         opts: Optional[InvokeOptions] = None) -> GetManagementGroupResult
def get_management_group_output(expand: Optional[pulumi.Input[str]] = None,
                         filter: Optional[pulumi.Input[str]] = None,
                         group_id: Optional[pulumi.Input[str]] = None,
                         recurse: Optional[pulumi.Input[bool]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetManagementGroupResult]
Copy
func LookupManagementGroup(ctx *Context, args *LookupManagementGroupArgs, opts ...InvokeOption) (*LookupManagementGroupResult, error)
func LookupManagementGroupOutput(ctx *Context, args *LookupManagementGroupOutputArgs, opts ...InvokeOption) LookupManagementGroupResultOutput
Copy

> Note: This function is named LookupManagementGroup in the Go SDK.

public static class GetManagementGroup 
{
    public static Task<GetManagementGroupResult> InvokeAsync(GetManagementGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementGroupResult> Invoke(GetManagementGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetManagementGroupResult> getManagementGroup(GetManagementGroupArgs args, InvokeOptions options)
public static Output<GetManagementGroupResult> getManagementGroup(GetManagementGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:management:getManagementGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupId
This property is required.
Changes to this property will trigger replacement.
string
Management Group ID.
Expand string
The $expand=children query string parameter allows clients to request inclusion of children in the response payload. $expand=path includes the path from the root group to the current group. $expand=ancestors includes the ancestor Ids of the current group.
Filter string
A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription')
Recurse bool
The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true.
GroupId
This property is required.
Changes to this property will trigger replacement.
string
Management Group ID.
Expand string
The $expand=children query string parameter allows clients to request inclusion of children in the response payload. $expand=path includes the path from the root group to the current group. $expand=ancestors includes the ancestor Ids of the current group.
Filter string
A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription')
Recurse bool
The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true.
groupId
This property is required.
Changes to this property will trigger replacement.
String
Management Group ID.
expand String
The $expand=children query string parameter allows clients to request inclusion of children in the response payload. $expand=path includes the path from the root group to the current group. $expand=ancestors includes the ancestor Ids of the current group.
filter String
A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription')
recurse Boolean
The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true.
groupId
This property is required.
Changes to this property will trigger replacement.
string
Management Group ID.
expand string
The $expand=children query string parameter allows clients to request inclusion of children in the response payload. $expand=path includes the path from the root group to the current group. $expand=ancestors includes the ancestor Ids of the current group.
filter string
A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription')
recurse boolean
The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true.
group_id
This property is required.
Changes to this property will trigger replacement.
str
Management Group ID.
expand str
The $expand=children query string parameter allows clients to request inclusion of children in the response payload. $expand=path includes the path from the root group to the current group. $expand=ancestors includes the ancestor Ids of the current group.
filter str
A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription')
recurse bool
The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true.
groupId
This property is required.
Changes to this property will trigger replacement.
String
Management Group ID.
expand String
The $expand=children query string parameter allows clients to request inclusion of children in the response payload. $expand=path includes the path from the root group to the current group. $expand=ancestors includes the ancestor Ids of the current group.
filter String
A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription')
recurse Boolean
The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true.

getManagementGroup Result

The following output properties are available:

Id string
The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
Name string
The name of the management group. For example, 00000000-0000-0000-0000-000000000000
Type string
The type of the resource. For example, Microsoft.Management/managementGroups
Children List<Pulumi.AzureNative.Management.Outputs.ManagementGroupChildInfoResponse>
The list of children.
Details Pulumi.AzureNative.Management.Outputs.ManagementGroupDetailsResponse
The details of a management group.
DisplayName string
The friendly name of the management group.
TenantId string
The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
Id string
The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
Name string
The name of the management group. For example, 00000000-0000-0000-0000-000000000000
Type string
The type of the resource. For example, Microsoft.Management/managementGroups
Children []ManagementGroupChildInfoResponse
The list of children.
Details ManagementGroupDetailsResponse
The details of a management group.
DisplayName string
The friendly name of the management group.
TenantId string
The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
id String
The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name String
The name of the management group. For example, 00000000-0000-0000-0000-000000000000
type String
The type of the resource. For example, Microsoft.Management/managementGroups
children List<ManagementGroupChildInfoResponse>
The list of children.
details ManagementGroupDetailsResponse
The details of a management group.
displayName String
The friendly name of the management group.
tenantId String
The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
id string
The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name string
The name of the management group. For example, 00000000-0000-0000-0000-000000000000
type string
The type of the resource. For example, Microsoft.Management/managementGroups
children ManagementGroupChildInfoResponse[]
The list of children.
details ManagementGroupDetailsResponse
The details of a management group.
displayName string
The friendly name of the management group.
tenantId string
The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
id str
The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name str
The name of the management group. For example, 00000000-0000-0000-0000-000000000000
type str
The type of the resource. For example, Microsoft.Management/managementGroups
children Sequence[ManagementGroupChildInfoResponse]
The list of children.
details ManagementGroupDetailsResponse
The details of a management group.
display_name str
The friendly name of the management group.
tenant_id str
The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
id String
The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name String
The name of the management group. For example, 00000000-0000-0000-0000-000000000000
type String
The type of the resource. For example, Microsoft.Management/managementGroups
children List<Property Map>
The list of children.
details Property Map
The details of a management group.
displayName String
The friendly name of the management group.
tenantId String
The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000

Supporting Types

ManagementGroupChildInfoResponse

Children List<Pulumi.AzureNative.Management.Inputs.ManagementGroupChildInfoResponse>
The list of children.
DisplayName string
The friendly name of the child resource.
Id string
The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
Name string
The name of the child entity.
Type string
The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups)
Children []ManagementGroupChildInfoResponse
The list of children.
DisplayName string
The friendly name of the child resource.
Id string
The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
Name string
The name of the child entity.
Type string
The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups)
children List<ManagementGroupChildInfoResponse>
The list of children.
displayName String
The friendly name of the child resource.
id String
The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name String
The name of the child entity.
type String
The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups)
children ManagementGroupChildInfoResponse[]
The list of children.
displayName string
The friendly name of the child resource.
id string
The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name string
The name of the child entity.
type string
The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups)
children Sequence[ManagementGroupChildInfoResponse]
The list of children.
display_name str
The friendly name of the child resource.
id str
The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name str
The name of the child entity.
type str
The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups)
children List<Property Map>
The list of children.
displayName String
The friendly name of the child resource.
id String
The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name String
The name of the child entity.
type String
The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups)

ManagementGroupDetailsResponse

ManagementGroupAncestors List<string>
The ancestors of the management group.
ManagementGroupAncestorsChain List<Pulumi.AzureNative.Management.Inputs.ManagementGroupPathElementResponse>
The ancestors of the management group displayed in reversed order, from immediate parent to the root.
Parent Pulumi.AzureNative.Management.Inputs.ParentGroupInfoResponse
(Optional) The ID of the parent management group.
Path List<Pulumi.AzureNative.Management.Inputs.ManagementGroupPathElementResponse>
The path from the root to the current group.
UpdatedBy string
The identity of the principal or process that updated the object.
UpdatedTime string
The date and time when this object was last updated.
Version double
The version number of the object.
ManagementGroupAncestors []string
The ancestors of the management group.
ManagementGroupAncestorsChain []ManagementGroupPathElementResponse
The ancestors of the management group displayed in reversed order, from immediate parent to the root.
Parent ParentGroupInfoResponse
(Optional) The ID of the parent management group.
Path []ManagementGroupPathElementResponse
The path from the root to the current group.
UpdatedBy string
The identity of the principal or process that updated the object.
UpdatedTime string
The date and time when this object was last updated.
Version float64
The version number of the object.
managementGroupAncestors List<String>
The ancestors of the management group.
managementGroupAncestorsChain List<ManagementGroupPathElementResponse>
The ancestors of the management group displayed in reversed order, from immediate parent to the root.
parent ParentGroupInfoResponse
(Optional) The ID of the parent management group.
path List<ManagementGroupPathElementResponse>
The path from the root to the current group.
updatedBy String
The identity of the principal or process that updated the object.
updatedTime String
The date and time when this object was last updated.
version Double
The version number of the object.
managementGroupAncestors string[]
The ancestors of the management group.
managementGroupAncestorsChain ManagementGroupPathElementResponse[]
The ancestors of the management group displayed in reversed order, from immediate parent to the root.
parent ParentGroupInfoResponse
(Optional) The ID of the parent management group.
path ManagementGroupPathElementResponse[]
The path from the root to the current group.
updatedBy string
The identity of the principal or process that updated the object.
updatedTime string
The date and time when this object was last updated.
version number
The version number of the object.
management_group_ancestors Sequence[str]
The ancestors of the management group.
management_group_ancestors_chain Sequence[ManagementGroupPathElementResponse]
The ancestors of the management group displayed in reversed order, from immediate parent to the root.
parent ParentGroupInfoResponse
(Optional) The ID of the parent management group.
path Sequence[ManagementGroupPathElementResponse]
The path from the root to the current group.
updated_by str
The identity of the principal or process that updated the object.
updated_time str
The date and time when this object was last updated.
version float
The version number of the object.
managementGroupAncestors List<String>
The ancestors of the management group.
managementGroupAncestorsChain List<Property Map>
The ancestors of the management group displayed in reversed order, from immediate parent to the root.
parent Property Map
(Optional) The ID of the parent management group.
path List<Property Map>
The path from the root to the current group.
updatedBy String
The identity of the principal or process that updated the object.
updatedTime String
The date and time when this object was last updated.
version Number
The version number of the object.

ManagementGroupPathElementResponse

DisplayName string
The friendly name of the group.
Name string
The name of the group.
DisplayName string
The friendly name of the group.
Name string
The name of the group.
displayName String
The friendly name of the group.
name String
The name of the group.
displayName string
The friendly name of the group.
name string
The name of the group.
display_name str
The friendly name of the group.
name str
The name of the group.
displayName String
The friendly name of the group.
name String
The name of the group.

ParentGroupInfoResponse

DisplayName string
The friendly name of the parent management group.
Id string
The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
Name string
The name of the parent management group
DisplayName string
The friendly name of the parent management group.
Id string
The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
Name string
The name of the parent management group
displayName String
The friendly name of the parent management group.
id String
The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name String
The name of the parent management group
displayName string
The friendly name of the parent management group.
id string
The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name string
The name of the parent management group
display_name str
The friendly name of the parent management group.
id str
The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name str
The name of the parent management group
displayName String
The friendly name of the parent management group.
id String
The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name String
The name of the parent management group

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native