ShareSubscriptionsOperations Class

ShareSubscriptionsOperations 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

ShareSubscriptionsOperations

Constructor

ShareSubscriptionsOperations(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_cancel_synchronization	Request cancellation of a data share snapshot. Request to cancel a synchronization.
begin_delete	Delete shareSubscription in an account. Delete a shareSubscription in an account.
begin_synchronize	Initiate an asynchronous data share job. Initiate a copy.
create	Create shareSubscription in an account. Create a shareSubscription in an account.
get	Get shareSubscription in an account. Get a shareSubscription in an account.
list_by_account	List of available share subscriptions under an account. List share subscriptions in an account.
list_source_share_synchronization_settings	Get source share synchronization settings for a shareSubscription. Get synchronization settings set on a share.
list_synchronization_details	List data set level details for a share subscription synchronization. List synchronization details.
list_synchronizations	List Synchronizations in a share subscription. List synchronizations of a share subscription.

begin_cancel_synchronization

Request cancellation of a data share snapshot.

Request to cancel a synchronization.

async begin_cancel_synchronization(resource_group_name: str, account_name: str, share_subscription_name: str, share_subscription_synchronization: azure.mgmt.datashare.models._models_py3.ShareSubscriptionSynchronization, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.datashare.models._models_py3.ShareSubscriptionSynchronization]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_subscription_name

str

Required

The name of the shareSubscription.

share_subscription_synchronization

ShareSubscriptionSynchronization

Required

Share Subscription Synchronization payload.

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 ShareSubscriptionSynchronization or the result of cls(response)

Return type

AsyncLROPoller[ShareSubscriptionSynchronization]

Exceptions

HttpResponseError

begin_delete

Delete shareSubscription in an account.

Delete a shareSubscription in an account.

async begin_delete(resource_group_name: str, account_name: str, share_subscription_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_subscription_name

str

Required

The name of the shareSubscription.

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

begin_synchronize

Initiate an asynchronous data share job.

Initiate a copy.

async begin_synchronize(resource_group_name: str, account_name: str, share_subscription_name: str, synchronize: azure.mgmt.datashare.models._models_py3.Synchronize, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.datashare.models._models_py3.ShareSubscriptionSynchronization]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_subscription_name

str

Required

The name of share subscription.

synchronize

Synchronize

Required

Synchronize payload.

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 ShareSubscriptionSynchronization or the result of cls(response)

Return type

AsyncLROPoller[ShareSubscriptionSynchronization]

Exceptions

HttpResponseError

create

Create shareSubscription in an account.

Create a shareSubscription in an account.

async create(resource_group_name: str, account_name: str, share_subscription_name: str, share_subscription: azure.mgmt.datashare.models._models_py3.ShareSubscription, **kwargs) -> azure.mgmt.datashare.models._models_py3.ShareSubscription

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_subscription_name

str

Required

The name of the shareSubscription.

share_subscription

ShareSubscription

Required

create parameters for shareSubscription.

cls

callable

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

Returns

ShareSubscription, or the result of cls(response)

Return type

ShareSubscription

Exceptions

HttpResponseError

get

Get shareSubscription in an account.

Get a shareSubscription in an account.

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

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_subscription_name

str

Required

The name of the shareSubscription.

cls

callable

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

Returns

ShareSubscription, or the result of cls(response)

Return type

ShareSubscription

Exceptions

HttpResponseError

list_by_account

List of available share subscriptions under an account.

List share subscriptions 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.ShareSubscriptionList]

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 ShareSubscriptionList or the result of cls(response)

Return type

AsyncItemPaged[ShareSubscriptionList]

Exceptions

HttpResponseError

list_source_share_synchronization_settings

Get source share synchronization settings for a shareSubscription.

Get synchronization settings set on a share.

list_source_share_synchronization_settings(resource_group_name: str, account_name: str, share_subscription_name: str, skip_token: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.datashare.models._models_py3.SourceShareSynchronizationSettingList]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_subscription_name

str

Required

The name of the shareSubscription.

skip_token

str

default value: None

Continuation token.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[SourceShareSynchronizationSettingList]

Exceptions

HttpResponseError

list_synchronization_details

List data set level details for a share subscription synchronization.

List synchronization details.

list_synchronization_details(resource_group_name: str, account_name: str, share_subscription_name: str, share_subscription_synchronization: azure.mgmt.datashare.models._models_py3.ShareSubscriptionSynchronization, 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_subscription_name

str

Required

The name of the share subscription.

share_subscription_synchronization

ShareSubscriptionSynchronization

Required

Share Subscription 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 subscription.

List synchronizations of a share subscription.

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

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_subscription_name

str

Required

The name of the share subscription.

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 ShareSubscriptionSynchronizationList or the result of cls(response)

Return type

AsyncItemPaged[ShareSubscriptionSynchronizationList]

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