SharesOperations Class

SharesOperations 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

SharesOperations

Constructor

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

models

Alias to model classes used in this operation group.

Methods

begin_delete	Deletes a share. Delete a share.
create	Create a share in the given account. Create a share.
get	Get a specified share. Get a share.
list_by_account	List of available shares under an account. List shares in an account.
list_synchronization_details	List data set level details for a share synchronization. List synchronization details.
list_synchronizations	List Synchronizations in a share. List synchronizations of a share.

begin_delete

Deletes a share.

Delete a share.

async begin_delete(resource_group_name: str, account_name: str, share_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.datashare.models._models_py3.OperationResponse]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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 AsyncLROPoller that returns either OperationResponse or the result of cls(response)

Return type

AsyncLROPoller[OperationResponse]

Exceptions

HttpResponseError

create

Create a share in the given account.

Create a share.

async create(resource_group_name: str, account_name: str, share_name: str, share: azure.mgmt.datashare.models._models_py3.Share, **kwargs) -> azure.mgmt.datashare.models._models_py3.Share

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

share

Share

Required

The share payload.

cls

callable

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

Returns

Share, or the result of cls(response)

Return type

Share

Exceptions

HttpResponseError

get

Get a specified share.

Get a share.

async get(resource_group_name: str, account_name: str, share_name: str, **kwargs) -> azure.mgmt.datashare.models._models_py3.Share

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share to retrieve.

cls

callable

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

Returns

Share, or the result of cls(response)

Return type

Share

Exceptions

HttpResponseError

list_by_account

List of available shares under an account.

List shares in an account.

list_by_account(resource_group_name: str, account_name: str, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.datashare.models._models_py3.ShareList]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

skip_token

str

default value: None

Continuation Token.

filter

str

default value: None

Filters the results using OData syntax.

orderby

str

default value: None

Sorts the results using OData syntax.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[ShareList]

Exceptions

HttpResponseError

list_synchronization_details

List data set level details for a share synchronization.

List synchronization details.

list_synchronization_details(resource_group_name: str, account_name: str, share_name: str, share_synchronization: azure.mgmt.datashare.models._models_py3.ShareSynchronization, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.datashare.models._models_py3.SynchronizationDetailsList]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

share_synchronization

ShareSynchronization

Required

Share Synchronization payload.

skip_token

str

default value: None

Continuation token.

filter

str

default value: None

Filters the results using OData syntax.

orderby

str

default value: None

Sorts the results using OData syntax.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[SynchronizationDetailsList]

Exceptions

HttpResponseError

list_synchronizations

List Synchronizations in a share.

List synchronizations of a share.

list_synchronizations(resource_group_name: str, account_name: str, share_name: str, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.datashare.models._models_py3.ShareSynchronizationList]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

skip_token

str

default value: None

Continuation token.

filter

str

default value: None

Filters the results using OData syntax.

orderby

str

default value: None

Sorts the results using OData syntax.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[ShareSynchronizationList]

Exceptions

HttpResponseError

Attributes

models

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