Share via


@azure/arm-storagesync package

Classes

CloudEndpoints

Class representing a CloudEndpoints.

OperationStatusOperations

Class representing a OperationStatusOperations.

Operations

Class representing a Operations.

RegisteredServers

Class representing a RegisteredServers.

ServerEndpoints

Class representing a ServerEndpoints.

StorageSyncServices

Class representing a StorageSyncServices.

SyncGroups

Class representing a SyncGroups.

Workflows

Class representing a Workflows.

StorageSyncManagementClient
StorageSyncManagementClientContext

Interfaces

AzureEntityResource

The resource model definition for a Azure Resource Manager resource with an etag.

BackupRequest

Backup request

CheckNameAvailabilityParameters

Parameters for a check name availability request.

CheckNameAvailabilityResult

The CheckNameAvailability operation response.

CloudEndpoint

Cloud Endpoint object.

CloudEndpointArray
CloudEndpointCreateParameters

The parameters used when creating a cloud endpoint.

CloudEndpointsCreateHeaders

Defines headers for Create operation.

CloudEndpointsDeleteHeaders

Defines headers for Delete operation.

CloudEndpointsGetHeaders

Defines headers for Get operation.

CloudEndpointsListBySyncGroupHeaders

Defines headers for ListBySyncGroup operation.

CloudEndpointsPostBackupHeaders

Defines headers for PostBackup operation.

CloudEndpointsPostRestoreHeaders

Defines headers for PostRestore operation.

CloudEndpointsPreBackupHeaders

Defines headers for PreBackup operation.

CloudEndpointsPreRestoreHeaders

Defines headers for PreRestore operation.

CloudEndpointsRestoreheartbeatHeaders

Defines headers for restoreheartbeat operation.

CloudEndpointsTriggerChangeDetectionHeaders

Defines headers for TriggerChangeDetection operation.

OperationDisplayInfo

The operation supported by storage sync.

OperationDisplayResource

Operation Display Resource object.

OperationEntity

The operation supported by storage sync.

OperationEntityListResult
OperationStatus

Operation status object

OperationStatusGetHeaders

Defines headers for Get operation.

OperationsListHeaders

Defines headers for List operation.

PostBackupResponse

Post Backup Response

PostRestoreRequest

Post Restore Request

PreRestoreRequest

Pre Restore request object.

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

RecallActionParameters

The parameters used when calling recall action on server endpoint.

RegisteredServer

Registered Server resource.

RegisteredServerArray
RegisteredServerCreateParameters

The parameters used when creating a registered server.

RegisteredServersCreateHeaders

Defines headers for Create operation.

RegisteredServersDeleteHeaders

Defines headers for Delete operation.

RegisteredServersGetHeaders

Defines headers for Get operation.

RegisteredServersListByStorageSyncServiceHeaders

Defines headers for ListByStorageSyncService operation.

RegisteredServersTriggerRolloverHeaders

Defines headers for triggerRollover operation.

Resource

An interface representing Resource.

ResourcesMoveInfo

Resource Move Info.

RestoreFileSpec

Restore file spec.

ServerEndpoint

Server Endpoint object.

ServerEndpointArray
ServerEndpointCloudTieringStatus

Server endpoint cloud tiering status object.

ServerEndpointCreateParameters

The parameters used when creating a server endpoint.

ServerEndpointFilesNotSyncingError

Files not syncing error object

ServerEndpointRecallError

Server endpoint recall error object

ServerEndpointRecallStatus

Server endpoint recall status object.

ServerEndpointSyncActivityStatus

Sync Session status object.

ServerEndpointSyncSessionStatus

Sync Session status object.

ServerEndpointSyncStatus

Server Endpoint sync status

ServerEndpointUpdateParameters

Parameters for updating an Server Endpoint.

ServerEndpointsBeginUpdateOptionalParams

Optional Parameters.

ServerEndpointsCreateHeaders

Defines headers for Create operation.

ServerEndpointsDeleteHeaders

Defines headers for Delete operation.

ServerEndpointsGetHeaders

Defines headers for Get operation.

ServerEndpointsListBySyncGroupHeaders

Defines headers for ListBySyncGroup operation.

ServerEndpointsRecallActionHeaders

Defines headers for recallAction operation.

ServerEndpointsUpdateHeaders

Defines headers for Update operation.

ServerEndpointsUpdateOptionalParams

Optional Parameters.

StorageSyncApiError

Error type

StorageSyncError

Error type

StorageSyncErrorDetails

Error Details object.

StorageSyncManagementClientOptions

An interface representing StorageSyncManagementClientOptions.

StorageSyncService

Storage Sync Service object.

StorageSyncServiceArray
StorageSyncServiceCreateParameters

The parameters used when creating a storage sync service.

StorageSyncServiceUpdateParameters

Parameters for updating an Storage sync service.

StorageSyncServicesDeleteHeaders

Defines headers for Delete operation.

StorageSyncServicesGetHeaders

Defines headers for Get operation.

StorageSyncServicesListByResourceGroupHeaders

Defines headers for ListByResourceGroup operation.

StorageSyncServicesListBySubscriptionHeaders

Defines headers for ListBySubscription operation.

StorageSyncServicesUpdateHeaders

Defines headers for Update operation.

StorageSyncServicesUpdateOptionalParams

Optional Parameters.

SubscriptionState

Subscription State object.

SyncGroup

Sync Group object.

SyncGroupArray
SyncGroupCreateParameters

The parameters used when creating a sync group.

SyncGroupsCreateHeaders

Defines headers for Create operation.

SyncGroupsDeleteHeaders

Defines headers for Delete operation.

SyncGroupsGetHeaders

Defines headers for Get operation.

SyncGroupsListByStorageSyncServiceHeaders

Defines headers for ListByStorageSyncService operation.

TrackedResource

The resource model definition for a ARM tracked top level resource

TriggerChangeDetectionParameters

The parameters used when calling trigger change detection action on cloud endpoint.

TriggerRolloverRequest

Trigger Rollover Request.

Workflow

Workflow resource.

WorkflowArray
WorkflowsAbortHeaders

Defines headers for Abort operation.

WorkflowsGetHeaders

Defines headers for Get operation.

WorkflowsListByStorageSyncServiceHeaders

Defines headers for ListByStorageSyncService operation.

Type Aliases

ChangeDetectionMode

Defines values for ChangeDetectionMode. Possible values include: 'Default', 'Recursive'

CloudEndpointsCreateResponse

Contains response data for the create operation.

CloudEndpointsDeleteResponse

Contains response data for the deleteMethod operation.

CloudEndpointsGetResponse

Contains response data for the get operation.

CloudEndpointsListBySyncGroupResponse

Contains response data for the listBySyncGroup operation.

CloudEndpointsPostBackupResponse

Contains response data for the postBackup operation.

CloudEndpointsPostRestoreResponse

Contains response data for the postRestore operation.

CloudEndpointsPreBackupResponse

Contains response data for the preBackup operation.

CloudEndpointsPreRestoreResponse

Contains response data for the preRestore operation.

CloudEndpointsRestoreheartbeatResponse

Contains response data for the restoreheartbeat operation.

CloudEndpointsTriggerChangeDetectionResponse

Contains response data for the triggerChangeDetection operation.

CloudTiering

Defines values for CloudTiering. Possible values include: 'on', 'off'

CloudTiering1

Defines values for CloudTiering1. Possible values include: 'on', 'off'

CloudTiering2

Defines values for CloudTiering2. Possible values include: 'on', 'off'

CombinedHealth

Defines values for CombinedHealth. Possible values include: 'Healthy', 'Error', 'SyncBlockedForRestore', 'SyncBlockedForChangeDetectionPostRestore', 'NoActivity'

DownloadHealth

Defines values for DownloadHealth. Possible values include: 'Healthy', 'Error', 'SyncBlockedForRestore', 'SyncBlockedForChangeDetectionPostRestore', 'NoActivity'

Health

Defines values for Health. Possible values include: 'Healthy', 'Error'

NameAvailabilityReason

Defines values for NameAvailabilityReason. Possible values include: 'Invalid', 'AlreadyExists'

OfflineDataTransfer

Defines values for OfflineDataTransfer. Possible values include: 'on', 'off'

OfflineDataTransfer1

Defines values for OfflineDataTransfer1. Possible values include: 'on', 'off'

OfflineDataTransfer2

Defines values for OfflineDataTransfer2. Possible values include: 'on', 'off'

OfflineDataTransferStatus

Defines values for OfflineDataTransferStatus. Possible values include: 'InProgress', 'Stopping', 'NotRunning', 'Complete'

Operation

Defines values for Operation. Possible values include: 'do', 'undo', 'cancel'

OperationStatusGetResponse

Contains response data for the get operation.

OperationsListResponse

Contains response data for the list operation.

Reason

Defines values for Reason. Possible values include: 'Registered', 'Unregistered', 'Warned', 'Suspended', 'Deleted'

RegisteredServersCreateResponse

Contains response data for the create operation.

RegisteredServersDeleteResponse

Contains response data for the deleteMethod operation.

RegisteredServersGetResponse

Contains response data for the get operation.

RegisteredServersListByStorageSyncServiceResponse

Contains response data for the listByStorageSyncService operation.

RegisteredServersTriggerRolloverResponse

Contains response data for the triggerRollover operation.

ServerEndpointsCreateResponse

Contains response data for the create operation.

ServerEndpointsDeleteResponse

Contains response data for the deleteMethod operation.

ServerEndpointsGetResponse

Contains response data for the get operation.

ServerEndpointsListBySyncGroupResponse

Contains response data for the listBySyncGroup operation.

ServerEndpointsRecallActionResponse

Contains response data for the recallAction operation.

ServerEndpointsUpdateResponse

Contains response data for the update operation.

Status

Defines values for Status. Possible values include: 'active', 'expired', 'succeeded', 'aborted', 'failed'

StorageSyncServicesCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

StorageSyncServicesCreateResponse

Contains response data for the create operation.

StorageSyncServicesDeleteResponse

Contains response data for the deleteMethod operation.

StorageSyncServicesGetResponse

Contains response data for the get operation.

StorageSyncServicesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

StorageSyncServicesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

StorageSyncServicesUpdateResponse

Contains response data for the update operation.

SyncActivity

Defines values for SyncActivity. Possible values include: 'Upload', 'Download', 'UploadAndDownload'

SyncGroupsCreateResponse

Contains response data for the create operation.

SyncGroupsDeleteResponse

Contains response data for the deleteMethod operation.

SyncGroupsGetResponse

Contains response data for the get operation.

SyncGroupsListByStorageSyncServiceResponse

Contains response data for the listByStorageSyncService operation.

UploadHealth

Defines values for UploadHealth. Possible values include: 'Healthy', 'Error', 'SyncBlockedForRestore', 'SyncBlockedForChangeDetectionPostRestore', 'NoActivity'

WorkflowsAbortResponse

Contains response data for the abort operation.

WorkflowsGetResponse

Contains response data for the get operation.

WorkflowsListByStorageSyncServiceResponse

Contains response data for the listByStorageSyncService operation.