@azure/arm-resiliencemanagement package

Classes

AzureResilienceManagementClient

Interfaces

AddOrUpdateResourcesRequest	Request body of the AddOrUpdateResources API.
ArmResponseErrorResponse	Azure operation completed successfully.
AssetPropertiesOfDrill	Drill asset properties.
AssociatedIdentity	Definition of associated identity linked with the various resources.
AttentionReason	Reason why the Drill is in NeedsAttention state, and not ready to run.
AzureResilienceManagementClientOptionalParams	Optional parameters for the client.
ChaosResourcePropertiesOfDrill	Chaos Resource properties.
CustomFaultDetails	Custom fault details
DiskReprotectInputDetails	Disk Reprotect Input Details
Drill	Drill resource
DrillEndRequest	Request body of the End Action of Drill.
DrillProperties	Properties of the Resiliency Drill.
DrillResource	Drill Resource
DrillResourceAttentionReason	Reason why the Drill resource is in NeedsAttention state.
DrillResourceProperties	Properties of the Resiliency Drill Resource
DrillResourcesGetOptionalParams	Optional parameters.
DrillResourcesListOptionalParams	Optional parameters.
DrillResourcesOperations	Interface representing a DrillResources operations.
DrillRun	DrillRun resource.
DrillRunAddNotesRequest	Request body for AddNotes API.
DrillRunFailoverRequest	Request body for Failover API.
DrillRunProperties	Properties of the Resiliency DrillRun.
DrillRunResource	Represents a Drill Run job resource in the Azure Resilience Management provider namespace.
DrillRunResourceProperties	Properties of a Drill Run resource.
DrillRunResourcesGetOptionalParams	Optional parameters.
DrillRunResourcesListOptionalParams	Optional parameters.
DrillRunResourcesOperations	Interface representing a DrillRunResources operations.
DrillRunsAddNotesOptionalParams	Optional parameters.
DrillRunsFailOverOptionalParams	Optional parameters.
DrillRunsGetOptionalParams	Optional parameters.
DrillRunsListOptionalParams	Optional parameters.
DrillRunsMarkAsCompleteOptionalParams	Optional parameters.
DrillRunsOperations	Interface representing a DrillRuns operations.
DrillRunsReprotectOptionalParams	Optional parameters.
DrillRunsResumeOptionalParams	Optional parameters.
DrillStartRequest	Request body of the Start Action of Drill.
DrillUpdate	The type used for update operations of the Drill.
DrillUpdateProperties	The updatable properties of the Drill.
DrillsAddOrUpdateResourcesOptionalParams	Optional parameters.
DrillsCreateOptionalParams	Optional parameters.
DrillsDeleteOptionalParams	Optional parameters.
DrillsEndOptionalParams	Optional parameters.
DrillsGetOptionalParams	Optional parameters.
DrillsListOptionalParams	Optional parameters.
DrillsOperations	Interface representing a Drills operations.
DrillsResyncReadinessCheckOptionalParams	Optional parameters.
DrillsStartOptionalParams	Optional parameters.
DrillsUpdateOptionalParams	Optional parameters.
DrillsValidateForExecutionOptionalParams	Optional parameters.
Enrollment	An enrollment that links a usage plan to a service group.
EnrollmentProperties	Definition of enrollment properties.
EnrollmentsCreateOrUpdateOptionalParams	Optional parameters.
EnrollmentsDeleteOptionalParams	Optional parameters.
EnrollmentsGetOptionalParams	Optional parameters.
EnrollmentsListOptionalParams	Optional parameters.
EnrollmentsOperations	Interface representing a Enrollments operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorDetails	Errors in T&C / RBAC assignment.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExecutionConfigurations	Execution configurations for recovery action.
FailoverRequest	Failover post action request.
FailoverRequestProperties	Additional properties for Failover.
FaultDetails	Fault Details
FaultProperties	Fault Properties
GoalAssignment	Goal assignment a AzureResilienceProviderHub resource
GoalAssignmentProperties	Definition of goal assignment property.
GoalAssignmentsCreateOrUpdateOptionalParams	Optional parameters.
GoalAssignmentsDeleteOptionalParams	Optional parameters.
GoalAssignmentsGetOptionalParams	Optional parameters.
GoalAssignmentsListOptionalParams	Optional parameters.
GoalAssignmentsOperations	Interface representing a GoalAssignments operations.
GoalAssignmentsRecommendCapacityOptionalParams	Optional parameters.
GoalAssignmentsRefreshGoalResourcesOptionalParams	Optional parameters.
GoalAssignmentsUpdateGoalResourcesOptionalParams	Optional parameters.
GoalAssignmentsUpdateOptionalParams	Optional parameters.
GoalResource	Goal Resource a AzureResilienceProviderHub resource
GoalResourceProperties	Definition of goal assignment property.
GoalResourcesGetOptionalParams	Optional parameters.
GoalResourcesListOptionalParams	Optional parameters.
GoalResourcesOperations	Interface representing a GoalResources operations.
GoalTemplate	Goal template a AzureResilienceProviderHub resource
GoalTemplateProperties	Definition of goal template property.
GoalTemplatesCreateOrUpdateOptionalParams	Optional parameters.
GoalTemplatesDeleteOptionalParams	Optional parameters.
GoalTemplatesGetOptionalParams	Optional parameters.
GoalTemplatesListOptionalParams	Optional parameters.
GoalTemplatesOperations	Interface representing a GoalTemplates operations.
GoalTemplatesUpdateOptionalParams	Optional parameters.
GoalsData	Definition of goals data in unified resilience item.
IncludeOrUpdateResource	Include or Update resource
JobErrorInfo	Job Error information.
JobExtendedInfo	Additional information for job.
JobProperties	Definition of a job, including its type, status, timing, and additional details.
JobResourceProperties	Definition of job-resource.
JobRetryDetails	Job Retry Details.
JobTaskDetail	Job task details.
JobUserComment	Job User's Comment.
LastRunProperties	Definition of Last Run properties.
ManagedOnBehalfOfConfiguration	Configuration of the managed on behalf of resource.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
MarkAsCompleteRequest	Request body for MarkAsComplete API.
MoboBrokerResource	MoboBroker resource.
MonitoringPropertiesOfDrill	Drill monitoring properties.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationQualificationDetails	Details of qualification for an operation.
OperationStatusGetOptionalParams	Optional parameters.
OperationStatusOperations	Interface representing a OperationStatus operations.
OperationStatusResult	The current status of an async 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.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RecommendCapacityRequest	Request body for the recommend capacity action. Provide specific resource IDs to evaluate, or pass an empty array to let the service automatically select non-resilient resources from the goal assignment.
RecommendationsData	Definition of recommendations data in unified resilience item.
RecommendationsHighAvailabilityData	Definition of recommendation data related to high availability in unified resilience item.
RecoveryActionRequest	Request body for providing user input for a recovery action.
RecoveryGroup	Represents a recovery orchestration group resource in the Azure Resilience Management provider namespace.
RecoveryGroupActionSettings	Settings for a recovery group action.
RecoveryGroupBaseAction	Defines an action for the recovery orchestration group.
RecoveryGroupCustomRunbookAction	Defines a custom runbook action for the recovery orchestration group.
RecoveryGroupManualAction	Defines a manual action for the recovery orchestration group.
RecoveryGroupProperties	Properties of the recovery orchestration group.
RecoveryGroupsSetting	Settings for the recovery orchestration groups.
RecoveryJob	Represents a recovery job resource in the Azure Resilience Management provider namespace.
RecoveryJobProperties	Definition of recovery job associated with Recovery Orchestration Plan.
RecoveryJobResource	Represents a recovery orchestration job resource in the Azure Resilience Management provider namespace.
RecoveryJobResourceProperties	Properties of a recovery orchestration job resource associated with a recovery orchestration plan.
RecoveryJobResourcesGetOptionalParams	Optional parameters.
RecoveryJobResourcesListOptionalParams	Optional parameters.
RecoveryJobResourcesOperations	Interface representing a RecoveryJobResources operations.
RecoveryJobsCancelOptionalParams	Optional parameters.
RecoveryJobsGetOptionalParams	Optional parameters.
RecoveryJobsListOptionalParams	Optional parameters.
RecoveryJobsOperations	Interface representing a RecoveryJobs operations.
RecoveryJobsResumeOptionalParams	Optional parameters.
RecoveryJobsRetryOptionalParams	Optional parameters.
RecoveryPlan	Represents a recovery orchestration plan resource in the Azure Resilience Management provider namespace.
RecoveryPlanActionBaseResponse	Recovery Orchestration Plan post action response.
RecoveryPlanActionsCheckReadinessOptionalParams	Optional parameters.
RecoveryPlanActionsFailoverCommitOptionalParams	Optional parameters.
RecoveryPlanActionsFailoverOptionalParams	Optional parameters.
RecoveryPlanActionsFinalizeOptionalParams	Optional parameters.
RecoveryPlanActionsOperations	Interface representing a RecoveryPlanActions operations.
RecoveryPlanActionsReprotectOptionalParams	Optional parameters.
RecoveryPlanActionsTestFailoverCleanupOptionalParams	Optional parameters.
RecoveryPlanActionsTestFailoverOptionalParams	Optional parameters.
RecoveryPlanActionsUpdateResourcesOptionalParams	Optional parameters.
RecoveryPlanActionsValidateForFailoverCommitOptionalParams	Optional parameters.
RecoveryPlanActionsValidateForFailoverOptionalParams	Optional parameters.
RecoveryPlanActionsValidateForOperationOptionalParams	Optional parameters.
RecoveryPlanActionsValidateForReprotectOptionalParams	Optional parameters.
RecoveryPlanActionsValidateForTestFailoverCleanupOptionalParams	Optional parameters.
RecoveryPlanActionsValidateForTestFailoverOptionalParams	Optional parameters.
RecoveryPlanFailoverOperationStatus	Details of the recovery orchestration plan failover operation execution.
RecoveryPlanOperationStatus	Details of the recovery orchestration plan operation execution.
RecoveryPlanProperties	Properties of the recovery orchestration plan.
RecoveryPlanPropertiesOfDrill	RecoveryPlan properties.
RecoveryPlanUpdate	Represents a recovery orchestration plan resource in the Azure Resilience Management provider namespace.
RecoveryPlanUpdateProperties	Properties of the recovery orchestration plan that can be updated.
RecoveryPlansCreateOrUpdateOptionalParams	Optional parameters.
RecoveryPlansDeleteOptionalParams	Optional parameters.
RecoveryPlansGetOptionalParams	Optional parameters.
RecoveryPlansListOptionalParams	Optional parameters.
RecoveryPlansOperations	Interface representing a RecoveryPlans operations.
RecoveryPlansUpdateOptionalParams	Optional parameters.
RecoveryResource	RecoveryPlan Resource a AzureResilienceProviderHub resource
RecoveryResourceProperties	Definition of recovery orchestration resource property associated with recovery orchestration plan.
RecoveryResourceQualification	Details of resource and its qualification for an operation
RecoveryResourcesGetOptionalParams	Optional parameters.
RecoveryResourcesListOptionalParams	Optional parameters.
RecoveryResourcesOperations	Interface representing a RecoveryResources operations.
RegionalDrillProperties	Definition of Regional Drill properties.
ReprotectRequest	Reprotect post action request.
ReprotectRequestProperties	Additional properties for Reprotect.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceBaseProtectionSolutionSetting	Definition of recovery orchestration resource protection solution setting with recovery orchestration plan.
ResourceCustomProtectionAction	Definition of recovery resource custom action setting with Recovery Orchestration Plan.
ResourceCustomProtectionSetting	Definition of recovery orchestration resource custom protection setting with recovery orchestration plan.
ResourceLists	Add, Update, Delete resource lists
ResourceNativeProtectionSolutionSetting	Definition of recovery orchestration resource native protection solution setting with recovery orchestration plan.
ResourceProtectionSolutionSettings	Definition of recovery resource resource protection solution settings.
ResourceSiteRecoveryProtectionSetting	Definition of recovery orchestration resource protection with azure site recovery.
ResourceSiteRecoveryReprotectParams	Definition of recovery resource reprotect params for site recovery solution.
ResourceSiteRecoveryTestFailoverCleanupParams	Definition of recovery resource reprotect params for site recovery solution.
ResourceSiteRecoveryTestFailoverParams	Definition of recovery resource failover params for site recovery solution.
RestorePollerOptions
ServiceGroupMembership	Model for service group membership.
ServiceLevelResource	The Service level resource model
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SupportedVerbsForStage	Model for supported verbs for stage.
SystemData	Metadata pertaining to creation and last modification of the resource.
SystemMetadata	Internal System Metadata, to be used by internal components only.
TestFailoverCleanupRequest	TestFailoverCleanup post action request.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UnifiedResilienceItem	A unified resilience item represents a computed and aggregated resilience information of Azure Applications.
UnifiedResilienceItemProperties	Definition of unified resilience item property.
UnifiedResilienceItemsGetOptionalParams	Optional parameters.
UnifiedResilienceItemsListOptionalParams	Optional parameters.
UnifiedResilienceItemsOperations	Interface representing a UnifiedResilienceItems operations.
UpdateGoalResourceRequest	Request model for update goal resource.
UpdateRecoveryResourcesRequest	RecoveryResources post action request to update in batch.
UpdateRecoveryResourcesResponse	RecoveryResources post action request to update in batch.
UsagePlan	A usage plan resource for Resiliency feature billing.
UsagePlanProperties	Definition of usage plan properties.
UsagePlanTagsUpdate	The type used for updating tags in UsagePlan resources.
UsagePlansCreateOrUpdateOptionalParams	Optional parameters.
UsagePlansDeleteOptionalParams	Optional parameters.
UsagePlansGetOptionalParams	Optional parameters.
UsagePlansListByResourceGroupOptionalParams	Optional parameters.
UsagePlansListBySubscriptionOptionalParams	Optional parameters.
UsagePlansOperations	Interface representing a UsagePlans operations.
UsagePlansUpdateOptionalParams	Optional parameters.
UserAssignedIdentity	User assigned identity properties
UserConfirmationForHighAvailabilityItem	Represents a user confirmation for a high availability solution.
ValidateForExecutionProperties	Additional properties for Failover.
ValidateForExecutionRequest	Request body of the Validate For Execute Action of Drill.
ValidateForOperationRequest	ValidateForOperation post action request to check if operation can be performed.
ValidateForRecoveryOperationBaseResponse	ValidateForRecoveryOperation post action response.
ZonalDrillProperties	Definition of Zonal Drill properties.

Type Aliases

ActionTask	An action task type indicates the type of action task. KnownActionTask can be used interchangeably with ActionTask, this enum contains the known values that the service supports. Known values supported by the service None: No action task. PreActionTask: Pre-action task. PostActionTask: Post-action task.
ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AttestationState	Enum for the attestation status of the resource in the goal. KnownAttestationState can be used interchangeably with AttestationState, this enum contains the known values that the service supports. Known values supported by the service NotAttested: Resource is not manually attested. ManuallyAttested: Resource is manually attested.
AutoFailover	Enum for AutoFailover KnownAutoFailover can be used interchangeably with AutoFailover, this enum contains the known values that the service supports. Known values supported by the service Enable: Enable AutoFailover. Disable: Disable AutoFailover.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CommentType	The type of user comment. KnownCommentType can be used interchangeably with CommentType, this enum contains the known values that the service supports. Known values supported by the service Description: A general description comment. ResumeReason: A comment indicating the reason for resuming a job.
ConfirmationStatus	Enum for the confirmation status of a high availability solution. KnownConfirmationStatus can be used interchangeably with ConfirmationStatus, this enum contains the known values that the service supports. Known values supported by the service ApprovedByUser: The high availability solution has been approved by the user. ApprovalPending: The high availability solution is pending approval from the user. ApprovalNotNeeded: The high availability solution does not require user approval. RejectedByUser: The high availability solution has been rejected by the user.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DrillAttestation	Drill Attestation status on terminating. KnownDrillAttestation can be used interchangeably with DrillAttestation, this enum contains the known values that the service supports. Known values supported by the service Success: Drill Attestation success. Failed: Drill Attestation failure.
DrillMode	Start mode of Drill. KnownDrillMode can be used interchangeably with DrillMode, this enum contains the known values that the service supports. Known values supported by the service Failover: Failover mode.
DrillPropertiesUnion	Alias for DrillPropertiesUnion
DrillResourceFaultState	Drill Resource Fault State KnownDrillResourceFaultState can be used interchangeably with DrillResourceFaultState, this enum contains the known values that the service supports. Known values supported by the service SystemNative: Native fault available. CustomScript: Custom script based fault associated with resource. NotDefined: No fault configured for this resource.
DrillResourceInclusionState	Drill Resource Inclusion State KnownDrillResourceInclusionState can be used interchangeably with DrillResourceInclusionState, this enum contains the known values that the service supports. Known values supported by the service Excluded: Resource excluded from Drill. Included: Resource included in Drill.
DrillResourceReadinessState	Drill Resource Readiness State KnownDrillResourceReadinessState can be used interchangeably with DrillResourceReadinessState, this enum contains the known values that the service supports. Known values supported by the service Ready: Resource ready. NeedsAttention: Resource needs attention.
DrillResourceState	Drill Resource State (wrt SG and RO). KnownDrillResourceState can be used interchangeably with DrillResourceState, this enum contains the known values that the service supports. Known values supported by the service InServiceGroupNotInDrill: Resource is in SG but not part of the Drill InDrillNotInServiceGroup: Resource is in Drill but not part of the SG InRecoveryPlanNotInDrill: Resource is in RecoveryPlan but not part of the Drill InDrillNotInRecoveryPlan: Resource is in Drill but not part of the RecoveryPlan ResourceStateIncompatibleWithFault: Resource is not in a state where it can be faulted.
DrillRunOperationVerbs	Enum for DrillRun operation actions. KnownDrillRunOperationVerbs can be used interchangeably with DrillRunOperationVerbs, this enum contains the known values that the service supports. Known values supported by the service Start: Start Action. Retry: Retry Action. MarkAsComplete: MarkAsComplete Action. Cancel: Cancel Action.
DrillRunSubtasks	Enum for Drill Run Subtasks. KnownDrillRunSubtasks can be used interchangeably with DrillRunSubtasks, this enum contains the known values that the service supports. Known values supported by the service FaultInjection: FaultInjection Subtasks. Failover: Failover Subtasks. Reprotect: Reprotect Subtasks. FailoverReverse: FailoverReverse Subtasks. ReprotectReverse: ReprotectReverse Subtasks.
DrillType	Enum for Drill type object hierarchy. KnownDrillType can be used interchangeably with DrillType, this enum contains the known values that the service supports. Known values supported by the service Zonal: Zonal Drill. Regional: Regional Drill.
ExclusionReason	Enum for the reason why a resource is excluded. KnownExclusionReason can be used interchangeably with ExclusionReason, this enum contains the known values that the service supports. Known values supported by the service UserSelectedExclusion: The resource was excluded by user selection. FailedOverResource: The resource failed over and is excluded. UnsupportedResource: The resource is unsupported and excluded.
ExclusionState	Enum for the status of the resource in the goal. KnownExclusionState can be used interchangeably with ExclusionState, this enum contains the known values that the service supports. Known values supported by the service Excluded: Resource is not included in the goals. Included: Resource is excluded from the goals.
ExecutionReadinessState	Drill Execution Readiness State KnownExecutionReadinessState can be used interchangeably with ExecutionReadinessState, this enum contains the known values that the service supports. Known values supported by the service Ready: Drill is ready to run. NeedsAttention: Drill is not ready to run. Details captured in AttentionReason field.
ExecutionState	Drill Execution State KnownExecutionState can be used interchangeably with ExecutionState, this enum contains the known values that the service supports. Known values supported by the service NotRunning: Drill is not running currently. Running: Drill is running currently. Paused: Drill is paused, waiting for manual resume.
ExtensionObjectState	Enum for AttentionReason - Extension Object State. KnownExtensionObjectState can be used interchangeably with ExtensionObjectState, this enum contains the known values that the service supports. Known values supported by the service Exists: Extension object exists. NotExists: Extension object not exists.
FailoverDirectionTypes	Types of Failover directions. KnownFailoverDirectionTypes can be used interchangeably with FailoverDirectionTypes, this enum contains the known values that the service supports. Known values supported by the service FromSpecificLocations: Failover resources from specific locations.
FailoverState	A state specific to the resource that helps identify its Failover state. KnownFailoverState can be used interchangeably with FailoverState, this enum contains the known values that the service supports. Known values supported by the service None: The resource is Not in failedOver state. FailedOver: The resource is in failed-over state. FailedOverCommitPending: The resource is in failover commit pending state. FailedOverReprotectPending: The resource is in reprotect pending state.
ForceInclusionAndUpdate	Enum for ForceInclusionAndUpdate KnownForceInclusionAndUpdate can be used interchangeably with ForceInclusionAndUpdate, this enum contains the known values that the service supports. Known values supported by the service Enable: Enable ForceInclusionAndUpdate. Disable: Disable ForceInclusionAndUpdate.
GoalAssignmentType	Supported type of goal assignment. KnownGoalAssignmentType can be used interchangeably with GoalAssignmentType, this enum contains the known values that the service supports. Known values supported by the service Resiliency: Resiliency goal assignment type.
GoalType	Supported type of goal. KnownGoalType can be used interchangeably with GoalType, this enum contains the known values that the service supports. Known values supported by the service Resiliency: Resiliency goal type.
HAStatus	HA Status KnownHAStatus can be used interchangeably with HAStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled: HA enabled. NotEnabled: HA not enabled.
InitialConfig	Enum for Initial config of Drill object. KnownInitialConfig can be used interchangeably with InitialConfig, this enum contains the known values that the service supports. Known values supported by the service Pending: Initial config pending. Complete: Initial config complete.
IsoDuration	ISO 8601 duration formats. KnownIsoDuration can be used interchangeably with IsoDuration, this enum contains the known values that the service supports. Known values supported by the service PT15M: 15 minutes. PT1H: 1 hour. PT4H: 4 hours. PT24H: 24 hours.
JobPropertiesUnion	Alias for JobPropertiesUnion
JobResourcePropertiesUnion	Alias for JobResourcePropertiesUnion
JobResourceType	A job resource type indicates the kind of jobresource. KnownJobResourceType can be used interchangeably with JobResourceType, this enum contains the known values that the service supports. Known values supported by the service Invalid: Abstract job resource - invalid. RecoveryPlan: Recovery Orchestration Plan created job resource. DrillRun: Drill Run job resource.
JobStatus	Job Statuses KnownJobStatus can be used interchangeably with JobStatus, this enum contains the known values that the service supports. Known values supported by the service NotApplicable: The job status is not applicable. NotStarted: The job has not started yet. Pending: The job is pending execution, awaiting the completion of dependent stages. InProgress: The job is currently in progress. Completed: The job has been completed successfully. CompletedWithWarnings: The job has been completed with warnings. Failed: The job has failed. Skipped: The job skipped for the resource (resource not qualified or not applicable). Cancelling: The job is in the process of being cancelled. Cancelled: The job has been cancelled. Paused: The job is currently paused.
JobTriggeredBy	Job TriggeredBy KnownJobTriggeredBy can be used interchangeably with JobTriggeredBy, this enum contains the known values that the service supports. Known values supported by the service System: Triggered by the system. User: Triggered by the user.
JobType	A job type indicates the kind of job. KnownJobType can be used interchangeably with JobType, this enum contains the known values that the service supports. Known values supported by the service Invalid: Abstract job - invalid. RecoveryPlan: Recovery Orchestration Plan created job. DrillRun: Drill Oober job which represents a given instance of Drill.
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
MembershipType	Membership type of the service group to resource. KnownMembershipType can be used interchangeably with MembershipType, this enum contains the known values that the service supports. Known values supported by the service Direct: Resource is direct member of service group. ThroughSubscription: Resource is member of service group through subscription. ThroughResourceGroup: Resource is member of service group through resource group.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProvisioningState	The status of the current operation. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Provisioning: Initial provisioning in progress Updating: Update in progress Deleting: Deletion in progress Accepted: Change accepted for processing
QualificationState	A state type that indicates qualification of a resource for an operation. KnownQualificationState can be used interchangeably with QualificationState, this enum contains the known values that the service supports. Known values supported by the service Unknown: A state that indicates the qualification state is unknown. Qualified: A state that indicates the resource is qualified for the operation. NotQualified: A state that indicates the resource is not qualified for the operation. Excluded: A state that indicates the resource is excluded from the recovery plan itself.
RbacSetupMode	RBAC setup mode. KnownRbacSetupMode can be used interchangeably with RbacSetupMode, this enum contains the known values that the service supports. Known values supported by the service AutomatedCustomRole: Automated-CustomRole mode. AutomatedBuiltinRoles: Automated-BuiltinRoles mode. Manual: Manual mode.
RbacState	Enum for AttentionReason - RBAC state on a resource. KnownRbacState can be used interchangeably with RbacState, this enum contains the known values that the service supports. Known values supported by the service Set: RBAC set. NotSet: RBAC not set.
ReasonForRequestingConfirmation	Enum for the reason for requesting user confirmation for a high availability solution. KnownReasonForRequestingConfirmation can be used interchangeably with ReasonForRequestingConfirmation, this enum contains the known values that the service supports. Known values supported by the service ZonePinnedZrsDataDisksConditional: Zone pinned ZRS data disks conditional. VmInMultiZoneScaleSetStatelessOnly: VM in multi-zone scale set stateless only.
RecoveryGroupActionType	Specifies the type of recovery orchestration group actions. KnownRecoveryGroupActionType can be used interchangeably with RecoveryGroupActionType, this enum contains the known values that the service supports. Known values supported by the service ManualAction: A manual action type for the recovery orchestration group. CustomRunbook: A custom runbook action type for the recovery orchestration group.
RecoveryGroupBaseActionUnion	Alias for RecoveryGroupBaseActionUnion
RecoveryOperationNames	Defines the set of operations that can be executed on a Recovery Orchestration Plan. These operations are applicable only to resources that meet the qualification criteria. KnownRecoveryOperationNames can be used interchangeably with RecoveryOperationNames, this enum contains the known values that the service supports. Known values supported by the service Failover: Initiates a failover process to recover eligible resources to the target location. FailoverCommit: Commits the failover for resources that require an explicit commit after recovery. Reprotect: Performs re-protection or configuration changes for resources that have failed over, as required. TestFailover: Initiates a test failover process for qualified resources and those that support test failover. TestFailoverCleanup: Cleans up resources and configurations created during a test failover, as required.
RecoveryOperationStatus	Specifies the operation status for failover and validation. KnownRecoveryOperationStatus can be used interchangeably with RecoveryOperationStatus, this enum contains the known values that the service supports. Known values supported by the service NotStarted: Operation has not started or ran. ValidationInProgress: Operation is in the process of being validated. InProgress: Operation is in progress. Succeeded: Operation has completed successfully. CompletedWithWarning: Operation has completed but ran into some warning state. ValidationFailed: Operation has completed but ran into some validation error state. Failed: Operation has completed but ran into some error state. Canceled: Operation has been canceled by the user.
RecoveryPlanExclusionReason	Enum for RecoveryPlan Exclusion reason. KnownRecoveryPlanExclusionReason can be used interchangeably with RecoveryPlanExclusionReason, this enum contains the known values that the service supports. Known values supported by the service ExcludedFromRecoveryPlan: Excluded From RecoveryPlan by user. ProtectionStatus: Protection not configured.
RecoveryPlanState	Specifies the state of the recovery orchestration plan. KnownRecoveryPlanState can be used interchangeably with RecoveryPlanState, this enum contains the known values that the service supports. Known values supported by the service UnderEdit: The recovery orchestration plan is currently being edited. Warning: The recovery orchestration plan is in a warning state. Ready: The recovery orchestration plan is ready.
RecoveryPlanType	Specifies the type of recovery orchestration plan. KnownRecoveryPlanType can be used interchangeably with RecoveryPlanType, this enum contains the known values that the service supports. Known values supported by the service Regional: A recovery orchestration plan for regional resiliency. Zonal: A recovery orchestration plan for zonal resiliency.
RelativeResourceCompositionState	Enum for AttentionReason - Resource state sync between two objects. KnownRelativeResourceCompositionState can be used interchangeably with RelativeResourceCompositionState, this enum contains the known values that the service supports. Known values supported by the service InSync: Resources in sync. OutOfSync: Resources out of sync.
RequirementSelected	Enum for the requirement status of the resource in the goal. KnownRequirementSelected can be used interchangeably with RequirementSelected, this enum contains the known values that the service supports. Known values supported by the service NotRequired: The resource is not required for the specified goal. Required: The resource is required for the specified goal.
ResilienceHealthStatus	enum for Resilience health status. KnownResilienceHealthStatus can be used interchangeably with ResilienceHealthStatus, this enum contains the known values that the service supports. Known values supported by the service NotEvaluated: Resource is not evaluated. Unhealthy: Resource is Unhealthy. Healthy: Resource is Healthy.
ResourceBaseProtectionSolutionSettingUnion	Alias for ResourceBaseProtectionSolutionSettingUnion
ResourceInclusionState	A state type that indicates inclusion of the resource with respect to the resiliency support. KnownResourceInclusionState can be used interchangeably with ResourceInclusionState, this enum contains the known values that the service supports. Known values supported by the service Included: A state that indicates the resource is included. Excluded: A state that indicates the resource is excluded.
ResourceProtectionSolutionType	Protection solution type for the resources by which recovery takes place KnownResourceProtectionSolutionType can be used interchangeably with ResourceProtectionSolutionType, this enum contains the known values that the service supports. Known values supported by the service None: Resource is not protected with any protection solution. AzureNative: Resource is protected with the Azure native solution provided by the native Azure service. AzureSiteRecovery: Resource protected with the Azure solution provided by the native Azure Site Service for Azure VMs. CrossZoneVMRecovery: Cross zone recovery enabled Azure VMs. CustomRunbook: Resource is not protected with native solution and using custom runbook automation scripts for recovery verbs.
ResourceProtectionStatus	A state type that indicates the protection status of a resource with an Azure solution for regional or zonal recovery. KnownResourceProtectionStatus can be used interchangeably with ResourceProtectionStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown: The protection status of the resource is unknown. Protected: A state indicating that the resource is protected by the recovery solution. NotProtected: A state indicating that the resource is not protected by any recovery solution. HighlyAvailable: A state indicating that the resource is protected by the highly available recovery solution.
ResourceReplicationRole	A state specific to the resource that helps identify its role in replication. KnownResourceReplicationRole can be used interchangeably with ResourceReplicationRole, this enum contains the known values that the service supports. Known values supported by the service Unknown: The role of the resource is unknown. Primary: A state indicating that the resource is primary and actively replicating data to other replicas. Replica: A state indicating that the resource is a replica, receiving data from the primary.
ResourceTypeCategories	A state type that indicates qualification of a resource for an operation. KnownResourceTypeCategories can be used interchangeably with ResourceTypeCategories, this enum contains the known values that the service supports. Known values supported by the service AzureSiteRecoveryVMsPresent: Indicates that alteast one Azure Site Recovery VMs are present.
SolutionDisplayName	Identifies a high-availability solution that can be applied to a resource (for example, zone-pinned VM with ZRS disk). KnownSolutionDisplayName can be used interchangeably with SolutionDisplayName, this enum contains the known values that the service supports. Known values supported by the service ZonePinnedVmWithZrsDisk: Zone pinned VM with ZRS disk. VmInMultiZoneVmss: VM in multi-zone VMSS.
TestFailoverState	A state specific to the resource that helps identify its TestFailover state. KnownTestFailoverState can be used interchangeably with TestFailoverState, this enum contains the known values that the service supports. Known values supported by the service None: The resource is Not in TestFailedOver state (No test failover cleanup pending). TestFailoverCleanupPending: he resource is in test failover cleanup pending state.
UnifiedResilienceItemRequirementSelected	Enum for the requirement status of the resource in the goal. KnownUnifiedResilienceItemRequirementSelected can be used interchangeably with UnifiedResilienceItemRequirementSelected, this enum contains the known values that the service supports. Known values supported by the service NotRequired: The resource is not required for the specified goal. Required: The resource is required for the specified goal. NotSelected: The resource is not selected for the specified goal.
UsagePlanType	The type of usage plan. KnownUsagePlanType can be used interchangeably with UsagePlanType, this enum contains the known values that the service supports. Known values supported by the service Basic: Basic usage plan with restricted functionality without any charges. Standard: Standard usage plan with comprehensive functionality and usage based charges.
UserConsent	User consent for performing recovery action. KnownUserConsent can be used interchangeably with UserConsent, this enum contains the known values that the service supports. Known values supported by the service Unspecified: User consent is not specified for the operation. Allowed: Action is allowed with user consent.
VMPresent	Enum for VM presence. KnownVMPresent can be used interchangeably with VMPresent, this enum contains the known values that the service supports. Known values supported by the service Present: Atleast one VM Present. Absent: No VM present.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionTask	An action task type indicates the type of action task.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAttestationState	Enum for the attestation status of the resource in the goal.
KnownAutoFailover	Enum for AutoFailover
KnownCommentType	The type of user comment.
KnownConfirmationStatus	Enum for the confirmation status of a high availability solution.
KnownCreatedByType	The kind of entity that created the resource.
KnownDrillAttestation	Drill Attestation status on terminating.
KnownDrillMode	Start mode of Drill.
KnownDrillResourceFaultState	Drill Resource Fault State
KnownDrillResourceInclusionState	Drill Resource Inclusion State
KnownDrillResourceReadinessState	Drill Resource Readiness State
KnownDrillResourceState	Drill Resource State (wrt SG and RO).
KnownDrillRunOperationVerbs	Enum for DrillRun operation actions.
KnownDrillRunSubtasks	Enum for Drill Run Subtasks.
KnownDrillType	Enum for Drill type object hierarchy.
KnownExclusionReason	Enum for the reason why a resource is excluded.
KnownExclusionState	Enum for the status of the resource in the goal.
KnownExecutionReadinessState	Drill Execution Readiness State
KnownExecutionState	Drill Execution State
KnownExtensionObjectState	Enum for AttentionReason - Extension Object State.
KnownFailoverDirectionTypes	Types of Failover directions.
KnownFailoverState	A state specific to the resource that helps identify its Failover state.
KnownForceInclusionAndUpdate	Enum for ForceInclusionAndUpdate
KnownGoalAssignmentType	Supported type of goal assignment.
KnownGoalType	Supported type of goal.
KnownHAStatus	HA Status
KnownInitialConfig	Enum for Initial config of Drill object.
KnownIsoDuration	ISO 8601 duration formats.
KnownJobResourceType	A job resource type indicates the kind of jobresource.
KnownJobStatus	Job Statuses
KnownJobTriggeredBy	Job TriggeredBy
KnownJobType	A job type indicates the kind of job.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownMembershipType	Membership type of the service group to resource.
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 status of the current operation.
KnownQualificationState	A state type that indicates qualification of a resource for an operation.
KnownRbacSetupMode	RBAC setup mode.
KnownRbacState	Enum for AttentionReason - RBAC state on a resource.
KnownReasonForRequestingConfirmation	Enum for the reason for requesting user confirmation for a high availability solution.
KnownRecoveryGroupActionType	Specifies the type of recovery orchestration group actions.
KnownRecoveryOperationNames	Defines the set of operations that can be executed on a Recovery Orchestration Plan. These operations are applicable only to resources that meet the qualification criteria.
KnownRecoveryOperationStatus	Specifies the operation status for failover and validation.
KnownRecoveryPlanExclusionReason	Enum for RecoveryPlan Exclusion reason.
KnownRecoveryPlanState	Specifies the state of the recovery orchestration plan.
KnownRecoveryPlanType	Specifies the type of recovery orchestration plan.
KnownRelativeResourceCompositionState	Enum for AttentionReason - Resource state sync between two objects.
KnownRequirementSelected	Enum for the requirement status of the resource in the goal.
KnownResilienceHealthStatus	enum for Resilience health status.
KnownResourceInclusionState	A state type that indicates inclusion of the resource with respect to the resiliency support.
KnownResourceProtectionSolutionType	Protection solution type for the resources by which recovery takes place
KnownResourceProtectionStatus	A state type that indicates the protection status of a resource with an Azure solution for regional or zonal recovery.
KnownResourceReplicationRole	A state specific to the resource that helps identify its role in replication.
KnownResourceTypeCategories	A state type that indicates qualification of a resource for an operation.
KnownSolutionDisplayName	Identifies a high-availability solution that can be applied to a resource (for example, zone-pinned VM with ZRS disk).
KnownTestFailoverState	A state specific to the resource that helps identify its TestFailover state.
KnownUnifiedResilienceItemRequirementSelected	Enum for the requirement status of the resource in the goal.
KnownUsagePlanType	The type of usage plan.
KnownUserConsent	User consent for performing recovery action.
KnownVMPresent	Enum for VM presence.
KnownVersions	Microsoft.AzureResilienceManagement Resource Provider supported API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(AzureResilienceManagementClient, 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.

Variables

RestError

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>(AzureResilienceManagementClient, 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: AzureResilienceManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

AzureResilienceManagementClient

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

Type

RestErrorConstructor