Module managementgroups

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

Resources

Data Sources

Others

Resources

Resource ManagementGroup

class ManagementGroup extends CustomResource

Manages a Management Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getSubscription({});
const exampleParent = new azure.management.Group("exampleParent", {
    displayName: "ParentGroup",
    subscriptionIds: [current.subscriptionId],
});
const exampleChild = new azure.management.Group("exampleChild", {
    displayName: "ChildGroup",
    parentManagementGroupId: exampleParent.id,
    subscriptionIds: [current.subscriptionId],
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/management_group_legacy.html.markdown.

constructor

new ManagementGroup(name: string, args?: ManagementGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ManagementGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ManagementGroupState, opts?: pulumi.CustomResourceOptions): ManagementGroup

Get an existing ManagementGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of ManagementGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property displayName

public displayName: pulumi.Output<string>;

A friendly name for this Management Group. If not specified, this’ll be the same as the groupId.

property groupId

public groupId: pulumi.Output<string>;

The UUID for this Management Group, which needs to be unique across your tenant - which will be generated if not provided. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property parentManagementGroupId

public parentManagementGroupId: pulumi.Output<string>;

The ID of the Parent Management Group. Changing this forces a new resource to be created.

property subscriptionIds

public subscriptionIds: pulumi.Output<string[] | undefined>;

A list of Subscription GUIDs which should be assigned to the Management Group.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Data Sources

Data Source getManagementGroup

getManagementGroup(args: GetManagementGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetManagementGroupResult> & GetManagementGroupResult

Use this data source to access information about an existing Management Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const test = azure.management.getGroup({
    groupId: "00000000-0000-0000-0000-000000000000",
});

export const displayName = test.displayName;

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/management_group_legacy.html.markdown.

Others

interface GetManagementGroupArgs

interface GetManagementGroupArgs

A collection of arguments for invoking getManagementGroup.

property groupId

groupId: string;

Specifies the UUID of this Management Group.

interface GetManagementGroupResult

interface GetManagementGroupResult

A collection of values returned by getManagementGroup.

property displayName

displayName: string;

A friendly name for the Management Group.

property groupId

groupId: string;

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property parentManagementGroupId

parentManagementGroupId: string;

The ID of any Parent Management Group.

property subscriptionIds

subscriptionIds: string[];

A list of Subscription ID’s which are assigned to the Management Group.

interface ManagementGroupArgs

interface ManagementGroupArgs

The set of arguments for constructing a ManagementGroup resource.

property displayName

displayName?: pulumi.Input<string>;

A friendly name for this Management Group. If not specified, this’ll be the same as the groupId.

property groupId

groupId?: pulumi.Input<string>;

The UUID for this Management Group, which needs to be unique across your tenant - which will be generated if not provided. Changing this forces a new resource to be created.

property parentManagementGroupId

parentManagementGroupId?: pulumi.Input<string>;

The ID of the Parent Management Group. Changing this forces a new resource to be created.

property subscriptionIds

subscriptionIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of Subscription GUIDs which should be assigned to the Management Group.

interface ManagementGroupState

interface ManagementGroupState

Input properties used for looking up and filtering ManagementGroup resources.

property displayName

displayName?: pulumi.Input<string>;

A friendly name for this Management Group. If not specified, this’ll be the same as the groupId.

property groupId

groupId?: pulumi.Input<string>;

The UUID for this Management Group, which needs to be unique across your tenant - which will be generated if not provided. Changing this forces a new resource to be created.

property parentManagementGroupId

parentManagementGroupId?: pulumi.Input<string>;

The ID of the Parent Management Group. Changing this forces a new resource to be created.

property subscriptionIds

subscriptionIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of Subscription GUIDs which should be assigned to the Management Group.