AccountsOperations Class
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.objectAccountsOperations
Constructor
AccountsOperations(client, config, serializer, deserializer)
Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- 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
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
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
- 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
An instance of LROPoller that returns either Account or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes the account resource.
Deletes an account resource.
begin_delete(resource_group_name: str, account_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
- 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
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
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
- 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
An instance of LROPoller that returns either Account or the result of cls(response)
Return type
Exceptions
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
- check_name_availability_request
- CheckNameAvailabilityRequest
The check name availability request.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CheckNameAvailabilityResult, or the result of cls(response)
Return type
Exceptions
get
Gets the account resource.
Get an account.
get(resource_group_name: str, account_name: str, **kwargs: Any) -> _models.Account
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Account, or the result of cls(response)
Return type
Exceptions
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: Optional[str] = None, **kwargs: Any) -> Iterable[_models.AccountList]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either AccountList or the result of cls(response)
Return type
Exceptions
list_by_subscription
Gets the accounts resources by subscription.
List accounts in Subscription.
list_by_subscription(skip_token: Optional[str] = None, **kwargs: Any) -> Iterable[_models.AccountList]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either AccountList or the result of cls(response)
Return type
Exceptions
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
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AccessKeys, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.purview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\purview\\models\\__init__.py'>
Feedback
Submit and view feedback for