AccountsOperations Class

AccountsOperations operations.

Inheritance

builtins.object

AccountsOperations

Constructor

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

api_version

Client Api Version. Constant value: "2016-11-01".

Methods

check_name_availability	Checks whether the specified account name is available or taken.
create	Creates the specified Data Lake Store account.
delete	Deletes the specified Data Lake Store account.
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.
update	Updates the specified Data Lake Store account information.

check_name_availability

Checks whether the specified account name is available or taken.

check_name_availability(location, name, custom_headers=None, raw=False, **operation_config)

Parameters

location

str

Required

The resource location without whitespace.

name

str

Required

The Data Lake Store name to check availability for.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

NameAvailabilityInformation or ClientRawResponse if raw=true

Return type

NameAvailabilityInformation,

ClientRawResponse

Exceptions

CloudError

create

Creates the specified Data Lake Store account.

create(resource_group_name, account_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name

str

Required

The name of the Azure resource group.

account_name

str

Required

The name of the Data Lake Store account.

parameters

CreateDataLakeStoreAccountParameters

Required

Parameters supplied to create the Data Lake Store account.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DataLakeStoreAccount or ClientRawResponse if raw==True

Return type

AzureOperationPoller[DataLakeStoreAccount],

AzureOperationPoller[ClientRawResponse[DataLakeStoreAccount]]

Exceptions

CloudError

delete

Deletes the specified Data Lake Store account.

delete(resource_group_name, account_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name

str

Required

The name of the Azure resource group.

account_name

str

Required

The name of the Data Lake Store account.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

CloudError

enable_key_vault

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

enable_key_vault(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

The name of the Azure resource group.

account_name

str

Required

The name of the Data Lake Store account.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

get

Gets the specified Data Lake Store account.

get(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

The name of the Azure resource group.

account_name

str

Required

The name of the Data Lake Store account.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

DataLakeStoreAccount or ClientRawResponse if raw=true

Return type

DataLakeStoreAccount,

ClientRawResponse

Exceptions

CloudError

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=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)

Parameters

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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.

count

bool

default value: None

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.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of DataLakeStoreAccountBasic

Return type

DataLakeStoreAccountBasicPaged[DataLakeStoreAccountBasic]

Exceptions

CloudError

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, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

The name of the Azure resource group.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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.

count

bool

default value: None

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.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of DataLakeStoreAccountBasic

Return type

DataLakeStoreAccountBasicPaged[DataLakeStoreAccountBasic]

Exceptions

CloudError

update

Updates the specified Data Lake Store account information.

update(resource_group_name, account_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name

str

Required

The name of the Azure resource group.

account_name

str

Required

The name of the Data Lake Store account.

parameters

UpdateDataLakeStoreAccountParameters

Required

Parameters supplied to update the Data Lake Store account.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DataLakeStoreAccount or ClientRawResponse if raw==True

Return type

AzureOperationPoller[DataLakeStoreAccount],

AzureOperationPoller[ClientRawResponse[DataLakeStoreAccount]]

Exceptions

CloudError

Attributes

models

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