swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ProtectedItemOperationStatuses API
schemes:
- https
tags:
- name: ProtectedItemOperationStatuses
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationsStatus/{operationId}
  : get:
      tags:
      - ProtectedItemOperationStatuses
      description: Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed<br>or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations<br>create jobs. This method returns the list of jobs associated with the operation.
      operationId: microsoftAzureProtecteditemoperationstatusesGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/VaultName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name associated with the backup item.
        required: true
        type: string
      - name: containerName
        in: path
        description: Container name associated with the backup item.
        required: true
        type: string
      - name: protectedItemName
        in: path
        description: Backup item name whose details are to be fetched.
        required: true
        type: string
      - name: operationId
        in: path
        description: OperationID represents the operation whose status needs to be fetched.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Get Operation Status of Protected Vm:
          $ref: ./examples/AzureIaasVm/ProtectedItemOperationStatus.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Operationsstatus Operationid
definitions:
  OperationStatus:
    description: Operation status.
    type: object
    properties:
      id:
        description: ID of the operation.
        type: string
      name:
        description: Name of the operation.
        type: string
      status:
        description: Operation status.
        enum:
        - Invalid
        - InProgress
        - Succeeded
        - Failed
        - Canceled
        type: string
        x-ms-enum:
          name: OperationStatusValues
          modelAsString: true
      startTime:
        format: date-time
        description: 'Operation start time. Format: ISO-8601.'
        type: string
      endTime:
        format: date-time
        description: 'Operation end time. Format: ISO-8601.'
        type: string
      error:
        $ref: '#/definitions/OperationStatusError'
        description: Error information related to this operation.
      properties:
        $ref: '#/definitions/OperationStatusExtendedInfo'
        description: Additional information associated with this operation.
  OperationStatusError:
    description: Error information associated with operation status call.
    type: object
    properties:
      code:
        description: Error code of the operation failure.
        type: string
      message:
        description: Error message displayed if the operation failure.
        type: string
  OperationStatusExtendedInfo:
    description: Base class for additional information of operation status.
    required:
    - objectType
    type: object
    properties:
      objectType:
        description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
        type: string
    discriminator: objectType
  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.
  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.
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'