swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector OperationsStatus API
schemes:
- https
tags:
- name: OperationsStatus
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}
  : get:
      tags:
      - OperationsStatus
      summary: Microsoft Azure Gets The Details Of A Specified Job On A Data Box Edge Data Box Gateway Device
      operationId: microsoftAzureOperationsstatusGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The job name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The job details.
          schema:
            $ref: '#/definitions/Job'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        OperationsStatusGet:
          $ref: ./examples/OperationsStatusGet.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/operationsStatus/{operationId}:
    get:
      tags:
      - OperationsStatus
      operationId: microsoftAzureOperationsstatusGet
      x-ms-examples:
        OperationsStatusGet:
          $ref: ./examples/OperationsStatusGet.json
      description: Gets the status of operation.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Success. The detailed status of the operation is in the response.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Cache Locations Location Operationsstatus Operationid
definitions:
  OperationStatus:
    description: The status of a long-running operation.
    type: object
    properties:
      id:
        type: string
        description: The operation's unique id.
      name:
        type: string
        description: The operation's name.
      startTime:
        type: string
        description: The start time of the operation.
      endTime:
        type: string
        description: The end time of the operation.
      status:
        type: string
        description: The current status of the operation.
      error:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
        description: Error response describing why the operation failed.
  UpdateInstallProgress:
    description: Progress details during installation of updates.
    type: object
    properties:
      percentComplete:
        format: int32
        description: Percentage completed.
        type: integer
        readOnly: true
      numberOfUpdatesToInstall:
        format: int32
        description: Number of updates to install.
        type: integer
        readOnly: true
      numberOfUpdatesInstalled:
        format: int32
        description: Number of updates installed.
        type: integer
        readOnly: true
  JobProperties:
    description: The properties for the job.
    type: object
    properties:
      jobType:
        description: The type of the job.
        enum:
        - Invalid
        - ScanForUpdates
        - DownloadUpdates
        - InstallUpdates
        - RefreshShare
        - RefreshContainer
        - Backup
        - Restore
        - TriggerSupportPackage
        type: string
        readOnly: true
        x-ms-enum:
          name: JobType
          modelAsString: true
      currentStage:
        description: Current stage of the update operation.
        enum:
        - Unknown
        - Initial
        - ScanStarted
        - ScanComplete
        - ScanFailed
        - DownloadStarted
        - DownloadComplete
        - DownloadFailed
        - InstallStarted
        - InstallComplete
        - InstallFailed
        - RebootInitiated
        - Success
        - Failure
        - RescanStarted
        - RescanComplete
        - RescanFailed
        type: string
        readOnly: true
        x-ms-enum:
          name: UpdateOperationStage
          modelAsString: true
      downloadProgress:
        $ref: '#/definitions/UpdateDownloadProgress'
        description: The download progress.
        readOnly: true
      installProgress:
        $ref: '#/definitions/UpdateInstallProgress'
        description: The install progress.
        readOnly: true
      totalRefreshErrors:
        format: int32
        description: Total number of errors encountered during the refresh process.
        type: integer
        readOnly: true
      errorManifestFile:
        description: Local share/remote container relative path to the error manifest file of the refresh.
        type: string
        readOnly: true
      refreshedEntityId:
        description: ARM ID of the entity that was refreshed.
        type: string
        readOnly: true
      folder:
        description: If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.)
        type: string
  CloudError:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: true
  JobErrorDetails:
    description: The job error information containing the list of job errors.
    type: object
    properties:
      errorDetails:
        description: The error details.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/JobErrorItem'
        x-ms-identifiers: []
        readOnly: true
      code:
        description: The code intended for programmatic access.
        type: string
        readOnly: true
      message:
        description: The message that describes the error in detail.
        type: string
        readOnly: true
  CloudErrorBody:
    description: An error response from the service.
    type: object
    properties:
      code:
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        type: string
      message:
        description: A message describing the error, intended to be suitable for display in a user interface.
        type: string
      details:
        description: A list of additional details about the error.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers: []
    x-ms-external: true
  JobErrorItem:
    description: The job error items.
    type: object
    properties:
      recommendations:
        description: The recommended actions.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
        x-ms-identifiers: []
      code:
        description: The code intended for programmatic access.
        type: string
        readOnly: true
      message:
        description: The message that describes the error in detail.
        type: string
        readOnly: true
  Job:
    description: A device job.
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The name of the object.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
      status:
        description: The current status of the job.
        enum:
        - Invalid
        - Running
        - Succeeded
        - Failed
        - Canceled
        - Paused
        - Scheduled
        type: string
        readOnly: true
        x-ms-enum:
          name: JobStatus
          modelAsString: true
      startTime:
        format: date-time
        description: The UTC date and time at which the job started.
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: The UTC date and time at which the job completed.
        type: string
        readOnly: true
      percentComplete:
        format: int32
        description: The percentage of the job that is complete.
        type: integer
        readOnly: true
      error:
        $ref: '#/definitions/JobErrorDetails'
        description: The error details.
        readOnly: true
      properties:
        $ref: '#/definitions/JobProperties'
        description: The properties of the job.
        readOnly: true
        x-ms-client-flatten: true
  UpdateDownloadProgress:
    description: Details about the download progress of update.
    type: object
    properties:
      downloadPhase:
        description: The download phase.
        enum:
        - Unknown
        - Initializing
        - Downloading
        - Verifying
        type: string
        readOnly: true
        x-ms-enum:
          name: DownloadPhase
          modelAsString: true
      percentComplete:
        format: int32
        description: Percentage of completion.
        type: integer
        readOnly: true
      totalBytesToDownload:
        format: double
        description: Total bytes to download.
        type: number
        readOnly: true
      totalBytesDownloaded:
        format: double
        description: Total bytes downloaded.
        type: number
        readOnly: true
      numberOfUpdatesToDownload:
        format: int32
        description: Number of updates to download.
        type: integer
        readOnly: true
      numberOfUpdatesDownloaded:
        format: int32
        description: Number of updates downloaded.
        type: integer
        readOnly: true
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    description: The API version.
    required: true
    type: string
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'