swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReplicationProtectionContainerMappings API
schemes:
- https
tags:
- name: ReplicationProtectionContainerMappings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings
  : get:
      tags:
      - ReplicationProtectionContainerMappings
      summary: Microsoft Azure Gets The List Of Protection Container Mappings For A Protection Container
      description: Lists the protection container mappings for a protection container.
      operationId: microsoftAzureReplicationprotectioncontainermappingsListbyreplicationprotectioncontainers
      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/ProtectionContainerMappingCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets the list of protection container mappings for a protection container.:
          $ref: ./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}
  : get:
      tags:
      - ReplicationProtectionContainerMappings
      summary: Microsoft Azure Gets A Protection Container Mapping
      description: Gets the details of a protection container mapping.
      operationId: microsoftAzureReplicationprotectioncontainermappingsGet
      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: mappingName
        in: path
        description: Protection Container mapping name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionContainerMapping'
      x-ms-examples:
        Gets a protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Get.json
    put:
      tags:
      - ReplicationProtectionContainerMappings
      summary: Microsoft Azure Create Protection Container Mapping
      description: The operation to create a protection container mapping.
      operationId: microsoftAzureReplicationprotectioncontainermappingsCreate
      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: mappingName
        in: path
        description: Protection container mapping name.
        required: true
        type: string
      - name: creationInput
        in: body
        description: Mapping creation input.
        required: true
        schema:
          $ref: '#/definitions/CreateProtectionContainerMappingInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionContainerMapping'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Create protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Create.json
    delete:
      tags:
      - ReplicationProtectionContainerMappings
      summary: Microsoft Azure Purge Protection Container Mapping
      description: The operation to purge(force delete) a protection container mapping.
      operationId: microsoftAzureReplicationprotectioncontainermappingsPurge
      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: mappingName
        in: path
        description: Protection container mapping name.
        required: true
        type: string
      responses:
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Purge protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Purge.json
    patch:
      tags:
      - ReplicationProtectionContainerMappings
      summary: Microsoft Azure Update Protection Container Mapping
      description: The operation to update protection container mapping.
      operationId: microsoftAzureReplicationprotectioncontainermappingsUpdate
      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: mappingName
        in: path
        description: Protection container mapping name.
        required: true
        type: string
      - name: updateInput
        in: body
        description: Mapping update input.
        required: true
        schema:
          $ref: '#/definitions/UpdateProtectionContainerMappingInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionContainerMapping'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Update protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Update.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove
  : post:
      tags:
      - ReplicationProtectionContainerMappings
      summary: Microsoft Azure Remove Protection Container Mapping
      description: The operation to delete or remove a protection container mapping.
      operationId: microsoftAzureReplicationprotectioncontainermappingsDelete
      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: mappingName
        in: path
        description: Protection container mapping name.
        required: true
        type: string
      - name: removalInput
        in: body
        description: Removal input.
        required: true
        schema:
          $ref: '#/definitions/RemoveProtectionContainerMappingInput'
      responses:
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Remove protection container mapping.:
          $ref: ./examples/ReplicationProtectionContainerMappings_Delete.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainerMappings
  : get:
      tags:
      - ReplicationProtectionContainerMappings
      summary: Microsoft Azure Gets The List Of All Protection Container Mappings In A Vault
      description: Lists the protection container mappings in the vault.
      operationId: microsoftAzureReplicationprotectioncontainermappingsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionContainerMappingCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets the list of all protection container mappings in a vault.:
          $ref: ./examples/ReplicationProtectionContainerMappings_List.json
definitions:
  ReplicationProviderContainerUnmappingInput:
    description: Provider specific input for unpairing operations.
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
  ProtectionContainerMappingProviderSpecificDetails:
    description: Container mapping provider specific details.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets the class type. Overridden in derived classes.
        type: string
    discriminator: instanceType
  ProtectionContainerMappingProperties:
    description: Protection container mapping properties.
    type: object
    properties:
      targetProtectionContainerId:
        description: Paired protection container ARM ID.
        type: string
      targetProtectionContainerFriendlyName:
        description: Friendly name of paired container.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/ProtectionContainerMappingProviderSpecificDetails'
        description: Provider specific provider details.
      health:
        description: Health of pairing.
        type: string
      healthErrorDetails:
        description: Health error.
        type: array
        items:
          $ref: '#/definitions/HealthError'
      policyId:
        description: Policy ARM Id.
        type: string
      state:
        description: Association Status.
        type: string
      sourceProtectionContainerFriendlyName:
        description: Friendly name of source protection container.
        type: string
      sourceFabricFriendlyName:
        description: Friendly name of source fabric.
        type: string
      targetFabricFriendlyName:
        description: Friendly name of target fabric.
        type: string
      policyFriendlyName:
        description: Friendly name of replication policy.
        type: string
  UpdateProtectionContainerMappingInput:
    description: Container pairing update input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/UpdateProtectionContainerMappingInputProperties'
        description: Update protection container mapping input properties.
  ReplicationProviderSpecificContainerMappingInput:
    description: Provider specific input for pairing operations.
    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
  CreateProtectionContainerMappingInput:
    description: Configure pairing input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/CreateProtectionContainerMappingInputProperties'
        description: Configure protection input properties.
  RemoveProtectionContainerMappingInput:
    description: Container unpairing input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/RemoveProtectionContainerMappingInputProperties'
        description: Configure protection input 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
  ProtectionContainerMapping:
    description: Protection container mapping object.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ProtectionContainerMappingProperties'
        description: The custom data.
  ReplicationProviderSpecificUpdateContainerMappingInput:
    description: Provider specific input for update pairing operations.
    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
  UpdateProtectionContainerMappingInputProperties:
    description: Container pairing update input.
    type: object
    properties:
      providerSpecificInput:
        $ref: '#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput'
        description: Provider specific input for updating protection container mapping.
  CreateProtectionContainerMappingInputProperties:
    description: Configure pairing input properties.
    type: object
    properties:
      targetProtectionContainerId:
        description: The target unique protection container name.
        type: string
      policyId:
        description: Applicable policy.
        type: string
      providerSpecificInput:
        $ref: '#/definitions/ReplicationProviderSpecificContainerMappingInput'
        description: Provider specific input for pairing.
  RemoveProtectionContainerMappingInputProperties:
    description: Unpairing input properties.
    type: object
    properties:
      providerSpecificInput:
        $ref: '#/definitions/ReplicationProviderContainerUnmappingInput'
        description: Provider specific input for unpairing.
  ProtectionContainerMappingCollection:
    description: Protection container mapping collection class.
    type: object
    properties:
      value:
        description: List of container mappings.
        type: array
        items:
          $ref: '#/definitions/ProtectionContainerMapping'
      nextLink:
        description: Link to fetch rest of the data.
        type: string
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'