TenantConfigurationsOperations Class

TenantConfigurationsOperations async 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

TenantConfigurationsOperations

Constructor

TenantConfigurationsOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

create	Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.
delete	Delete the tenant configuration. User has to be a Tenant Admin for this operation.
get	Gets the tenant configuration.
list	Gets list of the tenant configurations.

create

Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.

async create(configuration_name: Union[str, azure.mgmt.portal.models._portal_enums.ConfigurationName], tenant_configuration: azure.mgmt.portal.models._models_py3.Configuration, **kwargs: Any) -> azure.mgmt.portal.models._models_py3.Configuration

Parameters

configuration_name

str or ConfigurationName

Required

The configuration name. Value must be 'default'.

tenant_configuration

Configuration

Required

The parameters required to create or update tenant configuration.

cls

callable

A custom type or function that will be passed the direct response

Returns

Configuration, or the result of cls(response)

Return type

Configuration

Exceptions

HttpResponseError

delete

Delete the tenant configuration. User has to be a Tenant Admin for this operation.

async delete(configuration_name: Union[str, azure.mgmt.portal.models._portal_enums.ConfigurationName], **kwargs: Any) -> None

Parameters

configuration_name

str or ConfigurationName

Required

The configuration name. Value must be 'default'.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets the tenant configuration.

async get(configuration_name: Union[str, azure.mgmt.portal.models._portal_enums.ConfigurationName], **kwargs: Any) -> Optional[azure.mgmt.portal.models._models_py3.Configuration]

Parameters

configuration_name

str or ConfigurationName

Required

The configuration name. Value must be 'default'.

cls

callable

A custom type or function that will be passed the direct response

Returns

Configuration, or the result of cls(response)

Return type

Configuration,

None

Exceptions

HttpResponseError

list

Gets list of the tenant configurations.

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.portal.models._models_py3.ConfigurationList]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ConfigurationList or the result of cls(response)

Return type

AsyncItemPaged[ConfigurationList]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.portal.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\portal\\models\\__init__.py'>