1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. managementgroups

Module managementgroups

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource ManagementGroup

DEPRECATED azure.managementgroups.ManagementGroup has been deprecated in favor of azure.management.Group
class ManagementGroup extends CustomResource
Manages a Management Group. #### Example Usage ```typescript 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.then(current => current.subscriptionId)], }); const exampleChild = new azure.management.Group("exampleChild", { displayName: "ChildGroup", parentManagementGroupId: exampleParent.id, subscriptionIds: [current.then(current => current.subscriptionId)], }); // other subscription IDs can go here ```

constructor

DEPRECATED azure.managementgroups.ManagementGroup has been deprecated in favor of azure.management.Group

DEPRECATED azure.managementgroups.ManagementGroup has been deprecated in favor of azure.management.Group
new ManagementGroup(name: string, args?: ManagementGroupArgs, opts?: pulumi.CustomResourceOptions)

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): obj is ManagementGroup

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 name.

property groupId

DEPRECATED Deprecated in favour of name
public groupId: pulumi.Output<string>;

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.

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 name

public name: pulumi.Output<string>;

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.

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.

Functions

Function getManagementGroup

DEPRECATED azure.managementgroups.getManagementGroup has been deprecated in favor of azure.management.getGroup
getManagementGroup(args?: GetManagementGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetManagementGroupResult>

Others

interface GetManagementGroupArgs

interface GetManagementGroupArgs

A collection of arguments for invoking getManagementGroup.

property groupId

DEPRECATED Deprecated in favour of name
groupId?: undefined | string;

Specifies the name or UUID of this Management Group.

property name

name?: undefined | string;

Specifies the name or 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

DEPRECATED Deprecated in favour of name
groupId: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

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 name.

property groupId

DEPRECATED Deprecated in favour of name
groupId?: pulumi.Input<string>;

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.

property name

name?: pulumi.Input<string>;

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.

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 name.

property groupId

DEPRECATED Deprecated in favour of name
groupId?: pulumi.Input<string>;

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.

property name

name?: pulumi.Input<string>;

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.

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.