Azure Site Recovery Replication Protection Container Mappings API

openapi: 3.2.0
info:
  title: Microsoft Azure Site Recovery Replication Protection…
  version: '2026-11-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ReplicationProtectionContainerMappings across 2 of this provider''s published API definitions: microsoft-azure-site-recovery-service-2026-11-01.json, microsoft-azure-site-recovery-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ReplicationProtectionContainerMappings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings
  : get:
      operationId: ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers
      tags:
      - ReplicationProtectionContainerMappings
      summary: Gets the list of protection container mappings for a protection container
      description: Lists the protection container mappings for a protection container.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectionContainerMappingCollection'
      x-ms-examples:
        Gets the list of protection container mappings for a protection container.:
          $ref: ./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}
  : get:
      operationId: ReplicationProtectionContainerMappings_Get
      tags:
      - ReplicationProtectionContainerMappings
      summary: Gets a protection container mapping
      description: Gets the details of a protection container mapping.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        schema:
          type: string
      - name: mappingName
        in: path
        description: Protection Container mapping name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectionContainerMapping'
      x-ms-examples:
        Gets a protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Get.json
    put:
      operationId: ReplicationProtectionContainerMappings_Create
      tags:
      - ReplicationProtectionContainerMappings
      summary: Create protection container mapping
      description: The operation to create a protection container mapping.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        schema:
          type: string
      - name: mappingName
        in: path
        description: Protection Container mapping name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'ProtectionContainerMapping' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectionContainerMapping'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
      x-ms-examples:
        Create protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Create.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/ProtectionContainerMapping'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProtectionContainerMappingInput'
        description: Mapping creation input.
        required: true
    patch:
      operationId: ReplicationProtectionContainerMappings_Update
      tags:
      - ReplicationProtectionContainerMappings
      summary: Update protection container mapping
      description: The operation to update protection container mapping.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        schema:
          type: string
      - name: mappingName
        in: path
        description: Protection Container mapping name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectionContainerMapping'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
      x-ms-examples:
        Update protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Update.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/ProtectionContainerMapping'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProtectionContainerMappingInput'
        description: Mapping update input.
        required: true
    delete:
      operationId: ReplicationProtectionContainerMappings_Purge
      tags:
      - ReplicationProtectionContainerMappings
      summary: Purge protection container mapping
      description: The operation to purge(force delete) a protection container mapping.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        schema:
          type: string
      - name: mappingName
        in: path
        description: Protection Container mapping name.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
      x-ms-examples:
        Purge protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Purge.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove
  : post:
      operationId: ReplicationProtectionContainerMappings_Delete
      tags:
      - ReplicationProtectionContainerMappings
      summary: Remove protection container mapping
      description: The operation to delete or remove a protection container mapping.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        schema:
          type: string
      - name: mappingName
        in: path
        description: Protection Container mapping name.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: There is no content to send for this request, but the headers may be useful.
      x-ms-examples:
        Remove protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Delete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveProtectionContainerMappingInput'
        description: Removal input.
        required: true
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainerMappings
  : get:
      operationId: ReplicationProtectionContainerMappings_List
      tags:
      - ReplicationProtectionContainerMappings
      summary: Gets the list of all protection container mappings in a vault
      description: Lists the protection container mappings in the vault.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the recovery services vault.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectionContainerMappingCollection'
      x-ms-examples:
        Gets the list of all protection container mappings in a vault.:
          $ref: ./examples/ReplicationProtectionContainerMappings_List.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ProtectionContainerMappingProperties:
      type: object
      description: Protection container mapping properties.
      properties:
        targetProtectionContainerId:
          type: string
          description: Paired protection container ARM ID.
        targetProtectionContainerFriendlyName:
          type: string
          description: Friendly name of paired container.
        providerSpecificDetails:
          $ref: '#/components/schemas/ProtectionContainerMappingProviderSpecificDetails'
          description: Provider specific provider details.
        health:
          type: string
          description: Health of pairing.
        healthErrorDetails:
          type: array
          description: Health error.
          items:
            $ref: '#/components/schemas/HealthError'
        policyId:
          type: string
          description: Policy ARM Id.
        state:
          type: string
          description: Association Status.
        sourceProtectionContainerFriendlyName:
          type: string
          description: Friendly name of source protection container.
        sourceFabricFriendlyName:
          type: string
          description: Friendly name of source fabric.
        targetFabricFriendlyName:
          type: string
          description: Friendly name of target fabric.
        policyFriendlyName:
          type: string
          description: Friendly name of replication policy.
    ReplicationProviderContainerUnmappingInput:
      type: object
      description: Provider specific input for unpairing operations.
      properties:
        instanceType:
          type: string
          description: The class type.
    ProtectionContainerMappingProviderSpecificDetails:
      type: object
      description: Container mapping provider specific details.
      properties:
        instanceType:
          type: string
          description: Gets the class type. Overridden in derived classes.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    CreateProtectionContainerMappingInput:
      type: object
      description: Configure pairing input.
      properties:
        properties:
          $ref: '#/components/schemas/CreateProtectionContainerMappingInputProperties'
          description: Configure protection input properties.
    ReplicationProviderSpecificContainerMappingInput:
      type: object
      description: Provider specific input for pairing operations.
      properties:
        instanceType:
          type: string
          description: The class type.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    ProtectionContainerMapping:
      type: object
      description: Protection container mapping object.
      properties:
        properties:
          $ref: '#/components/schemas/ProtectionContainerMappingProperties'
          description: The custom data.
        location:
          type: string
          description: Resource Location
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    CreateProtectionContainerMappingInputProperties:
      type: object
      description: Configure pairing input properties.
      properties:
        targetProtectionContainerId:
          type: string
          description: The target unique protection container name.
        policyId:
          type: string
          description: Applicable policy.
        providerSpecificInput:
          $ref: '#/components/schemas/ReplicationProviderSpecificContainerMappingInput'
          description: Provider specific input for pairing.
    InnerHealthError:
      type: object
      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.
      properties:
        errorSource:
          type: string
          description: Source of error.
        errorType:
          type: string
          description: Type of error.
        errorLevel:
          type: string
          description: Level of error.
        errorCategory:
          type: string
          description: Category of error.
        errorCode:
          type: string
          description: Error code.
        summaryMessage:
          type: string
          description: Summary message of the entity.
        errorMessage:
          type: string
          description: Error message.
        possibleCauses:
          type: string
          description: Possible causes of error.
        recommendedAction:
          type: string
          description: Recommended action to resolve error.
        creationTimeUtc:
          type: string
          format: date-time
          description: Error creation time (UTC).
        recoveryProviderErrorMessage:
          type: string
          description: DRA error message.
        entityId:
          type: string
          description: ID of the entity.
        errorId:
          type: string
          description: The health error unique id.
        customerResolvability:
          $ref: '#/components/schemas/HealthErrorCustomerResolvability'
          description: Value indicating whether the health error is customer resolvable.
    UpdateProtectionContainerMappingInput:
      type: object
      description: Container pairing update input.
      properties:
        properties:
          $ref: '#/components/schemas/UpdateProtectionContainerMappingInputProperties'
          description: Update protection container mapping input properties.
    UpdateProtectionContainerMappingInputProperties:
      type: object
      description: Container pairing update input.
      properties:
        providerSpecificInput:
          $ref: '#/components/schemas/ReplicationProviderSpecificUpdateContainerMappingInput'
          description: Provider specific input for updating protection container mapping.
    ReplicationProviderSpecificUpdateContainerMappingInput:
      type: object
      description: Provider specific input for update pairing operations.
      properties:
        instanceType:
          type: string
          description: The class type.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    ProtectionContainerMappingCollection:
      type: object
      description: Protection container mapping collection class.
      properties:
        value:
          type: array
          description: The ProtectionContainerMapping items on this page
          items:
            $ref: '#/components/schemas/ProtectionContainerMapping'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    RemoveProtectionContainerMappingInputProperties:
      type: object
      description: Unpairing input properties.
      properties:
        providerSpecificInput:
          $ref: '#/components/schemas/ReplicationProviderContainerUnmappingInput'
          description: Provider specific input for unpairing.
    HealthErrorCustomerResolvability:
      type: string
      description: Value indicating whether the health error is customer resolvable.
      enum:
      - Allowed
      - NotAllowed
      x-ms-enum:
        name: HealthErrorCustomerResolvability
        modelAsString: true
        values:
        - name: Allowed
          value: Allowed
          description: Allowed
        - name: NotAllowed
          value: NotAllowed
          description: NotAllowed
    RemoveProtectionContainerMappingInput:
      type: object
      description: Container unpairing input.
      properties:
        properties:
          $ref: '#/components/schemas/RemoveProtectionContainerMappingInputProperties'
          description: Configure protection input properties.
    HealthError:
      type: object
      description: Health Error.
      properties:
        innerHealthErrors:
          type: array
          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.
          items:
            $ref: '#/components/schemas/InnerHealthError'
        errorSource:
          type: string
          description: Source of error.
        errorType:
          type: string
          description: Type of error.
        errorLevel:
          type: string
          description: Level of error.
        errorCategory:
          type: string
          description: Category of error.
        errorCode:
          type: string
          description: Error code.
        summaryMessage:
          type: string
          description: Summary message of the entity.
        errorMessage:
          type: string
          description: Error message.
        possibleCauses:
          type: string
          description: Possible causes of error.
        recommendedAction:
          type: string
          description: Recommended action to resolve error.
        creationTimeUtc:
          type: string
          format: date-time
          description: Error creation time (UTC).
        recoveryProviderErrorMessage:
          type: string
          description: DRA error message.
        entityId:
          type: string
          description: ID of the entity.
        errorId:
          type: string
          description: The health error unique id.
        customerResolvability:
          $ref: '#/components/schemas/HealthErrorCustomerResolvability'
          description: Value indicating whether the health error is customer resolvable.
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-site-recovery-service-2026-11-01.json
- microsoft-azure-site-recovery-openapi.yml