@azure/arm-storagesync package

Classes

MicrosoftStorageSync

Interfaces

BackupRequest	Backup request
CheckNameAvailabilityParameters	Parameters for a check name availability request.
CheckNameAvailabilityResult	The CheckNameAvailability operation response.
CloudEndpoint	Cloud Endpoint object.
CloudEndpointArray	Array of CloudEndpoint
CloudEndpointChangeEnumerationActivity	Cloud endpoint change enumeration activity object
CloudEndpointChangeEnumerationStatus	Cloud endpoint change enumeration status object
CloudEndpointCreateParameters	The parameters used when creating a cloud endpoint.
CloudEndpointLastChangeEnumerationStatus	Cloud endpoint change enumeration status object
CloudEndpoints	Interface representing a CloudEndpoints.
CloudEndpointsCreateHeaders	Defines headers for CloudEndpoints_create operation.
CloudEndpointsCreateOptionalParams	Optional parameters.
CloudEndpointsDeleteHeaders	Defines headers for CloudEndpoints_delete operation.
CloudEndpointsDeleteOptionalParams	Optional parameters.
CloudEndpointsGetHeaders	Defines headers for CloudEndpoints_get operation.
CloudEndpointsGetOptionalParams	Optional parameters.
CloudEndpointsListBySyncGroupHeaders	Defines headers for CloudEndpoints_listBySyncGroup operation.
CloudEndpointsListBySyncGroupOptionalParams	Optional parameters.
CloudEndpointsPostBackupHeaders	Defines headers for CloudEndpoints_postBackup operation.
CloudEndpointsPostBackupOptionalParams	Optional parameters.
CloudEndpointsPostRestoreHeaders	Defines headers for CloudEndpoints_postRestore operation.
CloudEndpointsPostRestoreOptionalParams	Optional parameters.
CloudEndpointsPreBackupHeaders	Defines headers for CloudEndpoints_preBackup operation.
CloudEndpointsPreBackupOptionalParams	Optional parameters.
CloudEndpointsPreRestoreHeaders	Defines headers for CloudEndpoints_preRestore operation.
CloudEndpointsPreRestoreOptionalParams	Optional parameters.
CloudEndpointsRestoreheartbeatHeaders	Defines headers for CloudEndpoints_restoreheartbeat operation.
CloudEndpointsRestoreheartbeatOptionalParams	Optional parameters.
CloudEndpointsTriggerChangeDetectionHeaders	Defines headers for CloudEndpoints_triggerChangeDetection operation.
CloudEndpointsTriggerChangeDetectionOptionalParams	Optional parameters.
CloudTieringCachePerformance	Server endpoint cloud tiering status object.
CloudTieringDatePolicyStatus	Status of the date policy
CloudTieringFilesNotTiering	Server endpoint cloud tiering status object.
CloudTieringSpaceSavings	Server endpoint cloud tiering status object.
CloudTieringVolumeFreeSpacePolicyStatus	Status of the volume free space policy
FilesNotTieringError	Files not tiering error object
LocationOperationStatus	Operation status object
LocationOperationStatusOptionalParams	Optional parameters.
MicrosoftStorageSyncLocationOperationStatusHeaders	Defines headers for MicrosoftStorageSync_locationOperationStatus operation.
MicrosoftStorageSyncOptionalParams	Optional parameters.
OperationDisplayInfo	The operation supported by storage sync.
OperationDisplayResource	Operation Display Resource object.
OperationEntity	The operation supported by storage sync.
OperationEntityListResult	The list of storage sync operations.
OperationProperties	Properties of the operations resource.
OperationResourceMetricSpecification	Operation Display Resource object.
OperationResourceMetricSpecificationDimension	OperationResourceMetricSpecificationDimension object.
OperationResourceServiceSpecification	Service specification.
OperationStatus	Operation status object
OperationStatusGetHeaders	Defines headers for OperationStatus_get operation.
OperationStatusGetOptionalParams	Optional parameters.
OperationStatusOperations	Interface representing a OperationStatusOperations.
Operations	Interface representing a Operations.
OperationsListHeaders	Defines headers for Operations_list operation.
OperationsListNextHeaders	Defines headers for Operations_listNext operation.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PostBackupResponse	Post Backup Response
PostRestoreRequest	Post Restore Request
PreRestoreRequest	Pre Restore request object.
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionListResult	List of private endpoint connection associated with the specified storage account
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateHeaders	Defines headers for PrivateEndpointConnections_create operation.
PrivateEndpointConnectionsCreateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteHeaders	Defines headers for PrivateEndpointConnections_delete operation.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByStorageSyncServiceHeaders	Defines headers for PrivateEndpointConnections_listByStorageSyncService operation.
PrivateEndpointConnectionsListByStorageSyncServiceOptionalParams	Optional parameters.
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesListByStorageSyncServiceOptionalParams	Optional parameters.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RecallActionParameters	The parameters used when calling recall action on server endpoint.
RegisteredServer	Registered Server resource.
RegisteredServerArray	Array of RegisteredServer
RegisteredServerCreateParameters	The parameters used when creating a registered server.
RegisteredServers	Interface representing a RegisteredServers.
RegisteredServersCreateHeaders	Defines headers for RegisteredServers_create operation.
RegisteredServersCreateOptionalParams	Optional parameters.
RegisteredServersDeleteHeaders	Defines headers for RegisteredServers_delete operation.
RegisteredServersDeleteOptionalParams	Optional parameters.
RegisteredServersGetHeaders	Defines headers for RegisteredServers_get operation.
RegisteredServersGetOptionalParams	Optional parameters.
RegisteredServersListByStorageSyncServiceHeaders	Defines headers for RegisteredServers_listByStorageSyncService operation.
RegisteredServersListByStorageSyncServiceOptionalParams	Optional parameters.
RegisteredServersTriggerRolloverHeaders	Defines headers for RegisteredServers_triggerRollover operation.
RegisteredServersTriggerRolloverOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourcesMoveInfo	Resource Move Info.
RestoreFileSpec	Restore file spec.
ServerEndpoint	Server Endpoint object.
ServerEndpointArray	Array of ServerEndpoint
ServerEndpointBackgroundDataDownloadActivity	Background data download activity object
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.
ServerEndpoints	Interface representing a ServerEndpoints.
ServerEndpointsCreateHeaders	Defines headers for ServerEndpoints_create operation.
ServerEndpointsCreateOptionalParams	Optional parameters.
ServerEndpointsDeleteHeaders	Defines headers for ServerEndpoints_delete operation.
ServerEndpointsDeleteOptionalParams	Optional parameters.
ServerEndpointsGetHeaders	Defines headers for ServerEndpoints_get operation.
ServerEndpointsGetOptionalParams	Optional parameters.
ServerEndpointsListBySyncGroupHeaders	Defines headers for ServerEndpoints_listBySyncGroup operation.
ServerEndpointsListBySyncGroupOptionalParams	Optional parameters.
ServerEndpointsRecallActionHeaders	Defines headers for ServerEndpoints_recallAction operation.
ServerEndpointsRecallActionOptionalParams	Optional parameters.
ServerEndpointsUpdateHeaders	Defines headers for ServerEndpoints_update operation.
ServerEndpointsUpdateOptionalParams	Optional parameters.
StorageSyncApiError	Error type
StorageSyncError	Error type
StorageSyncErrorDetails	Error Details object.
StorageSyncInnerErrorDetails	Error Details object.
StorageSyncService	Storage Sync Service object.
StorageSyncServiceArray	Array of StorageSyncServices
StorageSyncServiceCreateParameters	The parameters used when creating a storage sync service.
StorageSyncServiceUpdateParameters	Parameters for updating an Storage sync service.
StorageSyncServices	Interface representing a StorageSyncServices.
StorageSyncServicesCheckNameAvailabilityOptionalParams	Optional parameters.
StorageSyncServicesCreateHeaders	Defines headers for StorageSyncServices_create operation.
StorageSyncServicesCreateOptionalParams	Optional parameters.
StorageSyncServicesDeleteHeaders	Defines headers for StorageSyncServices_delete operation.
StorageSyncServicesDeleteOptionalParams	Optional parameters.
StorageSyncServicesGetHeaders	Defines headers for StorageSyncServices_get operation.
StorageSyncServicesGetOptionalParams	Optional parameters.
StorageSyncServicesListByResourceGroupHeaders	Defines headers for StorageSyncServices_listByResourceGroup operation.
StorageSyncServicesListByResourceGroupOptionalParams	Optional parameters.
StorageSyncServicesListBySubscriptionHeaders	Defines headers for StorageSyncServices_listBySubscription operation.
StorageSyncServicesListBySubscriptionOptionalParams	Optional parameters.
StorageSyncServicesUpdateHeaders	Defines headers for StorageSyncServices_update operation.
StorageSyncServicesUpdateOptionalParams	Optional parameters.
SubscriptionState	Subscription State object.
SyncGroup	Sync Group object.
SyncGroupArray	Array of SyncGroup
SyncGroupCreateParameters	The parameters used when creating a sync group.
SyncGroups	Interface representing a SyncGroups.
SyncGroupsCreateHeaders	Defines headers for SyncGroups_create operation.
SyncGroupsCreateOptionalParams	Optional parameters.
SyncGroupsDeleteHeaders	Defines headers for SyncGroups_delete operation.
SyncGroupsDeleteOptionalParams	Optional parameters.
SyncGroupsGetHeaders	Defines headers for SyncGroups_get operation.
SyncGroupsGetOptionalParams	Optional parameters.
SyncGroupsListByStorageSyncServiceHeaders	Defines headers for SyncGroups_listByStorageSyncService operation.
SyncGroupsListByStorageSyncServiceOptionalParams	Optional parameters.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TriggerChangeDetectionParameters	The parameters used when calling trigger change detection action on cloud endpoint.
TriggerRolloverRequest	Trigger Rollover Request.
Workflow	Workflow resource.
WorkflowArray	Array of Workflow
Workflows	Interface representing a Workflows.
WorkflowsAbortHeaders	Defines headers for Workflows_abort operation.
WorkflowsAbortOptionalParams	Optional parameters.
WorkflowsGetHeaders	Defines headers for Workflows_get operation.
WorkflowsGetOptionalParams	Optional parameters.
WorkflowsListByStorageSyncServiceHeaders	Defines headers for Workflows_listByStorageSyncService operation.
WorkflowsListByStorageSyncServiceOptionalParams	Optional parameters.

Type Aliases

ChangeDetectionMode	Defines values for ChangeDetectionMode. KnownChangeDetectionMode can be used interchangeably with ChangeDetectionMode, this enum contains the known values that the service supports. Known values supported by the service Default Recursive
CloudEndpointChangeEnumerationActivityState	Defines values for CloudEndpointChangeEnumerationActivityState. KnownCloudEndpointChangeEnumerationActivityState can be used interchangeably with CloudEndpointChangeEnumerationActivityState, this enum contains the known values that the service supports. Known values supported by the service InitialEnumerationInProgress EnumerationInProgress
CloudEndpointChangeEnumerationTotalCountsState	Defines values for CloudEndpointChangeEnumerationTotalCountsState. KnownCloudEndpointChangeEnumerationTotalCountsState can be used interchangeably with CloudEndpointChangeEnumerationTotalCountsState, this enum contains the known values that the service supports. Known values supported by the service Calculating Final
CloudEndpointsCreateResponse	Contains response data for the create operation.
CloudEndpointsDeleteResponse	Contains response data for the delete 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.
CloudEndpointsPreBackupResponse	Contains response data for the preBackup operation.
CloudEndpointsRestoreheartbeatResponse	Contains response data for the restoreheartbeat operation.
FeatureStatus	Defines values for FeatureStatus. KnownFeatureStatus can be used interchangeably with FeatureStatus, this enum contains the known values that the service supports. Known values supported by the service on off
IncomingTrafficPolicy	Defines values for IncomingTrafficPolicy. KnownIncomingTrafficPolicy can be used interchangeably with IncomingTrafficPolicy, this enum contains the known values that the service supports. Known values supported by the service AllowAllTraffic AllowVirtualNetworksOnly
InitialDownloadPolicy	Defines values for InitialDownloadPolicy. KnownInitialDownloadPolicy can be used interchangeably with InitialDownloadPolicy, this enum contains the known values that the service supports. Known values supported by the service NamespaceOnly NamespaceThenModifiedFiles AvoidTieredFiles
InitialUploadPolicy	Defines values for InitialUploadPolicy. KnownInitialUploadPolicy can be used interchangeably with InitialUploadPolicy, this enum contains the known values that the service supports. Known values supported by the service ServerAuthoritative Merge
LocalCacheMode	Defines values for LocalCacheMode. KnownLocalCacheMode can be used interchangeably with LocalCacheMode, this enum contains the known values that the service supports. Known values supported by the service DownloadNewAndModifiedFiles UpdateLocallyCachedFiles
LocationOperationStatusResponse	Contains response data for the locationOperationStatus operation.
NameAvailabilityReason	Defines values for NameAvailabilityReason.
OperationDirection	Defines values for OperationDirection. KnownOperationDirection can be used interchangeably with OperationDirection, this enum contains the known values that the service supports. Known values supported by the service do undo cancel
OperationStatusGetResponse	Contains response data for the get operation.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
PrivateEndpointConnectionProvisioningState	Defines values for PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Deleting Failed
PrivateEndpointConnectionsCreateResponse	Contains response data for the create operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListByStorageSyncServiceResponse	Contains response data for the listByStorageSyncService operation.
PrivateEndpointServiceConnectionStatus	Defines values for PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected
PrivateLinkResourcesListByStorageSyncServiceResponse	Contains response data for the listByStorageSyncService operation.
ProgressType	Defines values for ProgressType. KnownProgressType can be used interchangeably with ProgressType, this enum contains the known values that the service supports. Known values supported by the service none initialize download upload recall
Reason	Defines values for Reason. KnownReason can be used interchangeably with Reason, this enum contains the known values that the service supports. Known values supported by the service Registered Unregistered Warned Suspended Deleted
RegisteredServerAgentVersionStatus	Defines values for RegisteredServerAgentVersionStatus. KnownRegisteredServerAgentVersionStatus can be used interchangeably with RegisteredServerAgentVersionStatus, this enum contains the known values that the service supports. Known values supported by the service Ok NearExpiry Expired Blocked
RegisteredServersCreateResponse	Contains response data for the create operation.
RegisteredServersDeleteResponse	Contains response data for the delete 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.
ServerEndpointHealthState	Defines values for ServerEndpointHealthState. KnownServerEndpointHealthState can be used interchangeably with ServerEndpointHealthState, this enum contains the known values that the service supports. Known values supported by the service Unavailable Healthy Error
ServerEndpointOfflineDataTransferState	Defines values for ServerEndpointOfflineDataTransferState. KnownServerEndpointOfflineDataTransferState can be used interchangeably with ServerEndpointOfflineDataTransferState, this enum contains the known values that the service supports. Known values supported by the service InProgress Stopping NotRunning Complete
ServerEndpointSyncActivityState	Defines values for ServerEndpointSyncActivityState. KnownServerEndpointSyncActivityState can be used interchangeably with ServerEndpointSyncActivityState, this enum contains the known values that the service supports. Known values supported by the service Upload Download UploadAndDownload
ServerEndpointSyncMode	Defines values for ServerEndpointSyncMode. KnownServerEndpointSyncMode can be used interchangeably with ServerEndpointSyncMode, this enum contains the known values that the service supports. Known values supported by the service Regular NamespaceDownload InitialUpload SnapshotUpload InitialFullDownload
ServerEndpointsCreateResponse	Contains response data for the create operation.
ServerEndpointsDeleteResponse	Contains response data for the delete 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.
StorageSyncServicesCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
StorageSyncServicesCreateResponse	Contains response data for the create operation.
StorageSyncServicesDeleteResponse	Contains response data for the delete 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.
SyncGroupsCreateResponse	Contains response data for the create operation.
SyncGroupsDeleteResponse	Contains response data for the delete operation.
SyncGroupsGetResponse	Contains response data for the get operation.
SyncGroupsListByStorageSyncServiceResponse	Contains response data for the listByStorageSyncService operation.
WorkflowStatus	Defines values for WorkflowStatus. KnownWorkflowStatus can be used interchangeably with WorkflowStatus, this enum contains the known values that the service supports. Known values supported by the service active expired succeeded aborted failed
WorkflowsAbortResponse	Contains response data for the abort operation.
WorkflowsGetResponse	Contains response data for the get operation.
WorkflowsListByStorageSyncServiceResponse	Contains response data for the listByStorageSyncService operation.

Enums

KnownChangeDetectionMode	Known values of ChangeDetectionMode that the service accepts.
KnownCloudEndpointChangeEnumerationActivityState	Known values of CloudEndpointChangeEnumerationActivityState that the service accepts.
KnownCloudEndpointChangeEnumerationTotalCountsState	Known values of CloudEndpointChangeEnumerationTotalCountsState that the service accepts.
KnownFeatureStatus	Known values of FeatureStatus that the service accepts.
KnownIncomingTrafficPolicy	Known values of IncomingTrafficPolicy that the service accepts.
KnownInitialDownloadPolicy	Known values of InitialDownloadPolicy that the service accepts.
KnownInitialUploadPolicy	Known values of InitialUploadPolicy that the service accepts.
KnownLocalCacheMode	Known values of LocalCacheMode that the service accepts.
KnownOperationDirection	Known values of OperationDirection that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateEndpointServiceConnectionStatus	Known values of PrivateEndpointServiceConnectionStatus that the service accepts.
KnownProgressType	Known values of ProgressType that the service accepts.
KnownReason	Known values of Reason that the service accepts.
KnownRegisteredServerAgentVersionStatus	Known values of RegisteredServerAgentVersionStatus that the service accepts.
KnownServerEndpointHealthState	Known values of ServerEndpointHealthState that the service accepts.
KnownServerEndpointOfflineDataTransferState	Known values of ServerEndpointOfflineDataTransferState that the service accepts.
KnownServerEndpointSyncActivityState	Known values of ServerEndpointSyncActivityState that the service accepts.
KnownServerEndpointSyncMode	Known values of ServerEndpointSyncMode that the service accepts.
KnownWorkflowStatus	Known values of WorkflowStatus that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.