TableServiceClient Classe

Référence

Client pour interagir avec le service de table au niveau du compte.

Ce client fournit des opérations pour récupérer et configurer les propriétés du compte, ainsi que répertorier, créer et supprimer des tables dans le compte. Pour les opérations relatives à une table spécifique, un client pour cette entité peut être récupéré à l’aide de la get_table_client fonction .

Créez TablesBaseClient à partir d’informations d’identification.

Héritage: azure.data.tables._base_client.TablesBaseClient

TableServiceClient

Constructeur

TableServiceClient(endpoint: str, *, credential: AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs)

Paramètres

endpoint: str

Obligatoire

URL du point de terminaison du service de table. Toutes les autres entités incluses dans le chemin d’URL (par exemple, table) sont ignorées. Cette URL peut éventuellement être authentifiée avec un jeton SAS.

credential: AzureNamedKeyCredential ou AzureSasCredential ou TokenCredential ou None

Informations d’identification avec lesquelles s’authentifier. Cela est facultatif si l’URL du compte a déjà un jeton SAS. La valeur peut être azureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) ou une implémentation TokenCredential à partir d’azure-identity.

api_version: str

Version de l’API de stockage à utiliser pour les requêtes. La valeur par défaut est « 2019-02-02 ». La définition d’une version antérieure peut réduire la compatibilité des fonctionnalités.

endpoint: str

Obligatoire

URL d’un compte Tables Azure.

credential: AzureNamedKeyCredential ou AzureSasCredential ou TokenCredential ou None

api_version: str ou None

Spécifie la version de l'opération à utiliser pour cette demande. La valeur par défaut est « 2019-02-02 ».

Exemples

Authentification d’un TableServiceClient à partir d’une clé d’accès partagé


   from azure.data.tables import TableServiceClient
   from azure.core.credentials import AzureNamedKeyCredential, AzureSasCredential

   # Create a SAS token to use for authentication of a client
   from azure.data.tables import generate_account_sas, ResourceTypes, AccountSasPermissions

   print("Account name: {}".format(self.account_name))
   credential = AzureNamedKeyCredential(self.account_name, self.access_key)  # type: ignore[arg-type]
   sas_token = generate_account_sas(
       credential,
       resource_types=ResourceTypes(service=True),
       permission=AccountSasPermissions(read=True),
       expiry=datetime.utcnow() + timedelta(hours=1),
   )

   with TableServiceClient(
       endpoint=self.endpoint, credential=AzureSasCredential(sas_token)
   ) as token_auth_table_service:
       properties = token_auth_table_service.get_service_properties()
       print("Shared Access Signature: {}".format(properties))

Authentification d’un TableServiceClient à partir d’une clé de compte partagé


   from azure.data.tables import TableServiceClient
   from azure.core.credentials import AzureNamedKeyCredential

   credential = AzureNamedKeyCredential(self.account_name, self.access_key)  # type: ignore[arg-type]
   with TableServiceClient(endpoint=self.endpoint, credential=credential) as table_service:
       properties = table_service.get_service_properties()
       print("Shared Key: {}".format(properties))

Variables

account_name: str

Nom du compte Tables.

url: str

URL complète du compte Tables.

Méthodes

close	Cette méthode consiste à fermer les sockets ouverts par le client. Il n’est pas nécessaire de l’utiliser lors de l’utilisation avec un gestionnaire de contexte.
create_table	Crée une table sous le compte actuel.
create_table_if_not_exists	Crée une table si elle n’existe pas actuellement. Si la table existe actuellement, la table active est retournée.
delete_table	Supprime la table sous le compte actuel. Aucune erreur n’est générée si la table donnée est introuvable.
from_connection_string	Créez TableServiceClient à partir d’une chaîne de connexion.
get_service_properties	Obtient les propriétés du service Table d’un compte, y compris les propriétés pour les règles Analytics et CORS (Cross-Origin Resource Sharing).
get_service_stats	Récupère des statistiques relatives à la réplication pour le service de Table. Elle est disponible uniquement sur le point de terminaison de l’emplacement secondaire lorsque la réplication géoredondante avec accès en lecture est activée pour le compte.
get_table_client	Obtenir un client pour interagir avec la table spécifiée. La table n’a pas besoin d’exister.
list_tables	Interroge les tables sous le compte donné.
query_tables	Interroge les tables sous le compte donné.
set_service_properties	Définit les propriétés du point de terminaison de service Table d’un compte, y compris les propriétés pour les règles Analytics et CORS (Cross-Origin Resource Sharing).

close

Cette méthode consiste à fermer les sockets ouverts par le client. Il n’est pas nécessaire de l’utiliser lors de l’utilisation avec un gestionnaire de contexte.

close() -> None

create_table

Crée une table sous le compte actuel.

create_table(table_name: str, **kwargs) -> TableClient

Paramètres

table_name: str

Obligatoire

Nom de la table.

Retours

TableClient

Type de retour

TableClient

Exceptions

ResourceExistsError

Exemples

Création d’une table à partir de l’objet TableServiceClient


   with TableServiceClient.from_connection_string(self.connection_string) as table_service_client:
       try:
           table_client = table_service_client.create_table(table_name=self.table_name)
           print("Created table {}!".format(table_client.table_name))
       except ResourceExistsError:
           print("Table already exists")

create_table_if_not_exists

Crée une table si elle n’existe pas actuellement. Si la table existe actuellement, la table active est retournée.

create_table_if_not_exists(table_name: str, **kwargs) -> TableClient

Paramètres

table_name: str

Obligatoire

Nom de la table.

Retours

TableClient

Type de retour

TableClient

Exceptions

HttpResponseError

Exemples

Création d’une table si elle n’existe pas, à partir de l’objet TableServiceClient


   with TableServiceClient.from_connection_string(self.connection_string) as table_service_client:
       table_client = table_service_client.create_table_if_not_exists(table_name=self.table_name)
       print("Table name: {}".format(table_client.table_name))

delete_table

Supprime la table sous le compte actuel. Aucune erreur n’est générée si la table donnée est introuvable.

delete_table(table_name: str, **kwargs) -> None

Paramètres

table_name: str

Obligatoire

Nom de la table.

Retours

Aucun

Exceptions

HttpResponseError

Exemples

Suppression d’une table de l’objet TableServiceClient


   with TableServiceClient.from_connection_string(self.connection_string) as table_service_client:
       table_service_client.delete_table(table_name=self.table_name)
       print("Deleted table {}!".format(self.table_name))

from_connection_string

Créez TableServiceClient à partir d’une chaîne de connexion.

from_connection_string(conn_str: str, **kwargs) -> TableServiceClient

Paramètres

conn_str: str

Obligatoire

Chaîne de connexion à un compte Stockage Azure ou Cosmos.

Retours

Un client de service de table.

Type de retour

TableServiceClient

Exemples

Authentification d’un TableServiceClient à partir d’un connection_string


   from azure.data.tables import TableServiceClient

   with TableServiceClient.from_connection_string(conn_str=self.connection_string) as table_service:
       properties = table_service.get_service_properties()
       print("Connection String: {}".format(properties))

get_service_properties

Obtient les propriétés du service Table d’un compte, y compris les propriétés pour les règles Analytics et CORS (Cross-Origin Resource Sharing).

get_service_properties(**kwargs) -> Dict[str, object]

Retours

Dictionnaire des propriétés de service

Type de retour

dict[str, object]

Exceptions

HttpResponseError

get_service_stats

Récupère des statistiques relatives à la réplication pour le service de Table. Elle est disponible uniquement sur le point de terminaison de l’emplacement secondaire lorsque la réplication géoredondante avec accès en lecture est activée pour le compte.

get_service_stats(**kwargs) -> Dict[str, object]

Retours

Dictionnaire des statistiques de service

Type de retour

dict[str, object]

Exceptions

azure.core.exceptions.HttpResponseError:

get_table_client

Obtenir un client pour interagir avec la table spécifiée.

La table n’a pas besoin d’exister.

get_table_client(table_name: str, **kwargs) -> TableClient

Paramètres

table_name: str

Obligatoire

Le nom de la table

Retours

Objet TableClient.

Type de retour

TableClient

list_tables

Interroge les tables sous le compte donné.

list_tables(**kwargs) -> ItemPaged[TableItem]

Paramètres

results_per_page: int

Nombre de tables par page dans itemPaged retourné

Retours

Itérateur de TableItem

Type de retour

ItemPaged[TableItem]

Exceptions

HttpResponseError

Exemples

Liste de toutes les tables d’un compte de stockage


   # List all the tables in the service
   list_tables = table_service.list_tables()
   print("Listing tables:")
   for table in list_tables:
       print("\t{}".format(table.name))

query_tables

Interroge les tables sous le compte donné.

query_tables(query_filter: str, **kwargs) -> ItemPaged[TableItem]

Paramètres

query_filter: str

Obligatoire

Spécifiez un filtre pour retourner certaines tables.

results_per_page: int

Nombre de tables par page dans itemPaged retourné

parameters: dict[str, Any]

Dictionnaire pour la mise en forme de la requête avec des paramètres supplémentaires définis par l’utilisateur

Retours

Itérateur de TableItem

Type de retour

ItemPaged[TableItem]

Exceptions

HttpResponseError

Exemples

Interrogation de tables dans un compte de stockage


   table_name = "mytable1"
   name_filter = "TableName eq '{}'".format(table_name)
   queried_tables = table_service.query_tables(name_filter)

   print("Queried_tables")
   for table in queried_tables:
       print("\t{}".format(table.name))

set_service_properties

Définit les propriétés du point de terminaison de service Table d’un compte, y compris les propriétés pour les règles Analytics et CORS (Cross-Origin Resource Sharing).

set_service_properties(**kwargs) -> None

Paramètres

analytics_logging: TableAnalyticsLogging

Propriétés pour l’analytique

hour_metrics: TableMetrics

Métriques au niveau de l’heure

minute_metrics: TableMetrics

Métriques de niveau de minute

cors: list[TableCorsRule]

Règles de partage de ressources inter-origines

Retours

Aucun

Exceptions

HttpResponseError

Attributs

api_version

Version de l’API de stockage utilisée pour les requêtes.

Retours

Version de l’API de stockage.

url

URL complète du point de terminaison de cette entité, y compris le jeton SAS s’il est utilisé.

Il peut s’agir du point de terminaison principal ou du point de terminaison secondaire en fonction du actuel <xref:azure.data.tables.location_mode>.

Retours

URL complète du point de terminaison, y compris le jeton SAS, si elle est utilisée.

Type de retour

str

TableServiceClient Classe

Constructeur

Paramètres

Exemples

Variables

Méthodes

close

create_table

Paramètres

Retours

Type de retour

Exceptions

Exemples

create_table_if_not_exists

Paramètres

Retours

Type de retour

Exceptions

Exemples

delete_table

Paramètres

Retours

Exceptions

Exemples

from_connection_string

Paramètres

Retours

Type de retour

Exemples

get_service_properties

Retours

Type de retour

Exceptions

get_service_stats

Retours

Type de retour

Exceptions

get_table_client

Paramètres

Retours

Type de retour

list_tables

Paramètres

Retours

Type de retour

Exceptions

Exemples

query_tables

Paramètres

Retours

Type de retour

Exceptions

Exemples

set_service_properties

Paramètres

Retours

Exceptions

Attributs

api_version

Retours

url

Retours

Type de retour

Commentaires

Ressources supplémentaires