@azure/arm-recoveryservicesdatareplication package
Interfaces
AffectedObjectDetails |
Details of the affected object. |
AzStackHCIClusterProperties |
AzStackHCI cluster properties. |
AzStackHCIFabricModelCustomProperties |
AzStackHCI fabric model custom properties. |
AzureSiteRecoveryManagementServiceAPIOptionalParams |
Optional parameters for the client. |
CheckNameAvailabilityModel |
Check name availability model. |
CheckNameAvailabilityOperations |
Interface representing a CheckNameAvailability operations. |
CheckNameAvailabilityPostOptionalParams |
Optional parameters. |
CheckNameAvailabilityResponseModel |
Check name availability response model. |
ConnectionDetails |
Private endpoint connection details at member level. |
DeploymentPreflightModel |
Deployment preflight model. |
DeploymentPreflightOperations |
Interface representing a DeploymentPreflight operations. |
DeploymentPreflightPostOptionalParams |
Optional parameters. |
DeploymentPreflightResource |
Deployment preflight resource. |
DiskControllerInputs |
Disk controller. |
EmailConfigurationCreateOptionalParams |
Optional parameters. |
EmailConfigurationGetOptionalParams |
Optional parameters. |
EmailConfigurationListOptionalParams |
Optional parameters. |
EmailConfigurationModel |
Email configuration model. |
EmailConfigurationModelProperties |
Email configuration model properties. |
EmailConfigurationOperations |
Interface representing a EmailConfiguration operations. |
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. |
EventGetOptionalParams |
Optional parameters. |
EventListOptionalParams |
Optional parameters. |
EventModel |
Event model. |
EventModelCustomProperties |
Event model custom properties. |
EventModelProperties |
Event model properties. |
EventOperations |
Interface representing a Event operations. |
FabricAgentCreateOptionalParams |
Optional parameters. |
FabricAgentDeleteOptionalParams |
Optional parameters. |
FabricAgentGetOptionalParams |
Optional parameters. |
FabricAgentListOptionalParams |
Optional parameters. |
FabricAgentModel |
Fabric agent model. |
FabricAgentModelCustomProperties |
Fabric agent model custom properties. |
FabricAgentModelProperties |
Fabric agent model properties. |
FabricAgentOperations |
Interface representing a FabricAgent operations. |
FabricCreateOptionalParams |
Optional parameters. |
FabricDeleteOptionalParams |
Optional parameters. |
FabricGetOptionalParams |
Optional parameters. |
FabricListBySubscriptionOptionalParams |
Optional parameters. |
FabricListOptionalParams |
Optional parameters. |
FabricModel |
Fabric model. |
FabricModelCustomProperties |
Fabric model custom properties. |
FabricModelProperties |
Fabric model properties. |
FabricModelUpdate |
Fabric model update. |
FabricOperations |
Interface representing a Fabric operations. |
FabricUpdateOptionalParams |
Optional parameters. |
FailoverJobModelCustomProperties |
Failover job model custom properties. |
FailoverProtectedItemProperties |
Failover properties of the protected item. |
GroupConnectivityInformation |
Represents of a connection's group information. |
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. |
HyperVToAzStackHCIProtectedItemModelCustomPropertiesUpdate |
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. |
JobGetOptionalParams |
Optional parameters. |
JobListOptionalParams |
Optional parameters. |
JobModel |
Job model. |
JobModelCustomProperties |
Job model custom properties. |
JobModelProperties |
Job model properties. |
JobOperations |
Interface representing a Job operations. |
LocationBasedOperationResultsGetOptionalParams |
Optional parameters. |
LocationBasedOperationResultsOperations |
Interface representing a LocationBasedOperationResults operations. |
ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
OperationDisplay |
Localized display information for and operation. |
OperationResultsGetOptionalParams |
Optional parameters. |
OperationResultsOperations |
Interface representing a OperationResults operations. |
OperationStatus |
Defines the operation status. |
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. |
PlannedFailoverModel |
Planned failover model. |
PlannedFailoverModelCustomProperties |
Planned failover model custom properties. |
PlannedFailoverModelProperties |
Planned failover model properties. |
PolicyCreateOptionalParams |
Optional parameters. |
PolicyDeleteOptionalParams |
Optional parameters. |
PolicyGetOptionalParams |
Optional parameters. |
PolicyListOptionalParams |
Optional parameters. |
PolicyModel |
Policy model. |
PolicyModelCustomProperties |
Policy model custom properties. |
PolicyModelProperties |
Policy model properties. |
PolicyOperations |
Interface representing a Policy operations. |
PrivateEndpoint |
Represent private Endpoint network resource that is linked to the Private Endpoint connection. |
PrivateEndpointConnection |
Represents private endpoint connection. |
PrivateEndpointConnectionProxiesCreateOptionalParams |
Optional parameters. |
PrivateEndpointConnectionProxiesDeleteOptionalParams |
Optional parameters. |
PrivateEndpointConnectionProxiesGetOptionalParams |
Optional parameters. |
PrivateEndpointConnectionProxiesListOptionalParams |
Optional parameters. |
PrivateEndpointConnectionProxiesOperations |
Interface representing a PrivateEndpointConnectionProxies operations. |
PrivateEndpointConnectionProxiesValidateOptionalParams |
Optional parameters. |
PrivateEndpointConnectionProxy |
Represents private endpoint connection proxy request. |
PrivateEndpointConnectionProxyProperties |
Represents private endpoint connection proxy request. |
PrivateEndpointConnectionResponseProperties |
Represents Private endpoint connection response properties. |
PrivateEndpointConnectionsDeleteOptionalParams |
Optional parameters. |
PrivateEndpointConnectionsGetOptionalParams |
Optional parameters. |
PrivateEndpointConnectionsListOptionalParams |
Optional parameters. |
PrivateEndpointConnectionsOperations |
Interface representing a PrivateEndpointConnections operations. |
PrivateEndpointConnectionsUpdateOptionalParams |
Optional parameters. |
PrivateLinkResource |
Represents private link resource. |
PrivateLinkResourceProperties |
Represents private link resource properties. |
PrivateLinkResourcesGetOptionalParams |
Optional parameters. |
PrivateLinkResourcesListOptionalParams |
Optional parameters. |
PrivateLinkResourcesOperations |
Interface representing a PrivateLinkResources operations. |
PrivateLinkServiceConnection |
Represents of an NRP private link service connection. |
PrivateLinkServiceConnectionState |
Represents Private link service connection state. |
PrivateLinkServiceProxy |
Represents NRP private link service proxy. |
ProtectedItemCreateOptionalParams |
Optional parameters. |
ProtectedItemDeleteOptionalParams |
Optional parameters. |
ProtectedItemDynamicMemoryConfig |
Protected item dynamic memory config. |
ProtectedItemGetOptionalParams |
Optional parameters. |
ProtectedItemJobProperties |
Protected item job properties. |
ProtectedItemListOptionalParams |
Optional parameters. |
ProtectedItemModel |
Protected item model. |
ProtectedItemModelCustomProperties |
Protected item model custom properties. |
ProtectedItemModelCustomPropertiesUpdate |
Protected item model custom properties. |
ProtectedItemModelProperties |
Protected item model properties. |
ProtectedItemModelPropertiesUpdate |
Protected item model properties update. |
ProtectedItemModelUpdate |
Protected item model update. |
ProtectedItemOperations |
Interface representing a ProtectedItem operations. |
ProtectedItemPlannedFailoverOptionalParams |
Optional parameters. |
ProtectedItemUpdateOptionalParams |
Optional parameters. |
ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
RecoveryPointGetOptionalParams |
Optional parameters. |
RecoveryPointListOptionalParams |
Optional parameters. |
RecoveryPointModel |
Recovery point model. |
RecoveryPointModelCustomProperties |
Recovery point model custom properties. |
RecoveryPointModelProperties |
Recovery point model properties. |
RecoveryPointOperations |
Interface representing a RecoveryPoint operations. |
RemotePrivateEndpoint |
Represent remote private endpoint information for the private endpoint connection proxy. |
RemotePrivateEndpointConnection |
Represent remote private endpoint connection. |
ReplicationExtensionCreateOptionalParams |
Optional parameters. |
ReplicationExtensionDeleteOptionalParams |
Optional parameters. |
ReplicationExtensionGetOptionalParams |
Optional parameters. |
ReplicationExtensionListOptionalParams |
Optional parameters. |
ReplicationExtensionModel |
Replication extension model. |
ReplicationExtensionModelCustomProperties |
Replication extension model custom properties. |
ReplicationExtensionModelProperties |
Replication extension model properties. |
ReplicationExtensionOperations |
Interface representing a ReplicationExtension operations. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
RestorePollerOptions | |
StorageContainerProperties |
Storage container properties. |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
TaskModel |
Task model. |
TaskModelCustomProperties |
Task model custom properties. |
TestFailoverCleanupJobModelCustomProperties |
Test failover cleanup job model custom properties. |
TestFailoverJobModelCustomProperties |
Test failover job model custom properties. |
TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
UserAssignedIdentity |
User assigned identity properties |
VMwareFabricAgentModelCustomProperties |
VMware fabric agent model custom properties. |
VMwareMigrateFabricModelCustomProperties |
VMware migrate fabric model custom properties. |
VMwareToAzStackHCIDiskInput |
VMwareToAzStack disk input. |
VMwareToAzStackHCIEventModelCustomProperties |
VMware 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. |
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. |
VMwareToAzStackHCIProtectedItemModelCustomPropertiesUpdate |
VMware to AzStackHCI Protected item model custom properties. |
VMwareToAzStackHCIProtectedNicProperties |
VMwareToAzStackHCI NIC properties. |
VMwareToAzStackHCIRecoveryPointModelCustomProperties |
VMware to AzStackHCI recovery point model custom properties. |
VMwareToAzStackHCIReplicationExtensionModelCustomProperties |
VMware to AzStackHCI Replication extension model custom properties. |
VaultCreateOptionalParams |
Optional parameters. |
VaultDeleteOptionalParams |
Optional parameters. |
VaultGetOptionalParams |
Optional parameters. |
VaultIdentityModel |
Vault model. |
VaultListBySubscriptionOptionalParams |
Optional parameters. |
VaultListOptionalParams |
Optional parameters. |
VaultModel |
Vault model. |
VaultModelProperties |
Vault properties. |
VaultModelUpdate |
Vault model update. |
VaultOperations |
Interface representing a Vault operations. |
VaultUpdateOptionalParams |
Optional parameters. |
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. |
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. |
EventModelCustomPropertiesUnion |
Alias for EventModelCustomPropertiesUnion |
FabricAgentModelCustomPropertiesUnion |
Alias for FabricAgentModelCustomPropertiesUnion |
FabricModelCustomPropertiesUnion |
Alias for FabricModelCustomPropertiesUnion |
HealthStatus |
Gets or sets the fabric health. Known values supported by the serviceNormal: Healthy Status. |
JobModelCustomPropertiesUnion |
Alias for JobModelCustomPropertiesUnion |
JobObjectType |
Gets or sets the object type. Known values supported by the serviceAvsDiskPool: AVS disk pool. |
JobState |
Gets or sets the job state. Known values supported by the servicePending: Job has not been started. |
ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
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. |
PlannedFailoverModelCustomPropertiesUnion |
Alias for PlannedFailoverModelCustomPropertiesUnion |
PolicyModelCustomPropertiesUnion |
Alias for PolicyModelCustomPropertiesUnion |
PrivateEndpointConnectionStatus |
Gets or sets the status. Known values supported by the serviceApproved: Approved Status. |
ProtectedItemActiveLocation |
Gets or sets the location of the protected item. Known values supported by the servicePrimary: Protected item is active on Primary. |
ProtectedItemModelCustomPropertiesUnion |
Alias for ProtectedItemModelCustomPropertiesUnion |
ProtectedItemModelCustomPropertiesUpdateUnion |
Alias for ProtectedItemModelCustomPropertiesUpdateUnion |
ProtectionState |
Gets or sets the protection state. Known values supported by the serviceUnprotectedStatesBegin: Begin marker for unprotected states. |
ProvisioningState |
Gets or sets the provisioning state of the email configuration. Known values supported by the serviceCanceled: Resource creation has been canceled |
RecoveryPointModelCustomPropertiesUnion |
Alias for RecoveryPointModelCustomPropertiesUnion |
RecoveryPointType |
Gets or sets the recovery point type. Known values supported by the serviceApplicationConsistent: Application consistent recovery point. |
ReplicationExtensionModelCustomPropertiesUnion |
Alias for ReplicationExtensionModelCustomPropertiesUnion |
ReplicationVaultType |
Gets or sets the type of vault. Known values supported by the serviceDisasterRecovery: Disaster recovery vault. |
ResynchronizationState |
Gets or sets the resynchronization state. Known values supported by the serviceNone: Resynchronization is not active. |
TaskState |
Gets or sets the task state. Known values supported by the servicePending: Task has not been started. |
TestFailoverState |
Gets or sets the test failover state. Known values supported by the serviceNone: Test failover is not active. |
VMNicSelection |
Gets or sets the selection type of the NIC. Known values supported by the serviceNotSelected: Not Selected. |
VMwareToAzureMigrateResyncState |
Gets or sets the resync state. Known values supported by the serviceNone: None state. |
VaultIdentityType |
Gets or sets the identityType which can be either SystemAssigned or None. Known values supported by the serviceNone: No identity. |
Enums
KnownActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
KnownCreatedByType |
The kind of entity that created the resource. |
KnownHealthStatus |
Gets or sets the fabric health. |
KnownJobObjectType |
Gets or sets the object type. |
KnownJobState |
Gets or sets the job state. |
KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
KnownOrigin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" |
KnownPrivateEndpointConnectionStatus |
Gets or sets the status. |
KnownProtectedItemActiveLocation |
Gets or sets the location of the protected item. |
KnownProtectionState |
Gets or sets the protection state. |
KnownProvisioningState |
Gets or sets the provisioning state of the email configuration. |
KnownRecoveryPointType |
Gets or sets the recovery point type. |
KnownReplicationVaultType |
Gets or sets the type of vault. |
KnownResynchronizationState |
Gets or sets the resynchronization state. |
KnownTaskState |
Gets or sets the task state. |
KnownTestFailoverState |
Gets or sets the test failover state. |
KnownVMNicSelection |
Gets or sets the selection type of the NIC. |
KnownVMwareToAzureMigrateResyncState |
Gets or sets the resync state. |
KnownVaultIdentityType |
Gets or sets the identityType which can be either SystemAssigned or None. |
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>(AzureSiteRecoveryManagementServiceAPI, 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: AzureSiteRecoveryManagementServiceAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>