@azure/arm-storagemover package
Classes
| StorageMoverClient |
Interfaces
| Agent |
The Agent resource. |
| AgentProperties |
model interface AgentProperties |
| AgentPropertiesErrorDetails |
model interface AgentPropertiesErrorDetails |
| AgentUpdateParameters |
The Agent resource. |
| AgentUpdateProperties |
model interface AgentUpdateProperties |
| AgentsCreateOrUpdateOptionalParams |
Optional parameters. |
| AgentsDeleteOptionalParams |
Optional parameters. |
| AgentsGetOptionalParams |
Optional parameters. |
| AgentsListOptionalParams |
Optional parameters. |
| AgentsOperations |
Interface representing a Agents operations. |
| AgentsUpdateOptionalParams |
Optional parameters. |
| AzureKeyVaultSmbCredentials |
The Azure Key Vault secret URIs which store the credentials. |
| AzureMultiCloudConnectorEndpointProperties |
The properties of Azure MultiCloudConnector endpoint. |
| AzureMultiCloudConnectorEndpointUpdateProperties |
The properties of Azure Storage NFS file share endpoint to update. |
| AzureStorageBlobContainerEndpointProperties |
The properties of Azure Storage blob container endpoint. |
| AzureStorageBlobContainerEndpointUpdateProperties |
model interface AzureStorageBlobContainerEndpointUpdateProperties |
| AzureStorageNfsFileShareEndpointProperties |
The properties of Azure Storage NFS file share endpoint. |
| AzureStorageNfsFileShareEndpointUpdateProperties |
The properties of Azure Storage NFS file share endpoint to update. |
| AzureStorageSmbFileShareEndpointProperties |
The properties of Azure Storage SMB file share endpoint. |
| AzureStorageSmbFileShareEndpointUpdateProperties |
The properties of Azure Storage SMB file share endpoint to update. |
| Credentials |
The Credentials. |
| Endpoint |
The Endpoint resource, which contains information about file sources and targets. |
| EndpointBaseProperties |
The resource specific properties for the Storage Mover resource. |
| EndpointBaseUpdateParameters |
The Endpoint resource. |
| EndpointBaseUpdateProperties |
The Endpoint resource, which contains information about file sources and targets. |
| EndpointsCreateOrUpdateOptionalParams |
Optional parameters. |
| EndpointsDeleteOptionalParams |
Optional parameters. |
| EndpointsGetOptionalParams |
Optional parameters. |
| EndpointsListOptionalParams |
Optional parameters. |
| EndpointsOperations |
Interface representing a Endpoints operations. |
| EndpointsUpdateOptionalParams |
Optional parameters. |
| 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. |
| JobDefinition |
The Job Definition resource. |
| JobDefinitionProperties |
Job definition properties. |
| JobDefinitionUpdateParameters |
The Job Definition resource. |
| JobDefinitionUpdateProperties |
Job definition properties. |
| JobDefinitionsCreateOrUpdateOptionalParams |
Optional parameters. |
| JobDefinitionsDeleteOptionalParams |
Optional parameters. |
| JobDefinitionsGetOptionalParams |
Optional parameters. |
| JobDefinitionsListOptionalParams |
Optional parameters. |
| JobDefinitionsOperations |
Interface representing a JobDefinitions operations. |
| JobDefinitionsStartJobOptionalParams |
Optional parameters. |
| JobDefinitionsStopJobOptionalParams |
Optional parameters. |
| JobDefinitionsUpdateOptionalParams |
Optional parameters. |
| JobRun |
The Job Run resource. |
| JobRunError |
Error type |
| JobRunProperties |
Job run properties. |
| JobRunResourceId |
Response that identifies a Job Run. |
| JobRunsGetOptionalParams |
Optional parameters. |
| JobRunsListOptionalParams |
Optional parameters. |
| JobRunsOperations |
Interface representing a JobRuns operations. |
| ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
| NfsMountEndpointProperties |
The properties of NFS share endpoint. |
| NfsMountEndpointUpdateProperties |
model interface NfsMountEndpointUpdateProperties |
| Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
| OperationDisplay |
Localized display information for and operation. |
| 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. |
| Project |
The Project resource. |
| ProjectProperties |
Project properties. |
| ProjectUpdateParameters |
The Project resource. |
| ProjectUpdateProperties |
Project properties. |
| ProjectsCreateOrUpdateOptionalParams |
Optional parameters. |
| ProjectsDeleteOptionalParams |
Optional parameters. |
| ProjectsGetOptionalParams |
Optional parameters. |
| ProjectsListOptionalParams |
Optional parameters. |
| ProjectsOperations |
Interface representing a Projects operations. |
| ProjectsUpdateOptionalParams |
Optional parameters. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| Recurrence |
The schedule recurrence. |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| RestorePollerOptions | |
| SmbMountEndpointProperties |
The properties of SMB share endpoint. |
| SmbMountEndpointUpdateProperties |
The properties of SMB share endpoint to update. |
| SourceEndpoint |
The source endpoint resource for source and target mapping. |
| SourceEndpointProperties |
The properties of the cloud source endpoint to migrate. |
| SourceTargetMap |
The properties of cloud endpoints to migrate. |
| StorageMover |
The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints. |
| StorageMoverClientOptionalParams |
Optional parameters for the client. |
| StorageMoverProperties |
The resource specific properties for the Storage Mover resource. |
| StorageMoverUpdateParameters |
The Storage Mover resource. |
| StorageMoverUpdateProperties |
The resource specific properties for the Storage Mover resource. |
| StorageMoversCreateOrUpdateOptionalParams |
Optional parameters. |
| StorageMoversDeleteOptionalParams |
Optional parameters. |
| StorageMoversGetOptionalParams |
Optional parameters. |
| StorageMoversListBySubscriptionOptionalParams |
Optional parameters. |
| StorageMoversListOptionalParams |
Optional parameters. |
| StorageMoversOperations |
Interface representing a StorageMovers operations. |
| StorageMoversUpdateOptionalParams |
Optional parameters. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TargetEndpoint |
The target endpoint resource for source and target mapping. |
| TargetEndpointProperties |
The properties of the cloud target endpoint to migrate. |
| Time |
The time of day. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| UploadLimitSchedule |
The WAN-link upload limit schedule. Overlapping recurrences are not allowed. |
| UploadLimitWeeklyRecurrence |
The weekly recurrence of the WAN-link upload limit schedule. The start time must be earlier in the day than the end time. The recurrence must not span across multiple days. |
| UserAssignedIdentity |
User assigned identity properties |
| WeeklyRecurrence |
The weekly recurrence of the schedule. |
Type Aliases
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| AgentStatus |
The Agent status. Known values supported by the serviceRegistering |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| ContinuablePage |
An interface that describes a page of results. |
| CopyMode |
Strategy to use for copy. Known values supported by the serviceAdditive |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| CredentialType |
The Credentials type. Known values supported by the serviceAzureKeyVaultSmb |
| CredentialsUnion |
Alias for CredentialsUnion |
| DayOfWeek |
The day of week. |
| EndpointBasePropertiesUnion |
Alias for EndpointBasePropertiesUnion |
| EndpointBaseUpdatePropertiesUnion |
Alias for EndpointBaseUpdatePropertiesUnion |
| EndpointType |
The Endpoint resource type. Known values supported by the serviceAzureStorageBlobContainer |
| JobRunScanStatus |
The status of Agent's scanning of source. Known values supported by the serviceNotStarted |
| JobRunStatus |
The current status of the Job Run in a non-terminal state, if exists. Known values supported by the serviceQueued |
| JobType |
The type of the Job. Known values supported by the serviceOnPremToCloud |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| Minute |
The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0. Known values supported by the service0 |
| NfsVersion |
The NFS protocol version. Known values supported by the serviceNFSauto |
| Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| ProvisioningState |
The provisioning state of a resource. Known values supported by the serviceSucceeded |
Enums
| AzureClouds |
An enum to describe Azure Cloud. |
| KnownActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
| KnownAgentStatus |
The Agent status. |
| KnownCopyMode |
Strategy to use for copy. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownCredentialType |
The Credentials type. |
| KnownEndpointType |
The Endpoint resource type. |
| KnownJobRunScanStatus |
The status of Agent's scanning of source. |
| KnownJobRunStatus |
The current status of the Job Run in a non-terminal state, if exists. |
| KnownJobType |
The type of the Job. |
| KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| KnownMinute |
The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0. |
| KnownNfsVersion |
The NFS protocol version. |
| KnownOrigin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" |
| KnownProvisioningState |
The provisioning state of a resource. |
| KnownVersions |
The available API versions. |
Functions
| 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. |
Function Details
restorePoller<TResponse, TResult>(StorageMoverClient, 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: StorageMoverClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- StorageMoverClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>