Azure Native

v1.88.1 published on Thursday, Dec 1, 2022 by Pulumi

HierarchySetting

Settings defined at the Management Group scope. API Version: 2020-05-01.

Example Usage

GetGroupSettings

using System.Collections.Generic;
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,
    });

});
package main

import (
	management "github.com/pulumi/pulumi-azure-native/sdk/go/azure/management"
	"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
	})
}
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());

    }
}
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)
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,
});
resources:
  hierarchySetting:
    type: azure-native:management:HierarchySetting
    properties:
      defaultManagementGroup: /providers/Microsoft.Management/managementGroups/DefaultGroup
      groupId: root
      requireAuthorizationForGroupCreation: true

Create HierarchySetting Resource

new HierarchySetting(name: string, args: HierarchySettingArgs, opts?: CustomResourceOptions);
@overload
def HierarchySetting(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     default_management_group: Optional[str] = None,
                     group_id: Optional[str] = None,
                     require_authorization_for_group_creation: Optional[bool] = None)
@overload
def HierarchySetting(resource_name: str,
                     args: HierarchySettingArgs,
                     opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args HierarchySettingArgs
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 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 string
The unique name of the resource.
args HierarchySettingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args HierarchySettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args HierarchySettingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The HierarchySetting resource accepts the following input properties:

GroupId 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 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 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 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 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 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:

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

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

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

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

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

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/root/settings/default 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0