HierarchySettingsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ManagementGroupsMgmtClient's

<xref:hierarchy_settings> attribute.

Constructor

HierarchySettingsOperations(*args, **kwargs)

Methods

create_or_update

Creates or updates the hierarchy settings defined at the Management Group level.

delete

Deletes the hierarchy settings defined at the Management Group level.

get

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

list

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

update

Updates the hierarchy settings defined at the Management Group level.

create_or_update

Creates or updates the hierarchy settings defined at the Management Group level.

create_or_update(group_id: str, create_tenant_settings_request: _models.CreateOrUpdateSettingsRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.HierarchySettings

Parameters

Name Description
group_id
Required
str

Management Group ID. Required.

create_tenant_settings_request
Required

Tenant level settings request parameter. Is one of the following types: CreateOrUpdateSettingsRequest, JSON, IO[bytes] Required.

Returns

Type Description

HierarchySettings. The HierarchySettings is compatible with MutableMapping

Exceptions

Type Description

delete

Deletes the hierarchy settings defined at the Management Group level.

delete(group_id: str, **kwargs: Any) -> None

Parameters

Name Description
group_id
Required
str

Management Group ID. Required.

Returns

Type Description

None

Exceptions

Type Description

get

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

get(group_id: str, **kwargs: Any) -> HierarchySettings

Parameters

Name Description
group_id
Required
str

Management Group ID. Required.

Returns

Type Description

HierarchySettings. The HierarchySettings is compatible with MutableMapping

Exceptions

Type Description

list

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

list(group_id: str, **kwargs: Any) -> HierarchySettingsList

Parameters

Name Description
group_id
Required
str

Management Group ID. Required.

Returns

Type Description

HierarchySettingsList. The HierarchySettingsList is compatible with MutableMapping

Exceptions

Type Description

update

Updates the hierarchy settings defined at the Management Group level.

update(group_id: str, create_tenant_settings_request: _models.CreateOrUpdateSettingsRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.HierarchySettings

Parameters

Name Description
group_id
Required
str

Management Group ID. Required.

create_tenant_settings_request
Required

Tenant level settings request parameter. Is one of the following types: CreateOrUpdateSettingsRequest, JSON, IO[bytes] Required.

Returns

Type Description

HierarchySettings. The HierarchySettings is compatible with MutableMapping

Exceptions

Type Description