SynchronizationSettingsOperations Class

SynchronizationSettingsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

SynchronizationSettingsOperations

Constructor

SynchronizationSettingsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_delete	Delete synchronizationSetting in a share. Delete a synchronizationSetting in a share.
create	Adds a new synchronization setting to an existing share. Create a synchronizationSetting.
get	Get synchronizationSetting in a share. Get a synchronizationSetting in a share.
list_by_share	List synchronizationSettings in a share. List synchronizationSettings in a share.

begin_delete

Delete synchronizationSetting in a share.

Delete a synchronizationSetting in a share.

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

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

synchronization_setting_name

str

Required

The name of the synchronizationSetting .

cls

callable

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

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[OperationResponse]

Exceptions

HttpResponseError

create

Adds a new synchronization setting to an existing share.

Create a synchronizationSetting.

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

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share to add the synchronization setting to.

synchronization_setting_name

str

Required

The name of the synchronizationSetting.

synchronization_setting

SynchronizationSetting

Required

The new synchronization setting information.

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

Exceptions

HttpResponseError

get

Get synchronizationSetting in a share.

Get a synchronizationSetting in a share.

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

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

synchronization_setting_name

str

Required

The name of the synchronizationSetting.

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

Exceptions

HttpResponseError

list_by_share

List synchronizationSettings in a share.

List synchronizationSettings in a share.

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

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

skip_token

str

default value: None

continuation token.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[SynchronizationSettingList]

Exceptions

HttpResponseError

Attributes

models

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