CloudEndpointsOperations interface

Package:

@azure/arm-storagesync

Interface representing a CloudEndpoints operations.

Properties

afsShareMetadataCertificatePublicKeys	Get the AFS file share metadata signing certificate public keys.
beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginPostBackup
beginPostBackupAndWait
beginPostRestore
beginPostRestoreAndWait
beginPreBackup
beginPreBackupAndWait
beginPreRestore
beginPreRestoreAndWait
beginTriggerChangeDetection
beginTriggerChangeDetectionAndWait
create	Create a new CloudEndpoint.
delete	Delete a given CloudEndpoint.
get	Get a given CloudEndpoint.
listBySyncGroup	Get a CloudEndpoint List.
postBackup	Post Backup a given CloudEndpoint.
postRestore	Post Restore a given CloudEndpoint.
preBackup	Pre Backup a given CloudEndpoint.
preRestore	Pre Restore a given CloudEndpoint.
restoreheartbeat	Restore Heartbeat a given CloudEndpoint.
triggerChangeDetection	Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.

Property Details

afsShareMetadataCertificatePublicKeys

Get the AFS file share metadata signing certificate public keys.

afsShareMetadataCertificatePublicKeys: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsAfsShareMetadataCertificatePublicKeysOptionalParams) => Promise<CloudEndpointAfsShareMetadataCertificatePublicKeys>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsAfsShareMetadataCertificatePublicKeysOptionalParams) => Promise<CloudEndpointAfsShareMetadataCertificatePublicKeys>

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: CloudEndpointCreateParameters, options?: CloudEndpointsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<CloudEndpoint>, CloudEndpoint>>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: CloudEndpointCreateParameters, options?: CloudEndpointsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<CloudEndpoint>, CloudEndpoint>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

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

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: CloudEndpointCreateParameters, options?: CloudEndpointsCreateOptionalParams) => Promise<CloudEndpoint>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsDeleteOptionalParams) => Promise<void>

beginPostBackup

Warning

This API is now deprecated.

use postBackup instead

beginPostBackup: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPostBackupOptionalParams) => Promise<SimplePollerLike<OperationState<PostBackupResponse>, PostBackupResponse>>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPostBackupOptionalParams) => Promise<SimplePollerLike<OperationState<PostBackupResponse>, PostBackupResponse>>

beginPostBackupAndWait

Warning

This API is now deprecated.

use postBackup instead

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

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPostBackupOptionalParams) => Promise<PostBackupResponse>

beginPostRestore

Warning

This API is now deprecated.

use postRestore instead

beginPostRestore: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PostRestoreRequest, options?: CloudEndpointsPostRestoreOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PostRestoreRequest, options?: CloudEndpointsPostRestoreOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginPostRestoreAndWait

Warning

This API is now deprecated.

use postRestore instead

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

Property Value

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

beginPreBackup

Warning

This API is now deprecated.

use preBackup instead

beginPreBackup: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPreBackupOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPreBackupOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginPreBackupAndWait

Warning

This API is now deprecated.

use preBackup instead

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

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPreBackupOptionalParams) => Promise<void>

beginPreRestore

Warning

This API is now deprecated.

use preRestore instead

beginPreRestore: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PreRestoreRequest, options?: CloudEndpointsPreRestoreOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PreRestoreRequest, options?: CloudEndpointsPreRestoreOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginPreRestoreAndWait

Warning

This API is now deprecated.

use preRestore instead

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

Property Value

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

beginTriggerChangeDetection

Warning

This API is now deprecated.

use triggerChangeDetection instead

beginTriggerChangeDetection: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: TriggerChangeDetectionParameters, options?: CloudEndpointsTriggerChangeDetectionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: TriggerChangeDetectionParameters, options?: CloudEndpointsTriggerChangeDetectionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginTriggerChangeDetectionAndWait

Warning

This API is now deprecated.

use triggerChangeDetection instead

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

Property Value

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

create

Create a new CloudEndpoint.

create: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: CloudEndpointCreateParameters, options?: CloudEndpointsCreateOptionalParams) => PollerLike<OperationState<CloudEndpoint>, CloudEndpoint>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: CloudEndpointCreateParameters, options?: CloudEndpointsCreateOptionalParams) => PollerLike<OperationState<CloudEndpoint>, CloudEndpoint>

delete

Delete a given CloudEndpoint.

delete: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get a given CloudEndpoint.

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

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsGetOptionalParams) => Promise<CloudEndpoint>

listBySyncGroup

Get a CloudEndpoint List.

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

Property Value

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

postBackup

Post Backup a given CloudEndpoint.

postBackup: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPostBackupOptionalParams) => PollerLike<OperationState<PostBackupResponse>, PostBackupResponse>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPostBackupOptionalParams) => PollerLike<OperationState<PostBackupResponse>, PostBackupResponse>

postRestore

Post Restore a given CloudEndpoint.

postRestore: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PostRestoreRequest, options?: CloudEndpointsPostRestoreOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PostRestoreRequest, options?: CloudEndpointsPostRestoreOptionalParams) => PollerLike<OperationState<void>, void>

preBackup

Pre Backup a given CloudEndpoint.

preBackup: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPreBackupOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: BackupRequest, options?: CloudEndpointsPreBackupOptionalParams) => PollerLike<OperationState<void>, void>

preRestore

Pre Restore a given CloudEndpoint.

preRestore: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PreRestoreRequest, options?: CloudEndpointsPreRestoreOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: PreRestoreRequest, options?: CloudEndpointsPreRestoreOptionalParams) => PollerLike<OperationState<void>, void>

restoreheartbeat

Restore Heartbeat a given CloudEndpoint.

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

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, options?: CloudEndpointsRestoreheartbeatOptionalParams) => Promise<void>

triggerChangeDetection

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

triggerChangeDetection: (resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: TriggerChangeDetectionParameters, options?: CloudEndpointsTriggerChangeDetectionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, cloudEndpointName: string, parameters: TriggerChangeDetectionParameters, options?: CloudEndpointsTriggerChangeDetectionOptionalParams) => PollerLike<OperationState<void>, void>