azure.mgmt.datashare.operations module¶

class azure.mgmt.datashare.operations.AccountsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s accounts attribute.

begin_create(resource_group_name: str, account_name: str, account: _models.Account, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Account][source]¶

begin_create(resource_group_name: str, account_name: str, account: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Account]

Create an account in the given resource group.

Create an account.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
account (Account or IO) – The account payload. Is either a model type or a IO type. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either Account or the result of cls(response)

Return type

LROPoller[Account]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, account_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.datashare.models._models_py3.OperationResponse][source]¶

Delete an account.

DeleteAccount.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either OperationResponse or the result of cls(response)

Return type

LROPoller[OperationResponse]

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.Account[source]¶

Get an account under a resource group.

Get an account.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Account or the result of cls(response)

Return type

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.Account][source]¶

List Accounts in a resource group.

List Accounts in ResourceGroup.

Parameters

resource_group_name (str) – The resource group name. Required.
skip_token (str) – Continuation token. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Account]

Raises

HttpResponseError –

list_by_subscription(skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.Account][source]¶

List Accounts in a subscription.

List Accounts in Subscription.

Parameters: skip_token (str) – Continuation token. Default value is None.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Account or the result of cls(response)
Return type: ItemPaged[Account]
Raises: HttpResponseError –

update(resource_group_name: str, account_name: str, account_update_parameters: _models.AccountUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Account[source]¶

update(resource_group_name: str, account_name: str, account_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Account

Patch a given account.

Patch an account.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
account_update_parameters (AccountUpdateParameters or IO) – The account update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

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

Account or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.ConsumerInvitationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s consumer_invitations attribute.

get(location: str, invitation_id: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.ConsumerInvitation[source]¶

Gets the invitation identified by invitationId.

Get an invitation.

Parameters

location (str) – Location of the invitation. Required.
invitation_id (str) – An invitation id. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ConsumerInvitation or the result of cls(response)

Return type

ConsumerInvitation

Raises

HttpResponseError –

list_invitations(skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.ConsumerInvitation][source]¶

List the invitations.

Lists invitations.

Parameters: skip_token (str) – The continuation token. Default value is None.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ConsumerInvitation or the result of cls(response)
Return type: ItemPaged[ConsumerInvitation]
Raises: HttpResponseError –

reject_invitation(location: str, invitation: _models.ConsumerInvitation, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ConsumerInvitation[source]¶

reject_invitation(location: str, invitation: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ConsumerInvitation

Rejects the invitation identified by invitationId.

Reject an invitation.

Parameters

location (str) – Location of the invitation. Required.
invitation (ConsumerInvitation or IO) – An invitation payload. Is either a model type or a IO type. Required.

Keyword Arguments

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

ConsumerInvitation or the result of cls(response)

Return type

ConsumerInvitation

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.ConsumerSourceDataSetsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s consumer_source_data_sets attribute.

list_by_share_subscription(resource_group_name: str, account_name: str, share_subscription_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.ConsumerSourceDataSet][source]¶

Get source dataSets of a shareSubscription.

Get source dataSets of a shareSubscription.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.
skip_token (str) – Continuation token. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ConsumerSourceDataSet]

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.DataSetMappingsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s data_set_mappings attribute.

create(resource_group_name: str, account_name: str, share_subscription_name: str, data_set_mapping_name: str, data_set_mapping: _models.DataSetMapping, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataSetMapping[source]¶

create(resource_group_name: str, account_name: str, share_subscription_name: str, data_set_mapping_name: str, data_set_mapping: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataSetMapping

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. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the share subscription which will hold the data set sink. Required.
data_set_mapping_name (str) – The name of the data set mapping to be created. Required.
data_set_mapping (DataSetMapping or IO) – Destination data set configuration details. Is either a model type or a IO type. Required.

Keyword Arguments

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

DataSetMapping or the result of cls(response)

Return type

Raises

HttpResponseError –

delete(resource_group_name: str, account_name: str, share_subscription_name: str, data_set_mapping_name: str, **kwargs: Any) → None [source]¶

Delete DataSetMapping in a shareSubscription.

Delete a DataSetMapping in a shareSubscription.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.
data_set_mapping_name (str) – The name of the dataSetMapping. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, share_subscription_name: str, data_set_mapping_name: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.DataSetMapping[source]¶

Get DataSetMapping in a shareSubscription.

Get a DataSetMapping in a shareSubscription.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.
data_set_mapping_name (str) – The name of the dataSetMapping. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataSetMapping or the result of cls(response)

Return type

Raises

HttpResponseError –

list_by_share_subscription(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: Any) → Iterable[azure.mgmt.datashare.models._models_py3.DataSetMapping][source]¶

List DataSetMappings in a share subscription.

List DataSetMappings in a share subscription.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the share subscription. Required.
skip_token (str) – Continuation token. Default value is None.
filter (str) – Filters the results using OData syntax. Default value is None.
orderby (str) – Sorts the results using OData syntax. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[DataSetMapping]

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.DataSetsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s data_sets attribute.

begin_delete(resource_group_name: str, account_name: str, share_name: str, data_set_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete DataSet in a share.

Delete a DataSet in a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
data_set_name (str) – The name of the dataSet. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

create(resource_group_name: str, account_name: str, share_name: str, data_set_name: str, data_set: _models.DataSet, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataSet[source]¶

create(resource_group_name: str, account_name: str, share_name: str, data_set_name: str, data_set: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataSet

Adds a new data set to an existing share.

Create a DataSet.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share to add the data set to. Required.
data_set_name (str) – The name of the dataSet. Required.
data_set (DataSet or IO) – The new data set information. Is either a model type or a IO type. Required.

Keyword Arguments

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

DataSet or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, share_name: str, data_set_name: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.DataSet[source]¶

Get DataSet in a share.

Get a DataSet in a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
data_set_name (str) – The name of the dataSet. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataSet or the result of cls(response)

Return type

Raises

HttpResponseError –

list_by_share(resource_group_name: str, account_name: str, share_name: str, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.DataSet][source]¶

List DataSets in a share.

List DataSets in a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
skip_token (str) – continuation token. Default value is None.
filter (str) – Filters the results using OData syntax. Default value is None.
orderby (str) – Sorts the results using OData syntax. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[DataSet]

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.EmailRegistrationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s email_registrations attribute.

activate_email(location: str, email_registration: _models.EmailRegistration, *, content_type: str = "'application/json'", **kwargs: Any) → _models.EmailRegistration[source]¶

activate_email(location: str, email_registration: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.EmailRegistration

Activates the tenant and email combination using email code received.

Activate the email registration for the current tenant.

Parameters

location (str) – Location of the activation. Required.
email_registration (EmailRegistration or IO) – The payload for tenant domain activation. Is either a model type or a IO type. Required.

Keyword Arguments

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

EmailRegistration or the result of cls(response)

Return type

EmailRegistration

Raises

HttpResponseError –

register_email(location: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.EmailRegistration[source]¶

Registers the tenant and email combination for verification.

Register an email for the current tenant.

Parameters: location (str) – Location of the registration. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: EmailRegistration or the result of cls(response)
Return type: EmailRegistration
Raises: HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.InvitationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s invitations attribute.

create(resource_group_name: str, account_name: str, share_name: str, invitation_name: str, invitation: _models.Invitation, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Invitation[source]¶

create(resource_group_name: str, account_name: str, share_name: str, invitation_name: str, invitation: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Invitation

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

Create an invitation.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share to send the invitation for. Required.
invitation_name (str) – The name of the invitation. Required.
invitation (Invitation or IO) – Invitation details. Is either a model type or a IO type. Required.

Keyword Arguments

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

Invitation or the result of cls(response)

Return type

Raises

HttpResponseError –

delete(resource_group_name: str, account_name: str, share_name: str, invitation_name: str, **kwargs: Any) → None [source]¶

Delete Invitation in a share.

Delete an invitation in a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
invitation_name (str) – The name of the invitation. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, share_name: str, invitation_name: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.Invitation[source]¶

Get Invitation in a share.

Get an invitation in a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
invitation_name (str) – The name of the invitation. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Invitation or the result of cls(response)

Return type

Raises

HttpResponseError –

list_by_share(resource_group_name: str, account_name: str, share_name: str, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.Invitation][source]¶

List all Invitations in a share.

List invitations in a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
skip_token (str) – The continuation token. Default value is None.
filter (str) – Filters the results using OData syntax. Default value is None.
orderby (str) – Sorts the results using OData syntax. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Invitation]

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.OperationModel][source]¶

Lists the available operations.

List of available operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either OperationModel or the result of cls(response)
Return type: ItemPaged[OperationModel]
Raises: HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.ProviderShareSubscriptionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s provider_share_subscriptions attribute.

adjust(resource_group_name: str, account_name: str, share_name: str, provider_share_subscription_id: str, provider_share_subscription: _models.ProviderShareSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProviderShareSubscription[source]¶

adjust(resource_group_name: str, account_name: str, share_name: str, provider_share_subscription_id: str, provider_share_subscription: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProviderShareSubscription

Adjust the expiration date of a share subscription in a provider share.

Adjust a share subscription’s expiration date in a provider share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
provider_share_subscription_id (str) – To locate shareSubscription. Required.
provider_share_subscription (ProviderShareSubscription or IO) – The provider share subscription. Is either a model type or a IO type. Required.

Keyword Arguments

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

ProviderShareSubscription or the result of cls(response)

Return type

ProviderShareSubscription

Raises

HttpResponseError –

begin_revoke(resource_group_name: str, account_name: str, share_name: str, provider_share_subscription_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.datashare.models._models_py3.ProviderShareSubscription][source]¶

Revoke share subscription in a provider share.

Revoke share subscription in a provider share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
provider_share_subscription_id (str) – To locate shareSubscription. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either ProviderShareSubscription or the result of cls(response)

Return type

LROPoller[ProviderShareSubscription]

Raises

HttpResponseError –

get_by_share(resource_group_name: str, account_name: str, share_name: str, provider_share_subscription_id: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.ProviderShareSubscription[source]¶

Get share subscription in a provider share.

Get share subscription in a provider share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
provider_share_subscription_id (str) – To locate shareSubscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ProviderShareSubscription or the result of cls(response)

Return type

ProviderShareSubscription

Raises

HttpResponseError –

list_by_share(resource_group_name: str, account_name: str, share_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.ProviderShareSubscription][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. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
skip_token (str) – Continuation Token. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ProviderShareSubscription]

Raises

HttpResponseError –

reinstate(resource_group_name: str, account_name: str, share_name: str, provider_share_subscription_id: str, provider_share_subscription: _models.ProviderShareSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProviderShareSubscription[source]¶

reinstate(resource_group_name: str, account_name: str, share_name: str, provider_share_subscription_id: str, provider_share_subscription: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProviderShareSubscription

Reinstate share subscription in a provider share.

Reinstate share subscription in a provider share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
provider_share_subscription_id (str) – To locate shareSubscription. Required.
provider_share_subscription (ProviderShareSubscription or IO) – The provider share subscription. Is either a model type or a IO type. Required.

Keyword Arguments

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

ProviderShareSubscription or the result of cls(response)

Return type

ProviderShareSubscription

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.ShareSubscriptionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s share_subscriptions attribute.

begin_cancel_synchronization(resource_group_name: str, account_name: str, share_subscription_name: str, share_subscription_synchronization: _models.ShareSubscriptionSynchronization, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ShareSubscriptionSynchronization][source]¶

begin_cancel_synchronization(resource_group_name: str, account_name: str, share_subscription_name: str, share_subscription_synchronization: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ShareSubscriptionSynchronization]

Request cancellation of a data share snapshot.

Request to cancel a synchronization.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.
share_subscription_synchronization (ShareSubscriptionSynchronization or IO) – Share Subscription Synchronization payload. Is either a model type or a IO type. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either ShareSubscriptionSynchronization or the result of cls(response)

Return type

LROPoller[ShareSubscriptionSynchronization]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, account_name: str, share_subscription_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.datashare.models._models_py3.OperationResponse][source]¶

Delete shareSubscription in an account.

Delete a shareSubscription in an account.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either OperationResponse or the result of cls(response)

Return type

LROPoller[OperationResponse]

Raises

HttpResponseError –

begin_synchronize(resource_group_name: str, account_name: str, share_subscription_name: str, synchronize: _models.Synchronize, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ShareSubscriptionSynchronization][source]¶

begin_synchronize(resource_group_name: str, account_name: str, share_subscription_name: str, synchronize: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ShareSubscriptionSynchronization]

Initiate an asynchronous data share job.

Initiate a copy.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of share subscription. Required.
synchronize (Synchronize or IO) – Synchronize payload. Is either a model type or a IO type. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either ShareSubscriptionSynchronization or the result of cls(response)

Return type

LROPoller[ShareSubscriptionSynchronization]

Raises

HttpResponseError –

create(resource_group_name: str, account_name: str, share_subscription_name: str, share_subscription: _models.ShareSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ShareSubscription[source]¶

create(resource_group_name: str, account_name: str, share_subscription_name: str, share_subscription: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ShareSubscription

Create shareSubscription in an account.

Create a shareSubscription in an account.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.
share_subscription (ShareSubscription or IO) – create parameters for shareSubscription. Is either a model type or a IO type. Required.

Keyword Arguments

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

ShareSubscription or the result of cls(response)

Return type

ShareSubscription

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, share_subscription_name: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.ShareSubscription[source]¶

Get shareSubscription in an account.

Get a shareSubscription in an account.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.

Keyword Arguments

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

Raises

HttpResponseError –

list_by_account(resource_group_name: str, account_name: str, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.ShareSubscription][source]¶

List of available share subscriptions under an account.

List share subscriptions in an account.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
skip_token (str) – Continuation Token. Default value is None.
filter (str) – Filters the results using OData syntax. Default value is None.
orderby (str) – Sorts the results using OData syntax. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ShareSubscription]

Raises

HttpResponseError –

list_source_share_synchronization_settings(resource_group_name: str, account_name: str, share_subscription_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.SourceShareSynchronizationSetting][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. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.
skip_token (str) – Continuation token. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[SourceShareSynchronizationSetting]

Raises

HttpResponseError –

list_synchronization_details(resource_group_name: str, account_name: str, share_subscription_name: str, share_subscription_synchronization: _models.ShareSubscriptionSynchronization, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[_models.SynchronizationDetails][source]¶

list_synchronization_details(resource_group_name: str, account_name: str, share_subscription_name: str, share_subscription_synchronization: IO, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[_models.SynchronizationDetails]

List data set level details for a share subscription synchronization.

List synchronization details.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the share subscription. Required.
share_subscription_synchronization (ShareSubscriptionSynchronization or IO) – Share Subscription Synchronization payload. Is either a model type or a IO type. Required.
skip_token (str) – Continuation token. Default value is None.
filter (str) – Filters the results using OData syntax. Default value is None.
orderby (str) – Sorts the results using OData syntax. Default value is None.

Keyword Arguments

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

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

Return type

ItemPaged[SynchronizationDetails]

Raises

HttpResponseError –

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: Any) → Iterable[azure.mgmt.datashare.models._models_py3.ShareSubscriptionSynchronization][source]¶

List Synchronizations in a share subscription.

List synchronizations of a share subscription.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the share subscription. Required.
skip_token (str) – Continuation token. Default value is None.
filter (str) – Filters the results using OData syntax. Default value is None.
orderby (str) – Sorts the results using OData syntax. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ShareSubscriptionSynchronization]

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.SharesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s shares attribute.

begin_delete(resource_group_name: str, account_name: str, share_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.datashare.models._models_py3.OperationResponse][source]¶

Deletes a share.

Delete a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either OperationResponse or the result of cls(response)

Return type

LROPoller[OperationResponse]

Raises

HttpResponseError –

create(resource_group_name: str, account_name: str, share_name: str, share: _models.Share, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Share[source]¶

create(resource_group_name: str, account_name: str, share_name: str, share: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Share

Create a share in the given account.

Create a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
share (Share or IO) – The share payload. Is either a model type or a IO type. Required.

Keyword Arguments

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

Share or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, share_name: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.Share[source]¶

Get a specified share.

Get a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share to retrieve. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Share or the result of cls(response)

Return type

Raises

HttpResponseError –

list_by_account(resource_group_name: str, account_name: str, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.Share][source]¶

List of available shares under an account.

List shares in an account.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
skip_token (str) – Continuation Token. Default value is None.
filter (str) – Filters the results using OData syntax. Default value is None.
orderby (str) – Sorts the results using OData syntax. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Share]

Raises

HttpResponseError –

list_synchronization_details(resource_group_name: str, account_name: str, share_name: str, share_synchronization: _models.ShareSynchronization, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[_models.SynchronizationDetails][source]¶

list_synchronization_details(resource_group_name: str, account_name: str, share_name: str, share_synchronization: IO, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[_models.SynchronizationDetails]

List data set level details for a share synchronization.

List synchronization details.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
share_synchronization (ShareSynchronization or IO) – Share Synchronization payload. Is either a model type or a IO type. Required.
skip_token (str) – Continuation token. Default value is None.
filter (str) – Filters the results using OData syntax. Default value is None.
orderby (str) – Sorts the results using OData syntax. Default value is None.

Keyword Arguments

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

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

Return type

ItemPaged[SynchronizationDetails]

Raises

HttpResponseError –

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: Any) → Iterable[azure.mgmt.datashare.models._models_py3.ShareSynchronization][source]¶

List Synchronizations in a share.

List synchronizations of a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
skip_token (str) – Continuation token. Default value is None.
filter (str) – Filters the results using OData syntax. Default value is None.
orderby (str) – Sorts the results using OData syntax. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ShareSynchronization]

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.SynchronizationSettingsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s synchronization_settings attribute.

begin_delete(resource_group_name: str, account_name: str, share_name: str, synchronization_setting_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.datashare.models._models_py3.OperationResponse][source]¶

Delete synchronizationSetting in a share.

Delete a synchronizationSetting in a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
synchronization_setting_name (str) – The name of the synchronizationSetting . Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either OperationResponse or the result of cls(response)

Return type

LROPoller[OperationResponse]

Raises

HttpResponseError –

create(resource_group_name: str, account_name: str, share_name: str, synchronization_setting_name: str, synchronization_setting: _models.SynchronizationSetting, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SynchronizationSetting[source]¶

create(resource_group_name: str, account_name: str, share_name: str, synchronization_setting_name: str, synchronization_setting: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SynchronizationSetting

Adds a new synchronization setting to an existing share.

Create a synchronizationSetting.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share to add the synchronization setting to. Required.
synchronization_setting_name (str) – The name of the synchronizationSetting. Required.
synchronization_setting (SynchronizationSetting or IO) – The new synchronization setting information. Is either a model type or a IO type. Required.

Keyword Arguments

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

SynchronizationSetting or the result of cls(response)

Return type

SynchronizationSetting

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, share_name: str, synchronization_setting_name: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.SynchronizationSetting[source]¶

Get synchronizationSetting in a share.

Get a synchronizationSetting in a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
synchronization_setting_name (str) – The name of the synchronizationSetting. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SynchronizationSetting or the result of cls(response)

Return type

SynchronizationSetting

Raises

HttpResponseError –

list_by_share(resource_group_name: str, account_name: str, share_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.SynchronizationSetting][source]¶

List synchronizationSettings in a share.

List synchronizationSettings in a share.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_name (str) – The name of the share. Required.
skip_token (str) – continuation token. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[SynchronizationSetting]

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶

class azure.mgmt.datashare.operations.TriggersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataShareManagementClient’s triggers attribute.

begin_create(resource_group_name: str, account_name: str, share_subscription_name: str, trigger_name: str, trigger: _models.Trigger, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Trigger][source]¶

begin_create(resource_group_name: str, account_name: str, share_subscription_name: str, trigger_name: str, trigger: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Trigger]

This method creates a trigger for a share subscription.

Create a Trigger.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the share subscription which will hold the data set sink. Required.
trigger_name (str) – The name of the trigger. Required.
trigger (Trigger or IO) – Trigger details. Is either a model type or a IO type. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either Trigger or the result of cls(response)

Return type

LROPoller[Trigger]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, account_name: str, share_subscription_name: str, trigger_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.datashare.models._models_py3.OperationResponse][source]¶

Delete Trigger in a shareSubscription.

Delete a Trigger in a shareSubscription.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.
trigger_name (str) – The name of the trigger. Required.

Keyword Arguments

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 PollingMethod) – By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either OperationResponse or the result of cls(response)

Return type

LROPoller[OperationResponse]

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, share_subscription_name: str, trigger_name: str, **kwargs: Any) → azure.mgmt.datashare.models._models_py3.Trigger[source]¶

Get Trigger in a shareSubscription.

Get a Trigger in a shareSubscription.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the shareSubscription. Required.
trigger_name (str) – The name of the trigger. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Trigger or the result of cls(response)

Return type

Raises

HttpResponseError –

list_by_share_subscription(resource_group_name: str, account_name: str, share_subscription_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datashare.models._models_py3.Trigger][source]¶

List Triggers in a share subscription.

List Triggers in a share subscription.

Parameters

resource_group_name (str) – The resource group name. Required.
account_name (str) – The name of the share account. Required.
share_subscription_name (str) – The name of the share subscription. Required.
skip_token (str) – Continuation token. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Trigger]

Raises

HttpResponseError –

models = <module 'azure.mgmt.datashare.models' from '/mnt/vss/_work/1/s/sdk/datashare/azure-mgmt-datashare/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datashare/models/__init__.py'>¶