swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Table API schemes: - https 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: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/DataServiceVersionParameter' - $ref: '#/parameters/formatParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/filterParameter' - name: NextTableName in: query required: false type: string description: A table query continuation token from a previous call. responses: '200': description: Success, table query completed. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-continuation-NextTableName: type: string description: This header contains the continuation token value. schema: $ref: '#/definitions/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: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/DataServiceVersionParameter' - $ref: '#/parameters/formatParameter' - $ref: '#/parameters/TableProperties' - $ref: '#/parameters/PreferParameter' responses: '201': description: Success, table created. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. Preference-Applied: type: string 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: $ref: '#/definitions/TableResponse' '204': description: Success, table created. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. Preference-Applied: type: string 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. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/TableServiceError' summary: Microsoft Azure Post Tables /Tables('{table}'): delete: tags: - Table consumes: - application/json produces: - application/json operationId: microsoftAzureTableDelete x-ms-examples: TableDelete: $ref: ./examples/TableDelete.json description: Operation permanently deletes the specified table. parameters: - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/tableNameParameter' responses: '204': description: No Content headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/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: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/DataServiceVersionParameter' - $ref: '#/parameters/formatParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/tableNameParameter' - name: NextPartitionKey in: query required: false type: string description: An entity query continuation token from a previous call. - name: NextRowKey in: query required: false type: string description: An entity query continuation token from a previous call. responses: '200': description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-continuation-NextPartitionKey: type: string description: This header contains the continuation token value for partition key. x-ms-continuation-NextRowKey: type: string description: This header contains the continuation token value for row key. schema: $ref: '#/definitions/TableEntityQueryResponse' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/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: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/DataServiceVersionParameter' - $ref: '#/parameters/formatParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/tableNameParameter' - $ref: '#/parameters/partitionKeyParameter' - $ref: '#/parameters/rowKeyParameter' responses: '200': description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. ETag: type: string description: UTC date/time value generated by the service that indicates the time at which the response was initiated x-ms-continuation-NextPartitionKey: type: string description: This header contains the continuation token value for partition key. x-ms-continuation-NextRowKey: type: string description: This header contains the continuation token value for row key. schema: $ref: '#/definitions/TableEntityProperties' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/TableServiceError' summary: Microsoft Azure Get Table Partitionkey Partitionkey ,rowkey Rowkey put: tags: - Table consumes: - application/json produces: - application/json operationId: microsoftAzureTableUpdateentity x-ms-examples: TableUpdateEntity: $ref: ./examples/TableUpdateEntity.json description: Update entity in a table. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/DataServiceVersionParameter' - $ref: '#/parameters/formatParameter' - $ref: '#/parameters/TableEntityProperties' - $ref: '#/parameters/tableNameParameter' - $ref: '#/parameters/partitionKeyParameter' - $ref: '#/parameters/rowKeyParameter' - name: If-Match in: header required: false type: string 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 responses: '204': description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. ETag: type: string description: UTC date/time value generated by the service that indicates the time at which the entity was last updated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/TableServiceError' summary: Microsoft Azure Put Table Partitionkey Partitionkey ,rowkey Rowkey patch: tags: - Table consumes: - application/json produces: - application/json operationId: microsoftAzureTableMergeentity x-ms-examples: TableMergeEntity: $ref: ./examples/TableMergeEntity.json description: Merge entity in a table. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/DataServiceVersionParameter' - $ref: '#/parameters/formatParameter' - $ref: '#/parameters/TableEntityProperties' - $ref: '#/parameters/tableNameParameter' - $ref: '#/parameters/partitionKeyParameter' - $ref: '#/parameters/rowKeyParameter' - name: If-Match in: header required: false type: string 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 responses: '204': description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. ETag: type: string description: UTC date/time value generated by the service that indicates the time at which the entity was last updated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/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: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/DataServiceVersionParameter' - $ref: '#/parameters/formatParameter' - $ref: '#/parameters/tableNameParameter' - $ref: '#/parameters/partitionKeyParameter' - $ref: '#/parameters/rowKeyParameter' - name: If-Match in: header required: true type: string 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 responses: '204': description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/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: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/DataServiceVersionParameter' - $ref: '#/parameters/formatParameter' - $ref: '#/parameters/TableEntityProperties' - $ref: '#/parameters/tableNameParameter' - $ref: '#/parameters/PreferParameter' responses: '201': description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. ETag: type: string description: UTC date/time value generated by the service that indicates the time at which the entity was last updated. Preference-Applied: type: string 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. Content-Type: type: string description: Indicates the content type of the payload. The value depends on the value specified for the Accept request header. schema: $ref: '#/definitions/TableEntityProperties' '204': description: No Content. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. ETag: type: string description: UTC date/time value generated by the service that indicates the time at which the entity was last updated. Preference-Applied: type: string 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. Content-Type: type: string description: Indicates the content type of the payload. The value depends on the value specified for the Accept request header. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/TableServiceError' summary: Microsoft Azure Post Table get: tags: - Table consumes: - application/xml produces: - application/xml operationId: microsoftAzureTableGetaccesspolicy description: Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/tableNameParameter' - $ref: '#/parameters/compAclParameter' responses: '200': description: Success. headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: $ref: '#/definitions/SignedIdentifiers' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/TableServiceError' summary: Microsoft Azure Get Table put: tags: - Table consumes: - application/xml produces: - application/xml operationId: microsoftAzureTableSetaccesspolicy description: Sets stored access policies for the table that may be used with Shared Access Signatures. parameters: - $ref: '#/parameters/TableAcl' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/tableNameParameter' - $ref: '#/parameters/compAclParameter' responses: '204': description: No Content headers: x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string 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. Date: type: string format: date-time-rfc1123 description: UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/TableServiceError' summary: Microsoft Azure Put Table definitions: TableQueryResponse: description: The properties for the table query response. type: object properties: odata.metadata: description: The metadata response of the table. type: string value: description: List of tables. type: array items: $ref: '#/definitions/TableResponseProperties' AccessPolicy: xml: name: AccessPolicy type: object required: - Start - Expiry - Permission description: An Access policy. properties: Start: description: The start datetime from which the policy is active. type: string format: date-time xml: name: Start Expiry: description: The datetime that the policy expires. type: string format: date-time xml: name: Expiry Permission: description: The permissions for the acl policy. type: string xml: name: Permission SignedIdentifier: xml: name: SignedIdentifier description: A signed identifier. type: object required: - Id - AccessPolicy properties: Id: type: string description: A unique id. xml: name: Id AccessPolicy: description: The access policy. $ref: '#/definitions/AccessPolicy' TableResponse: description: The response for a single table. type: object properties: odata.metadata: description: The metadata response of the table. type: string allOf: - $ref: '#/definitions/TableResponseProperties' TableEntityProperties: description: The other properties of the table entity. type: object additionalProperties: true SignedIdentifiers: description: A collection of signed identifiers. type: array items: $ref: '#/definitions/SignedIdentifier' xml: name: SignedIdentifier xml: wrapped: true name: SignedIdentifiers TableResponseProperties: description: The properties for the table response. type: object properties: TableName: description: The name of the table. type: string odata.type: description: The odata type of the table. type: string odata.id: description: The id of the table. type: string odata.editLink: description: The edit link of the table. type: string TableServiceError: description: Table Service error. type: object xml: {} properties: Message: description: The error message. type: string xml: name: Message TableEntityQueryResponse: description: The properties for the table entity query response. type: object properties: odata.metadata: description: The metadata response of the table. type: string value: description: List of table entities. type: array items: $ref: '#/definitions/TableEntityProperties' TableProperties: description: The properties for creating a table. type: object properties: TableName: description: The name of the table to create. type: string parameters: DataServiceVersionParameter: name: DataServiceVersion in: header required: true type: string description: Specifies the data service version. x-ms-parameter-location: method enum: - '3.0' x-ms-enum: modelAsString: false ApiVersionParameter: name: x-ms-version x-ms-parameter-location: client x-ms-client-name: version in: header required: true type: string description: Specifies the version of the operation to use for this request. enum: - '2019-02-02' x-ms-enum: modelAsString: false topParameter: name: $top in: query required: false type: integer format: int32 minimum: 0 description: Maximum number of records to return. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Top tableNameParameter: name: table in: path required: true type: string x-ms-parameter-location: method description: The name of the table. TableEntityProperties: name: tableEntityProperties in: body schema: $ref: '#/definitions/TableEntityProperties' x-ms-parameter-location: method description: The properties for the table entity. Timeout: name: timeout in: query required: false type: integer minimum: 0 x-ms-parameter-location: method description: The timeout parameter is expressed in seconds. selectParameter: name: $select in: query required: false type: string description: Select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Select rowKeyParameter: name: rowKey in: path required: true type: string x-ms-parameter-location: method description: The row key of the entity. filterParameter: name: $filter in: query required: false type: string description: OData filter expression. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Filter formatParameter: name: $format in: query required: false type: string description: Specifies the media type for the response. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Format enum: - application/json;odata=nometadata - application/json;odata=minimalmetadata - application/json;odata=fullmetadata x-ms-enum: name: OdataMetadataFormat modelAsString: true partitionKeyParameter: name: partitionKey in: path required: true type: string x-ms-parameter-location: method description: The partition key of the entity. PreferParameter: name: Prefer in: header required: false type: string description: Specifies whether the response should include the inserted entity in the payload. Possible values are return-no-content and return-content. x-ms-parameter-location: method x-ms-client-name: ResponsePreference enum: - return-no-content - return-content x-ms-enum: name: ResponseFormat modelAsString: true TableProperties: name: tableProperties in: body required: true schema: $ref: '#/definitions/TableProperties' x-ms-parameter-location: method description: The Table properties. TableAcl: name: tableAcl in: body schema: $ref: '#/definitions/SignedIdentifiers' x-ms-parameter-location: method description: The acls for the table. compAclParameter: name: comp in: query required: true type: string enum: - acl x-ms-enum: modelAsString: false x-ms-parameter-location: method description: Required query string to handle stored access policies for the table that may be used with Shared Access Signatures. ClientRequestId: name: x-ms-client-request-id x-ms-client-name: requestId in: header required: false type: string x-ms-parameter-location: method description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when analytics logging is enabled. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'