Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. management
  5. getHierarchySetting
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.37.0 published on Monday, Apr 15, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.management.getHierarchySetting

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.37.0 published on Monday, Apr 15, 2024 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.

    Azure REST API version: 2021-04-01.

    Other available API versions: 2023-04-01.

    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>
    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]
    func LookupHierarchySetting(ctx *Context, args *LookupHierarchySettingArgs, opts ...InvokeOption) (*LookupHierarchySettingResult, error)
func LookupHierarchySettingOutput(ctx *Context, args *LookupHierarchySettingOutputArgs, opts ...InvokeOption) LookupHierarchySettingResultOutput

    > 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)
}
    public static CompletableFuture<GetHierarchySettingResult> getHierarchySetting(GetHierarchySettingArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:management:getHierarchySetting
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GroupId string
    Management Group ID.
    GroupId string
    Management Group ID.
    groupId String
    Management Group ID.
    groupId string
    Management Group ID.
    group_id str
    Management Group ID.
    groupId String
    Management Group ID.

    getHierarchySetting Result

    The following output properties are available:

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