This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi
azure-native.management.getManagementGroup
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi
Get the details of the management group.
Azure REST API version: 2021-04-01.
Other available API versions: 2017-11-01-preview, 2020-02-01, 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>
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]
func LookupManagementGroup(ctx *Context, args *LookupManagementGroupArgs, opts ...InvokeOption) (*LookupManagementGroupResult, error)
func LookupManagementGroupOutput(ctx *Context, args *LookupManagementGroupOutputArgs, opts ...InvokeOption) LookupManagementGroupResultOutput
> 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)
}
public static CompletableFuture<GetManagementGroupResult> getManagementGroup(GetManagementGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:management:getManagementGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Group
Id 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.
- Group
Id 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.
- group
Id 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 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 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.
- group
Id 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.
Azure Native. Management. Outputs. Management Group Child Info Response> - The list of children.
- Details
Pulumi.
Azure Native. Management. Outputs. Management Group Details Response - The details of a management group.
- Display
Name string - The friendly name of the management group.
- Tenant
Id 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
[]Management
Group Child Info Response - The list of children.
- Details
Management
Group Details Response - The details of a management group.
- Display
Name string - The friendly name of the management group.
- Tenant
Id 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<Management
Group Child Info Response> - The list of children.
- details
Management
Group Details Response - The details of a management group.
- display
Name String - The friendly name of the management group.
- tenant
Id 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
Management
Group Child Info Response[] - The list of children.
- details
Management
Group Details Response - The details of a management group.
- display
Name string - The friendly name of the management group.
- tenant
Id 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[Management
Group Child Info Response] - The list of children.
- details
Management
Group Details Response - 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.
- display
Name String - The friendly name of the management group.
- tenant
Id String - The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
Supporting Types
ManagementGroupChildInfoResponse
- Children
List<Pulumi.
Azure Native. Management. Inputs. Management Group Child Info Response> - The list of children.
- Display
Name 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
[]Management
Group Child Info Response - The list of children.
- Display
Name 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<Management
Group Child Info Response> - The list of children.
- display
Name 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
Management
Group Child Info Response[] - The list of children.
- display
Name 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[Management
Group Child Info Response] - 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.
- display
Name 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
- Management
Group List<string>Ancestors - The ancestors of the management group.
- Management
Group List<Pulumi.Ancestors Chain Azure Native. Management. Inputs. Management Group Path Element Response> - The ancestors of the management group displayed in reversed order, from immediate parent to the root.
- Parent
Pulumi.
Azure Native. Management. Inputs. Parent Group Info Response - (Optional) The ID of the parent management group.
- Path
List<Pulumi.
Azure Native. Management. Inputs. Management Group Path Element Response> - The path from the root to the current group.
- Updated
By string - The identity of the principal or process that updated the object.
- Updated
Time string - The date and time when this object was last updated.
- Version double
- The version number of the object.
- Management
Group []stringAncestors - The ancestors of the management group.
- Management
Group []ManagementAncestors Chain Group Path Element Response - The ancestors of the management group displayed in reversed order, from immediate parent to the root.
- Parent
Parent
Group Info Response - (Optional) The ID of the parent management group.
- Path
[]Management
Group Path Element Response - The path from the root to the current group.
- Updated
By string - The identity of the principal or process that updated the object.
- Updated
Time string - The date and time when this object was last updated.
- Version float64
- The version number of the object.
- management
Group List<String>Ancestors - The ancestors of the management group.
- management
Group List<ManagementAncestors Chain Group Path Element Response> - The ancestors of the management group displayed in reversed order, from immediate parent to the root.
- parent
Parent
Group Info Response - (Optional) The ID of the parent management group.
- path
List<Management
Group Path Element Response> - The path from the root to the current group.
- updated
By String - The identity of the principal or process that updated the object.
- updated
Time String - The date and time when this object was last updated.
- version Double
- The version number of the object.
- management
Group string[]Ancestors - The ancestors of the management group.
- management
Group ManagementAncestors Chain Group Path Element Response[] - The ancestors of the management group displayed in reversed order, from immediate parent to the root.
- parent
Parent
Group Info Response - (Optional) The ID of the parent management group.
- path
Management
Group Path Element Response[] - The path from the root to the current group.
- updated
By string - The identity of the principal or process that updated the object.
- updated
Time string - The date and time when this object was last updated.
- version number
- The version number of the object.
- management_
group_ Sequence[str]ancestors - The ancestors of the management group.
- management_
group_ Sequence[Managementancestors_ chain Group Path Element Response] - The ancestors of the management group displayed in reversed order, from immediate parent to the root.
- parent
Parent
Group Info Response - (Optional) The ID of the parent management group.
- path
Sequence[Management
Group Path Element Response] - 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.
- management
Group List<String>Ancestors - The ancestors of the management group.
- management
Group List<Property Map>Ancestors Chain - 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.
- updated
By String - The identity of the principal or process that updated the object.
- updated
Time String - The date and time when this object was last updated.
- version Number
- The version number of the object.
ManagementGroupPathElementResponse
- Display
Name string - The friendly name of the group.
- Name string
- The name of the group.
- Display
Name string - The friendly name of the group.
- Name string
- The name of the group.
- display
Name String - The friendly name of the group.
- name String
- The name of the group.
- display
Name 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.
- display
Name String - The friendly name of the group.
- name String
- The name of the group.
ParentGroupInfoResponse
- Display
Name 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 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 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 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
- display
Name 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 pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi