Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. management
  5. HierarchySetting
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.management.HierarchySetting

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Settings defined at the Management Group scope.

Uses Azure REST API version 2023-04-01. In version 2.x of the Azure Native provider, it used API version 2021-04-01.

Other available API versions: 2021-04-01. 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 for details.

Example Usage

GetGroupSettings

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

return await Deployment.RunAsync(() => 
{
    var hierarchySetting = new AzureNative.Management.HierarchySetting("hierarchySetting", new()
    {
        DefaultManagementGroup = "/providers/Microsoft.Management/managementGroups/DefaultGroup",
        GroupId = "root",
        RequireAuthorizationForGroupCreation = true,
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := management.NewHierarchySetting(ctx, "hierarchySetting", &management.HierarchySettingArgs{
			DefaultManagementGroup:               pulumi.String("/providers/Microsoft.Management/managementGroups/DefaultGroup"),
			GroupId:                              pulumi.String("root"),
			RequireAuthorizationForGroupCreation: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.management.HierarchySetting;
import com.pulumi.azurenative.management.HierarchySettingArgs;
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 hierarchySetting = new HierarchySetting("hierarchySetting", HierarchySettingArgs.builder()
            .defaultManagementGroup("/providers/Microsoft.Management/managementGroups/DefaultGroup")
            .groupId("root")
            .requireAuthorizationForGroupCreation(true)
            .build());

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

const hierarchySetting = new azure_native.management.HierarchySetting("hierarchySetting", {
    defaultManagementGroup: "/providers/Microsoft.Management/managementGroups/DefaultGroup",
    groupId: "root",
    requireAuthorizationForGroupCreation: true,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

hierarchy_setting = azure_native.management.HierarchySetting("hierarchySetting",
    default_management_group="/providers/Microsoft.Management/managementGroups/DefaultGroup",
    group_id="root",
    require_authorization_for_group_creation=True)
Copy
resources:
  hierarchySetting:
    type: azure-native:management:HierarchySetting
    properties:
      defaultManagementGroup: /providers/Microsoft.Management/managementGroups/DefaultGroup
      groupId: root
      requireAuthorizationForGroupCreation: true
Copy

Create HierarchySetting Resource

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

Constructor syntax

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

@overload
def HierarchySetting(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     group_id: Optional[str] = None,
                     default_management_group: Optional[str] = None,
                     require_authorization_for_group_creation: Optional[bool] = None)
func NewHierarchySetting(ctx *Context, name string, args HierarchySettingArgs, opts ...ResourceOption) (*HierarchySetting, error)
public HierarchySetting(string name, HierarchySettingArgs args, CustomResourceOptions? opts = null)
public HierarchySetting(String name, HierarchySettingArgs args)
public HierarchySetting(String name, HierarchySettingArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HierarchySettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HierarchySettingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HierarchySettingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HierarchySettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HierarchySettingArgs
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 hierarchySettingResource = new AzureNative.Management.HierarchySetting("hierarchySettingResource", new()
{
    GroupId = "string",
    DefaultManagementGroup = "string",
    RequireAuthorizationForGroupCreation = false,
});
Copy
example, err := management.NewHierarchySetting(ctx, "hierarchySettingResource", &management.HierarchySettingArgs{
	GroupId:                              pulumi.String("string"),
	DefaultManagementGroup:               pulumi.String("string"),
	RequireAuthorizationForGroupCreation: pulumi.Bool(false),
})
Copy
var hierarchySettingResource = new HierarchySetting("hierarchySettingResource", HierarchySettingArgs.builder()
    .groupId("string")
    .defaultManagementGroup("string")
    .requireAuthorizationForGroupCreation(false)
    .build());
Copy
hierarchy_setting_resource = azure_native.management.HierarchySetting("hierarchySettingResource",
    group_id="string",
    default_management_group="string",
    require_authorization_for_group_creation=False)
Copy
const hierarchySettingResource = new azure_native.management.HierarchySetting("hierarchySettingResource", {
    groupId: "string",
    defaultManagementGroup: "string",
    requireAuthorizationForGroupCreation: false,
});
Copy
type: azure-native:management:HierarchySetting
properties:
    defaultManagementGroup: string
    groupId: string
    requireAuthorizationForGroupCreation: false
Copy

HierarchySetting 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 HierarchySetting resource accepts the following input properties:

GroupId
This property is required.
Changes to this property will trigger replacement.
string
Management Group ID.
DefaultManagementGroup string
Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
RequireAuthorizationForGroupCreation bool
Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access.
GroupId
This property is required.
Changes to this property will trigger replacement.
string
Management Group ID.
DefaultManagementGroup string
Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
RequireAuthorizationForGroupCreation bool
Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access.
groupId
This property is required.
Changes to this property will trigger replacement.
String
Management Group ID.
defaultManagementGroup String
Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
requireAuthorizationForGroupCreation Boolean
Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access.
groupId
This property is required.
Changes to this property will trigger replacement.
string
Management Group ID.
defaultManagementGroup string
Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
requireAuthorizationForGroupCreation boolean
Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access.
group_id
This property is required.
Changes to this property will trigger replacement.
str
Management Group ID.
default_management_group str
Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
require_authorization_for_group_creation bool
Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access.
groupId
This property is required.
Changes to this property will trigger replacement.
String
Management Group ID.
defaultManagementGroup String
Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
requireAuthorizationForGroupCreation Boolean
Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the object. In this case, default.
Type string
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
TenantId string
The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the object. In this case, default.
Type string
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
TenantId string
The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the object. In this case, default.
type String
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
tenantId String
The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the object. In this case, default.
type string
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
tenantId string
The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the object. In this case, default.
type str
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
tenant_id str
The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the object. In this case, default.
type String
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
tenantId String
The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000

Import

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

$ pulumi import azure-native:management:HierarchySetting root /providers/Microsoft.Management/managementGroups/{groupId}/settings/default
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native