swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ImportJobs API
schemes:
- https
tags:
- name: ImportJobs
paths:
  /jobs/imports:
    parameters:
    - $ref: '#/parameters/traceparent'
    - $ref: '#/parameters/tracestate'
    get:
      tags:
      - ImportJobs
      operationId: microsoftAzureImportjobsList
      description: Retrieves all import jobs.<br>Status codes:<br>* 200 OK
      x-ms-examples:
        Get all import jobs:
          $ref: ./examples/ImportJobList.json
      parameters:
      - $ref: '#/parameters/max-items-per-page'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ImportJobCollection'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Jobs Imports
  /jobs/imports/{id}:
    parameters:
    - $ref: '#/parameters/traceparent'
    - $ref: '#/parameters/tracestate'
    put:
      tags:
      - ImportJobs
      operationId: microsoftAzureImportjobsAdd
      description: Creates an import job.<br>Status codes:<br>* 201 Created<br>* 400 Bad Request<br>  * JobLimitReached - The maximum number of import jobs allowed has been reached.<br>  * ValidationFailed - The import job request is not valid.
      x-ms-examples:
        Add a job:
          $ref: ./examples/ImportJobPut.json
      parameters:
      - $ref: '#/parameters/importJobId'
      - name: importJob
        description: The import job being added.
        in: body
        required: true
        schema:
          $ref: '#/definitions/ImportJob'
      - $ref: '#/parameters/api-version'
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/ImportJob'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Jobs Imports Id
    get:
      tags:
      - ImportJobs
      operationId: microsoftAzureImportjobsGetbyid
      description: Retrieves an import job.<br>Status codes:<br>* 200 OK<br>* 404 Not Found<br>  * ImportJobNotFound - The import job was not found.
      x-ms-examples:
        Get an import job by id:
          $ref: ./examples/ImportJobGet.json
      parameters:
      - $ref: '#/parameters/importJobId'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ImportJob'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Jobs Imports Id
    delete:
      tags:
      - ImportJobs
      operationId: microsoftAzureImportjobsDelete
      description: Deletes an import job.<br>Status codes:<br>* 204 No Content<br>* 400 Bad Request<br>  * ValidationFailed - The import job request is not valid.
      x-ms-examples:
        Delete an import job:
          $ref: ./examples/ImportJobDelete.json
      parameters:
      - $ref: '#/parameters/importJobId'
      - $ref: '#/parameters/api-version'
      responses:
        '204':
          description: Success
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Jobs Imports Id
  /jobs/imports/{id}/cancel:
    parameters:
    - $ref: '#/parameters/traceparent'
    - $ref: '#/parameters/tracestate'
    post:
      tags:
      - ImportJobs
      operationId: microsoftAzureImportjobsCancel
      description: Cancels an import job.<br>Status codes:<br>* 200 Request Accepted<br>* 400 Bad Request<br>  * ValidationFailed - The import job request is not valid.
      x-ms-examples:
        Cancel a job:
          $ref: ./examples/ImportJobCancel.json
      parameters:
      - $ref: '#/parameters/importJobId'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ImportJob'
        default:
          description: Default response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Jobs Imports Id Cancel
definitions:
  ErrorResponse:
    description: Error response.
    required:
    - error
    properties:
      error:
        $ref: '#/definitions/Error'
        description: The error details.
  InnerError:
    description: A more specific error description than was provided by the containing error.
    properties:
      code:
        description: A more specific error code than was provided by the containing error.
        type: string
      innererror:
        description: An object containing more specific information than the current object about the error.
        $ref: '#/definitions/InnerError'
  ImportJobCollection:
    description: A collection of import job objects.
    type: object
    required:
    - value
    properties:
      value:
        description: The list of import job objects.
        type: array
        items:
          $ref: '#/definitions/ImportJob'
      nextLink:
        description: A URI to retrieve the next page of results.
        type: string
  ImportJob:
    description: A job which contains a reference to the operations to perform, results, and execution metadata.
    type: object
    required:
    - inputBlobUri
    - outputBlobUri
    properties:
      id:
        description: The identifier of the import job.
        type: string
        readOnly: true
      inputBlobUri:
        description: The path to the input Azure storage blob that contains file(s) describing the operations to perform in the job.
        type: string
      outputBlobUri:
        description: The path to the output Azure storage blob that will contain the errors and progress logs of import job.
        type: string
      status:
        description: Status of the job.
        enum:
        - notstarted
        - running
        - failed
        - succeeded
        - cancelling
        - cancelled
        type: string
        readOnly: true
        x-ms-enum:
          name: status
          modelAsExtensible: true
          modelAsString: false
      createdDateTime:
        description: 'Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        format: date-time
        readOnly: true
      lastActionDateTime:
        description: 'Last time service performed any action from the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        format: date-time
        readOnly: true
      finishedDateTime:
        description: 'End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        format: date-time
        readOnly: true
      purgeDateTime:
        description: 'Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        format: date-time
        readOnly: true
      error:
        $ref: '#/definitions/Error'
        description: Details of the error(s) that occurred executing the import job.
  Error:
    description: Error definition.
    properties:
      code:
        description: Service specific error code which serves as the substatus for the HTTP error code.
        type: string
        readOnly: true
      message:
        description: A human-readable representation of the error.
        type: string
        readOnly: true
      details:
        description: Internal error details.
        type: array
        items:
          $ref: '#/definitions/Error'
        readOnly: true
      innererror:
        description: An object containing more specific information than the current object about the error.
        $ref: '#/definitions/InnerError'
parameters:
  tracestate:
    name: tracestate
    in: header
    description: Provides vendor-specific trace identification information and is a companion to traceparent.
    required: false
    type: string
    x-ms-parameter-location: method
    x-ms-parameter-grouping:
      postfix: Options
  importJobId:
    name: id
    in: path
    description: The id for the import job. The id is unique within the service and case sensitive.
    required: true
    type: string
    x-ms-parameter-location: method
  traceparent:
    name: traceparent
    in: header
    description: Identifies the request in a distributed tracing system.
    required: false
    type: string
    x-ms-parameter-location: method
    x-ms-parameter-grouping:
      postfix: Options
  max-items-per-page:
    name: max-items-per-page
    in: header
    description: The maximum number of items to retrieve per request. The server may choose to return less than the requested number.
    required: false
    type: integer
    x-ms-client-name: MaxItemsPerPage
    x-ms-parameter-location: method
    x-ms-parameter-grouping:
      postfix: Options
  api-version:
    name: api-version
    in: query
    description: The requested API version.
    required: true
    type: string
    minLength: 1
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'