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.

class pulumi_azure.managementgroups.AwaitableGetManagementGroupResult(display_name=None, group_id=None, id=None, name=None, parent_management_group_id=None, subscription_ids=None)¶

class pulumi_azure.managementgroups.GetManagementGroupResult(display_name=None, group_id=None, id=None, name=None, parent_management_group_id=None, subscription_ids=None)¶

A collection of values returned by getManagementGroup.

id = None¶

The provider-assigned unique ID for this managed resource.

parent_management_group_id = None¶

The ID of any Parent Management Group.

subscription_ids = None¶

A list of Subscription IDs which are assigned to the Management Group.

class pulumi_azure.managementgroups.ManagementGroup(resource_name, opts=None, display_name=None, group_id=None, name=None, parent_management_group_id=None, subscription_ids=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Management Group.

import pulumi
import pulumi_azure as azure

current = azure.core.get_subscription()
example_parent = azure.management.Group("exampleParent",
    display_name="ParentGroup",
    subscription_ids=[current.subscription_id])
example_child = azure.management.Group("exampleChild",
    display_name="ChildGroup",
    parent_management_group_id=example_parent.id,
    subscription_ids=[current.subscription_id])
# other subscription IDs can go here

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• display_name (pulumi.Input[str]) – A friendly name for this Management Group. If not specified, this’ll be the same as the name.

• group_id (pulumi.Input[str]) – The name or UUID for this Management Group, which needs to be unique across your tenant. A new UUID will be generated if not provided. Changing this forces a new resource to be created.

• name (pulumi.Input[str]) – The name or UUID for this Management Group, which needs to be unique across your tenant. A new UUID will be generated if not provided. Changing this forces a new resource to be created.

• parent_management_group_id (pulumi.Input[str]) – The ID of the Parent Management Group. Changing this forces a new resource to be created.

• subscription_ids (pulumi.Input[list]) – A list of Subscription GUIDs which should be assigned to the Management Group.

display_name: pulumi.Output[str] = None¶

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

group_id: pulumi.Output[str] = None¶

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

name: pulumi.Output[str] = None¶

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

parent_management_group_id: pulumi.Output[str] = None¶

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

subscription_ids: pulumi.Output[list] = None¶

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

static get(resource_name, id, opts=None, display_name=None, group_id=None, name=None, parent_management_group_id=None, subscription_ids=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• display_name (pulumi.Input[str]) – A friendly name for this Management Group. If not specified, this’ll be the same as the name.

• group_id (pulumi.Input[str]) – The name or UUID for this Management Group, which needs to be unique across your tenant. A new UUID will be generated if not provided. Changing this forces a new resource to be created.

• name (pulumi.Input[str]) – The name or UUID for this Management Group, which needs to be unique across your tenant. A new UUID will be generated if not provided. Changing this forces a new resource to be created.

• parent_management_group_id (pulumi.Input[str]) – The ID of the Parent Management Group. Changing this forces a new resource to be created.

• subscription_ids (pulumi.Input[list]) – A list of Subscription GUIDs which should be assigned to the Management Group.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azure.managementgroups.get_management_group(display_name=None, group_id=None, name=None, opts=None)¶

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

import pulumi
import pulumi_azure as azure

example = azure.management.get_group(name="00000000-0000-0000-0000-000000000000")
pulumi.export("displayName", example.display_name)

Parameters

• display_name (str) – Specifies the display name of this Management Group.

• group_id (str) – Specifies the name or UUID of this Management Group.

• name (str) – Specifies the name or UUID of this Management Group.