CloudEndpointsOperations Class

CloudEndpointsOperations 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

CloudEndpointsOperations

Constructor

CloudEndpointsOperations(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_create	Create a new CloudEndpoint.
begin_delete	Delete a given CloudEndpoint.
begin_post_backup	Post Backup a given CloudEndpoint.
begin_post_restore	Post Restore a given CloudEndpoint.
begin_pre_backup	Pre Backup a given CloudEndpoint.
begin_pre_restore	Pre Restore a given CloudEndpoint.
begin_trigger_change_detection	Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.
get	Get a given CloudEndpoint.
list_by_sync_group	Get a CloudEndpoint List.
restoreheartbeat	Restore Heartbeat a given CloudEndpoint.

begin_create

Create a new CloudEndpoint.

async begin_create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: azure.mgmt.storagesync.models._models_py3.CloudEndpointCreateParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.storagesync.models._models_py3.CloudEndpoint]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cloud_endpoint_name

str

Required

Name of Cloud Endpoint object.

parameters

CloudEndpointCreateParameters

Required

Body of Cloud Endpoint resource.

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

Return type

AsyncLROPoller[CloudEndpoint]

Exceptions

HttpResponseError

begin_delete

Delete a given CloudEndpoint.

async begin_delete(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cloud_endpoint_name

str

Required

Name of Cloud Endpoint object.

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

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_post_backup

Post Backup a given CloudEndpoint.

async begin_post_backup(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: azure.mgmt.storagesync.models._models_py3.BackupRequest, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.storagesync.models._models_py3.PostBackupResponse]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cloud_endpoint_name

str

Required

Name of Cloud Endpoint object.

parameters

BackupRequest

Required

Body of Backup request.

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

Return type

AsyncLROPoller[PostBackupResponse]

Exceptions

HttpResponseError

begin_post_restore

Post Restore a given CloudEndpoint.

async begin_post_restore(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: azure.mgmt.storagesync.models._models_py3.PostRestoreRequest, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cloud_endpoint_name

str

Required

Name of Cloud Endpoint object.

parameters

PostRestoreRequest

Required

Body of Cloud Endpoint object.

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

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_pre_backup

Pre Backup a given CloudEndpoint.

async begin_pre_backup(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: azure.mgmt.storagesync.models._models_py3.BackupRequest, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cloud_endpoint_name

str

Required

Name of Cloud Endpoint object.

parameters

BackupRequest

Required

Body of Backup request.

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

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_pre_restore

Pre Restore a given CloudEndpoint.

async begin_pre_restore(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: azure.mgmt.storagesync.models._models_py3.PreRestoreRequest, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cloud_endpoint_name

str

Required

Name of Cloud Endpoint object.

parameters

PreRestoreRequest

Required

Body of Cloud Endpoint object.

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

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_trigger_change_detection

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

async begin_trigger_change_detection(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: azure.mgmt.storagesync.models._models_py3.TriggerChangeDetectionParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cloud_endpoint_name

str

Required

Name of Cloud Endpoint object.

parameters

TriggerChangeDetectionParameters

Required

Trigger Change Detection Action parameters.

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

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Get a given CloudEndpoint.

async get(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs) -> azure.mgmt.storagesync.models._models_py3.CloudEndpoint

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cloud_endpoint_name

str

Required

Name of Cloud Endpoint object.

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

Exceptions

HttpResponseError

list_by_sync_group

Get a CloudEndpoint List.

list_by_sync_group(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, **kwargs) -> AsyncIterable[azure.mgmt.storagesync.models._models_py3.CloudEndpointArray]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[CloudEndpointArray]

Exceptions

HttpResponseError

restoreheartbeat

Restore Heartbeat a given CloudEndpoint.

async restoreheartbeat(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cloud_endpoint_name

str

Required

Name of Cloud Endpoint object.

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

Exceptions

HttpResponseError

Attributes

models

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