Microsoft Azure AzureBackupJob API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AzureBackupJob API
schemes:
- https
tags:
- name: AzureBackupJob
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}
  : get:
      tags:
      - AzureBackupJob
      description: Gets a job with id in a backup vault
      operationId: microsoftAzureJobsGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultName'
      - name: jobId
        description: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
        in: path
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/AzureBackupJobResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Get Job:
          $ref: ./examples/JobCRUD/GetJob.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupjobs Jobid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}/triggerCancel
  : post:
      tags:
      - AzureBackupJob
      description: Triggers cancellation of Job and returns an OperationID to track.
      operationId: microsoftAzureJobsTriggercancel
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/RestrictedVaultName'
      - name: jobId
        description: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
        in: path
        required: true
        type: string
      responses:
        '202':
          description: Accepted
          headers:
            Location:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Retry-After:
              description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.
              type: integer
              format: int32
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Trigger Cancel:
          $ref: ./examples/JobCRUD/TriggerCancel.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupjobs Jobid Triggercancel
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}/generateProgressUrl
  : post:
      tags:
      - AzureBackupJob
      description: Generates read SAS URL for a blob from which current job progress can be read.
      operationId: microsoftAzureJobsGenerateprogressurl
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/RestrictedVaultName'
      - name: jobId
        description: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
        in: path
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/AzureBackupJobProgressUrl'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Generate Progress URL:
          $ref: ./examples/JobCRUD/GenerateProgressURL.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupjobs Jobid Generateprogressurl
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/exportBackupJobs
  : post:
      tags:
      - AzureBackupJob
      description: Triggers export of jobs and returns an OperationID to track.
      operationId: microsoftAzureExportjobsTrigger
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultName'
      responses:
        '202':
          description: Accepted
          headers:
            Location:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Retry-After:
              description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.
              type: integer
              format: int32
        '204':
          description: NoContent
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Trigger Export Jobs:
          $ref: ./examples/JobCRUD/TriggerExportJobs.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Exportbackupjobs
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{operationId}
  : get:
      tags:
      - AzureBackupJob
      description: Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.
      operationId: microsoftAzureExportjobsoperationresultGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultName'
      - name: operationId
        description: OperationID which represents the export job.
        in: path
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ExportJobsResult'
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Get Export Jobs Operation Result:
          $ref: ./examples/JobCRUD/GetExportJobsOperationResult.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupjobs Operations Operationid
definitions:
  UserFacingWarningDetail:
    description: Warning object used by layers that have access to localized content, and propagate that to user
    properties:
      resourceName:
        description: Name of resource for which warning is raised.
        type: string
      warning:
        $ref: '#/definitions/UserFacingError'
        description: Error details for the warning.
    required:
    - warning
    type: object
  RestoreJobRecoveryPointDetails:
    properties:
      recoveryPointID:
        type: string
      recoveryPointTime:
        format: date-time
        type: string
    type: object
  AzureBackupJob:
    description: AzureBackup Job Class
    properties:
      activityID:
        description: Job Activity Id
        type: string
      backupInstanceFriendlyName:
        description: Name of the Backup Instance
        type: string
      backupInstanceId:
        description: ARM ID of the Backup Instance
        readOnly: true
        type: string
      dataSourceId:
        description: ARM ID of the DataSource
        type: string
      dataSourceLocation:
        description: Location of the DataSource
        type: string
      dataSourceName:
        description: User Friendly Name of the DataSource
        type: string
      dataSourceSetName:
        description: Data Source Set Name of the DataSource
        type: string
      dataSourceType:
        description: Type of DataSource
        type: string
      duration:
        description: Total run time of the job. ISO 8601 format.
        type: string
      endTime:
        description: EndTime of the job(in UTC)
        format: date-time
        readOnly: true
        type: string
      errorDetails:
        description: A List, detailing the errors related to the job
        items:
          $ref: '#/definitions/UserFacingError'
        x-ms-identifiers: []
        readOnly: true
        type: array
      extendedInfo:
        $ref: '#/definitions/JobExtendedInfo'
        description: Extended Information about the job
        readOnly: true
      isUserTriggered:
        description: Indicated that whether the job is adhoc(true) or scheduled(false)
        type: boolean
      operation:
        description: It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure
        type: string
      operationCategory:
        description: It indicates the type of Job i.e. Backup/Restore/Tiering/Management
        type: string
      policyId:
        description: ARM ID of the policy
        readOnly: true
        type: string
      policyName:
        description: Name of the policy
        readOnly: true
        type: string
      progressEnabled:
        description: Indicated whether progress is enabled for the job
        type: boolean
      progressUrl:
        description: Url which contains job's progress
        readOnly: true
        type: string
      rehydrationPriority:
        description: Priority to be used for rehydration
        readOnly: true
        type: string
      restoreType:
        description: It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR
        readOnly: true
        type: string
      sourceDataStoreType:
        description: The type of the source data store.
        readOnly: true
        type: string
      sourceResourceGroup:
        description: Resource Group Name of the Datasource
        type: string
      sourceSubscriptionID:
        description: SubscriptionId corresponding to the DataSource
        type: string
      startTime:
        description: StartTime of the job(in UTC)
        format: date-time
        type: string
      status:
        description: Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning
        type: string
      subscriptionId:
        description: Subscription Id of the corresponding backup vault
        type: string
      supportedActions:
        description: List of supported actions
        items:
          type: string
        type: array
      vaultName:
        description: Name of the vault
        type: string
      etag:
        type: string
      sourceDataStoreName:
        type: string
      destinationDataStoreName:
        type: string
    required:
    - activityID
    - subscriptionId
    - dataSourceId
    - vaultName
    - backupInstanceFriendlyName
    - sourceResourceGroup
    - dataSourceName
    - progressEnabled
    - sourceSubscriptionID
    - dataSourceLocation
    - startTime
    - dataSourceType
    - operationCategory
    - operation
    - status
    - isUserTriggered
    - supportedActions
    type: object
  CloudError:
    description: An error response from Azure Backup.
    properties:
      error:
        $ref: '#/definitions/Error'
    title: CloudError
    x-ms-external: true
  DppResource:
    description: Resource class
    properties:
      id:
        description: Resource Id represents the complete path to the resource.
        readOnly: true
        type: string
      name:
        description: Resource name associated with the resource.
        readOnly: true
        type: string
      type:
        description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
        readOnly: true
        type: string
      systemData:
        $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/systemData
    title: DppResource
    type: object
    x-ms-azure-resource: true
  JobExtendedInfo:
    description: Extended Information about the job
    properties:
      additionalDetails:
        additionalProperties:
          readOnly: true
          type: string
        description: Job's Additional Details
      backupInstanceState:
        description: State of the Backup Instance
        readOnly: true
        type: string
      dataTransferredInBytes:
        description: Number of bytes transferred
        format: double
        readOnly: true
        type: number
      recoveryDestination:
        description: Destination where restore is done
        readOnly: true
        type: string
      sourceRecoverPoint:
        $ref: '#/definitions/RestoreJobRecoveryPointDetails'
        description: Details of the Source Recovery Point
        readOnly: true
      subTasks:
        description: List of Sub Tasks of the job
        items:
          $ref: '#/definitions/JobSubTask'
        x-ms-identifiers: []
        readOnly: true
        type: array
      targetRecoverPoint:
        $ref: '#/definitions/RestoreJobRecoveryPointDetails'
        description: Details of the Target Recovery Point
        readOnly: true
      warningDetails:
        description: A List, detailing the warnings related to the job
        items:
          $ref: '#/definitions/UserFacingWarningDetail'
        x-ms-identifiers: []
        readOnly: true
        type: array
    type: object
  InnerError:
    description: Inner Error
    properties:
      additionalInfo:
        additionalProperties:
          type: string
        description: Any Key value pairs that can be provided to the client for additional  verbose information.
        type: object
      code:
        description: Unique code for this error
        type: string
      embeddedInnerError:
        $ref: '#/definitions/InnerError'
        description: Child Inner Error, to allow Nesting.
    title: InnerError
    type: object
  AzureBackupJobProgressUrl:
    description: Job Progress URL class.
    properties:
      progressUrl:
        description: Read SAS URI for a blob from which current job progress can be read.
        type: string
        x-ms-secret: true
    type: object
  AzureBackupJobResource:
    allOf:
    - $ref: '#/definitions/DppResource'
    description: AzureBackup Job Resource Class
    properties:
      properties:
        $ref: '#/definitions/AzureBackupJob'
        description: AzureBackupJobResource properties
        type: object
    type: object
  ExportJobsResult:
    description: The result for export jobs containing blob details.
    properties:
      blobUrl:
        description: URL of the blob into which the serialized string of list of jobs is exported.
        readOnly: true
        type: string
      blobSasKey:
        description: SAS key to access the blob.
        readOnly: true
        type: string
      excelFileBlobUrl:
        description: URL of the blob into which the ExcelFile is uploaded.
        readOnly: true
        type: string
      excelFileBlobSasKey:
        description: SAS key to access the ExcelFile blob.
        readOnly: true
        type: string
    title: ExportJobsResult
    type: object
  UserFacingError:
    description: Error object used by layers that have access to localized content, and propagate that to user
    properties:
      code:
        description: Unique code for this error
        type: string
      details:
        description: Additional related Errors
        items:
          $ref: '#/definitions/UserFacingError'
        x-ms-identifiers: []
        type: array
      innerError:
        $ref: '#/definitions/InnerError'
        description: Inner Error
      isRetryable:
        description: Whether the operation will be retryable or not
        type: boolean
      isUserError:
        description: Whether the operation is due to a user error or service error
        type: boolean
      properties:
        description: Any key value pairs that can be injected inside error object
        type: object
        additionalProperties:
          type: string
      message:
        type: string
      recommendedAction:
        description: RecommendedAction � localized.
        items:
          type: string
        type: array
      target:
        description: Target of the error.
        type: string
    type: object
  JobSubTask:
    description: Details of Job's Sub Task
    properties:
      additionalDetails:
        additionalProperties:
          readOnly: true
          type: string
        description: Additional details of Sub Tasks
      taskId:
        description: Task Id of the Sub Task
        format: int32
        type: integer
      taskName:
        description: Name of the Sub Task
        type: string
      taskProgress:
        description: Progress of the Sub Task
        readOnly: true
        type: string
      taskStatus:
        description: Status of the Sub Task
        type: string
    required:
    - taskId
    - taskName
    - taskStatus
    type: object
  ErrorAdditionalInfo:
    description: The resource management error additional info.
    properties:
      info:
        description: The additional info.
        readOnly: true
        type: object
      type:
        description: The additional info type.
        readOnly: true
        type: string
  Error:
    description: The resource management error response.
    properties:
      additionalInfo:
        description: The error additional info.
        items:
          $ref: '#/definitions/ErrorAdditionalInfo'
        x-ms-identifiers: []
        readOnly: true
        type: array
      code:
        description: The error code.
        readOnly: true
        type: string
      details:
        description: The error details.
        items:
          $ref: '#/definitions/Error'
        x-ms-identifiers: []
        readOnly: true
        type: array
      message:
        description: The error message.
        readOnly: true
        type: string
      target:
        description: The error target.
        readOnly: true
        type: string
parameters:
  RestrictedVaultName:
    name: vaultName
    in: path
    description: The name of the backup vault.
    required: true
    type: string
    x-ms-parameter-location: method
    pattern: ^[A-Za-z][-A-Za-z0-9]*[A-Za-z0-9]$
    minLength: 2
    maxLength: 50
  VaultName:
    name: vaultName
    in: path
    description: The name of the backup vault.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'