HierarchySetting

class HierarchySetting : KotlinCustomResource

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, 2024-02-01-preview. 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/#accessing-any-api-version-via-local-packages 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,
});
});
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
})
}
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

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

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard

Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The name of the object. In this case, default.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
val tenantId: Output<String>?

The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000

Link copied to clipboard
val type: Output<String>

The type of the resource. For example, Microsoft.Management/managementGroups/settings.

Link copied to clipboard
val urn: Output<String>