swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector fileUploads API
schemes:
- https
tags:
- name: fileUploads
paths:
  /fileUploads:
    get:
      operationId: microsoftAzureFileuploadsGet
      summary: Microsoft Azure Get The File Upload Storage Account Configuration
      x-ms-examples:
        Get file upload storage account configuration:
          $ref: ./examples/fileUpload_get.json
      parameters:
      - $ref: '#/parameters/Version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FileUpload'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - fileUploads
    put:
      operationId: microsoftAzureFileuploadsCreate
      summary: Microsoft Azure Create The File Upload Storage Account Configuration
      x-ms-examples:
        Create file upload storage account configuration:
          $ref: ./examples/fileUpload_update.json
      parameters:
      - $ref: '#/parameters/Version'
      - in: body
        name: body
        description: File upload storage account configuration body.
        schema:
          $ref: '#/definitions/FileUpload'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FileUpload'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - fileUploads
    patch:
      operationId: microsoftAzureFileuploadsUpdate
      summary: Microsoft Azure Update The File Upload Storage Account Configuration
      x-ms-examples:
        Update file upload storage account configuration:
          $ref: ./examples/fileUpload_update.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - in: body
        name: body
        description: File upload storage account configuration body.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FileUpload'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - fileUploads
    delete:
      operationId: microsoftAzureFileuploadsRemove
      summary: Microsoft Azure Delete The File Upload Storage Configuration
      x-ms-examples:
        Remove file upload storage configuration:
          $ref: ./examples/fileUpload_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - fileUploads
definitions:
  FileUpload:
    description: The file upload configuration definition.
    type: object
    properties:
      account:
        description: The storage account name where to upload the file to
        type: string
      connectionString:
        description: The connection string used to configure the storage account
        type: string
      container:
        description: The name of the container inside the storage account
        type: string
      sasTtl:
        description: ISO 8601 duration standard, The amount of time the device’s request to upload a file is valid before it expires.
        type: string
      state:
        description: The state of the file upload configuration
        type: string
        readOnly: true
        enum:
        - pending
        - updating
        - deleting
        - succeeded
        - failed
        x-ms-enum:
          name: FileUploadState
          modelAsString: false
          values:
          - value: pending
            name: Pending
          - value: updating
            name: Updating
          - value: deleting
            name: Deleting
          - value: succeeded
            name: Succeeded
          - value: failed
            name: Failed
      etag:
        description: ETag used to prevent conflict with multiple uploads
        type: string
      readAccess:
        description: The flag indicate if user be able to access device uploaded files from IoT Central portal
        type: boolean
        default: false
    required:
    - connectionString
    - container
  ErrorDetails:
    description: The detail information of the error.
    type: object
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message details.
      requestId:
        type: string
        description: Correlation Id for current request.
      time:
        type: string
        format: date-time-rfc1123
        description: The time that error request failed.
    required:
    - code
    - message
  Error:
    description: The response error definition.
    type: object
    properties:
      error:
        description: Error details for current request.
        $ref: '#/definitions/ErrorDetails'
    required:
    - error
parameters:
  Version:
    in: query
    name: api-version
    description: The version of the API being called.
    x-ms-parameter-location: client
    type: string
    required: true
  IfMatch:
    in: header
    name: If-Match
    description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
    x-ms-parameter-location: method
    type: string
    required: false
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'