@azure/arm-recoveryservicesdatareplication package

Classes

AzureSiteRecoveryManagementServiceAPI

Interfaces

AzStackHCIClusterProperties

AzStackHCI cluster properties.

AzStackHCIFabricModelCustomProperties

AzStackHCI fabric model custom properties.

AzureSiteRecoveryManagementServiceAPIOptionalParams

Optional parameters.

CheckNameAvailabilityModel

Check name availability model.

CheckNameAvailabilityOptionalParams

Optional parameters.

CheckNameAvailabilityResponseModel

Check name availability response model.

DeploymentPreflightModel

Deployment preflight model.

DeploymentPreflightOptionalParams

Optional parameters.

DeploymentPreflightResource

Deployment preflight resource.

Dra

Interface representing a Dra.

DraCreateOptionalParams

Optional parameters.

DraDeleteHeaders

Defines headers for Dra_delete operation.

DraDeleteOptionalParams

Optional parameters.

DraGetOptionalParams

Optional parameters.

DraListNextOptionalParams

Optional parameters.

DraListOptionalParams

Optional parameters.

DraModel

Dra model.

DraModelCollection

Dra model collection.

DraModelCustomProperties

Dra model custom properties.

DraModelProperties

Dra model properties.

DraModelSystemData

System data required to be defined for Azure resources.

DraOperationStatus

Interface representing a DraOperationStatus.

DraOperationStatusGetOptionalParams

Optional parameters.

EmailConfiguration

Interface representing a EmailConfiguration.

EmailConfigurationCreateOptionalParams

Optional parameters.

EmailConfigurationGetOptionalParams

Optional parameters.

EmailConfigurationListNextOptionalParams

Optional parameters.

EmailConfigurationListOptionalParams

Optional parameters.

EmailConfigurationModel

Email configuration model.

EmailConfigurationModelCollection

Email configuration model collection.

EmailConfigurationModelProperties

Email configuration model properties.

EmailConfigurationModelSystemData

System data required to be defined for Azure resources.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorModel

Error model.

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.).

Event

Interface representing a Event.

EventGetOptionalParams

Optional parameters.

EventListNextOptionalParams

Optional parameters.

EventListOptionalParams

Optional parameters.

EventModel

Event model.

EventModelCollection

Event model collection.

EventModelCustomProperties

Event model custom properties.

EventModelProperties

Event model properties.

EventModelSystemData

System data required to be defined for Azure resources.

Fabric

Interface representing a Fabric.

FabricCreateOptionalParams

Optional parameters.

FabricDeleteHeaders

Defines headers for Fabric_delete operation.

FabricDeleteOptionalParams

Optional parameters.

FabricGetOptionalParams

Optional parameters.

FabricListBySubscriptionNextOptionalParams

Optional parameters.

FabricListBySubscriptionOptionalParams

Optional parameters.

FabricListNextOptionalParams

Optional parameters.

FabricListOptionalParams

Optional parameters.

FabricModel

Fabric model.

FabricModelCollection

Fabric model collection.

FabricModelCustomProperties

Fabric model custom properties.

FabricModelProperties

Fabric model properties.

FabricModelSystemData

System data required to be defined for Azure resources.

FabricModelUpdate

Fabric model for update.

FabricModelUpdateSystemData

System data required to be defined for Azure resources.

FabricOperationsStatus

Interface representing a FabricOperationsStatus.

FabricOperationsStatusGetOptionalParams

Optional parameters.

FabricUpdateHeaders

Defines headers for Fabric_update operation.

FabricUpdateOptionalParams

Optional parameters.

FailoverProtectedItemProperties

Failover properties of the protected item.

FailoverWorkflowModelCustomProperties

Failover workflow model custom properties.

HealthErrorModel

Health error model.

HyperVMigrateFabricModelCustomProperties

HyperV migrate fabric model custom properties.

HyperVToAzStackHCIDiskInput

HyperVToAzStack disk input.

HyperVToAzStackHCIEventModelCustomProperties

HyperV to AzStackHCI event model custom properties. This class provides provider specific details for events of type DataContract.HealthEvents.HealthEventType.ProtectedItemHealth and DataContract.HealthEvents.HealthEventType.AgentHealth.

HyperVToAzStackHCINicInput

HyperVToAzStackHCI NIC properties.

HyperVToAzStackHCIPlannedFailoverModelCustomProperties

HyperV to AzStackHCI planned failover model custom properties.

HyperVToAzStackHCIPolicyModelCustomProperties

HyperV To AzStackHCI Policy model custom properties.

HyperVToAzStackHCIProtectedDiskProperties

HyperVToAzStackHCI protected disk properties.

HyperVToAzStackHCIProtectedItemModelCustomProperties

HyperV to AzStackHCI Protected item model custom properties.

HyperVToAzStackHCIProtectedNicProperties

HyperVToAzStackHCI NIC properties.

HyperVToAzStackHCIRecoveryPointModelCustomProperties

HyperV to AzStackHCI recovery point model custom properties.

HyperVToAzStackHCIReplicationExtensionModelCustomProperties

HyperV to AzStackHCI Replication extension model custom properties.

IdentityModel

Identity model.

InnerHealthErrorModel

Inner health error model.

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.

OperationModel

Operation model.

OperationModelCollection

Available operations of the service.

OperationModelProperties

Operation model properties.

OperationStatus

Defines the operation status.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

PlannedFailoverModel

Planned failover model.

PlannedFailoverModelCustomProperties

Planned failover model custom properties.

PlannedFailoverModelProperties

Planned failover model properties.

Policy

Interface representing a Policy.

PolicyCreateOptionalParams

Optional parameters.

PolicyDeleteHeaders

Defines headers for Policy_delete operation.

PolicyDeleteOptionalParams

Optional parameters.

PolicyGetOptionalParams

Optional parameters.

PolicyListNextOptionalParams

Optional parameters.

PolicyListOptionalParams

Optional parameters.

PolicyModel

Policy model.

PolicyModelCollection

Policy model collection.

PolicyModelCustomProperties

Policy model custom properties.

PolicyModelProperties

Policy model properties.

PolicyModelSystemData

System data required to be defined for Azure resources.

PolicyOperationStatus

Interface representing a PolicyOperationStatus.

PolicyOperationStatusGetOptionalParams

Optional parameters.

ProtectedItem

Interface representing a ProtectedItem.

ProtectedItemCreateOptionalParams

Optional parameters.

ProtectedItemDeleteHeaders

Defines headers for ProtectedItem_delete operation.

ProtectedItemDeleteOptionalParams

Optional parameters.

ProtectedItemDynamicMemoryConfig

Protected item dynamic memory config.

ProtectedItemGetOptionalParams

Optional parameters.

ProtectedItemJobProperties

Protected item job properties.

ProtectedItemListNextOptionalParams

Optional parameters.

ProtectedItemListOptionalParams

Optional parameters.

ProtectedItemModel

Protected item model.

ProtectedItemModelCollection

Protected item model collection.

ProtectedItemModelCustomProperties

Protected item model custom properties.

ProtectedItemModelProperties

Protected item model properties.

ProtectedItemModelPropertiesCurrentJob

Protected item job properties.

ProtectedItemModelPropertiesLastFailedEnableProtectionJob

Protected item job properties.

ProtectedItemModelPropertiesLastFailedPlannedFailoverJob

Protected item job properties.

ProtectedItemModelPropertiesLastTestFailoverJob

Protected item job properties.

ProtectedItemModelSystemData

System data required to be defined for Azure resources.

ProtectedItemOperationStatus

Interface representing a ProtectedItemOperationStatus.

ProtectedItemOperationStatusGetOptionalParams

Optional parameters.

ProtectedItemPlannedFailoverHeaders

Defines headers for ProtectedItem_plannedFailover operation.

ProtectedItemPlannedFailoverOptionalParams

Optional parameters.

RecoveryPointModel

Recovery point model.

RecoveryPointModelCollection

Recovery point model collection.

RecoveryPointModelCustomProperties

Recovery point model custom properties.

RecoveryPointModelProperties

Recovery point model properties.

RecoveryPointModelSystemData

System data required to be defined for Azure resources.

RecoveryPoints

Interface representing a RecoveryPoints.

RecoveryPointsGetOptionalParams

Optional parameters.

RecoveryPointsListNextOptionalParams

Optional parameters.

RecoveryPointsListOptionalParams

Optional parameters.

ReplicationExtension

Interface representing a ReplicationExtension.

ReplicationExtensionCreateOptionalParams

Optional parameters.

ReplicationExtensionDeleteHeaders

Defines headers for ReplicationExtension_delete operation.

ReplicationExtensionDeleteOptionalParams

Optional parameters.

ReplicationExtensionGetOptionalParams

Optional parameters.

ReplicationExtensionListNextOptionalParams

Optional parameters.

ReplicationExtensionListOptionalParams

Optional parameters.

ReplicationExtensionModel

Replication extension model.

ReplicationExtensionModelCollection

Replication extension model collection.

ReplicationExtensionModelCustomProperties

Replication extension model custom properties.

ReplicationExtensionModelProperties

Replication extension model properties.

ReplicationExtensionModelSystemData

System data required to be defined for Azure resources.

ReplicationExtensionOperationStatus

Interface representing a ReplicationExtensionOperationStatus.

ReplicationExtensionOperationStatusGetOptionalParams

Optional parameters.

StorageContainerProperties

Storage container properties.

SystemDataModel

System data required to be defined for Azure resources.

TaskModel

Task model.

TaskModelCustomProperties

Task model custom properties.

TestFailoverCleanupWorkflowModelCustomProperties

Test failover cleanup workflow model custom properties.

TestFailoverWorkflowModelCustomProperties

Test failover workflow model custom properties.

VMwareDraModelCustomProperties

VMware DRA model custom properties.

VMwareMigrateFabricModelCustomProperties

VMware migrate fabric model custom properties.

VMwareToAzStackHCIDiskInput

VMwareToAzStack disk input.

VMwareToAzStackHCINicInput

VMwareToAzStackHCI NIC properties.

VMwareToAzStackHCIPlannedFailoverModelCustomProperties

VMware to AzStackHCI planned failover model custom properties.

VMwareToAzStackHCIPolicyModelCustomProperties

VMware To AzStackHCI Policy model custom properties.

VMwareToAzStackHCIProtectedDiskProperties

VMwareToAzStackHCI protected disk properties.

VMwareToAzStackHCIProtectedItemModelCustomProperties

VMware to AzStackHCI Protected item model custom properties.

VMwareToAzStackHCIProtectedNicProperties

VMwareToAzStackHCI NIC properties.

VMwareToAzStackHCIReplicationExtensionModelCustomProperties

VMware to AzStackHCI Replication extension model custom properties.

Vault

Interface representing a Vault.

VaultCreateOptionalParams

Optional parameters.

VaultDeleteHeaders

Defines headers for Vault_delete operation.

VaultDeleteOptionalParams

Optional parameters.

VaultGetOptionalParams

Optional parameters.

VaultListBySubscriptionNextOptionalParams

Optional parameters.

VaultListBySubscriptionOptionalParams

Optional parameters.

VaultListNextOptionalParams

Optional parameters.

VaultListOptionalParams

Optional parameters.

VaultModel

Vault model.

VaultModelCollection

Vault model collection.

VaultModelProperties

Vault properties.

VaultModelSystemData

System data required to be defined for Azure resources.

VaultModelUpdate

Vault model for update.

VaultModelUpdateSystemData

System data required to be defined for Azure resources.

VaultOperationStatus

Interface representing a VaultOperationStatus.

VaultOperationStatusGetOptionalParams

Optional parameters.

VaultUpdateHeaders

Defines headers for Vault_update operation.

VaultUpdateOptionalParams

Optional parameters.

Workflow

Interface representing a Workflow.

WorkflowGetOptionalParams

Optional parameters.

WorkflowListNextOptionalParams

Optional parameters.

WorkflowListOptionalParams

Optional parameters.

WorkflowModel

Workflow model.

WorkflowModelCollection

Workflow model collection.

WorkflowModelCustomProperties

Workflow model custom properties.

WorkflowModelProperties

Workflow model properties.

WorkflowModelSystemData

System data required to be defined for Azure resources.

WorkflowOperationStatus

Interface representing a WorkflowOperationStatus.

WorkflowOperationStatusGetOptionalParams

Optional parameters.

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

CheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

DeploymentPreflightResponse

Contains response data for the deploymentPreflight operation.

DraCreateResponse

Contains response data for the create operation.

DraDeleteResponse

Contains response data for the delete operation.

DraGetResponse

Contains response data for the get operation.

DraListNextResponse

Contains response data for the listNext operation.

DraListResponse

Contains response data for the list operation.

DraModelCustomPropertiesUnion
DraOperationStatusGetResponse

Contains response data for the get operation.

EmailConfigurationCreateResponse

Contains response data for the create operation.

EmailConfigurationGetResponse

Contains response data for the get operation.

EmailConfigurationListNextResponse

Contains response data for the listNext operation.

EmailConfigurationListResponse

Contains response data for the list operation.

EventGetResponse

Contains response data for the get operation.

EventListNextResponse

Contains response data for the listNext operation.

EventListResponse

Contains response data for the list operation.

EventModelCustomPropertiesUnion
FabricCreateResponse

Contains response data for the create operation.

FabricDeleteResponse

Contains response data for the delete operation.

FabricGetResponse

Contains response data for the get operation.

FabricListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

FabricListBySubscriptionResponse

Contains response data for the listBySubscription operation.

FabricListNextResponse

Contains response data for the listNext operation.

FabricListResponse

Contains response data for the list operation.

FabricModelCustomPropertiesUnion
FabricOperationsStatusGetResponse

Contains response data for the get operation.

FabricUpdateResponse

Contains response data for the update operation.

HealthStatus

Defines values for HealthStatus.
KnownHealthStatus can be used interchangeably with HealthStatus, this enum contains the known values that the service supports.

Known values supported by the service

Normal
Warning
Critical

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

PlannedFailoverModelCustomPropertiesUnion
PolicyCreateResponse

Contains response data for the create operation.

PolicyDeleteResponse

Contains response data for the delete operation.

PolicyGetResponse

Contains response data for the get operation.

PolicyListNextResponse

Contains response data for the listNext operation.

PolicyListResponse

Contains response data for the list operation.

PolicyModelCustomPropertiesUnion
PolicyOperationStatusGetResponse

Contains response data for the get operation.

ProtectedItemActiveLocation

Defines values for ProtectedItemActiveLocation.
KnownProtectedItemActiveLocation can be used interchangeably with ProtectedItemActiveLocation, this enum contains the known values that the service supports.

Known values supported by the service

Primary
Recovery

ProtectedItemCreateResponse

Contains response data for the create operation.

ProtectedItemDeleteResponse

Contains response data for the delete operation.

ProtectedItemGetResponse

Contains response data for the get operation.

ProtectedItemListNextResponse

Contains response data for the listNext operation.

ProtectedItemListResponse

Contains response data for the list operation.

ProtectedItemModelCustomPropertiesUnion
ProtectedItemOperationStatusGetResponse

Contains response data for the get operation.

ProtectedItemPlannedFailoverResponse

Contains response data for the plannedFailover operation.

ProtectionState

Defines values for ProtectionState.
KnownProtectionState can be used interchangeably with ProtectionState, this enum contains the known values that the service supports.

Known values supported by the service

UnprotectedStatesBegin
EnablingProtection
EnablingFailed
DisablingProtection
MarkedForDeletion
DisablingFailed
UnprotectedStatesEnd
InitialReplicationStatesBegin
InitialReplicationInProgress
InitialReplicationCompletedOnPrimary
InitialReplicationCompletedOnRecovery
InitialReplicationFailed
InitialReplicationStatesEnd
ProtectedStatesBegin
Protected
ProtectedStatesEnd
PlannedFailoverTransitionStatesBegin
PlannedFailoverInitiated
PlannedFailoverCompleting
PlannedFailoverCompleted
PlannedFailoverFailed
PlannedFailoverCompletionFailed
PlannedFailoverTransitionStatesEnd
UnplannedFailoverTransitionStatesBegin
UnplannedFailoverInitiated
UnplannedFailoverCompleting
UnplannedFailoverCompleted
UnplannedFailoverFailed
UnplannedFailoverCompletionFailed
UnplannedFailoverTransitionStatesEnd
CommitFailoverStatesBegin
CommitFailoverInProgressOnPrimary
CommitFailoverInProgressOnRecovery
CommitFailoverCompleted
CommitFailoverFailedOnPrimary
CommitFailoverFailedOnRecovery
CommitFailoverStatesEnd
CancelFailoverStatesBegin
CancelFailoverInProgressOnPrimary
CancelFailoverInProgressOnRecovery
CancelFailoverFailedOnPrimary
CancelFailoverFailedOnRecovery
CancelFailoverStatesEnd
ChangeRecoveryPointStatesBegin
ChangeRecoveryPointInitiated
ChangeRecoveryPointCompleted
ChangeRecoveryPointFailed
ChangeRecoveryPointStatesEnd
ReprotectStatesBegin
ReprotectInitiated
ReprotectFailed
ReprotectStatesEnd

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

Canceled
Creating
Deleting
Deleted
Failed
Succeeded
Updating

RecoveryPointModelCustomPropertiesUnion
RecoveryPointType

Defines values for RecoveryPointType.
KnownRecoveryPointType can be used interchangeably with RecoveryPointType, this enum contains the known values that the service supports.

Known values supported by the service

ApplicationConsistent
CrashConsistent

RecoveryPointsGetResponse

Contains response data for the get operation.

RecoveryPointsListNextResponse

Contains response data for the listNext operation.

RecoveryPointsListResponse

Contains response data for the list operation.

ReplicationExtensionCreateResponse

Contains response data for the create operation.

ReplicationExtensionDeleteResponse

Contains response data for the delete operation.

ReplicationExtensionGetResponse

Contains response data for the get operation.

ReplicationExtensionListNextResponse

Contains response data for the listNext operation.

ReplicationExtensionListResponse

Contains response data for the list operation.

ReplicationExtensionModelCustomPropertiesUnion
ReplicationExtensionOperationStatusGetResponse

Contains response data for the get operation.

ReplicationVaultType

Defines values for ReplicationVaultType.
KnownReplicationVaultType can be used interchangeably with ReplicationVaultType, this enum contains the known values that the service supports.

Known values supported by the service

DisasterRecovery
Migrate

ResynchronizationState

Defines values for ResynchronizationState.
KnownResynchronizationState can be used interchangeably with ResynchronizationState, this enum contains the known values that the service supports.

Known values supported by the service

None
ResynchronizationInitiated
ResynchronizationCompleted
ResynchronizationFailed

TaskState

Defines values for TaskState.
KnownTaskState can be used interchangeably with TaskState, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Started
Succeeded
Failed
Cancelled
Skipped

TestFailoverState

Defines values for TestFailoverState.
KnownTestFailoverState can be used interchangeably with TestFailoverState, this enum contains the known values that the service supports.

Known values supported by the service

None
TestFailoverInitiated
TestFailoverCompleting
TestFailoverCompleted
TestFailoverFailed
TestFailoverCompletionFailed
TestFailoverCleanupInitiated
TestFailoverCleanupCompleting
MarkedForDeletion

VMNicSelection

Defines values for VMNicSelection.
KnownVMNicSelection can be used interchangeably with VMNicSelection, this enum contains the known values that the service supports.

Known values supported by the service

NotSelected
SelectedByUser
SelectedByDefault
SelectedByUserOverride

VMwareToAzureMigrateResyncState

Defines values for VMwareToAzureMigrateResyncState.
KnownVMwareToAzureMigrateResyncState can be used interchangeably with VMwareToAzureMigrateResyncState, this enum contains the known values that the service supports.

Known values supported by the service

None
PreparedForResynchronization
StartedResynchronization

VaultCreateResponse

Contains response data for the create operation.

VaultDeleteResponse

Contains response data for the delete operation.

VaultGetResponse

Contains response data for the get operation.

VaultListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

VaultListBySubscriptionResponse

Contains response data for the listBySubscription operation.

VaultListNextResponse

Contains response data for the listNext operation.

VaultListResponse

Contains response data for the list operation.

VaultOperationStatusGetResponse

Contains response data for the get operation.

VaultUpdateResponse

Contains response data for the update operation.

WorkflowGetResponse

Contains response data for the get operation.

WorkflowListNextResponse

Contains response data for the listNext operation.

WorkflowListResponse

Contains response data for the list operation.

WorkflowModelCustomPropertiesUnion
WorkflowObjectType

Defines values for WorkflowObjectType.
KnownWorkflowObjectType can be used interchangeably with WorkflowObjectType, this enum contains the known values that the service supports.

Known values supported by the service

AvsDiskPool
Dra
Fabric
Policy
ProtectedItem
RecoveryPlan
ReplicationExtension
Vault

WorkflowOperationStatusGetResponse

Contains response data for the get operation.

WorkflowState

Defines values for WorkflowState.
KnownWorkflowState can be used interchangeably with WorkflowState, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Started
Cancelling
Succeeded
Failed
Cancelled
CompletedWithInformation
CompletedWithWarnings
CompletedWithErrors

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownHealthStatus

Known values of HealthStatus that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownProtectedItemActiveLocation

Known values of ProtectedItemActiveLocation that the service accepts.

KnownProtectionState

Known values of ProtectionState that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownRecoveryPointType

Known values of RecoveryPointType that the service accepts.

KnownReplicationVaultType

Known values of ReplicationVaultType that the service accepts.

KnownResynchronizationState

Known values of ResynchronizationState that the service accepts.

KnownTaskState

Known values of TaskState that the service accepts.

KnownTestFailoverState

Known values of TestFailoverState that the service accepts.

KnownVMNicSelection

Known values of VMNicSelection that the service accepts.

KnownVMwareToAzureMigrateResyncState

Known values of VMwareToAzureMigrateResyncState that the service accepts.

KnownWorkflowObjectType

Known values of WorkflowObjectType that the service accepts.

KnownWorkflowState

Known values of WorkflowState 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.