swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReplicationProtectionContainers API
schemes:
- https
tags:
- name: ReplicationProtectionContainers
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers
  : get:
      tags:
      - ReplicationProtectionContainers
      summary: Microsoft Azure Gets The List Of Protection Container For A Fabric
      description: Lists the protection containers in the specified fabric.
      operationId: microsoftAzureReplicationprotectioncontainersListbyreplicationfabrics
      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
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionContainerCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets the list of protection container for a fabric.:
          $ref: ./examples/ReplicationProtectionContainers_ListByReplicationFabrics.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}
  : get:
      tags:
      - ReplicationProtectionContainers
      summary: Microsoft Azure Gets The Protection Container Details
      description: Gets the details of a protection container.
      operationId: microsoftAzureReplicationprotectioncontainersGet
      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/ProtectionContainer'
      x-ms-examples:
        Gets the protection container details.:
          $ref: ./examples/ReplicationProtectionContainers_Get.json
    put:
      tags:
      - ReplicationProtectionContainers
      summary: Microsoft Azure Create A Protection Container
      description: Operation to create a protection container.
      operationId: microsoftAzureReplicationprotectioncontainersCreate
      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 ARM name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Unique protection container ARM name.
        required: true
        type: string
      - name: creationInput
        in: body
        description: Creation input.
        required: true
        schema:
          $ref: '#/definitions/CreateProtectionContainerInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionContainer'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Create a protection container.:
          $ref: ./examples/ReplicationProtectionContainers_Create.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/discoverProtectableItem
  : post:
      tags:
      - ReplicationProtectionContainers
      summary: Microsoft Azure Adds A Protectable Item To The Replication Protection Container
      description: The operation to a add a protectable item to a protection container(Add physical server).
      operationId: microsoftAzureReplicationprotectioncontainersDiscoverprotectableitem
      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.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: The name of the protection container.
        required: true
        type: string
      - name: discoverProtectableItemRequest
        in: body
        description: The request object to add a protectable item.
        required: true
        schema:
          $ref: '#/definitions/DiscoverProtectableItemRequest'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionContainer'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Adds a protectable item to the replication protection container.:
          $ref: ./examples/ReplicationProtectionContainers_DiscoverProtectableItem.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/remove
  : post:
      tags:
      - ReplicationProtectionContainers
      summary: Microsoft Azure Removes A Protection Container
      description: Operation to remove a protection container.
      operationId: microsoftAzureReplicationprotectioncontainersDelete
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Unique fabric ARM name.
        required: true
        type: string
      - name: protectionContainerName
        in: path
        description: Unique protection container ARM name.
        required: true
        type: string
      responses:
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Removes a protection container.:
          $ref: ./examples/ReplicationProtectionContainers_Delete.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection
  : post:
      tags:
      - ReplicationProtectionContainers
      summary: Microsoft Azure Switches Protection From One Container To Another Or One Replication Provider To Another
      description: Operation to switch protection from one container to another or one replication provider to another.
      operationId: microsoftAzureReplicationprotectioncontainersSwitchprotection
      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: switchInput
        in: body
        description: Switch protection input.
        required: true
        schema:
          $ref: '#/definitions/SwitchProtectionInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionContainer'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Switches protection from one container to another or one replication provider to another.:
          $ref: ./examples/ReplicationProtectionContainers_SwitchProtection.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainers
  : get:
      tags:
      - ReplicationProtectionContainers
      summary: Microsoft Azure Gets The List Of All Protection Containers In A Vault
      description: Lists the protection containers in a vault.
      operationId: microsoftAzureReplicationprotectioncontainersList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionContainerCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets the list of all protection containers in a vault.:
          $ref: ./examples/ReplicationProtectionContainers_List.json
definitions:
  CreateProtectionContainerInput:
    description: Create protection container input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/CreateProtectionContainerInputProperties'
        description: Create protection container input properties.
  ProtectionContainerProperties:
    description: Protection profile custom data details.
    type: object
    properties:
      fabricFriendlyName:
        description: Fabric friendly name.
        type: string
      friendlyName:
        description: The name.
        type: string
      fabricType:
        description: The fabric type.
        type: string
      protectedItemCount:
        format: int32
        description: Number of protected PEs.
        type: integer
      pairingStatus:
        description: The pairing status of this cloud.
        type: string
      role:
        description: The role of this cloud.
        type: string
      fabricSpecificDetails:
        $ref: '#/definitions/ProtectionContainerFabricSpecificDetails'
        description: Fabric specific details.
  DiscoverProtectableItemRequest:
    description: Request to add a physical machine as a protectable item in a container.
    type: object
    properties:
      properties:
        $ref: '#/definitions/DiscoverProtectableItemRequestProperties'
        description: The properties of a discover protectable item request.
  ProtectionContainerFabricSpecificDetails:
    description: Base class for fabric specific details of container.
    type: object
    properties:
      instanceType:
        description: Gets the class type. Overridden in derived classes.
        type: string
        readOnly: true
  DiscoverProtectableItemRequestProperties:
    description: Discover protectable item properties.
    type: object
    properties:
      friendlyName:
        description: The friendly name of the physical machine.
        type: string
      ipAddress:
        description: The IP address of the physical machine to be discovered.
        type: string
      osType:
        description: The OS type on the physical machine.
        type: string
  ReplicationProviderSpecificContainerCreationInput:
    description: Provider specific input for container creation operation.
    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
  SwitchProtectionInputProperties:
    description: Switch protection input properties.
    type: object
    properties:
      replicationProtectedItemName:
        description: The unique replication protected item name.
        type: string
      providerSpecificDetails:
        $ref: '#/definitions/SwitchProtectionProviderSpecificInput'
        description: Provider specific switch protection input.
  SwitchProtectionInput:
    description: Switch protection input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/SwitchProtectionInputProperties'
        description: Switch protection properties.
  ProtectionContainer:
    description: Protection container details.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ProtectionContainerProperties'
        description: The custom data.
  ProtectionContainerCollection:
    description: Protection Container collection.
    type: object
    properties:
      value:
        description: The Protection Container details.
        type: array
        items:
          $ref: '#/definitions/ProtectionContainer'
      nextLink:
        description: The value of next link.
        type: string
  CreateProtectionContainerInputProperties:
    description: Create protection container input properties.
    type: object
    properties:
      providerSpecificInput:
        description: Provider specific inputs for container creation.
        type: array
        items:
          $ref: '#/definitions/ReplicationProviderSpecificContainerCreationInput'
  SwitchProtectionProviderSpecificInput:
    description: Provider specific switch protection input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets the Instance type.
        type: string
    discriminator: instanceType
parameters:
  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
  ResourceName:
    name: resourceName
    in: path
    description: The name of the recovery services vault.
    required: true
    type: string
    x-ms-parameter-location: client
  ApiVersion:
    name: api-version
    in: query
    description: Client Api Version.
    required: true
    type: string
  SubscriptionId:
    name: subscriptionId
    in: path
    description: The subscription Id.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'