TableServiceClient Klasse

  • Referenz

Ein Client für die Interaktion mit dem Tabellendienst auf Kontoebene.

Dieser Client bietet Vorgänge zum Abrufen und Konfigurieren der Kontoeigenschaften sowie zum Auflisten, Erstellen und Löschen von Tabellen innerhalb des Kontos. Für Vorgänge im Zusammenhang mit einer bestimmten Tabelle kann ein Client für diese Entität mithilfe der get_table_client -Funktion abgerufen werden.

Erstellen Sie TablesBaseClient aus anmeldeinformationen.

Vererbung
azure.data.tables._base_client.TablesBaseClient
TableServiceClient

Konstruktor

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

Parameter

endpoint
str
Erforderlich

Die URL zum Tabellendienstendpunkt. Alle anderen Entitäten, die im URL-Pfad enthalten sind (z. B. tabelle), werden verworfen. Diese URL kann optional mit einem SAS-Token authentifiziert werden.

credential
AzureNamedKeyCredential oder AzureSasCredential oder TokenCredential oder None

Die Anmeldeinformationen, mit denen die Authentifizierung erfolgt. Dies ist optional, wenn die Konto-URL bereits über ein SAS-Token verfügt. Der Wert kann einer von AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) oder einer TokenCredential-Implementierung aus azure-identity sein.

api_version
str

Die Speicher-API-Version, die für Anforderungen verwendet werden soll. Der Standardwert ist "2019-02-02". Die Einstellung auf eine ältere Version kann zu einer verringerten Featurekompatibilität führen.

endpoint
str
Erforderlich

Eine URL zu einem Azure Tables-Konto.

credential
AzureNamedKeyCredential oder AzureSasCredential oder TokenCredential oder None

Die Anmeldeinformationen, mit denen die Authentifizierung erfolgt. Dies ist optional, wenn die Konto-URL bereits über ein SAS-Token verfügt. Der Wert kann einer von AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) oder einer TokenCredential-Implementierung aus azure-identity sein.

api_version
str oder None

Gibt die Version des für die Anforderung zu verwendenden Vorgangs an. Der Standardwert ist "2019-02-02".

Beispiele

Authentifizieren eines TableServiceClient über einen gemeinsam genutzten Zugriffsschlüssel


   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))

Authentifizieren eines TableServiceClient aus einem Schlüssel für gemeinsam genutzte Konten


   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))

Variablen

account_name
str

Der Name des Tabellenkontos.

url
str

Die vollständige URL zum Tabellenkonto.

Methoden

close

Diese Methode besteht darin, die vom Client geöffneten Sockets zu schließen. Es muss nicht verwendet werden, wenn sie mit einem Kontext-Manager verwendet wird.
create_table

Erstellt eine neue Tabelle unter dem aktuellen Konto.
create_table_if_not_exists

Erstellt eine neue Tabelle, wenn sie derzeit nicht vorhanden ist. Wenn die Tabelle derzeit vorhanden ist, wird die aktuelle Tabelle zurückgegeben.
delete_table

Löscht die Tabelle unter dem aktuellen Konto. Wenn die angegebene Tabelle nicht gefunden wird, wird kein Fehler ausgelöst.
from_connection_string

Erstellen Sie TableServiceClient aus einer Verbindungszeichenfolge.
get_service_properties

Ruft die Eigenschaften des Table-Diensts eines Kontos ab, einschließlich eigenschaften für Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).
get_service_stats

Ruft Statistiken zur Replikation für den Tabellendienst ab. Sie ist nur auf dem endpunkt des sekundären Standorts verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Konto aktiviert ist.
get_table_client

Rufen Sie einen Client für die Interaktion mit der angegebenen Tabelle ab.

Die Tabelle muss noch nicht vorhanden sein.
list_tables

Fragt Tabellen unter dem angegebenen Konto ab.
query_tables

Fragt Tabellen unter dem angegebenen Konto ab.
set_service_properties

Legt Eigenschaften für den Tabellendienstendpunkt eines Kontos fest, einschließlich Eigenschaften für Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

close

Diese Methode besteht darin, die vom Client geöffneten Sockets zu schließen. Es muss nicht verwendet werden, wenn sie mit einem Kontext-Manager verwendet wird.

close() -> None

create_table

Erstellt eine neue Tabelle unter dem aktuellen Konto.

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

Parameter

table_name
str
Erforderlich

Der Tabellenname.

Gibt zurück

TableClient

Rückgabetyp

TableClient

Ausnahmen

ResourceExistsError

Beispiele

Erstellen einer Tabelle aus dem TableServiceClient-Objekt


   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

Erstellt eine neue Tabelle, wenn sie derzeit nicht vorhanden ist. Wenn die Tabelle derzeit vorhanden ist, wird die aktuelle Tabelle zurückgegeben.

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

Parameter

table_name
str
Erforderlich

Der Tabellenname.

Gibt zurück

TableClient

Rückgabetyp

TableClient

Ausnahmen

HttpResponseError

Beispiele

Erstellen einer Tabelle, wenn sie nicht vorhanden ist, aus dem TableServiceClient-Objekt


   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

Löscht die Tabelle unter dem aktuellen Konto. Wenn die angegebene Tabelle nicht gefunden wird, wird kein Fehler ausgelöst.

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

Parameter

table_name
str
Erforderlich

Der Tabellenname.

Gibt zurück

Keine

Ausnahmen

HttpResponseError

Beispiele

Löschen einer Tabelle aus dem TableServiceClient-Objekt


   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

Erstellen Sie TableServiceClient aus einer Verbindungszeichenfolge.

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

Parameter

conn_str
str
Erforderlich

Eine Verbindungszeichenfolge mit einem Azure Storage- oder Cosmos-Konto.

Gibt zurück

Ein Tabellendienstclient.

Rückgabetyp

TableServiceClient

Beispiele

Authentifizieren eines TableServiceClient aus einem 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

Ruft die Eigenschaften des Table-Diensts eines Kontos ab, einschließlich eigenschaften für Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

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

Gibt zurück

Wörterbuch der Diensteigenschaften

Rückgabetyp

dict[str, object]

Ausnahmen

HttpResponseError

get_service_stats

Ruft Statistiken zur Replikation für den Tabellendienst ab. Sie ist nur auf dem endpunkt des sekundären Standorts verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Konto aktiviert ist.

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

Gibt zurück

Wörterbuch der Dienststatistiken

Rückgabetyp

dict[str, object]

Ausnahmen

azure.core.exceptions.HttpResponseError:

get_table_client

Rufen Sie einen Client für die Interaktion mit der angegebenen Tabelle ab.

Die Tabelle muss noch nicht vorhanden sein.

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

Parameter

table_name
str
Erforderlich

Der Tabellenname

Gibt zurück

Ein TableClient-Objekt.

Rückgabetyp

TableClient

list_tables

Fragt Tabellen unter dem angegebenen Konto ab.

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

Parameter

results_per_page
int

Anzahl von Tabellen pro Seite in zurückgegebenem ItemPaged

Gibt zurück

Ein Iterator von TableItem

Rückgabetyp

ItemPaged[TableItem]

Ausnahmen

HttpResponseError

Beispiele

Auflisten aller Tabellen in einem Speicherkonto


   # 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

Fragt Tabellen unter dem angegebenen Konto ab.

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

Parameter

query_filter
str
Erforderlich

Geben Sie einen Filter an, um bestimmte Tabellen zurückzugeben.

results_per_page
int

Anzahl von Tabellen pro Seite in rückgabe ItemPaged

parameters
dict[str, Any]

Wörterbuch zum Formatieren von Abfragen mit zusätzlichen benutzerdefinierten Parametern

Gibt zurück

Ein Iterator von TableItem

Rückgabetyp

ItemPaged[TableItem]

Ausnahmen

HttpResponseError

Beispiele

Abfragen von Tabellen in einem Speicherkonto


   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

Legt Eigenschaften für den Tabellendienstendpunkt eines Kontos fest, einschließlich Eigenschaften für Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

set_service_properties(**kwargs) -> None

Parameter

analytics_logging
TableAnalyticsLogging

Eigenschaften für Analysen

hour_metrics
TableMetrics

Metriken auf Stundenebene

minute_metrics
TableMetrics

Metriken auf Minutenebene

cors
list[TableCorsRule]

Regeln für die ursprungsübergreifende Ressourcenfreigabe

Gibt zurück

Keine

Ausnahmen

HttpResponseError

Attribute

api_version

Die Version der Speicher-API, die für Anforderungen verwendet wird.

Gibt zurück

Die Speicher-API-Version.

url

Die vollständige Endpunkt-URL für diese Entität, einschließlich des SAS-Tokens, falls verwendet.

Dies kann abhängig vom aktuellen <xref:azure.data.tables.location_mode>entweder der primäre Endpunkt oder der sekundäre Endpunkt sein.

Gibt zurück

Die vollständige Endpunkt-URL einschließlich SAS-Token, falls verwendet.

Rückgabetyp

str