Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. management
  5. ManagementGroup
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.management.ManagementGroup

Explore with Pulumi AI

azure-native logo
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    The management group details. Azure REST API version: 2021-04-01. Prior API version in Azure Native 1.x: 2020-05-01.

    Other available API versions: 2017-11-01-preview, 2020-02-01, 2023-04-01.

    Example Usage

    PutManagementGroup

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var managementGroup = new AzureNative.Management.ManagementGroup("managementGroup", new()
    {
        Details = new AzureNative.Management.Inputs.CreateManagementGroupDetailsArgs
        {
            Parent = new AzureNative.Management.Inputs.CreateParentGroupInfoArgs
            {
                Id = "/providers/Microsoft.Management/managementGroups/RootGroup",
            },
        },
        DisplayName = "ChildGroup",
        GroupId = "ChildGroup",
    });

});

    package main

import (
	management "github.com/pulumi/pulumi-azure-native-sdk/management/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := management.NewManagementGroup(ctx, "managementGroup", &management.ManagementGroupArgs{
			Details: &management.CreateManagementGroupDetailsArgs{
				Parent: &management.CreateParentGroupInfoArgs{
					Id: pulumi.String("/providers/Microsoft.Management/managementGroups/RootGroup"),
				},
			},
			DisplayName: pulumi.String("ChildGroup"),
			GroupId:     pulumi.String("ChildGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.management.ManagementGroup;
import com.pulumi.azurenative.management.ManagementGroupArgs;
import com.pulumi.azurenative.management.inputs.CreateManagementGroupDetailsArgs;
import com.pulumi.azurenative.management.inputs.CreateParentGroupInfoArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var managementGroup = new ManagementGroup("managementGroup", ManagementGroupArgs.builder()
            .details(CreateManagementGroupDetailsArgs.builder()
                .parent(CreateParentGroupInfoArgs.builder()
                    .id("/providers/Microsoft.Management/managementGroups/RootGroup")
                    .build())
                .build())
            .displayName("ChildGroup")
            .groupId("ChildGroup")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

management_group = azure_native.management.ManagementGroup("managementGroup",
    details={
        "parent": {
            "id": "/providers/Microsoft.Management/managementGroups/RootGroup",
        },
    },
    display_name="ChildGroup",
    group_id="ChildGroup")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const managementGroup = new azure_native.management.ManagementGroup("managementGroup", {
    details: {
        parent: {
            id: "/providers/Microsoft.Management/managementGroups/RootGroup",
        },
    },
    displayName: "ChildGroup",
    groupId: "ChildGroup",
});

    resources:
  managementGroup:
    type: azure-native:management:ManagementGroup
    properties:
      details:
        parent:
          id: /providers/Microsoft.Management/managementGroups/RootGroup
      displayName: ChildGroup
      groupId: ChildGroup

    Create ManagementGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ManagementGroup(name: string, args?: ManagementGroupArgs, opts?: CustomResourceOptions);
    @overload
def ManagementGroup(resource_name: str,
                    args: Optional[ManagementGroupArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def ManagementGroup(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    details: Optional[CreateManagementGroupDetailsArgs] = None,
                    display_name: Optional[str] = None,
                    group_id: Optional[str] = None,
                    name: Optional[str] = None)
    func NewManagementGroup(ctx *Context, name string, args *ManagementGroupArgs, opts ...ResourceOption) (*ManagementGroup, error)
    public ManagementGroup(string name, ManagementGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ManagementGroup(String name, ManagementGroupArgs args)
public ManagementGroup(String name, ManagementGroupArgs args, CustomResourceOptions options)

    type: azure-native:management:ManagementGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ManagementGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ManagementGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ManagementGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var managementGroupResource = new AzureNative.Management.ManagementGroup("managementGroupResource", new()
{
    Details = new AzureNative.Management.Inputs.CreateManagementGroupDetailsArgs
    {
        Parent = new AzureNative.Management.Inputs.CreateParentGroupInfoArgs
        {
            Id = "string",
        },
    },
    DisplayName = "string",
    GroupId = "string",
    Name = "string",
});

    example, err := management.NewManagementGroup(ctx, "managementGroupResource", &management.ManagementGroupArgs{
	Details: &management.CreateManagementGroupDetailsArgs{
		Parent: &management.CreateParentGroupInfoArgs{
			Id: pulumi.String("string"),
		},
	},
	DisplayName: pulumi.String("string"),
	GroupId:     pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var managementGroupResource = new ManagementGroup("managementGroupResource", ManagementGroupArgs.builder()
    .details(CreateManagementGroupDetailsArgs.builder()
        .parent(CreateParentGroupInfoArgs.builder()
            .id("string")
            .build())
        .build())
    .displayName("string")
    .groupId("string")
    .name("string")
    .build());

    management_group_resource = azure_native.management.ManagementGroup("managementGroupResource",
    details={
        "parent": {
            "id": "string",
        },
    },
    display_name="string",
    group_id="string",
    name="string")

    const managementGroupResource = new azure_native.management.ManagementGroup("managementGroupResource", {
    details: {
        parent: {
            id: "string",
        },
    },
    displayName: "string",
    groupId: "string",
    name: "string",
});

    type: azure-native:management:ManagementGroup
properties:
    details:
        parent:
            id: string
    displayName: string
    groupId: string
    name: string

    ManagementGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ManagementGroup resource accepts the following input properties:

    Details Pulumi.AzureNative.Management.Inputs.CreateManagementGroupDetails
    The details of a management group used during creation.
    DisplayName string
    The friendly name of the management group. If no value is passed then this field will be set to the groupId.
    GroupId string
    Management Group ID.
    Name string
    The name of the management group. For example, 00000000-0000-0000-0000-000000000000
    Details CreateManagementGroupDetailsArgs
    The details of a management group used during creation.
    DisplayName string
    The friendly name of the management group. If no value is passed then this field will be set to the groupId.
    GroupId string
    Management Group ID.
    Name string
    The name of the management group. For example, 00000000-0000-0000-0000-000000000000
    details CreateManagementGroupDetails
    The details of a management group used during creation.
    displayName String
    The friendly name of the management group. If no value is passed then this field will be set to the groupId.
    groupId String
    Management Group ID.
    name String
    The name of the management group. For example, 00000000-0000-0000-0000-000000000000
    details CreateManagementGroupDetails
    The details of a management group used during creation.
    displayName string
    The friendly name of the management group. If no value is passed then this field will be set to the groupId.
    groupId string
    Management Group ID.
    name string
    The name of the management group. For example, 00000000-0000-0000-0000-000000000000
    details CreateManagementGroupDetailsArgs
    The details of a management group used during creation.
    display_name str
    The friendly name of the management group. If no value is passed then this field will be set to the groupId.
    group_id str
    Management Group ID.
    name str
    The name of the management group. For example, 00000000-0000-0000-0000-000000000000
    details Property Map
    The details of a management group used during creation.
    displayName String
    The friendly name of the management group. If no value is passed then this field will be set to the groupId.
    groupId String
    Management Group ID.
    name String
    The name of the management group. For example, 00000000-0000-0000-0000-000000000000

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ManagementGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The type of the resource. For example, Microsoft.Management/managementGroups
    Children List<Pulumi.AzureNative.Management.Outputs.ManagementGroupChildInfoResponse>
    The list of children.
    TenantId string
    The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The type of the resource. For example, Microsoft.Management/managementGroups
    Children []ManagementGroupChildInfoResponse
    The list of children.
    TenantId string
    The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of the resource. For example, Microsoft.Management/managementGroups
    children List<ManagementGroupChildInfoResponse>
    The list of children.
    tenantId String
    The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The type of the resource. For example, Microsoft.Management/managementGroups
    children ManagementGroupChildInfoResponse[]
    The list of children.
    tenantId string
    The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    The type of the resource. For example, Microsoft.Management/managementGroups
    children Sequence[ManagementGroupChildInfoResponse]
    The list of children.
    tenant_id str
    The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of the resource. For example, Microsoft.Management/managementGroups
    children List<Property Map>
    The list of children.
    tenantId String
    The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000

    Supporting Types

    CreateManagementGroupDetails, CreateManagementGroupDetailsArgs

    Parent Pulumi.AzureNative.Management.Inputs.CreateParentGroupInfo
    (Optional) The ID of the parent management group used during creation.
    Parent CreateParentGroupInfo
    (Optional) The ID of the parent management group used during creation.
    parent CreateParentGroupInfo
    (Optional) The ID of the parent management group used during creation.
    parent CreateParentGroupInfo
    (Optional) The ID of the parent management group used during creation.
    parent CreateParentGroupInfo
    (Optional) The ID of the parent management group used during creation.
    parent Property Map
    (Optional) The ID of the parent management group used during creation.

    CreateParentGroupInfo, CreateParentGroupInfoArgs

    Id string
    The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
    Id string
    The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
    id String
    The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
    id string
    The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
    id str
    The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
    id String
    The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

    ManagementGroupChildInfoResponse, ManagementGroupChildInfoResponseArgs

    Children List<Pulumi.AzureNative.Management.Inputs.ManagementGroupChildInfoResponse>
    The list of children.
    DisplayName 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 []ManagementGroupChildInfoResponse
    The list of children.
    DisplayName 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<ManagementGroupChildInfoResponse>
    The list of children.
    displayName 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 ManagementGroupChildInfoResponse[]
    The list of children.
    displayName 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[ManagementGroupChildInfoResponse]
    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.
    displayName 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, ManagementGroupDetailsResponseArgs

    ManagementGroupAncestors List<string>
    The ancestors of the management group.
    ManagementGroupAncestorsChain List<Pulumi.AzureNative.Management.Inputs.ManagementGroupPathElementResponse>
    The ancestors of the management group displayed in reversed order, from immediate parent to the root.
    Parent Pulumi.AzureNative.Management.Inputs.ParentGroupInfoResponse
    (Optional) The ID of the parent management group.
    Path List<Pulumi.AzureNative.Management.Inputs.ManagementGroupPathElementResponse>
    The path from the root to the current group.
    UpdatedBy string
    The identity of the principal or process that updated the object.
    UpdatedTime string
    The date and time when this object was last updated.
    Version double
    The version number of the object.
    ManagementGroupAncestors []string
    The ancestors of the management group.
    ManagementGroupAncestorsChain []ManagementGroupPathElementResponse
    The ancestors of the management group displayed in reversed order, from immediate parent to the root.
    Parent ParentGroupInfoResponse
    (Optional) The ID of the parent management group.
    Path []ManagementGroupPathElementResponse
    The path from the root to the current group.
    UpdatedBy string
    The identity of the principal or process that updated the object.
    UpdatedTime string
    The date and time when this object was last updated.
    Version float64
    The version number of the object.
    managementGroupAncestors List<String>
    The ancestors of the management group.
    managementGroupAncestorsChain List<ManagementGroupPathElementResponse>
    The ancestors of the management group displayed in reversed order, from immediate parent to the root.
    parent ParentGroupInfoResponse
    (Optional) The ID of the parent management group.
    path List<ManagementGroupPathElementResponse>
    The path from the root to the current group.
    updatedBy String
    The identity of the principal or process that updated the object.
    updatedTime String
    The date and time when this object was last updated.
    version Double
    The version number of the object.
    managementGroupAncestors string[]
    The ancestors of the management group.
    managementGroupAncestorsChain ManagementGroupPathElementResponse[]
    The ancestors of the management group displayed in reversed order, from immediate parent to the root.
    parent ParentGroupInfoResponse
    (Optional) The ID of the parent management group.
    path ManagementGroupPathElementResponse[]
    The path from the root to the current group.
    updatedBy string
    The identity of the principal or process that updated the object.
    updatedTime string
    The date and time when this object was last updated.
    version number
    The version number of the object.
    management_group_ancestors Sequence[str]
    The ancestors of the management group.
    management_group_ancestors_chain Sequence[ManagementGroupPathElementResponse]
    The ancestors of the management group displayed in reversed order, from immediate parent to the root.
    parent ParentGroupInfoResponse
    (Optional) The ID of the parent management group.
    path Sequence[ManagementGroupPathElementResponse]
    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.
    managementGroupAncestors List<String>
    The ancestors of the management group.
    managementGroupAncestorsChain List<Property Map>
    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.
    updatedBy String
    The identity of the principal or process that updated the object.
    updatedTime String
    The date and time when this object was last updated.
    version Number
    The version number of the object.

    ManagementGroupPathElementResponse, ManagementGroupPathElementResponseArgs

    DisplayName string
    The friendly name of the group.
    Name string
    The name of the group.
    DisplayName string
    The friendly name of the group.
    Name string
    The name of the group.
    displayName String
    The friendly name of the group.
    name String
    The name of the group.
    displayName 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.
    displayName String
    The friendly name of the group.
    name String
    The name of the group.

    ParentGroupInfoResponse, ParentGroupInfoResponseArgs

    DisplayName 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
    DisplayName 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
    displayName 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
    displayName 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
    displayName 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

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:management:ManagementGroup ChildGroup /providers/Microsoft.Management/managementGroups/{groupId}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native