Share via

DefaultAccountsOperations Class

  • Reference

DefaultAccountsOperations 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
DefaultAccountsOperations

Constructor

DefaultAccountsOperations(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

get

Gets the default account information set for the scope.

Get the default account for the scope.
remove

Removes the default account from the scope.

Removes the default account from the scope.
set

Sets the default account for the scope.

Sets the default account for the scope.

get

Gets the default account information set for the scope.

Get the default account for the scope.

async get(scope_tenant_id: str, scope_type: str | ScopeType, scope: str | None = None, **kwargs: Any) -> DefaultAccountPayload

Parameters

Name Description
scope_tenant_id
Required
str

The tenant ID.
scope_type
Required
str or ScopeType

The scope for the default account.
scope
str

The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
DefaultAccountPayload

DefaultAccountPayload, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

remove

Removes the default account from the scope.

Removes the default account from the scope.

async remove(scope_tenant_id: str, scope_type: str | ScopeType, scope: str | None = None, **kwargs: Any) -> None

Parameters

Name Description
scope_tenant_id
Required
str

The tenant ID.
scope_type
Required
str or ScopeType

The scope for the default account.
scope
str

The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.

Default value: None

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

set

Sets the default account for the scope.

Sets the default account for the scope.

async set(default_account_payload: DefaultAccountPayload, **kwargs: Any) -> DefaultAccountPayload

Parameters

Name Description
default_account_payload
Required
DefaultAccountPayload

The payload containing the default account information and the scope.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
DefaultAccountPayload

DefaultAccountPayload, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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