@azure/arm-storagemover package

Classes

StorageMoverClient

Interfaces

Agent	The Agent resource.
AgentList	List of Agents.
AgentPropertiesErrorDetails
AgentUpdateParameters	The Agent resource.
Agents	Interface representing a Agents.
AgentsCreateOrUpdateOptionalParams	Optional parameters.
AgentsDeleteOptionalParams	Optional parameters.
AgentsGetOptionalParams	Optional parameters.
AgentsListNextOptionalParams	Optional parameters.
AgentsListOptionalParams	Optional parameters.
AgentsUpdateOptionalParams	Optional parameters.
AzureKeyVaultSmbCredentials	The Azure Key Vault secret URIs which store the credentials.
AzureStorageBlobContainerEndpointProperties	The properties of Azure Storage blob container endpoint.
AzureStorageBlobContainerEndpointUpdateProperties	The Endpoint resource, which contains information about file sources and targets.
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.
EndpointList	List of Endpoints.
Endpoints	Interface representing a Endpoints.
EndpointsCreateOrUpdateOptionalParams	Optional parameters.
EndpointsDeleteOptionalParams	Optional parameters.
EndpointsGetOptionalParams	Optional parameters.
EndpointsListNextOptionalParams	Optional parameters.
EndpointsListOptionalParams	Optional parameters.
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. (This also follows the OData error response format.).
JobDefinition	The Job Definition resource.
JobDefinitionList	List of Job Definitions.
JobDefinitionUpdateParameters	The Job Definition resource.
JobDefinitions	Interface representing a JobDefinitions.
JobDefinitionsCreateOrUpdateOptionalParams	Optional parameters.
JobDefinitionsDeleteOptionalParams	Optional parameters.
JobDefinitionsGetOptionalParams	Optional parameters.
JobDefinitionsListNextOptionalParams	Optional parameters.
JobDefinitionsListOptionalParams	Optional parameters.
JobDefinitionsStartJobOptionalParams	Optional parameters.
JobDefinitionsStopJobOptionalParams	Optional parameters.
JobDefinitionsUpdateOptionalParams	Optional parameters.
JobRun	The Job Run resource.
JobRunError	Error type
JobRunList	List of Job Runs.
JobRunResourceId	Response that identifies a Job Run.
JobRuns	Interface representing a JobRuns.
JobRunsGetOptionalParams	Optional parameters.
JobRunsListNextOptionalParams	Optional parameters.
JobRunsListOptionalParams	Optional parameters.
NfsMountEndpointProperties	The properties of NFS share endpoint.
NfsMountEndpointUpdateProperties	The Endpoint resource, which contains information about file sources and targets.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
Project	The Project resource.
ProjectList	List of Project resources.
ProjectUpdateParameters	The Project resource.
Projects	Interface representing a Projects.
ProjectsCreateOrUpdateOptionalParams	Optional parameters.
ProjectsDeleteOptionalParams	Optional parameters.
ProjectsGetOptionalParams	Optional parameters.
ProjectsListNextOptionalParams	Optional parameters.
ProjectsListOptionalParams	Optional parameters.
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
SmbMountEndpointProperties	The properties of SMB share endpoint.
SmbMountEndpointUpdateProperties	The properties of SMB share endpoint to update.
StorageMover	The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints.
StorageMoverClientOptionalParams	Optional parameters.
StorageMoverList	List of Storage Movers.
StorageMoverUpdateParameters	The Storage Mover resource.
StorageMovers	Interface representing a StorageMovers.
StorageMoversCreateOrUpdateOptionalParams	Optional parameters.
StorageMoversDeleteOptionalParams	Optional parameters.
StorageMoversGetOptionalParams	Optional parameters.
StorageMoversListBySubscriptionNextOptionalParams	Optional parameters.
StorageMoversListBySubscriptionOptionalParams	Optional parameters.
StorageMoversListNextOptionalParams	Optional parameters.
StorageMoversListOptionalParams	Optional parameters.
StorageMoversUpdateOptionalParams	Optional parameters.
SystemData	Metadata pertaining to creation and last modification of the resource.
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'
UploadLimit	The WAN-link upload limit.
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.
WeeklyRecurrence	The weekly recurrence of the schedule.

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
AgentStatus	Defines values for AgentStatus. KnownAgentStatus can be used interchangeably with AgentStatus, this enum contains the known values that the service supports. Known values supported by the service Registering Offline Online Executing RequiresAttention Unregistering
AgentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
AgentsGetResponse	Contains response data for the get operation.
AgentsListNextResponse	Contains response data for the listNext operation.
AgentsListResponse	Contains response data for the list operation.
AgentsUpdateResponse	Contains response data for the update operation.
CopyMode	Defines values for CopyMode. KnownCopyMode can be used interchangeably with CopyMode, this enum contains the known values that the service supports. Known values supported by the service Additive Mirror
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
CredentialType	Defines values for CredentialType. KnownCredentialType can be used interchangeably with CredentialType, this enum contains the known values that the service supports. Known values supported by the service AzureKeyVaultSmb
CredentialsUnion
DayOfWeek	Defines values for DayOfWeek.
EndpointBasePropertiesUnion
EndpointBaseUpdatePropertiesUnion
EndpointType	Defines values for EndpointType. KnownEndpointType can be used interchangeably with EndpointType, this enum contains the known values that the service supports. Known values supported by the service AzureStorageBlobContainer NfsMount AzureStorageSmbFileShare SmbMount
EndpointsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
EndpointsGetResponse	Contains response data for the get operation.
EndpointsListNextResponse	Contains response data for the listNext operation.
EndpointsListResponse	Contains response data for the list operation.
EndpointsUpdateResponse	Contains response data for the update operation.
JobDefinitionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
JobDefinitionsGetResponse	Contains response data for the get operation.
JobDefinitionsListNextResponse	Contains response data for the listNext operation.
JobDefinitionsListResponse	Contains response data for the list operation.
JobDefinitionsStartJobResponse	Contains response data for the startJob operation.
JobDefinitionsStopJobResponse	Contains response data for the stopJob operation.
JobDefinitionsUpdateResponse	Contains response data for the update operation.
JobRunScanStatus	Defines values for JobRunScanStatus. KnownJobRunScanStatus can be used interchangeably with JobRunScanStatus, this enum contains the known values that the service supports. Known values supported by the service NotStarted Scanning Completed
JobRunStatus	Defines values for JobRunStatus. KnownJobRunStatus can be used interchangeably with JobRunStatus, this enum contains the known values that the service supports. Known values supported by the service Queued Started Running CancelRequested Canceling Canceled Failed Succeeded PausedByBandwidthManagement
JobRunsGetResponse	Contains response data for the get operation.
JobRunsListNextResponse	Contains response data for the listNext operation.
JobRunsListResponse	Contains response data for the list operation.
Minute	Defines values for Minute. KnownMinute can be used interchangeably with Minute, this enum contains the known values that the service supports. Known values supported by the service 0 30
NfsVersion	Defines values for NfsVersion. KnownNfsVersion can be used interchangeably with NfsVersion, this enum contains the known values that the service supports. Known values supported by the service NFSauto NFSv3 NFSv4
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
ProjectsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ProjectsGetResponse	Contains response data for the get operation.
ProjectsListNextResponse	Contains response data for the listNext operation.
ProjectsListResponse	Contains response data for the list operation.
ProjectsUpdateResponse	Contains response data for the update operation.
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Canceled Failed Deleting
StorageMoversCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
StorageMoversGetResponse	Contains response data for the get operation.
StorageMoversListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
StorageMoversListBySubscriptionResponse	Contains response data for the listBySubscription operation.
StorageMoversListNextResponse	Contains response data for the listNext operation.
StorageMoversListResponse	Contains response data for the list operation.
StorageMoversUpdateResponse	Contains response data for the update operation.

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownAgentStatus	Known values of AgentStatus that the service accepts.
KnownCopyMode	Known values of CopyMode that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownCredentialType	Known values of CredentialType that the service accepts.
KnownEndpointType	Known values of EndpointType that the service accepts.
KnownJobRunScanStatus	Known values of JobRunScanStatus that the service accepts.
KnownJobRunStatus	Known values of JobRunStatus that the service accepts.
KnownMinute	Known values of Minute that the service accepts.
KnownNfsVersion	Known values of NfsVersion that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownProvisioningState	Known values of ProvisioningState 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.