azure.mgmt.datashare.operations module¶

class azure.mgmt.datashare.operations.AccountsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AccountsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

create(resource_group_name, account_name, account, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create an account in the given resource group.

Create an account.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
account (Account) – The account payload.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Account or ClientRawResponse<Account> if raw==True

Return type

AzureOperationPoller[Account] or AzureOperationPoller[ClientRawResponse[Account]]

Raises

DataShareErrorException

delete(resource_group_name, account_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Delete an account.

DeleteAccount.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns OperationResponse or ClientRawResponse<OperationResponse> if raw==True

Return type

AzureOperationPoller[OperationResponse] or AzureOperationPoller[ClientRawResponse[OperationResponse]]

Raises

DataShareErrorException

get(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get an account under a resource group.

Get an account.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Account or ClientRawResponse if raw=true

Return type

Account or ClientRawResponse

Raises

DataShareErrorException

list_by_resource_group(resource_group_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List Accounts in a resource group.

List Accounts in ResourceGroup.

Parameters

resource_group_name (str) – The resource group name.
skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Account

Return type

AccountPaged[Account]

Raises

DataShareErrorException

list_by_subscription(skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List Accounts in a subscription.

List Accounts in Subscription.

Parameters

skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Account

Return type

AccountPaged[Account]

Raises

DataShareErrorException

update(resource_group_name, account_name, tags=None, custom_headers=None, raw=False, **operation_config)[source]¶

Patch a given account.

Patch an account.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
tags (dict[str, str]) – Tags on the azure resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Account or ClientRawResponse if raw=true

Return type

Account or ClientRawResponse

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.ConsumerInvitationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ConsumerInvitationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

get(location, invitation_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the invitation identified by invitationId.

Get an invitation.

Parameters

location (str) – Location of the invitation
invitation_id (str) – An invitation id
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ConsumerInvitation or ClientRawResponse if raw=true

Return type

ConsumerInvitation or ClientRawResponse

Raises

DataShareErrorException

list_invitations(skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List the invitations.

Lists invitations.

Parameters

skip_token (str) – The continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ConsumerInvitation

Return type

ConsumerInvitationPaged[ConsumerInvitation]

Raises

DataShareErrorException

reject_invitation(location, invitation_id, custom_headers=None, raw=False, **operation_config)[source]¶

Rejects the invitation identified by invitationId.

Reject an invitation.

Parameters

location (str) – Location of the invitation
invitation_id (str) – Unique id of the invitation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ConsumerInvitation or ClientRawResponse if raw=true

Return type

ConsumerInvitation or ClientRawResponse

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.DataSetsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DataSetsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

create(resource_group_name, account_name, share_name, data_set_name, data_set, custom_headers=None, raw=False, **operation_config)[source]¶

Adds a new data set to an existing share.

Create a DataSet .

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share to add the data set to.
data_set_name (str) – The name of the dataSet.
data_set (DataSet) – The new data set information.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DataSet or ClientRawResponse if raw=true

Return type

DataSet or ClientRawResponse

Raises

DataShareErrorException

delete(resource_group_name, account_name, share_name, data_set_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Delete DataSet in a share.

Delete a DataSet in a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
data_set_name (str) – The name of the dataSet.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – 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<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

DataShareErrorException

get(resource_group_name, account_name, share_name, data_set_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get DataSet in a share.

Get a DataSet in a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
data_set_name (str) – The name of the dataSet.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DataSet or ClientRawResponse if raw=true

Return type

DataSet or ClientRawResponse

Raises

DataShareErrorException

list_by_share(resource_group_name, account_name, share_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List DataSets in a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
skip_token (str) – continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DataSet

Return type

DataSetPaged[DataSet]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.DataSetMappingsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DataSetMappingsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

create(resource_group_name, account_name, share_subscription_name, data_set_mapping_name, data_set_mapping, custom_headers=None, raw=False, **operation_config)[source]¶

Maps a source data set in the source share to a sink data set in the share subscription. Enables copying the data set from source to destination.

Create a DataSetMapping .

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the share subscription which will hold the data set sink.
data_set_mapping_name (str) – The name of the data set mapping to be created.
data_set_mapping (DataSetMapping) – Destination data set configuration details.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DataSetMapping or ClientRawResponse if raw=true

Return type

DataSetMapping or ClientRawResponse

Raises

DataShareErrorException

delete(resource_group_name, account_name, share_subscription_name, data_set_mapping_name, custom_headers=None, raw=False, **operation_config)[source]¶

Delete DataSetMapping in a shareSubscription.

Delete a DataSetMapping in a shareSubscription.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
data_set_mapping_name (str) – The name of the dataSetMapping.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

DataShareErrorException

get(resource_group_name, account_name, share_subscription_name, data_set_mapping_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get DataSetMapping in a shareSubscription.

Get a DataSetMapping in a shareSubscription.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
data_set_mapping_name (str) – The name of the dataSetMapping.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DataSetMapping or ClientRawResponse if raw=true

Return type

DataSetMapping or ClientRawResponse

Raises

DataShareErrorException

list_by_share_subscription(resource_group_name, account_name, share_subscription_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List DataSetMappings in a share subscription.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the share subscription.
skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DataSetMapping

Return type

DataSetMappingPaged[DataSetMapping]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.InvitationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

InvitationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

create(resource_group_name, account_name, share_name, invitation_name, invitation, custom_headers=None, raw=False, **operation_config)[source]¶

Sends a new invitation to a recipient to access a share.

Create an invitation .

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share to send the invitation for.
invitation_name (str) – The name of the invitation.
invitation (Invitation) – Invitation details.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Invitation or ClientRawResponse if raw=true

Return type

Invitation or ClientRawResponse

Raises

DataShareErrorException

delete(resource_group_name, account_name, share_name, invitation_name, custom_headers=None, raw=False, **operation_config)[source]¶

Delete Invitation in a share.

Delete an invitation in a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
invitation_name (str) – The name of the invitation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

DataShareErrorException

get(resource_group_name, account_name, share_name, invitation_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get Invitation in a share.

Get an invitation in a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
invitation_name (str) – The name of the invitation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Invitation or ClientRawResponse if raw=true

Return type

Invitation or ClientRawResponse

Raises

DataShareErrorException

list_by_share(resource_group_name, account_name, share_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List all Invitations in a share.

List invitations in a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
skip_token (str) – The continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Invitation

Return type

InvitationPaged[Invitation]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.Operations(client, config, serializer, deserializer)[source]¶

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

list(custom_headers=None, raw=False, **operation_config)[source]¶

Lists the available operations.

List of available operations.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of OperationModel

Return type

OperationModelPaged[OperationModel]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.SharesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SharesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

create(resource_group_name, account_name, share_name, share, custom_headers=None, raw=False, **operation_config)[source]¶

Create a share in the given account.

Create a share .

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
share (Share) – The share payload
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Share or ClientRawResponse if raw=true

Return type

Share or ClientRawResponse

Raises

DataShareErrorException

delete(resource_group_name, account_name, share_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a share.

Delete a share .

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns OperationResponse or ClientRawResponse<OperationResponse> if raw==True

Return type

AzureOperationPoller[OperationResponse] or AzureOperationPoller[ClientRawResponse[OperationResponse]]

Raises

DataShareErrorException

get(resource_group_name, account_name, share_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get a specified share.

Get a share .

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Share or ClientRawResponse if raw=true

Return type

Share or ClientRawResponse

Raises

DataShareErrorException

list_by_account(resource_group_name, account_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List of available shares under an account.

List shares in an account.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
skip_token (str) – Continuation Token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Share

Return type

SharePaged[Share]

Raises

DataShareErrorException

list_synchronization_details(resource_group_name, account_name, share_name, share_synchronization, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List data set level details for a share synchronization.

List synchronization details.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
share_synchronization (ShareSynchronization) – Share Synchronization payload.
skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SynchronizationDetails

Return type

SynchronizationDetailsPaged[SynchronizationDetails]

Raises

DataShareErrorException

list_synchronizations(resource_group_name, account_name, share_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List Synchronizations in a share.

List synchronizations of a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ShareSynchronization

Return type

ShareSynchronizationPaged[ShareSynchronization]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.ProviderShareSubscriptionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ProviderShareSubscriptionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

get_by_share(resource_group_name, account_name, share_name, provider_share_subscription_id, custom_headers=None, raw=False, **operation_config)[source]¶

Get share subscription in a provider share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
provider_share_subscription_id (str) – To locate shareSubscription
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ProviderShareSubscription or ClientRawResponse if raw=true

Return type

ProviderShareSubscription or ClientRawResponse

Raises

DataShareErrorException

list_by_share(resource_group_name, account_name, share_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List of available share subscriptions to a provider share.

List share subscriptions in a provider share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
skip_token (str) – Continuation Token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProviderShareSubscription

Return type

ProviderShareSubscriptionPaged[ProviderShareSubscription]

Raises

DataShareErrorException

reinstate(resource_group_name, account_name, share_name, provider_share_subscription_id, custom_headers=None, raw=False, **operation_config)[source]¶

Reinstate share subscription in a provider share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
provider_share_subscription_id (str) – To locate shareSubscription
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ProviderShareSubscription or ClientRawResponse if raw=true

Return type

ProviderShareSubscription or ClientRawResponse

Raises

DataShareErrorException

revoke(resource_group_name, account_name, share_name, provider_share_subscription_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Revoke share subscription in a provider share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
provider_share_subscription_id (str) – To locate shareSubscription
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ProviderShareSubscription or ClientRawResponse<ProviderShareSubscription> if raw==True

Return type

AzureOperationPoller[ProviderShareSubscription] or AzureOperationPoller[ClientRawResponse[ProviderShareSubscription]]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.ShareSubscriptionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ShareSubscriptionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

cancel_synchronization(resource_group_name, account_name, share_subscription_name, synchronization_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Request cancellation of a data share snapshot.

Request to cancel a synchronization.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
synchronization_id (str) – Synchronization id
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ShareSubscriptionSynchronization or ClientRawResponse<ShareSubscriptionSynchronization> if raw==True

Return type

AzureOperationPoller[ShareSubscriptionSynchronization] or AzureOperationPoller[ClientRawResponse[ShareSubscriptionSynchronization]]

Raises

DataShareErrorException

create(resource_group_name, account_name, share_subscription_name, invitation_id, source_share_location, custom_headers=None, raw=False, **operation_config)[source]¶

Create shareSubscription in an account.

Create a shareSubscription in an account.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
invitation_id (str) – The invitation id.
source_share_location (str) – Source share location.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ShareSubscription or ClientRawResponse if raw=true

Return type

ShareSubscription or ClientRawResponse

Raises

DataShareErrorException

delete(resource_group_name, account_name, share_subscription_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Delete shareSubscription in an account.

Delete a shareSubscription in an account.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns OperationResponse or ClientRawResponse<OperationResponse> if raw==True

Return type

AzureOperationPoller[OperationResponse] or AzureOperationPoller[ClientRawResponse[OperationResponse]]

Raises

DataShareErrorException

get(resource_group_name, account_name, share_subscription_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get shareSubscription in an account.

Get a shareSubscription in an account.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ShareSubscription or ClientRawResponse if raw=true

Return type

ShareSubscription or ClientRawResponse

Raises

DataShareErrorException

list_by_account(resource_group_name, account_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List of available share subscriptions under an account.

List share subscriptions in an account.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
skip_token (str) – Continuation Token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ShareSubscription

Return type

ShareSubscriptionPaged[ShareSubscription]

Raises

DataShareErrorException

list_source_share_synchronization_settings(resource_group_name, account_name, share_subscription_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

Get source share synchronization settings for a shareSubscription.

Get synchronization settings set on a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SourceShareSynchronizationSetting

Return type

SourceShareSynchronizationSettingPaged[SourceShareSynchronizationSetting]

Raises

DataShareErrorException

list_synchronization_details(resource_group_name, account_name, share_subscription_name, synchronization_id, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List data set level details for a share subscription synchronization.

List synchronization details.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the share subscription.
synchronization_id (str) – Synchronization id
skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SynchronizationDetails

Return type

SynchronizationDetailsPaged[SynchronizationDetails]

Raises

DataShareErrorException

list_synchronizations(resource_group_name, account_name, share_subscription_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List Synchronizations in a share subscription.

List synchronizations of a share subscription.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the share subscription.
skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ShareSubscriptionSynchronization

Return type

ShareSubscriptionSynchronizationPaged[ShareSubscriptionSynchronization]

Raises

DataShareErrorException

synchronize_method(resource_group_name, account_name, share_subscription_name, synchronization_mode=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Initiate an asynchronous data share job.

Initiate a copy.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of share subscription
synchronization_mode (str or SynchronizationMode) – Mode of synchronization used in triggers and snapshot sync. Incremental by default. Possible values include: ‘Incremental’, ‘FullSync’
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ShareSubscriptionSynchronization or ClientRawResponse<ShareSubscriptionSynchronization> if raw==True

Return type

AzureOperationPoller[ShareSubscriptionSynchronization] or AzureOperationPoller[ClientRawResponse[ShareSubscriptionSynchronization]]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.ConsumerSourceDataSetsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ConsumerSourceDataSetsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

list_by_share_subscription(resource_group_name, account_name, share_subscription_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

Get source dataSets of a shareSubscription.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ConsumerSourceDataSet

Return type

ConsumerSourceDataSetPaged[ConsumerSourceDataSet]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.SynchronizationSettingsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SynchronizationSettingsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

create(resource_group_name, account_name, share_name, synchronization_setting_name, synchronization_setting, custom_headers=None, raw=False, **operation_config)[source]¶

Adds a new synchronization setting to an existing share.

Create or update a synchronizationSetting .

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share to add the synchronization setting to.
synchronization_setting_name (str) – The name of the synchronizationSetting.
synchronization_setting (SynchronizationSetting) – The new synchronization setting information.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SynchronizationSetting or ClientRawResponse if raw=true

Return type

SynchronizationSetting or ClientRawResponse

Raises

DataShareErrorException

delete(resource_group_name, account_name, share_name, synchronization_setting_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Delete synchronizationSetting in a share.

Delete a synchronizationSetting in a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
synchronization_setting_name (str) – The name of the synchronizationSetting .
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns OperationResponse or ClientRawResponse<OperationResponse> if raw==True

Return type

AzureOperationPoller[OperationResponse] or AzureOperationPoller[ClientRawResponse[OperationResponse]]

Raises

DataShareErrorException

get(resource_group_name, account_name, share_name, synchronization_setting_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get synchronizationSetting in a share.

Get a synchronizationSetting in a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
synchronization_setting_name (str) – The name of the synchronizationSetting.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SynchronizationSetting or ClientRawResponse if raw=true

Return type

SynchronizationSetting or ClientRawResponse

Raises

DataShareErrorException

list_by_share(resource_group_name, account_name, share_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List synchronizationSettings in a share.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_name (str) – The name of the share.
skip_token (str) – continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SynchronizationSetting

Return type

SynchronizationSettingPaged[SynchronizationSetting]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.TriggersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TriggersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The api version to use. Constant value: “2019-11-01”.

create(resource_group_name, account_name, share_subscription_name, trigger_name, trigger, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

This method creates a trigger for a share subscription.

Create a Trigger .

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the share subscription which will hold the data set sink.
trigger_name (str) – The name of the trigger.
trigger (Trigger) – Trigger details.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Trigger or ClientRawResponse<Trigger> if raw==True

Return type

AzureOperationPoller[Trigger] or AzureOperationPoller[ClientRawResponse[Trigger]]

Raises

DataShareErrorException

delete(resource_group_name, account_name, share_subscription_name, trigger_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Delete Trigger in a shareSubscription.

Delete a Trigger in a shareSubscription.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
trigger_name (str) – The name of the trigger.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns OperationResponse or ClientRawResponse<OperationResponse> if raw==True

Return type

AzureOperationPoller[OperationResponse] or AzureOperationPoller[ClientRawResponse[OperationResponse]]

Raises

DataShareErrorException

get(resource_group_name, account_name, share_subscription_name, trigger_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get Trigger in a shareSubscription.

Get a Trigger in a shareSubscription.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the shareSubscription.
trigger_name (str) – The name of the trigger.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Trigger or ClientRawResponse if raw=true

Return type

Trigger or ClientRawResponse

Raises

DataShareErrorException

list_by_share_subscription(resource_group_name, account_name, share_subscription_name, skip_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

List Triggers in a share subscription.

Parameters

resource_group_name (str) – The resource group name.
account_name (str) – The name of the share account.
share_subscription_name (str) – The name of the share subscription.
skip_token (str) – Continuation token
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Trigger

Return type

TriggerPaged[Trigger]

Raises

DataShareErrorException

models = <module 'azure.mgmt.datashare.models' from '/home/vsts/work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datashare/models/__init__.py'>¶