swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BackupEngines API
schemes:
- https
tags:
- name: BackupEngines
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines
  : get:
      tags:
      - BackupEngines
      description: Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.
      operationId: microsoftAzureBackupenginesList
      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/BackupEngineBaseResourceList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-odata: '#/definitions/BMSBackupEnginesQueryObject'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List Dpm/AzureBackupServer/Lajolla Backup Engines:
          $ref: ./examples/Dpm/BackupEngines_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupengines
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines/{backupEngineName}
  : get:
      tags:
      - BackupEngines
      description: Returns backup management server registered to Recovery Services Vault.
      operationId: microsoftAzureBackupenginesGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/VaultName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: backupEngineName
        in: path
        description: Name of the backup management server.
        required: true
        type: string
      - 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/BackupEngineBaseResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-odata: '#/definitions/BMSBackupEngineQueryObject'
      x-ms-examples:
        Get Dpm/AzureBackupServer/Lajolla Backup Engine Details:
          $ref: ./examples/Dpm/BackupEngines_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupengines Backupenginename
definitions:
  BackupEngineExtendedInfo:
    description: Additional information on backup engine.
    type: object
    properties:
      databaseName:
        description: Database name of backup engine.
        type: string
      protectedItemsCount:
        format: int32
        description: Number of protected items in the backup engine.
        type: integer
      protectedServersCount:
        format: int32
        description: Number of protected servers in the backup engine.
        type: integer
      diskCount:
        format: int32
        description: Number of disks in the backup engine.
        type: integer
      usedDiskSpace:
        format: double
        description: Disk space used in the backup engine.
        type: number
      availableDiskSpace:
        format: double
        description: Disk space currently available in the backup engine.
        type: number
      refreshedAt:
        format: date-time
        description: Last refresh time in the backup engine.
        type: string
      azureProtectedInstances:
        format: int32
        description: Protected instances in the backup engine.
        type: integer
  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
  CloudError:
    x-ms-external: true
    properties:
      error:
        type: object
        $ref: '#/definitions/CloudErrorBody'
        description: The error object.
    description: An error response from the Container Instance service.
  BackupEngineBaseResourceList:
    description: List of BackupEngineBase resources
    type: object
    allOf:
    - $ref: '#/definitions/ResourceList'
    properties:
      value:
        description: List of resources.
        type: array
        items:
          $ref: '#/definitions/BackupEngineBaseResource'
  CloudErrorBody:
    x-ms-external: true
    properties:
      code:
        readOnly: true
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        readOnly: true
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      target:
        readOnly: true
        type: string
        description: The target of the particular error. For example, the name of the property in error.
      details:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers:
        - code
        description: A list of additional details about the error.
      additionalInfo:
        readOnly: true
        type: array
        items:
          $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo
        x-ms-identifiers: []
        description: The error additional info.
    description: An error response from the Container Instance service.
  BackupEngineBase:
    description: The base backup engine class. All workload specific backup engines derive from this class.
    type: object
    required:
    - backupEngineType
    properties:
      friendlyName:
        description: Friendly name of the backup engine.
        type: string
      backupManagementType:
        description: Type of backup management for the backup engine.
        enum:
        - Invalid
        - AzureIaasVM
        - MAB
        - DPM
        - AzureBackupServer
        - AzureSql
        - AzureStorage
        - AzureWorkload
        - DefaultBackup
        type: string
        x-ms-enum:
          name: BackupManagementType
          modelAsString: true
      registrationStatus:
        description: Registration status of the backup engine with the Recovery Services Vault.
        type: string
      backupEngineState:
        description: Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}
        type: string
      healthStatus:
        description: Backup status of the backup engine.
        type: string
      backupEngineType:
        description: Type of the backup engine.
        enum:
        - Invalid
        - DpmBackupEngine
        - AzureBackupServerEngine
        type: string
        x-ms-enum:
          name: BackupEngineType
          modelAsString: true
      canReRegister:
        description: Flag indicating if the backup engine be registered, once already registered.
        type: boolean
      backupEngineId:
        description: ID of the backup engine.
        type: string
      dpmVersion:
        description: Backup engine version
        type: string
      azureBackupAgentVersion:
        description: Backup agent version
        type: string
      isAzureBackupAgentUpgradeAvailable:
        description: To check if backup agent upgrade available
        type: boolean
      isDpmUpgradeAvailable:
        description: To check if backup engine upgrade available
        type: boolean
      extendedInfo:
        $ref: '#/definitions/BackupEngineExtendedInfo'
        description: Extended info of the backupengine
    discriminator: backupEngineType
  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
  BackupEngineBaseResource:
    description: The base backup engine class. All workload specific backup engines derive from this class.
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/BackupEngineBase'
        description: BackupEngineBaseResource 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: 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'