CloudEndpoints interface

Package:

@azure/arm-storagesync

Interface representing a CloudEndpoints.

Methods

beginCreate(string, string, string, string, CloudEndpointCreateParameters, CloudEndpointsCreateOptionalParams)	Create a new CloudEndpoint.
beginCreateAndWait(string, string, string, string, CloudEndpointCreateParameters, CloudEndpointsCreateOptionalParams)	Create a new CloudEndpoint.
beginDelete(string, string, string, string, CloudEndpointsDeleteOptionalParams)	Delete a given CloudEndpoint.
beginDeleteAndWait(string, string, string, string, CloudEndpointsDeleteOptionalParams)	Delete a given CloudEndpoint.
beginPostBackup(string, string, string, string, BackupRequest, CloudEndpointsPostBackupOptionalParams)	Post Backup a given CloudEndpoint.
beginPostBackupAndWait(string, string, string, string, BackupRequest, CloudEndpointsPostBackupOptionalParams)	Post Backup a given CloudEndpoint.
beginPostRestore(string, string, string, string, PostRestoreRequest, CloudEndpointsPostRestoreOptionalParams)	Post Restore a given CloudEndpoint.
beginPostRestoreAndWait(string, string, string, string, PostRestoreRequest, CloudEndpointsPostRestoreOptionalParams)	Post Restore a given CloudEndpoint.
beginPreBackup(string, string, string, string, BackupRequest, CloudEndpointsPreBackupOptionalParams)	Pre Backup a given CloudEndpoint.
beginPreBackupAndWait(string, string, string, string, BackupRequest, CloudEndpointsPreBackupOptionalParams)	Pre Backup a given CloudEndpoint.
beginPreRestore(string, string, string, string, PreRestoreRequest, CloudEndpointsPreRestoreOptionalParams)	Pre Restore a given CloudEndpoint.
beginPreRestoreAndWait(string, string, string, string, PreRestoreRequest, CloudEndpointsPreRestoreOptionalParams)	Pre Restore a given CloudEndpoint.
beginTriggerChangeDetection(string, string, string, string, TriggerChangeDetectionParameters, CloudEndpointsTriggerChangeDetectionOptionalParams)	Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.
beginTriggerChangeDetectionAndWait(string, string, string, string, TriggerChangeDetectionParameters, CloudEndpointsTriggerChangeDetectionOptionalParams)	Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.
get(string, string, string, string, CloudEndpointsGetOptionalParams)	Get a given CloudEndpoint.
listBySyncGroup(string, string, string, CloudEndpointsListBySyncGroupOptionalParams)	Get a CloudEndpoint List.
restoreheartbeat(string, string, string, string, CloudEndpointsRestoreheartbeatOptionalParams)	Restore Heartbeat a given CloudEndpoint.

Method Details

beginCreate(string, string, string, string, CloudEndpointCreateParameters, CloudEndpointsCreateOptionalParams)

Create a new CloudEndpoint.

function beginCreate(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: CloudEndpointCreateParameters, options?: CloudEndpointsCreateOptionalParams): Promise<PollerLike<PollOperationState<CloudEndpointsCreateResponse>, CloudEndpointsCreateResponse>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

CloudEndpointCreateParameters

Body of Cloud Endpoint resource.

options

CloudEndpointsCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<CloudEndpointsCreateResponse>, CloudEndpointsCreateResponse>>

beginCreateAndWait(string, string, string, string, CloudEndpointCreateParameters, CloudEndpointsCreateOptionalParams)

Create a new CloudEndpoint.

function beginCreateAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: CloudEndpointCreateParameters, options?: CloudEndpointsCreateOptionalParams): Promise<CloudEndpointsCreateResponse>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

CloudEndpointCreateParameters

Body of Cloud Endpoint resource.

options

CloudEndpointsCreateOptionalParams

The options parameters.

Returns

Promise<CloudEndpointsCreateResponse>

beginDelete(string, string, string, string, CloudEndpointsDeleteOptionalParams)

Delete a given CloudEndpoint.

function beginDelete(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsDeleteOptionalParams): Promise<PollerLike<PollOperationState<CloudEndpointsDeleteHeaders>, CloudEndpointsDeleteHeaders>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

options

CloudEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<CloudEndpointsDeleteHeaders>, CloudEndpointsDeleteHeaders>>

beginDeleteAndWait(string, string, string, string, CloudEndpointsDeleteOptionalParams)

Delete a given CloudEndpoint.

function beginDeleteAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsDeleteOptionalParams): Promise<CloudEndpointsDeleteHeaders>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

options

CloudEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<CloudEndpointsDeleteHeaders>

beginPostBackup(string, string, string, string, BackupRequest, CloudEndpointsPostBackupOptionalParams)

Post Backup a given CloudEndpoint.

function beginPostBackup(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPostBackupOptionalParams): Promise<PollerLike<PollOperationState<CloudEndpointsPostBackupResponse>, CloudEndpointsPostBackupResponse>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

BackupRequest

Body of Backup request.

options

CloudEndpointsPostBackupOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<CloudEndpointsPostBackupResponse>, CloudEndpointsPostBackupResponse>>

beginPostBackupAndWait(string, string, string, string, BackupRequest, CloudEndpointsPostBackupOptionalParams)

Post Backup a given CloudEndpoint.

function beginPostBackupAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPostBackupOptionalParams): Promise<CloudEndpointsPostBackupResponse>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

BackupRequest

Body of Backup request.

options

CloudEndpointsPostBackupOptionalParams

The options parameters.

Returns

Promise<CloudEndpointsPostBackupResponse>

beginPostRestore(string, string, string, string, PostRestoreRequest, CloudEndpointsPostRestoreOptionalParams)

Post Restore a given CloudEndpoint.

function beginPostRestore(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PostRestoreRequest, options?: CloudEndpointsPostRestoreOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

PostRestoreRequest

Body of Cloud Endpoint object.

options

CloudEndpointsPostRestoreOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginPostRestoreAndWait(string, string, string, string, PostRestoreRequest, CloudEndpointsPostRestoreOptionalParams)

Post Restore a given CloudEndpoint.

function beginPostRestoreAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PostRestoreRequest, options?: CloudEndpointsPostRestoreOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

PostRestoreRequest

Body of Cloud Endpoint object.

options

CloudEndpointsPostRestoreOptionalParams

The options parameters.

Returns

Promise<void>

beginPreBackup(string, string, string, string, BackupRequest, CloudEndpointsPreBackupOptionalParams)

Pre Backup a given CloudEndpoint.

function beginPreBackup(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPreBackupOptionalParams): Promise<PollerLike<PollOperationState<CloudEndpointsPreBackupHeaders>, CloudEndpointsPreBackupHeaders>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

BackupRequest

Body of Backup request.

options

CloudEndpointsPreBackupOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<CloudEndpointsPreBackupHeaders>, CloudEndpointsPreBackupHeaders>>

beginPreBackupAndWait(string, string, string, string, BackupRequest, CloudEndpointsPreBackupOptionalParams)

Pre Backup a given CloudEndpoint.

function beginPreBackupAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPreBackupOptionalParams): Promise<CloudEndpointsPreBackupHeaders>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

BackupRequest

Body of Backup request.

options

CloudEndpointsPreBackupOptionalParams

The options parameters.

Returns

Promise<CloudEndpointsPreBackupHeaders>

beginPreRestore(string, string, string, string, PreRestoreRequest, CloudEndpointsPreRestoreOptionalParams)

Pre Restore a given CloudEndpoint.

function beginPreRestore(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PreRestoreRequest, options?: CloudEndpointsPreRestoreOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

PreRestoreRequest

Body of Cloud Endpoint object.

options

CloudEndpointsPreRestoreOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginPreRestoreAndWait(string, string, string, string, PreRestoreRequest, CloudEndpointsPreRestoreOptionalParams)

Pre Restore a given CloudEndpoint.

function beginPreRestoreAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PreRestoreRequest, options?: CloudEndpointsPreRestoreOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

PreRestoreRequest

Body of Cloud Endpoint object.

options

CloudEndpointsPreRestoreOptionalParams

The options parameters.

Returns

Promise<void>

beginTriggerChangeDetection(string, string, string, string, TriggerChangeDetectionParameters, CloudEndpointsTriggerChangeDetectionOptionalParams)

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

function beginTriggerChangeDetection(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: TriggerChangeDetectionParameters, options?: CloudEndpointsTriggerChangeDetectionOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

TriggerChangeDetectionParameters

Trigger Change Detection Action parameters.

options

CloudEndpointsTriggerChangeDetectionOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginTriggerChangeDetectionAndWait(string, string, string, string, TriggerChangeDetectionParameters, CloudEndpointsTriggerChangeDetectionOptionalParams)

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

function beginTriggerChangeDetectionAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: TriggerChangeDetectionParameters, options?: CloudEndpointsTriggerChangeDetectionOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

parameters

TriggerChangeDetectionParameters

Trigger Change Detection Action parameters.

options

CloudEndpointsTriggerChangeDetectionOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, CloudEndpointsGetOptionalParams)

Get a given CloudEndpoint.

function get(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsGetOptionalParams): Promise<CloudEndpointsGetResponse>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

options

CloudEndpointsGetOptionalParams

The options parameters.

Returns

Promise<CloudEndpointsGetResponse>

listBySyncGroup(string, string, string, CloudEndpointsListBySyncGroupOptionalParams)

Get a CloudEndpoint List.

function listBySyncGroup(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, options?: CloudEndpointsListBySyncGroupOptionalParams): PagedAsyncIterableIterator<CloudEndpoint, CloudEndpoint[], PageSettings>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

options

CloudEndpointsListBySyncGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CloudEndpoint, CloudEndpoint[], PageSettings>

restoreheartbeat(string, string, string, string, CloudEndpointsRestoreheartbeatOptionalParams)

Restore Heartbeat a given CloudEndpoint.

function restoreheartbeat(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsRestoreheartbeatOptionalParams): Promise<CloudEndpointsRestoreheartbeatHeaders>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

cloudEndpointName

string

Name of Cloud Endpoint object.

options

CloudEndpointsRestoreheartbeatOptionalParams

The options parameters.

Returns

Promise<CloudEndpointsRestoreheartbeatHeaders>