Share via

AccountsOperations Class

  • Reference

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

Constructor

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

add_root_collection_admin

Add the administrator for root collection.

Add the administrator for root collection associated with this account.
begin_create_or_update

Create or update an account resource.

Creates or updates an account.
begin_delete

Deletes the account resource.

Deletes an account resource.
begin_update

Patches the account resource.

Updates an account.
check_name_availability

Checks the account name availability.

Checks if account name is available.
get

Gets the account resource.

Get an account.
list_by_resource_group

Gets the accounts resources by resource group.

List accounts in ResourceGroup.
list_by_subscription

Gets the accounts resources by subscription.

List accounts in Subscription.
list_keys

Lists the keys asynchronous.

List the authorization keys associated with this account.

add_root_collection_admin

Add the administrator for root collection.

Add the administrator for root collection associated with this account.

add_root_collection_admin(resource_group_name: str, account_name: str, collection_admin_update: '_models.CollectionAdminUpdate', **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The resource group name.
account_name
Required
str

The name of the account.
collection_admin_update
Required
CollectionAdminUpdate

The collection admin update payload.

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

begin_create_or_update

Create or update an account resource.

Creates or updates an account.

begin_create_or_update(resource_group_name: str, account_name: str, account: '_models.Account', **kwargs: Any) -> LROPoller['_models.Account']

Parameters

Name Description
resource_group_name
Required
str

The resource group name.
account_name
Required
str

The name of the account.
account
Required
Account

The account.

Keyword-Only Parameters

Name Description
cls
callable

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

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[Account]

An instance of LROPoller that returns either Account or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the account resource.

Deletes an account resource.

begin_delete(resource_group_name: str, account_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The resource group name.
account_name
Required
str

The name of the account.

Keyword-Only Parameters

Name Description
cls
callable

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

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Patches the account resource.

Updates an account.

begin_update(resource_group_name: str, account_name: str, account_update_parameters: '_models.AccountUpdateParameters', **kwargs: Any) -> LROPoller['_models.Account']

Parameters

Name Description
resource_group_name
Required
str

The resource group name.
account_name
Required
str

The name of the account.
account_update_parameters
Required
AccountUpdateParameters

The account update parameters.

Keyword-Only Parameters

Name Description
cls
callable

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

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[Account]

An instance of LROPoller that returns either Account or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_name_availability

Checks the account name availability.

Checks if account name is available.

check_name_availability(check_name_availability_request: '_models.CheckNameAvailabilityRequest', **kwargs: Any) -> _models.CheckNameAvailabilityResult

Parameters

Name Description
check_name_availability_request
Required
CheckNameAvailabilityRequest

The check name availability request.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
CheckNameAvailabilityResult

CheckNameAvailabilityResult, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the account resource.

Get an account.

get(resource_group_name: str, account_name: str, **kwargs: Any) -> _models.Account

Parameters

Name Description
resource_group_name
Required
str

The resource group name.
account_name
Required
str

The name of the account.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
Account

Account, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Gets the accounts resources by resource group.

List accounts in ResourceGroup.

list_by_resource_group(resource_group_name: str, skip_token: str | None = None, **kwargs: Any) -> Iterable['_models.AccountList']

Parameters

Name Description
resource_group_name
Required
str

The resource group name.
skip_token
str

The skip token.

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
ItemPaged[AccountList]

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

Exceptions

Type Description
HttpResponseError

list_by_subscription

Gets the accounts resources by subscription.

List accounts in Subscription.

list_by_subscription(skip_token: str | None = None, **kwargs: Any) -> Iterable['_models.AccountList']

Parameters

Name Description
skip_token
str

The skip token.

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
ItemPaged[AccountList]

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

Exceptions

Type Description
HttpResponseError

list_keys

Lists the keys asynchronous.

List the authorization keys associated with this account.

list_keys(resource_group_name: str, account_name: str, **kwargs: Any) -> _models.AccessKeys

Parameters

Name Description
resource_group_name
Required
str

The resource group name.
account_name
Required
str

The name of the account.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
AccessKeys

AccessKeys, 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'>