HierarchySettingsOperations Class

HierarchySettingsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

HierarchySettingsOperations

Constructor

HierarchySettingsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

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', **kwargs: Any) -> _models.HierarchySettings

Parameters

Name	Description
group_id Required	str Management Group ID.
create_tenant_settings_request Required	CreateOrUpdateSettingsRequest Tenant level settings request parameter.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
HierarchySettings	HierarchySettings, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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) -> _models.HierarchySettings

Parameters

Name	Description
group_id Required	str Management Group ID.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
HierarchySettings	HierarchySettings, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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) -> _models.HierarchySettingsList

Parameters

Name	Description
group_id Required	str Management Group ID.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
HierarchySettingsList	HierarchySettingsList, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Updates the hierarchy settings defined at the Management Group level.

update(group_id: str, create_tenant_settings_request: '_models.CreateOrUpdateSettingsRequest', **kwargs: Any) -> _models.HierarchySettings

Parameters

Name	Description
group_id Required	str Management Group ID.
create_tenant_settings_request Required	CreateOrUpdateSettingsRequest Tenant level settings request parameter.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
HierarchySettings	HierarchySettings, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.managementgroups.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\managementgroups\\models\\__init__.py'>