openapi: 3.2.0
info:
  title: Microsoft Azure Azure IoT Central File Uploads API
  description: Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.
  version: 2022-10-31-preview
servers:
- url: /api
security:
- azure_auth:
  - user_impersonation
tags:
- name: File Uploads
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: '#/components/parameters/Version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUpload'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - File Uploads
    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: '#/components/parameters/Version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUpload'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - File Uploads
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileUpload'
        description: File upload storage account configuration body.
        required: true
    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
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/IfMatch'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUpload'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - File Uploads
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/merge-patch+json:
            schema:
              type: object
        description: File upload storage account configuration body.
        required: true
    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: '#/components/parameters/Version'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - File Uploads
components:
  schemas:
    Error:
      description: The response error definition.
      type: object
      properties:
        error:
          description: Error details for current request.
          $ref: '#/components/schemas/ErrorDetails'
      required:
      - error
    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
    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
  parameters:
    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
      required: false
      schema:
        type: string
    Version:
      in: query
      name: api-version
      description: The version of the API being called.
      x-ms-parameter-location: client
      required: true
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-ms-parameterized-host:
  hostTemplate: '{subdomain}.{baseDomain}'
  parameters:
  - $ref: '#/components/parameters/BaseDomain'
  - $ref: '#/components/parameters/Subdomain'