Share via

HierarchySettings interface

  • Reference
Package:
@azure/arm-managementgroups

Settings defined at the Management Group scope.

Properties

defaultManagementGroup

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

The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default. NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the object. In this case, default. NOTE: This property will not be serialized. It can only be populated by the server.
requireAuthorizationForGroupCreation

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

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

The type of the resource. For example, Microsoft.Management/managementGroups/settings. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

defaultManagementGroup

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

defaultManagementGroup?: string

Property Value

string

id

The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

name

The name of the object. In this case, default. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

requireAuthorizationForGroupCreation

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.

requireAuthorizationForGroupCreation?: boolean

Property Value

boolean

tenantId

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

tenantId?: string

Property Value

string

type

The type of the resource. For example, Microsoft.Management/managementGroups/settings. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string