Share via

AccountsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataLakeStoreAccountManagementClient's

<xref:accounts> attribute.

Inheritance
builtins.object
AccountsOperations

Constructor

AccountsOperations(*args, **kwargs)

Methods

begin_create

Creates the specified Data Lake Store account.
begin_delete

Deletes the specified Data Lake Store account.
begin_update

Updates the specified Data Lake Store account information.
check_name_availability

Checks whether the specified account name is available or taken.
enable_key_vault

Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account.
get

Gets the specified Data Lake Store account.
list

Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.
list_by_resource_group

Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any.

begin_create

Creates the specified Data Lake Store account.

async begin_create(resource_group_name: str, account_name: str, parameters: _models.CreateDataLakeStoreAccountParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DataLakeStoreAccount]

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.
account_name
Required
str

The name of the Data Lake Store account. Required.
parameters
Required
CreateDataLakeStoreAccountParameters or IO

Parameters supplied to create the Data Lake Store account. Is either a CreateDataLakeStoreAccountParameters type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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
AsyncLROPoller[DataLakeStoreAccount]

An instance of AsyncLROPoller that returns either DataLakeStoreAccount or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified Data Lake Store account.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.
account_name
Required
str

The name of the Data Lake Store account. Required.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_update

Updates the specified Data Lake Store account information.

async begin_update(resource_group_name: str, account_name: str, parameters: _models.UpdateDataLakeStoreAccountParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DataLakeStoreAccount]

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.
account_name
Required
str

The name of the Data Lake Store account. Required.
parameters
Required
UpdateDataLakeStoreAccountParameters or IO

Parameters supplied to update the Data Lake Store account. Is either a UpdateDataLakeStoreAccountParameters type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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
AsyncLROPoller[DataLakeStoreAccount]

An instance of AsyncLROPoller that returns either DataLakeStoreAccount or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_name_availability

Checks whether the specified account name is available or taken.

async check_name_availability(location: str, parameters: _models.CheckNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NameAvailabilityInformation

Parameters

Name Description
location
Required
str

The resource location without whitespace. Required.
parameters
Required
CheckNameAvailabilityParameters or IO

Parameters supplied to check the Data Lake Store account name availability. Is either a CheckNameAvailabilityParameters type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

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

Returns

Type Description
NameAvailabilityInformation

NameAvailabilityInformation or the result of cls(response)

Exceptions

Type Description
HttpResponseError

enable_key_vault

Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account.

async enable_key_vault(resource_group_name: str, account_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.
account_name
Required
str

The name of the Data Lake Store account. Required.

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 specified Data Lake Store account.

async get(resource_group_name: str, account_name: str, **kwargs: Any) -> DataLakeStoreAccount

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.
account_name
Required
str

The name of the Data Lake Store account. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
DataLakeStoreAccount

DataLakeStoreAccount or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.

list(filter: str | None = None, top: int | None = None, skip: int | None = None, select: str | None = None, orderby: str | None = None, count: bool | None = None, **kwargs: Any) -> AsyncIterable[DataLakeStoreAccountBasic]

Parameters

Name Description
filter
Required
str

OData filter. Optional. Default value is None.
top
Required
int

The number of items to return. Optional. Default value is None.
skip
Required
int

The number of items to skip over before returning elements. Optional. Default value is None.
select
Required
str

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. Default value is None.
orderby
Required
str

OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. Default value is None.
count
Required
bool

The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
AsyncItemPaged[DataLakeStoreAccountBasic]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any.

list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, skip: int | None = None, select: str | None = None, orderby: str | None = None, count: bool | None = None, **kwargs: Any) -> AsyncIterable[DataLakeStoreAccountBasic]

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.
filter
Required
str

OData filter. Optional. Default value is None.
top
Required
int

The number of items to return. Optional. Default value is None.
skip
Required
int

The number of items to skip over before returning elements. Optional. Default value is None.
select
Required
str

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. Default value is None.
orderby
Required
str

OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. Default value is None.
count
Required
bool

A Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
AsyncItemPaged[DataLakeStoreAccountBasic]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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