@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. |
| CloudEndpointAfsShareMetadataCertificatePublicKeys |
Cloud endpoint AFS file share metadata signing certificate public keys. |
| CloudEndpointChangeEnumerationActivity |
Cloud endpoint change enumeration activity object |
| CloudEndpointChangeEnumerationStatus |
Cloud endpoint change enumeration status object |
| CloudEndpointCreateParameters |
The parameters used when creating a cloud endpoint. |
| CloudEndpointCreateParametersProperties |
CloudEndpoint Properties object. |
| CloudEndpointLastChangeEnumerationStatus |
Cloud endpoint change enumeration status object |
| CloudEndpointProperties |
CloudEndpoint Properties object. |
| CloudEndpointsAfsShareMetadataCertificatePublicKeysOptionalParams |
Optional parameters. |
| CloudEndpointsCreateOptionalParams |
Optional parameters. |
| CloudEndpointsDeleteOptionalParams |
Optional parameters. |
| CloudEndpointsGetOptionalParams |
Optional parameters. |
| CloudEndpointsListBySyncGroupOptionalParams |
Optional parameters. |
| CloudEndpointsOperations |
Interface representing a CloudEndpoints operations. |
| CloudEndpointsPostBackupOptionalParams |
Optional parameters. |
| CloudEndpointsPostRestoreOptionalParams |
Optional parameters. |
| CloudEndpointsPreBackupOptionalParams |
Optional parameters. |
| CloudEndpointsPreRestoreOptionalParams |
Optional parameters. |
| CloudEndpointsRestoreheartbeatOptionalParams |
Optional parameters. |
| CloudEndpointsTriggerChangeDetectionOptionalParams |
Optional parameters. |
| CloudTieringCachePerformance |
Server endpoint cloud tiering status object. |
| CloudTieringDatePolicyStatus |
Status of the date policy |
| CloudTieringFilesNotTiering |
Server endpoint cloud tiering status object. |
| CloudTieringLowDiskMode |
Information regarding the low disk mode state |
| CloudTieringSpaceSavings |
Server endpoint cloud tiering status object. |
| CloudTieringVolumeFreeSpacePolicyStatus |
Status of the volume free space policy |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. |
| FilesNotTieringError |
Files not tiering error object |
| LocationOperationStatus |
Operation status object |
| LocationOperationStatusOptionalParams |
Optional parameters. |
| ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
| MicrosoftStorageSyncOptionalParams |
Optional parameters for the client. |
| OperationDisplayInfo |
The operation supported by storage sync. |
| OperationEntity |
The operation supported by storage sync. |
| OperationProperties |
Properties of the operations resource. |
| OperationResourceMetricSpecification |
Operation Display Resource object. |
| OperationResourceMetricSpecificationDimension |
OperationResourceMetricSpecificationDimension object. |
| OperationResourceServiceSpecification |
Service specification. |
| OperationStatus |
Operation status object |
| OperationStatusOperationsGetOptionalParams |
Optional parameters. |
| OperationStatusOperationsOperations |
Interface representing a OperationStatusOperations operations. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| PostBackupResponse |
Post Backup Response |
| PostBackupResponseProperties |
Post Backup Response Properties object. |
| PostRestoreRequest |
Post Restore Request |
| PreRestoreRequest |
Pre Restore request object. |
| PrivateEndpoint |
The private endpoint resource. |
| PrivateEndpointConnection |
The private endpoint connection resource. |
| PrivateEndpointConnectionProperties |
Properties of the private endpoint connection. |
| PrivateEndpointConnectionsCreateOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsGetOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsListByStorageSyncServiceOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsOperations |
Interface representing a PrivateEndpointConnections operations. |
| PrivateLinkResource |
A private link resource. |
| PrivateLinkResourceListResult |
A list of private link resources for versions before v6. This model represents the standard Note: This is only intended for use with versions before v6. Do not use this if you are already on CommonTypes.Version.v6 or beyond. If you are migrating to v6 or above, use |
| PrivateLinkResourceProperties |
Properties of a private link resource. |
| PrivateLinkResourcesListByStorageSyncServiceOptionalParams |
Optional parameters. |
| PrivateLinkResourcesOperations |
Interface representing a PrivateLinkResources operations. |
| 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. |
| RegisteredServerCreateParameters |
The parameters used when creating a registered server. |
| RegisteredServerCreateParametersProperties |
RegisteredServer Create Properties object. |
| RegisteredServerProperties |
RegisteredServer Properties object. |
| RegisteredServerUpdateParameters |
The parameters used when updating a registered server. |
| RegisteredServerUpdateProperties |
RegisteredServer Update Properties object. |
| RegisteredServersCreateOptionalParams |
Optional parameters. |
| RegisteredServersDeleteOptionalParams |
Optional parameters. |
| RegisteredServersGetOptionalParams |
Optional parameters. |
| RegisteredServersListByStorageSyncServiceOptionalParams |
Optional parameters. |
| RegisteredServersOperations |
Interface representing a RegisteredServers operations. |
| RegisteredServersTriggerRolloverOptionalParams |
Optional parameters. |
| RegisteredServersUpdateOptionalParams |
Optional parameters. |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| RestoreFileSpec |
Restore file spec. |
| RestorePollerOptions | |
| ServerEndpoint |
Server Endpoint object. |
| ServerEndpointBackgroundDataDownloadActivity |
Background data download activity object |
| ServerEndpointCloudTieringStatus |
Server endpoint cloud tiering status object. |
| ServerEndpointCreateParameters |
The parameters used when creating a server endpoint. |
| ServerEndpointCreateParametersProperties |
ServerEndpoint Properties object. |
| ServerEndpointFilesNotSyncingError |
Files not syncing error object |
| ServerEndpointProperties |
ServerEndpoint Properties object. |
| ServerEndpointProvisioningStatus |
Server endpoint provisioning status information |
| ServerEndpointProvisioningStepStatus |
Server endpoint provisioning step status 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. |
| ServerEndpointUpdateProperties |
ServerEndpoint Update Properties object. |
| ServerEndpointsCreateOptionalParams |
Optional parameters. |
| ServerEndpointsDeleteOptionalParams |
Optional parameters. |
| ServerEndpointsGetOptionalParams |
Optional parameters. |
| ServerEndpointsListBySyncGroupOptionalParams |
Optional parameters. |
| ServerEndpointsOperations |
Interface representing a ServerEndpoints operations. |
| ServerEndpointsRecallActionOptionalParams |
Optional parameters. |
| ServerEndpointsUpdateOptionalParams |
Optional parameters. |
| SimplePollerLike |
A simple poller that can be used to poll a long running operation. |
| StorageSyncApiError |
Error type |
| StorageSyncError |
Error type |
| StorageSyncErrorDetails |
Error Details object. |
| StorageSyncInnerErrorDetails |
Error Details object. |
| StorageSyncService |
Storage Sync Service object. |
| StorageSyncServiceCreateParameters |
The parameters used when creating a storage sync service. |
| StorageSyncServiceCreateParametersProperties |
StorageSyncService Properties object. |
| StorageSyncServiceProperties |
Storage Sync Service Properties object. |
| StorageSyncServiceUpdateParameters |
Parameters for updating an Storage sync service. |
| StorageSyncServiceUpdateProperties |
StorageSyncService Properties object. |
| StorageSyncServicesCheckNameAvailabilityOptionalParams |
Optional parameters. |
| StorageSyncServicesCreateOptionalParams |
Optional parameters. |
| StorageSyncServicesDeleteOptionalParams |
Optional parameters. |
| StorageSyncServicesGetOptionalParams |
Optional parameters. |
| StorageSyncServicesListByResourceGroupOptionalParams |
Optional parameters. |
| StorageSyncServicesListBySubscriptionOptionalParams |
Optional parameters. |
| StorageSyncServicesOperations |
Interface representing a StorageSyncServices operations. |
| StorageSyncServicesUpdateOptionalParams |
Optional parameters. |
| SyncGroup |
Sync Group object. |
| SyncGroupCreateParameters |
The parameters used when creating a sync group. |
| SyncGroupProperties |
SyncGroup Properties object. |
| SyncGroupsCreateOptionalParams |
Optional parameters. |
| SyncGroupsDeleteOptionalParams |
Optional parameters. |
| SyncGroupsGetOptionalParams |
Optional parameters. |
| SyncGroupsListByStorageSyncServiceOptionalParams |
Optional parameters. |
| SyncGroupsOperations |
Interface representing a SyncGroups operations. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| 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. |
| UserAssignedIdentity |
User assigned identity properties |
| Workflow |
Workflow resource. |
| WorkflowProperties |
Workflow Properties object. |
| WorkflowsAbortOptionalParams |
Optional parameters. |
| WorkflowsGetOptionalParams |
Optional parameters. |
| WorkflowsListByStorageSyncServiceOptionalParams |
Optional parameters. |
| WorkflowsOperations |
Interface representing a Workflows operations. |
Type Aliases
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| ChangeDetectionMode |
Change Detection Mode. Applies to a directory specified in directoryPath parameter. Known values supported by the serviceDefault |
| CloudEndpointChangeEnumerationActivityState |
State of change enumeration activity Known values supported by the serviceInitialEnumerationInProgress |
| CloudEndpointChangeEnumerationTotalCountsState |
State of the total counts of change enumeration activity Known values supported by the serviceCalculating |
| CloudTieringLowDiskModeState |
Type of the cloud tiering low disk mode state Known values supported by the serviceEnabled |
| ContinuablePage |
An interface that describes a page of results. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| FeatureStatus |
Type of the Feature Status Known values supported by the serviceon |
| IncomingTrafficPolicy |
Type of the Incoming Traffic Policy Known values supported by the serviceAllowAllTraffic |
| InitialDownloadPolicy |
Policy for how namespace and files are recalled during FastDr Known values supported by the serviceNamespaceOnly |
| InitialUploadPolicy |
Policy for how the initial upload sync session is performed. Known values supported by the serviceServerAuthoritative |
| LocalCacheMode |
Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Known values supported by the serviceDownloadNewAndModifiedFiles |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| NameAvailabilityReason |
Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false. |
| OperationDirection |
Type of the Operation Direction Known values supported by the servicedo |
| PrivateEndpointConnectionProvisioningState |
The current provisioning state. Known values supported by the serviceSucceeded: Connection has been provisioned |
| PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. Known values supported by the servicePending: Connection waiting for approval or rejection |
| RegisteredServerAgentVersionStatus |
Type of the registered server agent version status Known values supported by the serviceOk |
| ServerAuthType |
Type of the Server Auth type Known values supported by the serviceCertificate |
| ServerEndpointHealthState |
Type of the server endpoint health state Known values supported by the serviceUnavailable |
| ServerEndpointOfflineDataTransferState |
Type of the Health state Known values supported by the serviceInProgress |
| ServerEndpointSyncActivityState |
Type of the sync activity state Known values supported by the serviceUpload |
| ServerEndpointSyncMode |
Sync mode for the server endpoint. Known values supported by the serviceRegular |
| ServerProvisioningStatus |
Server provisioning status Known values supported by the serviceNotStarted |
| Type |
Type of Type |
| WorkflowStatus |
Type of the Workflow Status Known values supported by the serviceactive |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownChangeDetectionMode |
Change Detection Mode. Applies to a directory specified in directoryPath parameter. |
| KnownCloudEndpointChangeEnumerationActivityState |
State of change enumeration activity |
| KnownCloudEndpointChangeEnumerationTotalCountsState |
State of the total counts of change enumeration activity |
| KnownCloudTieringLowDiskModeState |
Type of the cloud tiering low disk mode state |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownFeatureStatus |
Type of the Feature Status |
| KnownIncomingTrafficPolicy |
Type of the Incoming Traffic Policy |
| KnownInitialDownloadPolicy |
Policy for how namespace and files are recalled during FastDr |
| KnownInitialUploadPolicy |
Policy for how the initial upload sync session is performed. |
| KnownLocalCacheMode |
Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. |
| KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| KnownOperationDirection |
Type of the Operation Direction |
| KnownPrivateEndpointConnectionProvisioningState |
The current provisioning state. |
| KnownPrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
| KnownRegisteredServerAgentVersionStatus |
Type of the registered server agent version status |
| KnownServerAuthType |
Type of the Server Auth type |
| KnownServerEndpointHealthState |
Type of the server endpoint health state |
| KnownServerEndpointOfflineDataTransferState |
Type of the Health state |
| KnownServerEndpointSyncActivityState |
Type of the sync activity state |
| KnownServerEndpointSyncMode |
Sync mode for the server endpoint. |
| KnownServerProvisioningStatus |
Server provisioning status |
| KnownVersions |
The available API versions. |
| KnownWorkflowStatus |
Type of the Workflow Status |
Functions
| is |
Typeguard for RestError |
| restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
restorePoller<TResponse, TResult>(MicrosoftStorageSync, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
function restorePoller<TResponse, TResult>(client: MicrosoftStorageSync, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- MicrosoftStorageSync
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor