swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BackupProtectionIntent API
schemes:
- https
tags:
- name: BackupProtectionIntent
paths:
  ? /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionIntents
  : get:
      tags:
      - BackupProtectionIntent
      description: Provides a pageable list of all intents that are present within a vault.
      operationId: microsoftAzureBackupprotectionintentList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/VaultName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: $filter
        in: query
        description: OData filter options.
        required: false
        type: string
      - name: $skipToken
        in: query
        description: skipToken Filter.
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProtectionIntentResourceList'
      x-ms-odata: '#/definitions/ProtectionIntentQueryObject'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List protection intent with backupManagementType filter:
          $ref: ./examples/AzureWorkload/BackupProtectionIntent_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupprotectionintents
definitions:
  ProtectionIntentResource:
    description: Base class for backup ProtectionIntent.
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ProtectionIntent'
        description: ProtectionIntentResource properties
  Resource:
    description: ARM Resource.
    type: object
    properties:
      id:
        description: Resource Id represents the complete path to the resource.
        type: string
        readOnly: true
      name:
        description: Resource name associated with the resource.
        type: string
        readOnly: true
      type:
        description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
        type: string
        readOnly: true
      location:
        description: Resource location.
        type: string
      tags:
        description: Resource tags.
        type: object
        additionalProperties:
          type: string
      eTag:
        description: Optional ETag.
        type: string
    x-ms-azure-resource: true
  ProtectionIntent:
    description: Base class for backup ProtectionIntent.
    required:
    - protectionIntentItemType
    type: object
    properties:
      protectionIntentItemType:
        description: backup protectionIntent type.
        enum:
        - Invalid
        - AzureResourceItem
        - RecoveryServiceVaultItem
        - AzureWorkloadContainerAutoProtectionIntent
        - AzureWorkloadAutoProtectionIntent
        - AzureWorkloadSQLAutoProtectionIntent
        type: string
        x-ms-enum:
          name: ProtectionIntentItemType
          modelAsString: true
      backupManagementType:
        description: Type of backup management for the backed up item.
        enum:
        - Invalid
        - AzureIaasVM
        - MAB
        - DPM
        - AzureBackupServer
        - AzureSql
        - AzureStorage
        - AzureWorkload
        - DefaultBackup
        type: string
        x-ms-enum:
          name: BackupManagementType
          modelAsString: true
      sourceResourceId:
        description: ARM ID of the resource to be backed up.
        type: string
      itemId:
        description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
        type: string
      policyId:
        description: ID of the backup policy with which this item is backed up.
        type: string
      protectionState:
        description: Backup state of this backup item.
        enum:
        - Invalid
        - NotProtected
        - Protecting
        - Protected
        - ProtectionFailed
        type: string
        x-ms-enum:
          name: ProtectionStatus
          modelAsString: true
    discriminator: protectionIntentItemType
  ResourceList:
    description: Base for all lists of resources.
    type: object
    properties:
      nextLink:
        description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
        type: string
  ProtectionIntentResourceList:
    description: List of ProtectionIntent resources
    type: object
    allOf:
    - $ref: '#/definitions/ResourceList'
    properties:
      value:
        description: List of resources.
        type: array
        items:
          $ref: '#/definitions/ProtectionIntentResource'
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: method
  VaultName:
    name: vaultName
    in: path
    description: The name of the recovery services vault.
    required: true
    type: string
    x-ms-parameter-location: method
  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'