CloudEndpointsOperations Class

CloudEndpointsOperations 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.

begin_create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.CloudEndpointCreateParameters, **kwargs: Any) -> LROPoller[_models.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 PollingMethod

Pass in True if you'd like the ARMPolling 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 LROPoller that returns either CloudEndpoint or the result of cls(response)

Return type

Exceptions

begin_delete

Delete a given CloudEndpoint.

begin_delete(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs: Any) -> LROPoller[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 PollingMethod

Pass in True if you'd like the ARMPolling 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 LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_post_backup

Post Backup a given CloudEndpoint.

begin_post_backup(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.BackupRequest, **kwargs: Any) -> LROPoller[_models.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 PollingMethod

Pass in True if you'd like the ARMPolling 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 LROPoller that returns either PostBackupResponse or the result of cls(response)

Return type

Exceptions

begin_post_restore

Post Restore a given CloudEndpoint.

begin_post_restore(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.PostRestoreRequest, **kwargs: Any) -> LROPoller[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 PollingMethod

Pass in True if you'd like the ARMPolling 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 LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_pre_backup

Pre Backup a given CloudEndpoint.

begin_pre_backup(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.BackupRequest, **kwargs: Any) -> LROPoller[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 PollingMethod

Pass in True if you'd like the ARMPolling 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 LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_pre_restore

Pre Restore a given CloudEndpoint.

begin_pre_restore(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.PreRestoreRequest, **kwargs: Any) -> LROPoller[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 PollingMethod

Pass in True if you'd like the ARMPolling 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 LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_trigger_change_detection

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

begin_trigger_change_detection(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, parameters: _models.TriggerChangeDetectionParameters, **kwargs: Any) -> LROPoller[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 PollingMethod

Pass in True if you'd like the ARMPolling 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 LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

get

Get a given CloudEndpoint.

get(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs: Any) -> _models.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

Exceptions

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: Any) -> Iterable[_models.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

Exceptions

restoreheartbeat

Restore Heartbeat a given CloudEndpoint.

restoreheartbeat(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, cloud_endpoint_name: str, **kwargs: Any) -> 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

Exceptions

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'>