swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector JobRuns API
schemes:
- https
tags:
- name: JobRuns
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/jobRuns
  : get:
      tags:
      - JobRuns
      operationId: microsoftAzureJobrunsList
      description: Lists all Job Runs in a Job Definition.
      x-ms-examples:
        JobRuns_List:
          $ref: ./examples/JobRuns_List.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/StorageMoverNameParameter'
      - $ref: '#/parameters/ProjectNameParameter'
      - $ref: '#/parameters/JobDefinitionNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The list of Job Runs.
          schema:
            $ref: '#/definitions/JobRunList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Projects Projectname Jobdefinitions Jobdefinitionname Jobruns
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/jobRuns/{jobRunName}
  : get:
      tags:
      - JobRuns
      operationId: microsoftAzureJobrunsGet
      description: Gets a Job Run resource.
      x-ms-examples:
        JobRuns_Get:
          $ref: ./examples/JobRuns_Get.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/StorageMoverNameParameter'
      - $ref: '#/parameters/ProjectNameParameter'
      - $ref: '#/parameters/JobDefinitionNameParameter'
      - $ref: '#/parameters/JobRunNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The Job Run resource.
          schema:
            $ref: '#/definitions/JobRun'
        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 Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Projects Projectname Jobdefinitions Jobdefinitionname Jobruns Jobrunname
definitions:
  JobRunProperties:
    description: Job run properties.
    type: object
    properties:
      status:
        readOnly: true
        enum:
        - Queued
        - Started
        - Running
        - CancelRequested
        - Canceling
        - Canceled
        - Failed
        - Succeeded
        type: string
        x-ms-enum:
          name: JobRunStatus
          modelAsString: true
        description: The state of the job execution.
      scanStatus:
        readOnly: true
        enum:
        - NotStarted
        - Scanning
        - Completed
        type: string
        x-ms-enum:
          name: JobRunScanStatus
          modelAsString: true
        description: The status of Agent's scanning of source.
      agentName:
        readOnly: true
        type: string
        description: Name of the Agent assigned to this run.
      agentResourceId:
        readOnly: true
        type: string
        description: Fully qualified resource id of the Agent assigned to this run.
      executionStartTime:
        readOnly: true
        type: string
        format: date-time
        description: Start time of the run. Null if no Agent reported that the job has started.
      executionEndTime:
        readOnly: true
        type: string
        format: date-time
        description: End time of the run. Null if Agent has not reported that the job has ended.
      lastStatusUpdate:
        type: string
        format: date-time
        description: The last updated time of the Job Run.
        readOnly: true
      itemsScanned:
        type: integer
        format: int64
        description: Number of items scanned so far in source.
        readOnly: true
      itemsExcluded:
        type: integer
        format: int64
        description: Number of items that will not be transferred, as they are excluded by user configuration.
        readOnly: true
      itemsUnsupported:
        type: integer
        format: int64
        description: Number of items that will not be transferred, as they are unsupported on target.
        readOnly: true
      itemsNoTransferNeeded:
        type: integer
        format: int64
        description: Number of items that will not be transferred, as they are already found on target (e.g. mirror mode).
        readOnly: true
      itemsFailed:
        type: integer
        format: int64
        description: Number of items that were attempted to transfer and failed.
        readOnly: true
      itemsTransferred:
        type: integer
        format: int64
        description: Number of items successfully transferred to target.
        readOnly: true
      bytesScanned:
        type: integer
        format: int64
        description: Bytes of data scanned so far in source.
        readOnly: true
      bytesExcluded:
        type: integer
        format: int64
        description: Bytes of data that will not be transferred, as they are excluded by user configuration.
        readOnly: true
      bytesUnsupported:
        type: integer
        format: int64
        description: Bytes of data that will not be transferred, as they are unsupported on target.
        readOnly: true
      bytesNoTransferNeeded:
        type: integer
        format: int64
        description: Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode).
        readOnly: true
      bytesFailed:
        type: integer
        format: int64
        description: Bytes of data that were attempted to transfer and failed.
        readOnly: true
      bytesTransferred:
        type: integer
        format: int64
        description: Bytes of data successfully transferred to target.
        readOnly: true
      sourceName:
        type: string
        description: Name of source Endpoint resource. This resource may no longer exist.
        readOnly: true
      sourceResourceId:
        type: string
        description: Fully qualified resource id of source Endpoint. This id may no longer exist.
        readOnly: true
      sourceProperties:
        type: object
        description: Copy of source Endpoint resource's properties at time of Job Run creation.
        readOnly: true
      targetName:
        type: string
        description: Name of target Endpoint resource. This resource may no longer exist.
        readOnly: true
      targetResourceId:
        type: string
        description: Fully qualified resource id of of Endpoint. This id may no longer exist.
        readOnly: true
      targetProperties:
        type: object
        description: Copy of Endpoint resource's properties at time of Job Run creation.
        readOnly: true
      jobDefinitionProperties:
        type: object
        description: Copy of parent Job Definition's properties at time of Job Run creation.
        readOnly: true
      error:
        readOnly: true
        $ref: '#/definitions/JobRunError'
        description: Error details.
      provisioningState:
        description: The provisioning state of this resource.
        enum:
        - Succeeded
        type: string
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
        readOnly: true
  JobRunError:
    type: object
    description: Error type
    properties:
      code:
        type: string
        description: Error code of the given entry.
      message:
        type: string
        description: Error message of the given entry.
      target:
        type: string
        description: Target of the given error entry.
  JobRunList:
    description: List of Job Runs.
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/JobRun'
        readOnly: true
      nextLink:
        type: string
        description: Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.
        readOnly: true
  JobRun:
    description: The Job Run resource.
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/JobRunProperties'
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Resource system metadata.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
parameters:
  JobRunNameParameter:
    name: jobRunName
    in: path
    required: true
    type: string
    description: The name of the Job Run resource.
    x-ms-parameter-location: method
  JobDefinitionNameParameter:
    name: jobDefinitionName
    in: path
    required: true
    type: string
    description: The name of the Job Definition resource.
    x-ms-parameter-location: method
  ProjectNameParameter:
    name: projectName
    in: path
    required: true
    type: string
    description: The name of the Project resource.
    x-ms-parameter-location: method
  StorageMoverNameParameter:
    name: storageMoverName
    in: path
    required: true
    type: string
    description: The name of the Storage Mover resource.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'