table.json

{
  "swagger": "2.0",
  "info": {
    "version": "2023-01-01",
    "title": "StorageManagementClient",
    "description": "The Azure Storage Management API."
  },
  "host": "management.azure.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices": {
      "get": {
        "tags": [
          "TableServiceProperties"
        ],
        "operationId": "TableServices_List",
        "x-ms-examples": {
          "TableServicesList": {
            "$ref": "./examples/TableServicesList.json"
          }
        },
        "description": "List all table services for the storage account.",
        "parameters": [
          {
            "$ref": "./storage.json#/parameters/ResourceGroupName"
          },
          {
            "$ref": "./storage.json#/parameters/StorageAccountName"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "OK -- returned the properties of a storage account’s Table service.",
            "schema": {
              "$ref": "#/definitions/ListTableServices"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "./common.json#/definitions/CloudError"
            }
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}": {
      "put": {
        "tags": [
          "TableServiceProperties"
        ],
        "operationId": "TableServices_SetServiceProperties",
        "x-ms-examples": {
          "TableServicesPut": {
            "$ref": "./examples/TableServicesPut.json"
          }
        },
        "description": "Sets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. ",
        "parameters": [
          {
            "$ref": "./storage.json#/parameters/ResourceGroupName"
          },
          {
            "$ref": "./storage.json#/parameters/StorageAccountName"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/TableServiceName"
          },
          {
            "name": "parameters",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/TableServiceProperties"
            },
            "description": "The properties of a storage account’s Table service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified."
          }
        ],
        "responses": {
          "200": {
            "description": "OK -- Sets The properties of a storage account’s Table service successfully.",
            "schema": {
              "$ref": "#/definitions/TableServiceProperties"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "./common.json#/definitions/CloudError"
            }
          }
        }
      },
      "get": {
        "tags": [
          "TableServiceProperties"
        ],
        "operationId": "TableServices_GetServiceProperties",
        "x-ms-examples": {
          "TableServicesGet": {
            "$ref": "./examples/TableServicesGet.json"
          }
        },
        "description": "Gets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.",
        "parameters": [
          {
            "$ref": "./storage.json#/parameters/ResourceGroupName"
          },
          {
            "$ref": "./storage.json#/parameters/StorageAccountName"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/TableServiceName"
          }
        ],
        "responses": {
          "200": {
            "description": "OK -- returned the properties of a storage account’s Table service.",
            "schema": {
              "$ref": "#/definitions/TableServiceProperties"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "./common.json#/definitions/CloudError"
            }
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}": {
      "put": {
        "tags": [
          "TableService"
        ],
        "operationId": "Table_Create",
        "x-ms-examples": {
          "TableOperationPut": {
            "$ref": "./examples/TableOperationPut.json"
          },
          "TableOperationPutOrPatchAcls": {
            "$ref": "./examples/TableOperationPutOrPatchAcls.json"
          }
        },
        "description": "Creates a new table with the specified table name, under the specified account.",
        "parameters": [
          {
            "$ref": "./storage.json#/parameters/ResourceGroupName"
          },
          {
            "$ref": "./storage.json#/parameters/StorageAccountName"
          },
          {
            "name": "parameters",
            "in": "body",
            "required": false,
            "schema": {
              "$ref": "#/definitions/Table"
            },
            "description": "The parameters to provide to create a table."
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/TableName"
          }
        ],
        "responses": {
          "200": {
            "description": "OK -- Creates a table with the given table name successfully.",
            "schema": {
              "$ref": "#/definitions/Table"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "./common.json#/definitions/CloudError"
            }
          }
        }
      },
      "patch": {
        "tags": [
          "TableService"
        ],
        "operationId": "Table_Update",
        "x-ms-examples": {
          "TableOperationPatch": {
            "$ref": "./examples/TableOperationPatch.json"
          },
          "TableOperationPutOrPatchAcls": {
            "$ref": "./examples/TableOperationPutOrPatchAcls.json"
          }
        },
        "description": "Creates a new table with the specified table name, under the specified account.",
        "parameters": [
          {
            "$ref": "./storage.json#/parameters/ResourceGroupName"
          },
          {
            "$ref": "./storage.json#/parameters/StorageAccountName"
          },
          {
            "name": "parameters",
            "in": "body",
            "required": false,
            "schema": {
              "$ref": "#/definitions/Table"
            },
            "description": "The parameters to provide to create a table."
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/TableName"
          }
        ],
        "responses": {
          "200": {
            "description": "OK -- Creates a table with the given table name successfully.",
            "schema": {
              "$ref": "#/definitions/Table"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "./common.json#/definitions/CloudError"
            }
          }
        }
      },
      "get": {
        "tags": [
          "TableService"
        ],
        "operationId": "Table_Get",
        "x-ms-examples": {
          "TableOperationGet": {
            "$ref": "./examples/TableOperationGet.json"
          }
        },
        "description": "Gets the table with the specified table name, under the specified account if it exists.",
        "parameters": [
          {
            "$ref": "./storage.json#/parameters/ResourceGroupName"
          },
          {
            "$ref": "./storage.json#/parameters/StorageAccountName"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/TableName"
          }
        ],
        "responses": {
          "200": {
            "description": "OK -- returned table with the specified table name successfully.",
            "schema": {
              "$ref": "#/definitions/Table"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "./common.json#/definitions/CloudError"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "TableService"
        ],
        "operationId": "Table_Delete",
        "x-ms-examples": {
          "TableOperationDelete": {
            "$ref": "./examples/TableOperationDelete.json"
          }
        },
        "description": "Deletes the table with the specified table name, under the specified account if it exists.",
        "parameters": [
          {
            "$ref": "./storage.json#/parameters/ResourceGroupName"
          },
          {
            "$ref": "./storage.json#/parameters/StorageAccountName"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/TableName"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content - Successfully deleted the table with the specified table name"
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "./common.json#/definitions/CloudError"
            }
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables": {
      "get": {
        "tags": [
          "TableService"
        ],
        "operationId": "Table_List",
        "x-ms-examples": {
          "TableOperationList": {
            "$ref": "./examples/TableOperationList.json"
          }
        },
        "description": "Gets a list of all the tables under the specified storage account",
        "parameters": [
          {
            "$ref": "./storage.json#/parameters/ResourceGroupName"
          },
          {
            "$ref": "./storage.json#/parameters/StorageAccountName"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "OK -- returned a list of tables successfully.",
            "schema": {
              "$ref": "#/definitions/ListTableResource"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "./common.json#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    }
  },
  "definitions": {
    "ListTableServices": {
      "properties": {
        "value": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TableServiceProperties"
          },
          "description": "List of table services returned.",
          "readOnly": true
        }
      }
    },
    "TableServiceProperties": {
      "properties": {
        "properties": {
          "properties": {
            "cors": {
              "$ref": "./common.json#/definitions/CorsRules",
              "description": "Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service."
            }
          },
          "x-ms-client-flatten": true,
          "x-ms-client-name": "TableServiceProperties",
          "description": "The properties of a storage account’s Table service."
        }
      },
      "allOf": [
        {
          "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
        }
      ],
      "description": "The properties of a storage account’s Table service."
    },
    "Table": {
      "properties": {
        "properties": {
          "$ref": "#/definitions/TableProperties",
          "x-ms-client-flatten": true,
          "x-ms-client-name": "TableProperties",
          "description": "Table resource properties."
        }
      },
      "allOf": [
        {
          "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
        }
      ],
      "description": "Properties of the table, including Id, resource name, resource type."
    },
    "TableProperties": {
      "properties": {
        "tableName": {
          "type": "string",
          "readOnly": true,
          "description": "Table name under the specified account"
        },
        "signedIdentifiers": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TableSignedIdentifier"
          },
          "description": "List of stored access policies specified on the table."
        }
      }
    },
    "ListTableResource": {
      "properties": {
        "value": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Table"
          },
          "description": "List of tables returned.",
          "readOnly": true
        },
        "nextLink": {
          "type": "string",
          "description": "Request URL that can be used to query next page of tables",
          "readOnly": true
        }
      },
      "description": "Response schema. Contains list of tables returned"
    },
    "TableSignedIdentifier": {
      "properties": {
        "id": {
          "type": "string",
          "description": "unique-64-character-value of the stored access policy."
        },
        "accessPolicy": {
          "$ref": "#/definitions/TableAccessPolicy",
          "description": "Access policy"
        }
      },
      "required": [
        "id"
      ],
      "type": "object",
      "description": "Object to set Table Access Policy."
    },
    "TableAccessPolicy": {
      "properties": {
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "Start time of the access policy"
        },
        "expiryTime": {
          "type": "string",
          "format": "date-time",
          "description": "Expiry time of the access policy"
        },
        "permission": {
          "type": "string",
          "description": "Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d'"
        }
      },
      "required": [
        "permission"
      ],
      "type": "object",
      "description": "Table Access Policy Properties Object."
    }
  },
  "parameters": {
    "TableServiceName": {
      "name": "tableServiceName",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "The name of the Table Service within the specified storage account. Table Service Name must be 'default'",
      "enum": [
        "default"
      ],
      "x-ms-enum": {
        "name": "TableServiceName",
        "modelAsString": false
      },
      "x-ms-parameter-location": "method"
    },
    "TableName": {
      "name": "tableName",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character.",
      "maxLength": 63,
      "minLength": 3,
      "pattern": "^[A-Za-z][A-Za-z0-9]{2,62}$",
      "x-ms-parameter-location": "method"
    }
  },
  "securityDefinitions": {
    "azure_auth": {
      "type": "oauth2",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "flow": "implicit",
      "description": "Azure Active Directory OAuth2 Flow",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      }
    }
  },
  "security": [
    {
      "azure_auth": [
        "user_impersonation"
      ]
    }
  ]
}