Description

# Azure Tables client library for Python Azure Tables is a NoSQL data storage service that can be accessed from anywhere in the world via authenticated calls using HTTP or HTTPS. Tables scales as needed to support the amount of data inserted, and allow for the storing of data with non-complex accessing. The Azure Tables client can be used to access Azure Storage or Cosmos accounts. This document covers [`azure-data-tables`][Tables_pypi]. Please note, this package is a replacement for [`azure-cosmosdb-tables`](https://github.com/Azure/azure-cosmos-table-python/tree/master/azure-cosmosdb-table) which is now deprecated. See the [migration guide][migration_guide] for more details. [Source code][source_code] | [Package (PyPI)][Tables_pypi] | [Package (Conda)](https://anaconda.org/microsoft/azure-data-tables/) | [API reference documentation][Tables_ref_docs] | [Samples][Tables_samples] ## Getting started The Azure Tables SDK can access an Azure Storage or CosmosDB account. ### Prerequisites * Python 3.9 or later is required to use this package. * You must have an [Azure subscription][azure_subscription] and either * an [Azure Storage account][azure_storage_account] or * an [Azure Cosmos Account][azure_cosmos_account]. #### Create account * To create a new storage account, you can use [Azure Portal][azure_portal_create_account], [Azure PowerShell][azure_powershell_create_account], or [Azure CLI][azure_cli_create_account]: * To create a new cosmos storage account, you can use the [Azure CLI][azure_cli_create_cosmos] or [Azure Portal][azure_portal_create_cosmos]. ### Install the package Install the Azure Tables client library for Python with [pip][pip_link]: ```bash pip install azure-data-tables ``` #### Create the client The Azure Tables library allows you to interact with two types of resources: * the tables in your account * the entities within those tables. Interaction with these resources starts with an instance of a [client](#clients). To create a client object, you will need the account's table service endpoint URL and a credential that allows you to access the account. The `endpoint` can be found on the page for your storage account in the [Azure Portal][azure_portal_account_url] under the "Access Keys" section or by running the following Azure CLI command: ```bash # Get the table service URL for the account az storage account show -n mystorageaccount -g MyResourceGroup --query "primaryEndpoints.table" ``` Once you have the account URL, it can be used to create the service client: ```python from azure.data.tables import TableServiceClient service = TableServiceClient(endpoint="https://<my_account_name>.table.core.windows.net/", credential=credential) ``` For more information about table service URL's and how to configure custom domain names for Azure Storage check out the [official documentation][azure_portal_account_url] #### Types of credentials The `credential` parameter may be provided in a number of different forms, depending on the type of authorization you wish to use. The Tables library supports the following authorizations: * Shared Key * Connection String * Shared Access Signature Token * TokenCredential (Microsoft Entra ID)(Supported on Storage) ##### Creating the client from a shared key To use an account [shared key][azure_shared_key] (aka account key or access key), provide the key as a string. This can be found in your storage account in the [Azure Portal][azure_portal_account_url] under the "Access Keys" section or by running the following Azure CLI command: ```bash az storage account keys list -g MyResourceGroup -n MyStorageAccount ``` Use the key as the credential parameter to authenticate the client: ```python from azure.data.tables import TableServiceClient from azure.core.credentials import AzureNamedKeyCredential credential = AzureNamedKeyCredential("my_account_name", "my_access_key") with TableServiceClient( endpoint="https://<my_account_name>.table.core.windows.net", credential=credential ) as table_service_client: properties = table_service_client.get_service_properties() print(f"{properties}") ``` ##### Creating the client from a connection string Depending on your use case and authorization method, you may prefer to initialize a client instance with a connection string instead of providing the account URL and credential separately. To do this, pass the connection string to the client's `from_connection_string` class method. If the connection string does not specify a fully qualified endpoint URL (`"TableEndpoint"`), or URL suffix (`"EndpointSuffix"`), the endpoint will be assumed to be an Azure Storage account, and the URL automatically formatted accordingly. For Tables Storage, the connection string can be found in your storage account in the [Azure Portal][azure_portal_account_url] under the "Access Keys" section or with the following Azure CLI command: ```bash az storage account show-connection-string -g MyResourceGroup -n MyStorageAccount