Compartir a través de

TableServiceClient Clase

  • Referencia

Un cliente para interactuar con Table Service en el nivel de cuenta.

Este cliente proporciona operaciones para recuperar y configurar las propiedades de la cuenta, así como enumerar, crear y eliminar tablas dentro de la cuenta. Para las operaciones relacionadas con una tabla específica, se puede recuperar un cliente para esta entidad mediante la get_table_client función .

Cree TablesBaseClient a partir de una credencial.

Herencia
azure.data.tables._base_client.TablesBaseClient
TableServiceClient

Constructor

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

Parámetros

endpoint
str
Requerido

Dirección URL del punto de conexión de Table Service. Se descartarán todas las demás entidades incluidas en la ruta de acceso url (por ejemplo, tabla). Esta dirección URL se puede autenticar opcionalmente con un token de SAS.

credential
AzureNamedKeyCredential o AzureSasCredential o TokenCredential o None

Credenciales con las que se va a autenticar. Esto es opcional si la dirección URL de la cuenta ya tiene un token de SAS. El valor puede ser uno de AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) o una implementación de TokenCredential de azure-identity.

api_version
str

La versión de la API de Storage que se va a usar para las solicitudes. El valor predeterminado es "2019-02-02". Establecer en una versión anterior puede dar lugar a una reducción de la compatibilidad de características.

endpoint
str
Requerido

Una dirección URL a una cuenta de Azure Tables.

credential
AzureNamedKeyCredential o AzureSasCredential o TokenCredential o None

Credenciales con las que se va a autenticar. Esto es opcional si la dirección URL de la cuenta ya tiene un token de SAS. El valor puede ser uno de AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) o una implementación de TokenCredential de azure-identity.

api_version
str o None

Especifica la versión de la operación que se utiliza para esta solicitud. El valor predeterminado es "2019-02-02".

Ejemplos

Autenticación de tableServiceClient desde una clave de acceso compartido


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

Autenticación de tableServiceClient desde una clave de cuenta compartida


   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

Nombre de la cuenta De tablas.

url
str

Dirección URL completa de la cuenta De tablas.

Métodos

close

Este método es cerrar los sockets abiertos por el cliente. No es necesario usarse cuando se usa con un administrador de contexto.
create_table

Crea una tabla en la cuenta actual.
create_table_if_not_exists

Crea una nueva tabla si no existe actualmente. Si la tabla existe actualmente, se devuelve la tabla actual.
delete_table

Elimina la tabla de la cuenta actual. No se producirá ningún error si no se encuentra la tabla especificada.
from_connection_string

Cree TableServiceClient a partir de una cadena de conexión.
get_service_properties

Obtiene las propiedades de Table service de una cuenta, incluidas las propiedades de las reglas Analytics y CORS (uso compartido de recursos entre orígenes).
get_service_stats

Recupera las estadísticas relacionadas con la replicación para el servicio Tabla. Solo está disponible en el punto de conexión de ubicación secundaria cuando la replicación con redundancia geográfica con acceso de lectura está habilitada para la cuenta.
get_table_client

Obtener un cliente para interactuar con la tabla especificada.

No es necesario que la tabla ya exista.
list_tables

Consulta las tablas en la cuenta especificada.
query_tables

Consulta las tablas en la cuenta especificada.
set_service_properties

Establece las propiedades para el punto de conexión de Table service de una cuenta, incluidas las propiedades de las reglas analytics y CORS (uso compartido de recursos entre orígenes).

close

Este método es cerrar los sockets abiertos por el cliente. No es necesario usarse cuando se usa con un administrador de contexto.

close() -> None

create_table

Crea una tabla en la cuenta actual.

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

Parámetros

table_name
str
Requerido

Nombre de la tabla.

Devoluciones

TableClient

Tipo de valor devuelto

TableClient

Excepciones

ResourceExistsError

Ejemplos

Creación de una tabla a partir del objeto 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

Crea una nueva tabla si no existe actualmente. Si la tabla existe actualmente, se devuelve la tabla actual.

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

Parámetros

table_name
str
Requerido

Nombre de la tabla.

Devoluciones

TableClient

Tipo de valor devuelto

TableClient

Excepciones

HttpResponseError

Ejemplos

Crear una tabla si no existe, desde el objeto 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

Elimina la tabla de la cuenta actual. No se producirá ningún error si no se encuentra la tabla especificada.

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

Parámetros

table_name
str
Requerido

Nombre de la tabla.

Devoluciones

Ninguno

Excepciones

HttpResponseError

Ejemplos

Eliminación de una tabla del objeto 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

Cree TableServiceClient a partir de una cadena de conexión.

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

Parámetros

conn_str
str
Requerido

Una cadena de conexión a una cuenta de Azure Storage o Cosmos.

Devoluciones

Un cliente de Table service.

Tipo de valor devuelto

TableServiceClient

Ejemplos

Autenticación de tableServiceClient desde 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

Obtiene las propiedades de Table service de una cuenta, incluidas las propiedades de las reglas Analytics y CORS (uso compartido de recursos entre orígenes).

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

Devoluciones

Diccionario de propiedades de servicio

Tipo de valor devuelto

dict[str, object]

Excepciones

HttpResponseError

get_service_stats

Recupera las estadísticas relacionadas con la replicación para el servicio Tabla. Solo está disponible en el punto de conexión de ubicación secundaria cuando la replicación con redundancia geográfica con acceso de lectura está habilitada para la cuenta.

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

Devoluciones

Diccionario de estadísticas de servicio

Tipo de valor devuelto

dict[str, object]

Excepciones

azure.core.exceptions.HttpResponseError:

get_table_client

Obtener un cliente para interactuar con la tabla especificada.

No es necesario que la tabla ya exista.

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

Parámetros

table_name
str
Requerido

El nombre de la tabla

Devoluciones

Un objeto TableClient.

Tipo de valor devuelto

TableClient

list_tables

Consulta las tablas en la cuenta especificada.

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

Parámetros

results_per_page
int

Número de tablas por página en itemPaged devuelta

Devoluciones

Iterador de TableItem

Tipo de valor devuelto

ItemPaged[TableItem]

Excepciones

HttpResponseError

Ejemplos

Enumeración de todas las tablas de una cuenta de almacenamiento


   # 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

Consulta las tablas en la cuenta especificada.

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

Parámetros

query_filter
str
Requerido

Especifique un filtro para devolver determinadas tablas.

results_per_page
int

Número de tablas por página en la devolución ItemPaged

parameters
dict[str, Any]

Diccionario para dar formato a la consulta con parámetros adicionales definidos por el usuario

Devoluciones

Iterador de TableItem

Tipo de valor devuelto

ItemPaged[TableItem]

Excepciones

HttpResponseError

Ejemplos

Consulta de tablas en una cuenta de almacenamiento


   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

Establece las propiedades para el punto de conexión de Table service de una cuenta, incluidas las propiedades de las reglas analytics y CORS (uso compartido de recursos entre orígenes).

set_service_properties(**kwargs) -> None

Parámetros

analytics_logging
TableAnalyticsLogging

Propiedades de análisis

hour_metrics
TableMetrics

Métricas de nivel de hora

minute_metrics
TableMetrics

Métricas de nivel de minuto

cors
list[TableCorsRule]

Reglas de uso compartido de recursos entre orígenes

Devoluciones

Ninguno

Excepciones

HttpResponseError

Atributos

api_version

La versión de la API de storage que se usa para las solicitudes.

Devoluciones

La versión de la API de Storage.

url

Dirección URL completa del punto de conexión a esta entidad, incluido el token de SAS si se usa.

Puede ser el punto de conexión principal o el punto de conexión secundario según el actual <xref:azure.data.tables.location_mode>.

Devoluciones

Dirección URL completa del punto de conexión, incluido el token de SAS, si se usa.

Tipo de valor devuelto

str