Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. management
  5. getHierarchySetting
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.management.getHierarchySetting

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.

Uses Azure REST API version 2023-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.

Using getHierarchySetting

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getHierarchySetting(args: GetHierarchySettingArgs, opts?: InvokeOptions): Promise<GetHierarchySettingResult>
function getHierarchySettingOutput(args: GetHierarchySettingOutputArgs, opts?: InvokeOptions): Output<GetHierarchySettingResult>
Copy
def get_hierarchy_setting(group_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetHierarchySettingResult
def get_hierarchy_setting_output(group_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetHierarchySettingResult]
Copy
func LookupHierarchySetting(ctx *Context, args *LookupHierarchySettingArgs, opts ...InvokeOption) (*LookupHierarchySettingResult, error)
func LookupHierarchySettingOutput(ctx *Context, args *LookupHierarchySettingOutputArgs, opts ...InvokeOption) LookupHierarchySettingResultOutput
Copy

> Note: This function is named LookupHierarchySetting in the Go SDK.

public static class GetHierarchySetting 
{
    public static Task<GetHierarchySettingResult> InvokeAsync(GetHierarchySettingArgs args, InvokeOptions? opts = null)
    public static Output<GetHierarchySettingResult> Invoke(GetHierarchySettingInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHierarchySettingResult> getHierarchySetting(GetHierarchySettingArgs args, InvokeOptions options)
public static Output<GetHierarchySettingResult> getHierarchySetting(GetHierarchySettingArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:management:getHierarchySetting
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupId
This property is required.
Changes to this property will trigger replacement.
string
Management Group ID.
GroupId
This property is required.
Changes to this property will trigger replacement.
string
Management Group ID.
groupId
This property is required.
Changes to this property will trigger replacement.
String
Management Group ID.
groupId
This property is required.
Changes to this property will trigger replacement.
string
Management Group ID.
group_id
This property is required.
Changes to this property will trigger replacement.
str
Management Group ID.
groupId
This property is required.
Changes to this property will trigger replacement.
String
Management Group ID.

getHierarchySetting Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
Name string
The name of the object. In this case, default.
Type string
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
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.
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 fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
Name string
The name of the object. In this case, default.
Type string
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
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.
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 fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
name String
The name of the object. In this case, default.
type String
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
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.
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 fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
name string
The name of the object. In this case, default.
type string
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
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.
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 fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
name str
The name of the object. In this case, default.
type str
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
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.
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 fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
name String
The name of the object. In this case, default.
type String
The type of the resource. For example, Microsoft.Management/managementGroups/settings.
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.
tenantId String
The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native