swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector ReplicationRecoveryPlans API schemes: - https tags: - name: ReplicationRecoveryPlans paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans : get: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Gets The List Of Recovery Plans description: Lists the recovery plans in the vault. operationId: microsoftAzureReplicationrecoveryplansList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlanCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of recovery plans.: $ref: ./examples/ReplicationRecoveryPlans_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName} : get: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Gets The Requested Recovery Plan description: Gets the details of the recovery plan. operationId: microsoftAzureReplicationrecoveryplansGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Name of the recovery plan. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' x-ms-examples: Gets the requested recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_Get.json put: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Creates A Recovery Plan With The Given Details description: The operation to create a recovery plan. operationId: microsoftAzureReplicationrecoveryplansCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Recovery Plan creation input. required: true schema: $ref: '#/definitions/CreateRecoveryPlanInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Creates a recovery plan with the given details.: $ref: ./examples/ReplicationRecoveryPlans_Create.json delete: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Deletes The Specified Recovery Plan description: Delete a recovery plan. operationId: microsoftAzureReplicationrecoveryplansDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string responses: '202': description: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Deletes the specified recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_Delete.json patch: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Updates The Given Recovery Plan description: The operation to update a recovery plan. operationId: microsoftAzureReplicationrecoveryplansUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Update recovery plan input. required: true schema: $ref: '#/definitions/UpdateRecoveryPlanInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Updates the given recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_Update.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCancel : post: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Execute Cancel Failover Of The Recovery Plan description: The operation to cancel the failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansFailovercancel produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute cancel failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_FailoverCancel.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCommit : post: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Execute Commit Failover Of The Recovery Plan description: The operation to commit the failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansFailovercommit produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute commit failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_FailoverCommit.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover : post: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Execute Planned Failover Of The Recovery Plan description: The operation to start the planned failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansPlannedfailover consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Failover input. required: true schema: $ref: '#/definitions/RecoveryPlanPlannedFailoverInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute planned failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_PlannedFailover.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/reProtect : post: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Execute Reprotect Of The Recovery Plan description: The operation to reprotect(reverse replicate) a recovery plan. operationId: microsoftAzureReplicationrecoveryplansReprotect produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute reprotect of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_Reprotect.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailover : post: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Execute Test Failover Of The Recovery Plan description: The operation to start the test failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansTestfailover consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Recovery plan test failover input. required: true schema: $ref: '#/definitions/RecoveryPlanTestFailoverInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute test failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_TestFailover.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailoverCleanup : post: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Execute Test Failover Cleanup Of The Recovery Plan description: The operation to cleanup test failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansTestfailovercleanup consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Recovery plan test failover cleanup input. required: true schema: $ref: '#/definitions/RecoveryPlanTestFailoverCleanupInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute test failover cleanup of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_TestFailoverCleanup.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/unplannedFailover : post: tags: - ReplicationRecoveryPlans summary: Microsoft Azure Execute Unplanned Failover Of The Recovery Plan description: The operation to start the unplanned failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansUnplannedfailover consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Recovery plan unplanned failover input. required: true schema: $ref: '#/definitions/RecoveryPlanUnplannedFailoverInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute unplanned failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_UnplannedFailover.json definitions: RecoveryPlanTestFailoverCleanupInput: description: Recovery plan test failover cleanup input. required: - properties type: object properties: properties: $ref: '#/definitions/RecoveryPlanTestFailoverCleanupInputProperties' description: The recovery plan test failover cleanup input properties. RecoveryPlanUnplannedFailoverInputProperties: description: Recovery plan unplanned failover input properties. required: - failoverDirection - sourceSiteOperations type: object properties: failoverDirection: description: The failover direction. enum: - PrimaryToRecovery - RecoveryToPrimary type: string x-ms-enum: name: PossibleOperationsDirections modelAsString: true sourceSiteOperations: description: A value indicating whether source site operations are required. enum: - Required - NotRequired type: string x-ms-enum: name: SourceSiteOperations modelAsString: true providerSpecificDetails: description: The provider specific properties. maxLength: 1 type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' RecoveryPlanProviderSpecificFailoverInput: description: Recovery plan provider specific failover input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType UpdateRecoveryPlanInputProperties: description: Recovery plan update properties. type: object properties: groups: description: The recovery plan groups. type: array items: $ref: '#/definitions/RecoveryPlanGroup' Resource: description: Azure resource. type: object properties: id: description: Resource Id type: string readOnly: true name: description: Resource Name type: string readOnly: true type: description: Resource Type type: string readOnly: true location: description: Resource Location type: string x-ms-azure-resource: true CreateRecoveryPlanInput: description: Create recovery plan input class. required: - properties type: object properties: properties: $ref: '#/definitions/CreateRecoveryPlanInputProperties' description: Recovery plan creation properties. RecoveryPlanProtectedItem: description: Recovery plan protected item. type: object properties: id: description: The ARM Id of the recovery plan protected item. type: string virtualMachineId: description: The virtual machine Id. type: string RecoveryPlanTestFailoverInput: description: Recovery plan test failover input. required: - properties type: object properties: properties: $ref: '#/definitions/RecoveryPlanTestFailoverInputProperties' description: The recovery plan test failover input properties. RecoveryPlanTestFailoverInputProperties: description: Recovery plan test failover input properties. required: - failoverDirection - networkType type: object properties: failoverDirection: description: The failover direction. enum: - PrimaryToRecovery - RecoveryToPrimary type: string x-ms-enum: name: PossibleOperationsDirections modelAsString: true networkType: description: The network type to be used for test failover. type: string networkId: description: The Id of the network to be used for test failover. type: string providerSpecificDetails: description: The provider specific properties. maxLength: 1 type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' RecoveryPlanPlannedFailoverInput: description: Recovery plan planned failover input. required: - properties type: object properties: properties: $ref: '#/definitions/RecoveryPlanPlannedFailoverInputProperties' description: The recovery plan planned failover input properties. RecoveryPlanProviderSpecificInput: description: Recovery plan provider specific input base class. required: - instanceType type: object properties: instanceType: description: Gets the Instance type. type: string discriminator: instanceType CreateRecoveryPlanInputProperties: description: Recovery plan creation properties. required: - primaryFabricId - recoveryFabricId - groups type: object properties: primaryFabricId: description: The primary fabric Id. type: string recoveryFabricId: description: The recovery fabric Id. type: string failoverDeploymentModel: description: The failover deployment model. enum: - NotApplicable - Classic - ResourceManager type: string x-ms-enum: name: FailoverDeploymentModel modelAsString: true groups: description: The recovery plan groups. type: array items: $ref: '#/definitions/RecoveryPlanGroup' providerSpecificInput: description: The provider specific input. type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificInput' RecoveryPlanPlannedFailoverInputProperties: description: Recovery plan planned failover input properties. required: - failoverDirection type: object properties: failoverDirection: description: The failover direction. enum: - PrimaryToRecovery - RecoveryToPrimary type: string x-ms-enum: name: PossibleOperationsDirections modelAsString: true providerSpecificDetails: description: The provider specific properties. type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' RecoveryPlanProviderSpecificDetails: description: Recovery plan provider specific details. required: - instanceType type: object properties: instanceType: description: Gets the Instance type. type: string discriminator: instanceType RecoveryPlanTestFailoverCleanupInputProperties: description: Recovery plan test failover cleanup input properties. type: object properties: comments: description: The test failover cleanup comments. maxLength: 1024 type: string RecoveryPlanActionDetails: description: Recovery plan action custom details. required: - instanceType type: object properties: instanceType: description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). type: string discriminator: instanceType RecoveryPlanProperties: description: Recovery plan properties. type: object properties: friendlyName: description: The friendly name. type: string primaryFabricId: description: The primary fabric Id. type: string primaryFabricFriendlyName: description: The primary fabric friendly name. type: string recoveryFabricId: description: The recovery fabric Id. type: string recoveryFabricFriendlyName: description: The recovery fabric friendly name. type: string failoverDeploymentModel: description: The failover deployment model. type: string replicationProviders: description: The list of replication providers. type: array items: type: string allowedOperations: description: The list of allowed operations. type: array items: type: string lastPlannedFailoverTime: format: date-time description: The start time of the last planned failover. type: string lastUnplannedFailoverTime: format: date-time description: The start time of the last unplanned failover. type: string lastTestFailoverTime: format: date-time description: The start time of the last test failover. type: string currentScenario: $ref: '#/definitions/CurrentScenarioDetails' description: The current scenario details. currentScenarioStatus: description: The recovery plan status. type: string currentScenarioStatusDescription: description: The recovery plan status description. type: string groups: description: The recovery plan groups. type: array items: $ref: '#/definitions/RecoveryPlanGroup' providerSpecificDetails: description: The provider id and provider specific details. type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificDetails' CurrentScenarioDetails: description: Current scenario details of the protected entity. type: object properties: scenarioName: description: Scenario name. type: string jobId: description: ARM Id of the job being executed. type: string startTime: format: date-time description: Start time of the workflow. type: string RecoveryPlan: description: Recovery plan details. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/RecoveryPlanProperties' description: The custom details. UpdateRecoveryPlanInput: description: Update recovery plan input class. type: object properties: properties: $ref: '#/definitions/UpdateRecoveryPlanInputProperties' description: Recovery plan update properties. RecoveryPlanUnplannedFailoverInput: description: Recovery plan unplanned failover input. required: - properties type: object properties: properties: $ref: '#/definitions/RecoveryPlanUnplannedFailoverInputProperties' description: The recovery plan unplanned failover input properties. RecoveryPlanGroup: description: Recovery plan group details. required: - groupType type: object properties: groupType: description: The group type. enum: - Shutdown - Boot - Failover type: string x-ms-enum: name: RecoveryPlanGroupType modelAsString: true replicationProtectedItems: description: The list of protected items. type: array items: $ref: '#/definitions/RecoveryPlanProtectedItem' startGroupActions: description: The start group actions. type: array items: $ref: '#/definitions/RecoveryPlanAction' endGroupActions: description: The end group actions. type: array items: $ref: '#/definitions/RecoveryPlanAction' RecoveryPlanCollection: description: Recovery plan collection details. type: object properties: value: description: The list of recovery plans. type: array items: $ref: '#/definitions/RecoveryPlan' nextLink: description: The value of next link. type: string RecoveryPlanAction: description: Recovery plan action details. required: - actionName - failoverTypes - failoverDirections - customDetails type: object properties: actionName: description: The action name. type: string failoverTypes: description: The list of failover types. type: array items: enum: - ReverseReplicate - Commit - PlannedFailover - UnplannedFailover - DisableProtection - TestFailover - TestFailoverCleanup - Failback - FinalizeFailback - CancelFailover - ChangePit - RepairReplication - SwitchProtection - CompleteMigration type: string x-ms-enum: name: ReplicationProtectedItemOperation modelAsString: true failoverDirections: description: The list of failover directions. type: array items: enum: - PrimaryToRecovery - RecoveryToPrimary type: string x-ms-enum: name: PossibleOperationsDirections modelAsString: true customDetails: $ref: '#/definitions/RecoveryPlanActionDetails' description: The custom details. parameters: SubscriptionId: name: subscriptionId in: path description: The subscription Id. required: true type: string ResourceGroupName: name: resourceGroupName in: path description: The name of the resource group where the recovery services vault is present. required: true type: string x-ms-parameter-location: client ApiVersion: name: api-version in: query description: Client Api Version. required: true type: string ResourceName: name: resourceName in: path description: The name of the recovery services vault. required: true type: string x-ms-parameter-location: client x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'