azure.mgmt.storagesync.operations module¶
-
class
azure.mgmt.storagesync.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – The API version to use for this operation. Constant value: “2019-06-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the available Storage Sync Rest API operations.
Parameters: Returns: An iterator like instance of OperationEntity
Return type: Raises:
-
models
= <module 'azure.mgmt.storagesync.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storagesync/models/__init__.py'>¶
-
class
azure.mgmt.storagesync.operations.
StorageSyncServicesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
StorageSyncServicesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – The API version to use for this operation. Constant value: “2019-06-01”.
-
check_name_availability
(location_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Check the give namespace name availability.
Parameters: - location_name (str) – The desired region for the name check.
- name (str) – The name to check for availability
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: CheckNameAvailabilityResult or ClientRawResponse if raw=true
Return type: CheckNameAvailabilityResult or ClientRawResponse
Raises: CloudError
-
create
(resource_group_name, storage_sync_service_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Create a new StorageSyncService.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- parameters (StorageSyncServiceCreateParameters) – Storage Sync Service resource name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StorageSyncService or ClientRawResponse if raw=true
Return type: StorageSyncService or ClientRawResponse
Raises:
-
delete
(resource_group_name, storage_sync_service_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a given StorageSyncService.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(resource_group_name, storage_sync_service_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a given StorageSyncService.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StorageSyncService or ClientRawResponse if raw=true
Return type: StorageSyncService or ClientRawResponse
Raises:
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a StorageSyncService list by Resource group name.
Parameters: Returns: An iterator like instance of StorageSyncService
Return type: Raises:
-
list_by_subscription
(custom_headers=None, raw=False, **operation_config)[source]¶ Get a StorageSyncService list by subscription.
Parameters: Returns: An iterator like instance of StorageSyncService
Return type: Raises:
-
update
(resource_group_name, storage_sync_service_name, tags=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Patch a given StorageSyncService.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- tags (dict[str, str]) – The user-specified tags associated with the storage sync service.
- properties (object) – The properties of the storage sync service.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StorageSyncService or ClientRawResponse if raw=true
Return type: StorageSyncService or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.storagesync.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storagesync/models/__init__.py'>¶
-
class
azure.mgmt.storagesync.operations.
SyncGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SyncGroupsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – The API version to use for this operation. Constant value: “2019-06-01”.
-
create
(resource_group_name, storage_sync_service_name, sync_group_name, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Create a new SyncGroup.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- properties (object) – The parameters used to create the sync group
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SyncGroup or ClientRawResponse if raw=true
Return type: SyncGroup or ClientRawResponse
Raises:
-
delete
(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a given SyncGroup.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a given SyncGroup.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SyncGroup or ClientRawResponse if raw=true
Return type: SyncGroup or ClientRawResponse
Raises:
-
list_by_storage_sync_service
(resource_group_name, storage_sync_service_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a SyncGroup List.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of SyncGroup
Return type: Raises:
-
models
= <module 'azure.mgmt.storagesync.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storagesync/models/__init__.py'>¶
-
class
azure.mgmt.storagesync.operations.
CloudEndpointsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
CloudEndpointsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – The API version to use for this operation. Constant value: “2019-06-01”.
-
create
(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Create a new CloudEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- cloud_endpoint_name (str) – Name of Cloud Endpoint object.
- parameters (CloudEndpointCreateParameters) – Body of Cloud Endpoint resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns CloudEndpoint or ClientRawResponse<CloudEndpoint> if raw==True
Return type: AzureOperationPoller[CloudEndpoint] or AzureOperationPoller[ClientRawResponse[CloudEndpoint]]
Raises:
-
delete
(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Delete a given CloudEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- cloud_endpoint_name (str) – Name of Cloud Endpoint object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises:
-
get
(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a given CloudEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- cloud_endpoint_name (str) – Name of Cloud Endpoint object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: CloudEndpoint or ClientRawResponse if raw=true
Return type: CloudEndpoint or ClientRawResponse
Raises:
-
list_by_sync_group
(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a CloudEndpoint List.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of CloudEndpoint
Return type: Raises:
-
post_backup
(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, azure_file_share=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Post Backup a given CloudEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- cloud_endpoint_name (str) – Name of Cloud Endpoint object.
- azure_file_share (str) – Azure File Share.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns PostBackupResponse or ClientRawResponse<PostBackupResponse> if raw==True
Return type: AzureOperationPoller[PostBackupResponse] or AzureOperationPoller[ClientRawResponse[PostBackupResponse]]
Raises:
-
post_restore
(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Post Restore a given CloudEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- cloud_endpoint_name (str) – Name of Cloud Endpoint object.
- parameters (PostRestoreRequest) – Body of Cloud Endpoint object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises:
-
pre_backup
(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, azure_file_share=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Pre Backup a given CloudEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- cloud_endpoint_name (str) – Name of Cloud Endpoint object.
- azure_file_share (str) – Azure File Share.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises:
-
pre_restore
(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Pre Restore a given CloudEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- cloud_endpoint_name (str) – Name of Cloud Endpoint object.
- parameters (PreRestoreRequest) – Body of Cloud Endpoint object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises:
-
restoreheartbeat
(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers=None, raw=False, **operation_config)[source]¶ Restore Heartbeat a given CloudEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- cloud_endpoint_name (str) – Name of Cloud Endpoint object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
trigger_change_detection
(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ 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.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- cloud_endpoint_name (str) – Name of Cloud Endpoint object.
- parameters (TriggerChangeDetectionParameters) – Trigger Change Detection Action parameters.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises:
-
models
= <module 'azure.mgmt.storagesync.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storagesync/models/__init__.py'>¶
-
class
azure.mgmt.storagesync.operations.
ServerEndpointsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServerEndpointsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – The API version to use for this operation. Constant value: “2019-06-01”.
-
create
(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Create a new ServerEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- server_endpoint_name (str) – Name of Server Endpoint object.
- parameters (ServerEndpointCreateParameters) – Body of Server Endpoint object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns ServerEndpoint or ClientRawResponse<ServerEndpoint> if raw==True
Return type: AzureOperationPoller[ServerEndpoint] or AzureOperationPoller[ClientRawResponse[ServerEndpoint]]
Raises:
-
delete
(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Delete a given ServerEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- server_endpoint_name (str) – Name of Server Endpoint object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises:
-
get
(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a ServerEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- server_endpoint_name (str) – Name of Server Endpoint object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ServerEndpoint or ClientRawResponse if raw=true
Return type: ServerEndpoint or ClientRawResponse
Raises:
-
list_by_sync_group
(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a ServerEndpoint list.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ServerEndpoint
Return type: Raises:
-
recall_action
(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, pattern=None, recall_path=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Recall a server endpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- server_endpoint_name (str) – Name of Server Endpoint object.
- pattern (str) – Pattern of the files.
- recall_path (str) – Recall path.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises:
-
update
(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, parameters=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Patch a given ServerEndpoint.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- sync_group_name (str) – Name of Sync Group resource.
- server_endpoint_name (str) – Name of Server Endpoint object.
- parameters (ServerEndpointUpdateParameters) – Any of the properties applicable in PUT request.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns ServerEndpoint or ClientRawResponse<ServerEndpoint> if raw==True
Return type: AzureOperationPoller[ServerEndpoint] or AzureOperationPoller[ClientRawResponse[ServerEndpoint]]
Raises:
-
models
= <module 'azure.mgmt.storagesync.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storagesync/models/__init__.py'>¶
-
class
azure.mgmt.storagesync.operations.
RegisteredServersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
RegisteredServersOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – The API version to use for this operation. Constant value: “2019-06-01”.
-
create
(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Add a new registered server.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- server_id (str) – GUID identifying the on-premises server.
- parameters (RegisteredServerCreateParameters) – Body of Registered Server object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns RegisteredServer or ClientRawResponse<RegisteredServer> if raw==True
Return type: AzureOperationPoller[RegisteredServer] or AzureOperationPoller[ClientRawResponse[RegisteredServer]]
Raises:
-
delete
(resource_group_name, storage_sync_service_name, server_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Delete the given registered server.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- server_id (str) – GUID identifying the on-premises server.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises:
-
get
(resource_group_name, storage_sync_service_name, server_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get a given registered server.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- server_id (str) – GUID identifying the on-premises server.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: RegisteredServer or ClientRawResponse if raw=true
Return type: RegisteredServer or ClientRawResponse
Raises:
-
list_by_storage_sync_service
(resource_group_name, storage_sync_service_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a given registered server list.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of RegisteredServer
Return type: Raises:
-
trigger_rollover
(resource_group_name, storage_sync_service_name, server_id, server_certificate=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Triggers Server certificate rollover.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- server_id (str) – Server Id
- server_certificate (str) – Certificate Data
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises:
-
models
= <module 'azure.mgmt.storagesync.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storagesync/models/__init__.py'>¶
-
class
azure.mgmt.storagesync.operations.
WorkflowsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
WorkflowsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – The API version to use for this operation. Constant value: “2019-06-01”.
-
abort
(resource_group_name, storage_sync_service_name, workflow_id, custom_headers=None, raw=False, **operation_config)[source]¶ Abort the given workflow.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- workflow_id (str) – workflow Id
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(resource_group_name, storage_sync_service_name, workflow_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get Workflows resource.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- workflow_id (str) – workflow Id
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Workflow or ClientRawResponse if raw=true
Return type: Workflow or ClientRawResponse
Raises:
-
list_by_storage_sync_service
(resource_group_name, storage_sync_service_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a Workflow List.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- storage_sync_service_name (str) – Name of Storage Sync Service resource.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Workflow
Return type: Raises:
-
models
= <module 'azure.mgmt.storagesync.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storagesync/models/__init__.py'>¶
-
class
azure.mgmt.storagesync.operations.
OperationStatusOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
OperationStatusOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – The API version to use for this operation. Constant value: “2019-06-01”.
-
get
(resource_group_name, location_name, workflow_id, operation_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get Operation status.
Parameters: - resource_group_name (str) – The name of the resource group. The name is case insensitive.
- location_name (str) – The desired region to obtain information from.
- workflow_id (str) – workflow Id
- operation_id (str) – operation Id
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.storagesync.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storagesync/models/__init__.py'>¶