swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReplicationProtectionIntents API
schemes:
- https
tags:
- name: ReplicationProtectionIntents
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents
  : get:
      tags:
      - ReplicationProtectionIntents
      summary: Microsoft Azure Gets The List Of Replication Protection Intent Objects
      description: Gets the list of ASR replication protection intent objects in the vault.
      operationId: microsoftAzureReplicationprotectionintentsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: skipToken
        in: query
        description: The pagination token.
        required: false
        type: string
      - name: takeToken
        in: query
        description: The page size.
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectionIntentCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets the list of replication protection intent objects.:
          $ref: ./examples/ReplicationProtectionIntents_List.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName}
  : get:
      tags:
      - ReplicationProtectionIntents
      summary: Microsoft Azure Gets The Details Of A Replication Protection Intent Item
      description: Gets the details of an ASR replication protection intent.
      operationId: microsoftAzureReplicationprotectionintentsGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: intentObjectName
        in: path
        description: Replication protection intent name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectionIntent'
      x-ms-examples:
        Gets the details of a Replication protection intent item.:
          $ref: ./examples/ReplicationProtectionIntents_Get.json
    put:
      tags:
      - ReplicationProtectionIntents
      summary: Microsoft Azure Create Protection Intent Resource
      description: The operation to create an ASR replication protection intent item.
      operationId: microsoftAzureReplicationprotectionintentsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: intentObjectName
        in: path
        description: A name for the replication protection item.
        required: true
        type: string
      - name: input
        in: body
        description: Create Protection Intent Input.
        required: true
        schema:
          $ref: '#/definitions/CreateProtectionIntentInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReplicationProtectionIntent'
      x-ms-examples:
        Create protection intent Resource.:
          $ref: ./examples/ReplicationProtectionIntents_Create.json
definitions:
  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
  ReplicationProtectionIntentProviderSpecificSettings:
    description: Replication provider specific settings.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets the Instance type.
        type: string
    discriminator: instanceType
  CreateProtectionIntentProperties:
    description: Create protection intent input properties.
    type: object
    properties:
      providerSpecificDetails:
        $ref: '#/definitions/CreateProtectionIntentProviderSpecificDetails'
        description: The ReplicationProviderInput. For A2A provider, it will be A2ACreateProtectionIntentInput object.
  ReplicationProtectionIntentProperties:
    description: Replication protection intent custom data details.
    type: object
    properties:
      friendlyName:
        description: The name.
        type: string
      jobId:
        description: The job Id.
        type: string
        readOnly: true
      jobState:
        description: The job state.
        type: string
        readOnly: true
      isActive:
        description: A value indicating whether the intent object is active.
        type: boolean
        readOnly: true
      creationTimeUTC:
        description: The creation time in UTC.
        type: string
        readOnly: true
      providerSpecificDetails:
        $ref: '#/definitions/ReplicationProtectionIntentProviderSpecificSettings'
        description: The Replication provider custom settings.
  CreateProtectionIntentProviderSpecificDetails:
    description: Create protection intent provider specific input.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The class type.
        type: string
    discriminator: instanceType
  ReplicationProtectionIntentCollection:
    description: Replication protection intent objects collection.
    type: object
    properties:
      value:
        description: The Replication protection intent details.
        type: array
        items:
          $ref: '#/definitions/ReplicationProtectionIntent'
      nextLink:
        description: The value of next link.
        type: string
  ReplicationProtectionIntent:
    description: Replication protection intent.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ReplicationProtectionIntentProperties'
        description: The custom data.
  CreateProtectionIntentInput:
    description: Create protection intent input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/CreateProtectionIntentProperties'
        description: Create protection intent input properties.
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'