Microsoft Azure Table API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Table API
tags:
- name: Table
paths:
  /Tables:
    get:
      tags:
      - Table
      operationId: microsoftAzureTableQuery
      x-ms-examples:
        TableGet:
          $ref: ./examples/TableGet.json
      description: Queries tables under the given account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/DataServiceVersionParameter'
      - $ref: '#/components/parameters/formatParameter'
      - $ref: '#/components/parameters/topParameter'
      - $ref: '#/components/parameters/selectParameter'
      - $ref: '#/components/parameters/filterParameter'
      - name: NextTableName
        in: query
        required: false
        description: A table query continuation token from a previous call.
        schema:
          type: string
      responses:
        '200':
          description: Success, table query completed.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
            x-ms-continuation-NextTableName:
              description: This header contains the continuation token value.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableQueryResponse'
      summary: Microsoft Azure Get Tables
    post:
      tags:
      - Table
      operationId: microsoftAzureTableCreate
      x-ms-examples:
        TableCreate:
          $ref: ./examples/TableCreate.json
      description: Creates a new table under the given account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/DataServiceVersionParameter'
      - $ref: '#/components/parameters/formatParameter'
      - $ref: '#/components/parameters/TableProperties'
      - $ref: '#/components/parameters/PreferParameter'
      responses:
        '201':
          description: Success, table created.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
            Preference-Applied:
              description: Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableResponse'
        '204':
          description: Success, table created.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
            Preference-Applied:
              description: Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content.
              schema:
                type: string
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableServiceError'
      summary: Microsoft Azure Post Tables
  /Tables('{table}'):
    delete:
      tags:
      - Table
      operationId: microsoftAzureTableDelete
      x-ms-examples:
        TableDelete:
          $ref: ./examples/TableDelete.json
      description: Operation permanently deletes the specified table.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/tableNameParameter'
      responses:
        '204':
          description: No Content
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableServiceError'
      summary: Microsoft Azure Delete Tables Table
  /{table}():
    get:
      tags:
      - Table
      operationId: microsoftAzureTableQueryentities
      x-ms-examples:
        TableQueryEntities:
          $ref: ./examples/TableQueryEntities.json
      description: Queries entities in a table.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/DataServiceVersionParameter'
      - $ref: '#/components/parameters/formatParameter'
      - $ref: '#/components/parameters/topParameter'
      - $ref: '#/components/parameters/selectParameter'
      - $ref: '#/components/parameters/filterParameter'
      - $ref: '#/components/parameters/tableNameParameter'
      - name: NextPartitionKey
        in: query
        required: false
        description: An entity query continuation token from a previous call.
        schema:
          type: string
      - name: NextRowKey
        in: query
        required: false
        description: An entity query continuation token from a previous call.
        schema:
          type: string
      responses:
        '200':
          description: Success.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
            x-ms-continuation-NextPartitionKey:
              description: This header contains the continuation token value for partition key.
              schema:
                type: string
            x-ms-continuation-NextRowKey:
              description: This header contains the continuation token value for row key.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableEntityQueryResponse'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableServiceError'
      summary: Microsoft Azure Get Table
  /{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}'):
    get:
      tags:
      - Table
      operationId: microsoftAzureTableQueryentitywithpartitionandrowkey
      x-ms-examples:
        TableQueryEntitiesWithPartitionAndRowKey:
          $ref: ./examples/TableQueryEntityWithPartitionAndRowKey.json
      description: Queries a single entity in a table.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/DataServiceVersionParameter'
      - $ref: '#/components/parameters/formatParameter'
      - $ref: '#/components/parameters/selectParameter'
      - $ref: '#/components/parameters/filterParameter'
      - $ref: '#/components/parameters/tableNameParameter'
      - $ref: '#/components/parameters/partitionKeyParameter'
      - $ref: '#/components/parameters/rowKeyParameter'
      responses:
        '200':
          description: Success.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
            ETag:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated
              schema:
                type: string
            x-ms-continuation-NextPartitionKey:
              description: This header contains the continuation token value for partition key.
              schema:
                type: string
            x-ms-continuation-NextRowKey:
              description: This header contains the continuation token value for row key.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableEntityProperties'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableServiceError'
      summary: Microsoft Azure Get Table Partitionkey Partitionkey ,rowkey Rowkey
    put:
      tags:
      - Table
      operationId: microsoftAzureTableUpdateentity
      x-ms-examples:
        TableUpdateEntity:
          $ref: ./examples/TableUpdateEntity.json
      description: Update entity in a table.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/DataServiceVersionParameter'
      - $ref: '#/components/parameters/formatParameter'
      - $ref: '#/components/parameters/TableEntityProperties'
      - $ref: '#/components/parameters/tableNameParameter'
      - $ref: '#/components/parameters/partitionKeyParameter'
      - $ref: '#/components/parameters/rowKeyParameter'
      - name: If-Match
        in: header
        required: false
        description: Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a replace will be performed if an existing entity is found.
        x-ms-client-name: IfMatch
        schema:
          type: string
      responses:
        '204':
          description: Success.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
            ETag:
              description: UTC date/time value generated by the service that indicates the time at which the entity was last updated.
              schema:
                type: string
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableServiceError'
      summary: Microsoft Azure Put Table Partitionkey Partitionkey ,rowkey Rowkey
    patch:
      tags:
      - Table
      operationId: microsoftAzureTableMergeentity
      x-ms-examples:
        TableMergeEntity:
          $ref: ./examples/TableMergeEntity.json
      description: Merge entity in a table.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/DataServiceVersionParameter'
      - $ref: '#/components/parameters/formatParameter'
      - $ref: '#/components/parameters/TableEntityProperties'
      - $ref: '#/components/parameters/tableNameParameter'
      - $ref: '#/components/parameters/partitionKeyParameter'
      - $ref: '#/components/parameters/rowKeyParameter'
      - name: If-Match
        in: header
        required: false
        description: Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a merge will be performed if an existing entity is found.
        x-ms-client-name: IfMatch
        schema:
          type: string
      responses:
        '204':
          description: Success.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
            ETag:
              description: UTC date/time value generated by the service that indicates the time at which the entity was last updated.
              schema:
                type: string
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableServiceError'
      summary: Microsoft Azure Patch Table Partitionkey Partitionkey ,rowkey Rowkey
    delete:
      tags:
      - Table
      operationId: microsoftAzureTableDeleteentity
      x-ms-examples:
        TableDeleteEntity:
          $ref: ./examples/TableDeleteEntity.json
      description: Deletes the specified entity in a table.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/DataServiceVersionParameter'
      - $ref: '#/components/parameters/formatParameter'
      - $ref: '#/components/parameters/tableNameParameter'
      - $ref: '#/components/parameters/partitionKeyParameter'
      - $ref: '#/components/parameters/rowKeyParameter'
      - name: If-Match
        in: header
        required: true
        description: Match condition for an entity to be deleted. If specified and a matching entity is not found, an error will be raised. To force an unconditional delete, set to the wildcard character (*).
        x-ms-client-name: IfMatch
        schema:
          type: string
      responses:
        '204':
          description: Success.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableServiceError'
      summary: Microsoft Azure Delete Table Partitionkey Partitionkey ,rowkey Rowkey
  /{table}:
    post:
      tags:
      - Table
      operationId: microsoftAzureTableInsertentity
      x-ms-examples:
        TableInsertEntity:
          $ref: ./examples/TableInsertEntity.json
      description: Insert entity in a table.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/DataServiceVersionParameter'
      - $ref: '#/components/parameters/formatParameter'
      - $ref: '#/components/parameters/TableEntityProperties'
      - $ref: '#/components/parameters/tableNameParameter'
      - $ref: '#/components/parameters/PreferParameter'
      responses:
        '201':
          description: Success.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
            ETag:
              description: UTC date/time value generated by the service that indicates the time at which the entity was last updated.
              schema:
                type: string
            Preference-Applied:
              description: Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content.
              schema:
                type: string
            Content-Type:
              description: Indicates the content type of the payload. The value depends on the value specified for the Accept request header.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableEntityProperties'
        '204':
          description: No Content.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
            ETag:
              description: UTC date/time value generated by the service that indicates the time at which the entity was last updated.
              schema:
                type: string
            Preference-Applied:
              description: Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content.
              schema:
                type: string
            Content-Type:
              description: Indicates the content type of the payload. The value depends on the value specified for the Accept request header.
              schema:
                type: string
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableServiceError'
      summary: Microsoft Azure Post Table
    get:
      tags:
      - Table
      operationId: microsoftAzureTableGetaccesspolicy
      description: Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/tableNameParameter'
      - $ref: '#/components/parameters/compAclParameter'
      responses:
        '200':
          description: Success.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/SignedIdentifiers'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/TableServiceError'
      summary: Microsoft Azure Get Table
    put:
      tags:
      - Table
      operationId: microsoftAzureTableSetaccesspolicy
      description: Sets stored access policies for the table that may be used with Shared Access Signatures.
      parameters:
      - $ref: '#/components/parameters/TableAcl'
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      - $ref: '#/components/parameters/tableNameParameter'
      - $ref: '#/components/parameters/compAclParameter'
      responses:
        '204':
          description: No Content
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
              schema:
                type: string
                format: date-time-rfc1123
        default:
   

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-table-api-openapi.yml