azure.mgmt.storagesync.operations module

class azure.mgmt.storagesync.operations.CloudEndpointsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

afs_share_metadata_certificate_public_keys(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.CloudEndpointAfsShareMetadataCertificatePublicKeys

Get the AFS file share metadata signing certificate public keys.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. Required.

Keyword Arguments

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

Returns

CloudEndpointAfsShareMetadataCertificatePublicKeys or the result of cls(response)

Return type

CloudEndpointAfsShareMetadataCertificatePublicKeys

Raises

HttpResponseError –

begin_create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.CloudEndpointCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CloudEndpoint]

begin_create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CloudEndpoint]

Create a new CloudEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. Required.

• parameters (CloudEndpointCreateParameters or IO) – Body of Cloud Endpoint resource. 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 CloudEndpoint or the result of cls(response)

Return type

LROPoller[CloudEndpoint]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Delete a given CloudEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. 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 –

begin_post_backup(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.BackupRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PostBackupResponse]

begin_post_backup(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PostBackupResponse]

Post Backup a given CloudEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. Required.

• parameters (BackupRequest or IO) – Body of Backup request. 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 PostBackupResponse or the result of cls(response)

Return type

LROPoller[PostBackupResponse]

Raises

HttpResponseError –

begin_post_restore(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.PostRestoreRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_post_restore(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Post Restore a given CloudEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. Required.

• parameters (PostRestoreRequest or IO) – Body of Cloud Endpoint object. 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 None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_pre_backup(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.BackupRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_pre_backup(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Pre Backup a given CloudEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. Required.

• parameters (BackupRequest or IO) – Body of Backup request. 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 None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_pre_restore(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.PreRestoreRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_pre_restore(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Pre Restore a given CloudEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. Required.

• parameters (PreRestoreRequest or IO) – Body of Cloud Endpoint object. 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 None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_trigger_change_detection(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.TriggerChangeDetectionParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_trigger_change_detection(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. Required.

• parameters (TriggerChangeDetectionParameters or IO) – Trigger Change Detection Action 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

• 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 –

get(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.CloudEndpoint

Get a given CloudEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. Required.

Keyword Arguments

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

Returns

CloudEndpoint or the result of cls(response)

Return type

CloudEndpoint

Raises

HttpResponseError –

list_by_sync_group(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.storagesync.models._models_py3.CloudEndpoint]

Get a CloudEndpoint List.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[CloudEndpoint]

Raises

HttpResponseError –

restoreheartbeat(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs: Any) → None

Restore Heartbeat a given CloudEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• cloud_endpoint_name (str) – Name of Cloud Endpoint object. 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

None

Raises

HttpResponseError –

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

class azure.mgmt.storagesync.operations.MicrosoftStorageSyncOperationsMixin

Bases: azure.mgmt.storagesync._vendor.MicrosoftStorageSyncMixinABC

location_operation_status(location_name: str, operation_id: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.LocationOperationStatus

Get Operation status.

Parameters

• location_name (str) – The desired region to obtain information from. Required.

• operation_id (str) – operation Id. Required.

Keyword Arguments

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

Returns

LocationOperationStatus or the result of cls(response)

Return type

LocationOperationStatus

Raises

HttpResponseError –

class azure.mgmt.storagesync.operations.OperationStatusOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

get(resource_group_name: str, location_name: str, workflow_id: str, operation_id: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.OperationStatus

Get Operation status.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• location_name (str) – The desired region to obtain information from. Required.

• workflow_id (str) – workflow Id. Required.

• operation_id (str) – operation Id. Required.

Keyword Arguments

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

Returns

OperationStatus or the result of cls(response)

Return type

OperationStatus

Raises

HttpResponseError –

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

class azure.mgmt.storagesync.operations.Operations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list(**kwargs: Any) → Iterable[azure.mgmt.storagesync.models._models_py3.OperationEntity]

Lists all of the available Storage Sync Rest API operations.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[OperationEntity]

Raises

HttpResponseError –

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

class azure.mgmt.storagesync.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_create(resource_group_name: str, storage_sync_service_name: str, private_endpoint_connection_name: str, properties: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

begin_create(resource_group_name: str, storage_sync_service_name: str, private_endpoint_connection_name: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

Update the state of specified private endpoint connection associated with the storage sync service.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – The name of the storage sync service name within the specified resource group. Required.

• private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

• properties (PrivateEndpointConnection or IO) – The private endpoint connection properties. 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 PrivateEndpointConnection or the result of cls(response)

Return type

LROPoller[PrivateEndpointConnection]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, storage_sync_service_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes the specified private endpoint connection associated with the storage sync service.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – The name of the storage sync service name within the specified resource group. Required.

• private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. 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 –

get(resource_group_name: str, storage_sync_service_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.PrivateEndpointConnection

Gets the specified private endpoint connection associated with the storage sync service.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – The name of the storage sync service name within the specified resource group. Required.

• private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Keyword Arguments

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

Returns

PrivateEndpointConnection or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

HttpResponseError –

list_by_storage_sync_service(resource_group_name: str, storage_sync_service_name: str, **kwargs: Any) → Iterable[azure.mgmt.storagesync.models._models_py3.PrivateEndpointConnection]

Get a PrivateEndpointConnection List.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PrivateEndpointConnection]

Raises

HttpResponseError –

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

class azure.mgmt.storagesync.operations.PrivateLinkResourcesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list_by_storage_sync_service(resource_group_name: str, storage_sync_service_name: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.PrivateLinkResourceListResult

Gets the private link resources that need to be created for a storage sync service.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – The name of the storage sync service name within the specified resource group. Required.

Keyword Arguments

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

Returns

PrivateLinkResourceListResult or the result of cls(response)

Return type

PrivateLinkResourceListResult

Raises

HttpResponseError –

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

class azure.mgmt.storagesync.operations.RegisteredServersOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_create(resource_group_name: str, storage_sync_service_name: str, server_id: str, parameters: _models.RegisteredServerCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RegisteredServer]

begin_create(resource_group_name: str, storage_sync_service_name: str, server_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RegisteredServer]

Add a new registered server.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• server_id (str) – GUID identifying the on-premises server. Required.

• parameters (RegisteredServerCreateParameters or IO) – Body of Registered Server object. 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 RegisteredServer or the result of cls(response)

Return type

LROPoller[RegisteredServer]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, storage_sync_service_name: str, server_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Delete the given registered server.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• server_id (str) – GUID identifying the on-premises server. 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 –

begin_trigger_rollover(resource_group_name: str, storage_sync_service_name: str, server_id: str, parameters: _models.TriggerRolloverRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_trigger_rollover(resource_group_name: str, storage_sync_service_name: str, server_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Triggers Server certificate rollover.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• server_id (str) – Server Id. Required.

• parameters (TriggerRolloverRequest or IO) – Body of Trigger Rollover request. 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 None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, storage_sync_service_name: str, server_id: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.RegisteredServer

Get a given registered server.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• server_id (str) – GUID identifying the on-premises server. Required.

Keyword Arguments

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

Returns

RegisteredServer or the result of cls(response)

Return type

RegisteredServer

Raises

HttpResponseError –

list_by_storage_sync_service(resource_group_name: str, storage_sync_service_name: str, **kwargs: Any) → Iterable[azure.mgmt.storagesync.models._models_py3.RegisteredServer]

Get a given registered server list.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RegisteredServer]

Raises

HttpResponseError –

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

class azure.mgmt.storagesync.operations.ServerEndpointsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, parameters: _models.ServerEndpointCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerEndpoint]

begin_create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerEndpoint]

Create a new ServerEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• server_endpoint_name (str) – Name of Server Endpoint object. Required.

• parameters (ServerEndpointCreateParameters or IO) – Body of Server Endpoint object. 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 ServerEndpoint or the result of cls(response)

Return type

LROPoller[ServerEndpoint]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Delete a given ServerEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• server_endpoint_name (str) – Name of Server Endpoint object. 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 –

begin_recall_action(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, parameters: _models.RecallActionParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_recall_action(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Recall a server endpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• server_endpoint_name (str) – Name of Server Endpoint object. Required.

• parameters (RecallActionParameters or IO) – Body of Recall Action object. 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 None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, parameters: Optional[_models.ServerEndpointUpdateParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerEndpoint]

begin_update(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerEndpoint]

Patch a given ServerEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• server_endpoint_name (str) – Name of Server Endpoint object. Required.

• parameters (ServerEndpointUpdateParameters or IO) – Any of the properties applicable in PUT request. Is either a model type or a IO type. 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

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

Return type

LROPoller[ServerEndpoint]

Raises

HttpResponseError –

get(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.ServerEndpoint

Get a ServerEndpoint.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• server_endpoint_name (str) – Name of Server Endpoint object. Required.

Keyword Arguments

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

Returns

ServerEndpoint or the result of cls(response)

Return type

ServerEndpoint

Raises

HttpResponseError –

list_by_sync_group(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.storagesync.models._models_py3.ServerEndpoint]

Get a ServerEndpoint list.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerEndpoint]

Raises

HttpResponseError –

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

class azure.mgmt.storagesync.operations.StorageSyncServicesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_create(resource_group_name: str, storage_sync_service_name: str, parameters: _models.StorageSyncServiceCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.StorageSyncService]

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

Create a new StorageSyncService.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• parameters (StorageSyncServiceCreateParameters or IO) – Storage Sync Service resource name. 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 StorageSyncService or the result of cls(response)

Return type

LROPoller[StorageSyncService]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, storage_sync_service_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Delete a given StorageSyncService.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. 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 –

begin_update(resource_group_name: str, storage_sync_service_name: str, parameters: Optional[_models.StorageSyncServiceUpdateParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.StorageSyncService]

begin_update(resource_group_name: str, storage_sync_service_name: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.StorageSyncService]

Patch a given StorageSyncService.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• parameters (StorageSyncServiceUpdateParameters or IO) – Storage Sync Service resource. Is either a model type or a IO type. 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

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

Return type

LROPoller[StorageSyncService]

Raises

HttpResponseError –

check_name_availability(location_name: str, parameters: _models.CheckNameAvailabilityParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult

check_name_availability(location_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult

Check the give namespace name availability.

Parameters

• location_name (str) – The desired region for the name check. Required.

• parameters (CheckNameAvailabilityParameters or IO) – Parameters to check availability of the given namespace name. 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

CheckNameAvailabilityResult or the result of cls(response)

Return type

CheckNameAvailabilityResult

Raises

HttpResponseError –

get(resource_group_name: str, storage_sync_service_name: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.StorageSyncService

Get a given StorageSyncService.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

Keyword Arguments

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

Returns

StorageSyncService or the result of cls(response)

Return type

StorageSyncService

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.storagesync.models._models_py3.StorageSyncService]

Get a StorageSyncService list by Resource group name.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[StorageSyncService]

Raises

HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.storagesync.models._models_py3.StorageSyncService]

Get a StorageSyncService list by subscription.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[StorageSyncService]

Raises

HttpResponseError –

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

class azure.mgmt.storagesync.operations.SyncGroupsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, parameters: _models.SyncGroupCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SyncGroup

create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SyncGroup

Create a new SyncGroup.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

• parameters (SyncGroupCreateParameters or IO) – Sync Group Body. 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

SyncGroup or the result of cls(response)

Return type

SyncGroup

Raises

HttpResponseError –

delete(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, **kwargs: Any) → None

Delete a given SyncGroup.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. 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

None

Raises

HttpResponseError –

get(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.SyncGroup

Get a given SyncGroup.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• sync_group_name (str) – Name of Sync Group resource. Required.

Keyword Arguments

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

Returns

SyncGroup or the result of cls(response)

Return type

SyncGroup

Raises

HttpResponseError –

list_by_storage_sync_service(resource_group_name: str, storage_sync_service_name: str, **kwargs: Any) → Iterable[azure.mgmt.storagesync.models._models_py3.SyncGroup]

Get a SyncGroup List.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SyncGroup]

Raises

HttpResponseError –

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

class azure.mgmt.storagesync.operations.WorkflowsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

abort(resource_group_name: str, storage_sync_service_name: str, workflow_id: str, **kwargs: Any) → None

Abort the given workflow.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• workflow_id (str) – workflow Id. 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

None

Raises

HttpResponseError –

get(resource_group_name: str, storage_sync_service_name: str, workflow_id: str, **kwargs: Any) → azure.mgmt.storagesync.models._models_py3.Workflow

Get Workflows resource.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

• workflow_id (str) – workflow Id. Required.

Keyword Arguments

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

Returns

Workflow or the result of cls(response)

Return type

Workflow

Raises

HttpResponseError –

list_by_storage_sync_service(resource_group_name: str, storage_sync_service_name: str, **kwargs: Any) → Iterable[azure.mgmt.storagesync.models._models_py3.Workflow]

Get a Workflow List.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• storage_sync_service_name (str) – Name of Storage Sync Service resource. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Workflow]

Raises

HttpResponseError –

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