@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get the details of the management group.
*
* Uses Azure REST API version 2023-04-01.
*
* Other available API versions: 2021-04-01, 2024-02-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native management [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getManagementGroup(args: GetManagementGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetManagementGroupResult>;
export interface GetManagementGroupArgs {
/**
* 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.
*/
expand?: string;
/**
* A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription')
*/
filter?: string;
/**
* Management Group ID.
*/
groupId: string;
/**
* 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.
*/
recurse?: boolean;
}
/**
* The management group details.
*/
export interface GetManagementGroupResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The list of children.
*/
readonly children?: outputs.management.ManagementGroupChildInfoResponse[];
/**
* The details of a management group.
*/
readonly details?: outputs.management.ManagementGroupDetailsResponse;
/**
* The friendly name of the management group.
*/
readonly displayName?: string;
/**
* The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
*/
readonly id: string;
/**
* The name of the management group. For example, 00000000-0000-0000-0000-000000000000
*/
readonly name: string;
/**
* The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
*/
readonly tenantId?: string;
/**
* The type of the resource. For example, Microsoft.Management/managementGroups
*/
readonly type: string;
}
/**
* Get the details of the management group.
*
* Uses Azure REST API version 2023-04-01.
*
* Other available API versions: 2021-04-01, 2024-02-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native management [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getManagementGroupOutput(args: GetManagementGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetManagementGroupResult>;
export interface GetManagementGroupOutputArgs {
/**
* 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.
*/
expand?: pulumi.Input<string>;
/**
* A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription')
*/
filter?: pulumi.Input<string>;
/**
* Management Group ID.
*/
groupId: pulumi.Input<string>;
/**
* 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.
*/
recurse?: pulumi.Input<boolean>;
}