swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReplicationProtectedItems API
schemes:
- https
tags:
- name: ReplicationProtectedItems
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems
  : get:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Gets The List Of Replication Protected Items
      description: Gets the list of ASR replication protected items in the protection container.
      operationId: microsoftAzureReplicationprotecteditemsListbyreplicationprotectioncontainers
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItemCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets the list of Replication protected items.:
          $ref: ./examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
  : get:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Gets The Details Of A Replication Protected Item
      description: Gets the details of an ASR replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric unique name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
      x-ms-examples:
        Gets the details of a Replication protected item.:
          $ref: ./examples/ReplicationProtectedItems_Get.json
    put:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Enables Protection
      description: The operation to create an ASR replication protected item (Enable replication).
      operationId: microsoftAzureReplicationprotecteditemsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Name of the fabric.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: A name for the replication protected item.
        required: true
        type: string
      - name: input
        in: body
        description: Enable Protection Input.
        required: true
        schema:
          $ref: '#/definitions/EnableProtectionInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Enables protection.:
          $ref: ./examples/ReplicationProtectedItems_Create.json
    delete:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Purges Protection
      description: The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.
      operationId: microsoftAzureReplicationprotecteditemsPurge
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      responses:
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Purges protection.:
          $ref: ./examples/ReplicationProtectedItems_Purge.json
    patch:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Updates The Replication Protected Item Settings
      description: The operation to update the recovery settings of an ASR replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: updateProtectionInput
        in: body
        description: Update protection input.
        required: true
        schema:
          $ref: '#/definitions/UpdateReplicationProtectedItemInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Updates the replication protected Item settings.:
          $ref: ./examples/ReplicationProtectedItems_Update.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Add Disk S For Protection
      description: Operation to add disks(s) to the replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsAdddisks
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: addDisksInput
        in: body
        description: Add disks input.
        required: true
        schema:
          $ref: '#/definitions/AddDisksInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Add disk(s) for protection.:
          $ref: ./examples/ReplicationProtectedItems_AddDisks.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Change Or Apply Recovery Point
      description: The operation to change the recovery point of a failed over replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsApplyrecoverypoint
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: The ARM fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: The protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: The replicated protected item name.
        required: true
        type: string
      - name: applyRecoveryPointInput
        in: body
        description: The ApplyRecoveryPointInput.
        required: true
        schema:
          $ref: '#/definitions/ApplyRecoveryPointInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Change or apply recovery point.:
          $ref: ./examples/ReplicationProtectedItems_ApplyRecoveryPoint.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Execute Cancel Failover
      description: Operation to cancel the failover of the replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsFailovercancel
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Execute cancel failover.:
          $ref: ./examples/ReplicationProtectedItems_FailoverCancel.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Execute Commit Failover
      description: Operation to commit the failover of the replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsFailovercommit
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Execute commit failover.:
          $ref: ./examples/ReplicationProtectedItems_FailoverCommit.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Execute Planned Failover
      description: Operation to initiate a planned failover of the replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsPlannedfailover
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: failoverInput
        in: body
        description: Planned failover input.
        required: true
        schema:
          $ref: '#/definitions/PlannedFailoverInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Execute planned failover.:
          $ref: ./examples/ReplicationProtectedItems_PlannedFailover.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Disables Protection
      description: The operation to disable replication on a replication protected item. This will also remove the item.
      operationId: microsoftAzureReplicationprotecteditemsDelete
      consumes:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: disableProtectionInput
        in: body
        description: Disable protection input.
        required: true
        schema:
          $ref: '#/definitions/DisableProtectionInput'
      responses:
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Disables protection.:
          $ref: ./examples/ReplicationProtectedItems_Delete.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Removes Disk S
      description: Operation to remove disk(s) from the replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsRemovedisks
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: removeDisksInput
        in: body
        description: Remove disks input.
        required: true
        schema:
          $ref: '#/definitions/RemoveDisksInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Removes disk(s).:
          $ref: ./examples/ReplicationProtectedItems_RemoveDisks.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Resynchronize Or Repair Replication
      description: The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.
      operationId: microsoftAzureReplicationprotecteditemsRepairreplication
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: The name of the fabric.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: The name of the container.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: The name of the replication protected item.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Resynchronize or repair replication.:
          $ref: ./examples/ReplicationProtectedItems_RepairReplication.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Execute Reverse Replication\reprotect
      description: Operation to reprotect or reverse replicate a failed over replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsReprotect
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: reprotectInput
        in: body
        description: Reverse replication input.
        required: true
        schema:
          $ref: '#/definitions/ReverseReplicationInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Execute Reverse Replication\Reprotect.:
          $ref: ./examples/ReplicationProtectedItems_Reprotect.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Resolve Health Errors
      description: Operation to resolve health issues of the replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsResolvehealtherrors
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: resolveHealthInput
        in: body
        description: Health issue input object.
        required: true
        schema:
          $ref: '#/definitions/ResolveHealthInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Resolve health errors.:
          $ref: ./examples/ReplicationProtectedItems_ResolveHealthErrors.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/switchProvider
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Execute Switch Provider
      description: Operation to initiate a switch provider of the replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsSwitchprovider
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: switchProviderInput
        in: body
        description: Switch provider input.
        required: true
        schema:
          $ref: '#/definitions/SwitchProviderInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Execute switch provider.:
          $ref: ./examples/ReplicationProtectedItems_SwitchProvider.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Execute Test Failover
      description: Operation to perform a test failover of the replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsTestfailover
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: testfailoverInput
        in: body
        description: Test failover input.
        required: true
        schema:
          $ref: '#/definitions/TestFailoverInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Execute test failover.:
          $ref: ./examples/ReplicationProtectedItems_TestFailover.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Execute Test Failover Cleanup
      description: Operation to clean up the test failover of a replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsTestfailovercleanup
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: cleanupInput
        in: body
        description: Test failover cleanup input.
        required: true
        schema:
          $ref: '#/definitions/TestFailoverCleanupInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Execute test failover cleanup.:
          $ref: ./examples/ReplicationProtectedItems_TestFailoverCleanup.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Execute Unplanned Failover
      description: Operation to initiate a failover of the replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsUnplannedfailover
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: failoverInput
        in: body
        description: Failover input.
        required: true
        schema:
          $ref: '#/definitions/UnplannedFailoverInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Execute unplanned failover.:
          $ref: ./examples/ReplicationProtectedItems_UnplannedFailover.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Updates Appliance For Replication Protected Item
      description: The operation to update appliance of an ASR replication protected item.
      operationId: microsoftAzureReplicationprotecteditemsUpdateappliance
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: Replication protected item name.
        required: true
        type: string
      - name: applianceUpdateInput
        in: body
        description: Appliance update protection input.
        required: true
        schema:
          $ref: '#/definitions/UpdateApplianceForReplicationProtectedItemInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Updates appliance for replication protected Item.:
          $ref: ./examples/ReplicationProtectedItems_UpdateAppliance.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateMobilityService
  : post:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Update The Mobility Service On A Protected Item
      description: The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.
      operationId: microsoftAzureReplicationprotecteditemsUpdatemobilityservice
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: The name of the fabric containing the protected item.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: The name of the container containing the protected item.
        required: true
        type: string
      - name: replicatedProtectedItemName
        in: path
        description: The name of the protected item on which the agent is to be updated.
        required: true
        type: string
      - name: updateMobilityServiceRequest
        in: body
        description: Request to update the mobility service on the protected item.
        required: true
        schema:
          $ref: '#/definitions/UpdateMobilityServiceRequest'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItem'
        '202':
          description: Accepted
          headers:
            Location:
              type: string
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Update the mobility service on a protected item.:
          $ref: ./examples/ReplicationProtectedItems_UpdateMobilityService.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems
  : get:
      tags:
      - ReplicationProtectedItems
      summary: Microsoft Azure Gets The List Of Replication Protected Items
      description: Gets the list of ASR replication protected items in the vault.
      operationId: microsoftAzureReplicationprotecteditemsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: skipToken
        in: query
        description: 'The pagination token. Possible values: "FabricId" or "FabricId_CloudId" or null.'
        required: false
        type: string
      - name: $filter
        in: query
        description: OData filter options.
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectedItemCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/ProtectedItemsQueryParameter'
      x-ms-examples:
        Gets the list of replication protected items.:
          $ref: ./examples/ReplicationProtectedItems_List.json
definitions:
  VMNicInputDetails:
    description: Hyper V VM network input details.
    type: object
    properties:
      nicId:
        description: The nic Id.
        type: string
      ipConfigs:
        description: The IP configurations to be used by NIC during test failover and failover.
        type: array
        items:
          $ref: '#/definitions/IPConfigInputDetails'
      selectionType:
        description: Selection type for failover.
        type: string
      recoveryNetworkSecurityGroupId:
        description: The id of the NSG associated with the NIC.
        type: string
      enableAcceleratedNetworkingOnRecovery:
        description: Whether the NIC has accelerated networking enabled.
        type: boolean
      tfoNetworkSecurityGroupId:
        description: The NSG to be used by NIC during test failover.
        type: string
      enableAcceleratedNetworkingOnTfo:
        description: Whether the test NIC has accelerated networking enabled.
        type: boolean
      recoveryNicName:
        description: The name of the NIC to be used when creating target NICs.
        type: string
      recoveryNicResourceGroupName:
        description: The resource group of the NIC to be used when creating target NICs.
        type: string
      reuseExistingNic:
        description: A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.
        type: boolean
      tfoNicName:
        description: The name of the NIC to be used when creating target NICs in TFO.
        type: string
      tfoNicResourceGroupName:
        description: The resource group of the NIC to be used when creating target NICs in TFO.
        type: string
      tfoReuseExistingNic:
        description: A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.
        type: boolean
      targetNicName:
        description: Target NIC name.
        type: string
  TestFailoverInputProperties:
    description: Input definition for test failover input properties.
    type: object
    properties:
      failoverDirection:
        description: Test failover direction.
        type: string
      networkType:
        description: 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:
        $ref: '#/definitions/TestFailoverProviderSpecificInput'
        description: Provider specific settings.
  UpdateReplicationProtectedItemInputProperties:
    description: Update protected item input properties.
    type: object
    properties:
      recoveryAzureVMName:
        description: Target Azure VM name given by the user.
        type: string
      recoveryAzureVMSize:
        description: Target Azure VM size.
        type: string
      selectedRecoveryAzureNetworkId:
        description: Target Azure Network Id.
        type: string
      selectedTfoAzureNetworkId:
        description: The Azure Network Id for test failover.
        type: string
      selectedSourceNicId:
        description: The selected source nic Id which will be used as the primary nic during failover.
        type: string
      enableRdpOnTargetOption:
        description: The selected option to enable RDP\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.
        type: string
      vmNics:
        description: The list of VM nic details.
        type: array
        items:
          $ref: '#/definitions/VMNicInputDetails'
      licenseType:
        description: License type.
        enum:
        - NotSpecified
        - NoLicenseType
        - WindowsServer
        type: string
        x-ms-enum:
          name: LicenseType
          modelAsString: true
      recoveryAvailabilitySetId:
        description: The target availability set Id.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/UpdateReplicationProtectedItemProviderInput'
        description: The provider specific input to update replication protected item.
  UnplannedFailoverInputProperties:
    description: Input definition for unplanned failover input properties.
    type: object
    properties:
      failoverDirection:
        description: Failover direction.
        type: string
      sourceSiteOperations:
        description: Source site operations status.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/UnplannedFailoverProviderSpecificInput'
        description: Provider specific settings.
  ReplicationProtectedItem:
    description: Replication protected item.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ReplicationProtectedItemProperties'
        description: The custom data.
  ResolveHealthInputProperties:
    description: Resolve health input properties.
    type: object
    properties:
      healthErrors:
        description: Health errors.
        type: array
        items:
          $ref: '#/definitions/ResolveHealthError'
  ResolveHealthError:
    description: Resolve health errors input properties.
    type: object
    properties:
      healthErrorId:
        description: Health error id.
        type: string
  ReverseReplicationProviderSpecificInput:
    description: Provider specific reverse replication input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  UnplannedFailoverInput:
    description: Input definition for unplanned failover.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/UnplannedFailoverInputProperties'
        description: Unplanned failover input properties.
  TestFailoverCleanupInput:
    description: Input definition for test failover cleanup.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/TestFailoverCleanupInputProperties'
        description: Test failover cleanup input properties.
  SwitchProviderInput:
    description: Input definition for switch provider.
    type: object
    properties:
      properties:
        $ref: '#/definitions/SwitchProviderInputProperties'
        description: Switch provider input properties.
  UpdateMobilityServiceRequest:
    description: Request to update the mobility service on a protected item.
    type: object
    properties:
      properties:
        $ref: '#/definitions/UpdateMobilityServiceRequestProperties'
        description: The properties of the update mobility service request.
  EnableProtectionProviderSpecificInput:
    description: Enable protection provider specific input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  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
  DisableProtectionInput:
    description: Disable protection input.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/DisableProtectionInputProperties'
        description: Disable protection input properties.
  PlannedFailoverInput:
    description: Input definition for planned failover.
    type: object
    properties:
      properties:
        $ref: '#/definitions/PlannedFailoverInputProperties'
        description: Planned failover input properties.
  ReplicationProtectedItemCollection:
    description: Replication protected item collection.
    type: object
    properties:
      value:
        description: The Replication protected item details.
        type: array
        items:
          $ref: '#/definitions/ReplicationProtectedItem'
      nextLink:
        description: The value of next link.
        type: string
  UnplannedFailoverProviderSpecificInput:
    description: Provider specific unplanned failover input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  ReplicationProviderSpecificSettings:
    description: Replication provider specific settings.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets the Instance type.
        type: string
    discriminator: instanceType
  RemoveDisksProviderSpecificInput:
    description: Remove Disk provider specific input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  EnableProtectionInputProperties:
    description: Enable protection input properties.
    type: object
    properties:
      policyId:
        description: The Policy Id.
        type: string
      protectableItemId:
        description: The protectable item Id.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/EnableProtectionProviderSpecificInput'
        description: The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null.
  ResolveHealthInput:
    description: Resolve health input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/ResolveHealthInputProperties'
        description: Disable resolve health input properties.
  DisableProtectionInputProperties:
    description: Disable protection input properties.
    type: object
    properties:
      disableProtectionReason:
        description: Disable protection reason. It can have values NotSpecified/MigrationComplete.
        enum:
        - NotSpecified
        - MigrationComplete
        type: string
        x-ms-enum:
          name: DisableProtectionReason
          modelAsString: true
      replicationProviderInput:
        $ref: '#/definitions/DisableProtectionProviderSpecificInput'
        description: Replication provider specific input.
  DisableProtectionProviderSpecificInput:
    description: Disable protection provider specific input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  SwitchProviderProviderSpecificInput:
    description: Provider specific switch provider input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  TestFailoverProviderSpecificInput:
    description: Provider specific test failover input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  RemoveDisksInputProperties:
    description: Remove Disk input properties.
    type: object
    properties:
      providerSpecificDetails:
        $ref: '#/definitions/RemoveDisksProviderSpecificInput'
        description: The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null.
  RemoveDisksInput:
    description: Input for remove disk(s) operation.
    type: object
    properties:
      properties:
        $ref: '#/definitions/RemoveDisksInputProperties'
        description: Remove disk input properties.
  ReverseReplicationInput:
    description: Reverse replication input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/ReverseReplicationInputProperties'
        description: Reverse replication properties.
  HealthError:
    description: Health Error.
    type: object
    properties:
      innerHealthErrors:
        description: The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
        type: array
        items:
          $ref: '#/definitions/InnerHealthError'
      errorSource:
        description: Source of error.
        type: string
      errorType:
        description: Type of error.
        type: string
      errorLevel:
        description: Level of error.
        type: string
      errorCategory:
        description: Category of error.
        type: string
      errorCode:
        description: Error code.
        type: string
      summaryMessage:
        description: Summary message of the entity.
        type: string
      errorMessage:
        description: Error message.
        type: string
      possibleCauses:
        description: Possible causes of error.
        type: string
      recommendedAction:
        description: Recommended action to resolve error.
        type: string
      creationTimeUtc:
        format: date-time
        description: Error creation time (UTC).
        type: string
      recoveryProviderErrorMessage:
        description: DRA error message.
        type: string
      entityId:
        description: ID of the entity.
        type: string
      errorId:
        description: The health error unique id.
        type: string
      customerResolvability:
        description: Value indicating whether the health error is customer resolvable.
        enum:
        - Allowed
        - NotAllowed
        type: string
        x-ms-enum:
          name: HealthErrorCustomerResolvability
          modelAsString: true
  UpdateMobilityServiceRequestProperties:
    description: The properties of an update mobility service request.
    type: object
    properties:
      runAsAccountId:
        description: The CS run as account Id.
        type: string
  AddDisksInputProperties:
    description: Add Disks input properties.
    required:
    - providerSpecificDetails
    type: object
    properties:
      providerSpecificDetails:
        $ref: '#/definitions/AddDisksProviderSpecificInput'
        description: The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null.
  UpdateApplianceForReplicationProtectedItemInputProperties:
    description: Update appliance for protected item input properties.
    required:
    - targetApplianceId
    - providerSpecificDetails
    type: object
    properties:
      targetApplianceId:
        description: The target appliance Id.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput'
        description: The provider specific input to update replication protected item.
  ReplicationProtectedItemProperties:
    description: Replication protected item custom data details.
    type: object
    properties:
      friendlyName:
        description: The name.
        type: string
      protectedItemType:
        description: The type of protected item type.
        type: string
      protectableItemId:
        description: The protected item ARM Id.
        type: string
      recoveryServicesProviderId:
        description: The recovery provider ARM Id.
        type: string
      primaryFabricFriendlyName:
        description: The friendly name of the primary fabric.
        type: string
      primaryFabricProvider:
        description: The fabric provider of the primary fabric.
        type: string
      recoveryFabricFriendlyName:
        description: The friendly name of recovery fabric.
        type: string
      recoveryFabricId:
        description: The Arm Id of recovery fabric.
        type: string
      primaryProtectionContainerFriendlyName:
        description: The name of primary protection container friendly name.
        type: string
      recoveryProtectionContainerFriendlyName:
        description: The name of recovery container friendly name.
        type: string
      protectionState:
        description: The protection status.
        type: string
      protectionStateDescription:
        description: The protection state description.
        type: string
      activeLocation:
        description: The Current active location of the PE.
        type: string
      testFailoverState:
        description: The Test failover state.
        type: string
      testFailoverStateDescription:
        description: The Test failover state description.
        type: string
      switchProviderState:
        description: The switch provider state.
        type: string
      switchProviderStateDescription:
        description: The switch provider state description.
        type: string
      allowedOperations:
        description: The allowed operations on the Replication protected item.
        type: array
        items:
          type: string
      replicationHealth:
        description: The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.
        type: string
      failoverHealth:
        description: The consolidated failover health for the VM.
        type: string
      healthErrors:
        description: List of health errors.
        type: array
        items:
          $ref: '#/definitions/HealthError'
      policyId:
        description: The ID of Policy governing this PE.
        type: string
      policyFriendlyName:
        description: The name of Policy governing this PE.
        type: string
      lastSuccessfulFailoverTime:
        format: date-time
        description: The Last successful failover time.
        type: string
      lastSuccessfulTestFailoverTime:
        format: date-time
        description: The Last successful test failover time.
        type: string
      currentScenario:
        $ref: '#/definitions/CurrentScenarioDetails'
        description: The current scenario.
      failoverRecoveryPointId:
        description: The recovery point ARM Id to which the Vm was failed over.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/ReplicationProviderSpecificSettings'
        description: The Replication provider custom settings.
      recoveryContainerId:
        description: The recovery container Id.
        type: string
      eventCorrelationId:
        description: The correlation Id for events associated with this protected item.
        type: string
  IPConfigInputDetails:
    type: object
    properties:
      ipConfigName:
        type: string
      isPrimary:
        type: boolean
      isSeletedForFailover:
        type: boolean
      recoverySubnetName:
        type: string
      recoveryStaticIPAddress:
        type: string
      recoveryPublicIPAddressId:
        type: string
      recoveryLBBackendAddressPoolIds:
        type: array
        items:
          type: string
      tfoSubnetName:
        type: string
      tfoStaticIPAddress:
        type: string
      tfoPublicIPAddressId:
        type: string
      tfoLBBackendAddressPoolIds:
        type: array
        items:
          type: string
  UpdateApplianceForReplicationProtectedItemInput:
    description: Update appliance for replication protected item input.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/UpdateApplianceForReplicationProtectedItemInputProperties'
        description: Update appliance replication protected item properties.
  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
  ApplyRecoveryPointProviderSpecificInput:
    description: Provider specific input for apply recovery point.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  PlannedFailoverProviderSpecificFailoverInput:
    description: Provider specific failover input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  InnerHealthError:
    description: Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
    type: object
    properties:
      errorSource:
        description: Source of error.
        type: string
      errorType:
        description: Type of error.
        type: string
      errorLevel:
        description: Level of error.
        type: string
      errorCategory:
        description: Category of error.
        type: string
      errorCode:
        description: Error code.
        type: string
      summaryMessage:
        description: Summary message of the entity.
        type: string
      errorMessage:
        description: Error message.
        type: string
      possibleCauses:
        description: Possible causes of error.
        type: string
      recommendedAction:
        description: Recommended action to resolve error.
        type: string
      creationTimeUtc:
        format: date-time
        description: Error creation time (UTC).
        type: string
      recoveryProviderErrorMessage:
        description: DRA error message.
        type: string
      entityId:
        description: ID of the entity.
        type: string
      errorId:
        description: The health error unique id.
        type: string
      customerResolvability:
        description: Value indicating whether the health error is customer resolvable.
        enum:
        - Allowed
        - NotAllowed
        type: string
        x-ms-enum:
          name: HealthErrorCustomerResolvability
          modelAsString: true
  PlannedFailoverInputProperties:
    description: Input definition for planned failover input properties.
    type: object
    properties:
      failoverDirection:
        description: Failover direction.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/PlannedFailoverProviderSpecificFailoverInput'
        description: Provider specific settings.
  AddDisksInput:
    description: Input for add disk(s) operation.
    type: object
    properties:
      properties:
        $ref: '#/definitions/AddDisksInputProperties'
        description: Add disks input properties.
  SwitchProviderInputProperties:
    description: Input definition for switch provider input properties.
    type: object
    properties:
      targetInstanceType:
        description: Target provider type.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/SwitchProviderProviderSpecificInput'
        description: Provider specific settings.
  ReverseReplicationInputProperties:
    description: Reverse replication input properties.
    type: object
    properties:
      failoverDirection:
        description: Failover direction.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/ReverseReplicationProviderSpecificInput'
        description: Provider specific reverse replication input.
  TestFailoverCleanupInputProperties:
    description: Input definition for test failover cleanup input properties.
    type: object
    properties:
      comments:
        description: Test failover cleanup comments.
        maxLength: 1024
        type: string
  UpdateReplicationProtectedItemInput:
    description: Update replication protected item input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/UpdateReplicationProtectedItemInputProperties'
        description: Update replication protected item properties.
  ApplyRecoveryPointInputProperties:
    description: Input properties to apply recovery point.
    required:
    - providerSpecificDetails
    type: object
    properties:
      recoveryPointId:
        description: The recovery point Id.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/ApplyRecoveryPointProviderSpecificInput'
        description: Provider specific input for applying recovery point.
  UpdateReplicationProtectedItemProviderInput:
    description: Update replication protected item provider specific input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  EnableProtectionInput:
    description: Enable protection input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/EnableProtectionInputProperties'
        description: Enable protection input properties.
  UpdateApplianceForReplicationProtectedItemProviderSpecificInput:
    description: Update replication protected item provider specific input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  ApplyRecoveryPointInput:
    description: Input to apply recovery point.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/ApplyRecoveryPointInputProperties'
        description: The input properties to apply recovery point.
  TestFailoverInput:
    description: Input definition for test failover.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/TestFailoverInputProperties'
        description: Test failover input properties.
  AddDisksProviderSpecificInput:
    description: Add Disks provider specific input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
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'