Partilhar via

TableServiceClient Classe

  • Referência

Um cliente para interagir com o Serviço tabela ao nível da conta.

Este cliente fornece operações para obter e configurar as propriedades da conta, bem como listar, criar e eliminar tabelas na conta. Para operações relacionadas com uma tabela específica, um cliente para esta entidade pode ser obtido com a get_table_client função .

Criar TabelasBaseCliente a partir de uma Credencial.

Herança
azure.data.tables._base_client.TablesBaseClient
TableServiceClient

Construtor

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

Parâmetros

endpoint
str
Necessário

O URL para o ponto final de serviço da tabela. Quaisquer outras entidades incluídas no caminho do URL (por exemplo, tabela) serão eliminadas. Opcionalmente, este URL pode ser autenticado com um token de SAS.

credential
AzureNamedKeyCredential ou AzureSasCredential ou TokenCredential ou None

As credenciais com as quais se autenticar. Isto é opcional se o URL da conta já tiver um token de SAS. O valor pode ser um de AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) ou uma implementação TokenCredential a partir de azure-identity.

api_version
str

A versão da API de Armazenamento a utilizar para pedidos. O valor predefinido é "2019-02-02". Definir para uma versão mais antiga pode resultar numa compatibilidade de funcionalidades reduzida.

endpoint
str
Necessário

Um URL para uma conta de Tabelas do Azure.

credential
AzureNamedKeyCredential ou AzureSasCredential ou TokenCredential ou None

As credenciais com as quais se autenticar. Isto é opcional se o URL da conta já tiver um token de SAS. O valor pode ser um de AzureNamedKeyCredential (azure-core), AzureSasCredential (azure-core) ou uma implementação TokenCredential a partir de azure-identity.

api_version
str ou None

Especifica a versão da operação a utilizar para este pedido. O valor predefinido é "2019-02-02".

Exemplos

Autenticar um TableServiceClient a partir de uma Chave de Acesso Partilhado


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

Autenticar um TableServiceClient a partir de uma Chave de Conta Partilhada


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

Variáveis

account_name
str

O nome da conta Tabelas.

url
str

O URL completo para a conta Tabelas.

Métodos

close

Este método consiste em fechar os sockets abertos pelo cliente. Não é necessário utilizá-la ao utilizar com um gestor de contexto.
create_table

Cria uma nova tabela na conta atual.
create_table_if_not_exists

Cria uma nova tabela se não existir atualmente. Se a tabela existir atualmente, a tabela atual é devolvida.
delete_table

Elimina a tabela na conta atual. Não será gerado nenhum erro se a tabela especificada não for encontrada.
from_connection_string

Crie TableServiceClient a partir de uma cadeia de ligação.
get_service_properties

Obtém as propriedades do serviço Tabela de uma conta, incluindo as propriedades das regras de Análise e CORS (Partilha de Recursos Transversais à Origem).
get_service_stats

Obtém estatísticas relacionadas com a replicação do serviço Tabela. Só está disponível no ponto final de localização secundária quando a replicação georredundante de acesso de leitura está ativada para a conta.
get_table_client

Obter um cliente para interagir com a tabela especificada.

A tabela ainda não precisa de existir.
list_tables

Consulta tabelas na conta especificada.
query_tables

Consulta tabelas na conta especificada.
set_service_properties

Define propriedades para o ponto final de serviço Tabela de uma conta, incluindo propriedades para regras de Análise e CORS (Partilha de Recursos Transversais à Origem).

close

Este método consiste em fechar os sockets abertos pelo cliente. Não é necessário utilizá-la ao utilizar com um gestor de contexto.

close() -> None

create_table

Cria uma nova tabela na conta atual.

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

Parâmetros

table_name
str
Necessário

O Nome da tabela.

Devoluções

TableClient

Tipo de retorno

TableClient

Exceções

ResourceExistsError

Exemplos

Criar uma tabela a partir do 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

Cria uma nova tabela se não existir atualmente. Se a tabela existir atualmente, a tabela atual é devolvida.

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

Parâmetros

table_name
str
Necessário

O Nome da tabela.

Devoluções

TableClient

Tipo de retorno

TableClient

Exceções

HttpResponseError

Exemplos

Criar uma tabela se não existir, a partir do 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 a tabela na conta atual. Não será gerado nenhum erro se a tabela especificada não for encontrada.

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

Parâmetros

table_name
str
Necessário

O Nome da tabela.

Devoluções

Nenhuma

Exceções

HttpResponseError

Exemplos

Eliminar uma tabela do 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

Crie TableServiceClient a partir de uma cadeia de ligação.

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

Parâmetros

conn_str
str
Necessário

Uma cadeia de ligação para uma conta do Armazenamento do Azure ou do Cosmos.

Devoluções

Um cliente de serviço Tabela.

Tipo de retorno

TableServiceClient

Exemplos

Autenticar um TableServiceClient a partir de um 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

Obtém as propriedades do serviço Tabela de uma conta, incluindo as propriedades das regras de Análise e CORS (Partilha de Recursos Transversais à Origem).

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

Devoluções

Dicionário de propriedades do serviço

Tipo de retorno

dict[str, object]

Exceções

HttpResponseError

get_service_stats

Obtém estatísticas relacionadas com a replicação do serviço Tabela. Só está disponível no ponto final de localização secundária quando a replicação georredundante de acesso de leitura está ativada para a conta.

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

Devoluções

Dicionário de estatísticas de serviço

Tipo de retorno

dict[str, object]

Exceções

azure.core.exceptions.HttpResponseError:

get_table_client

Obter um cliente para interagir com a tabela especificada.

A tabela ainda não precisa de existir.

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

Parâmetros

table_name
str
Necessário

O nome da tabela

Devoluções

Um TableClient objeto.

Tipo de retorno

TableClient

list_tables

Consulta tabelas na conta especificada.

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

Parâmetros

results_per_page
int

Número de tabelas por página no ItemPaged devolvido

Devoluções

Um iterador de TableItem

Tipo de retorno

ItemPaged[TableItem]

Exceções

HttpResponseError

Exemplos

Listar todas as tabelas numa conta de armazenamento


   # 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 tabelas na conta especificada.

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

Parâmetros

query_filter
str
Necessário

Especifique um filtro para devolver determinadas tabelas.

results_per_page
int

Número de tabelas por página em Devolver ItemPaged

parameters
dict[str, Any]

Dicionário para formatar consulta com parâmetros adicionais definidos pelo utilizador

Devoluções

Um iterador de TableItem

Tipo de retorno

ItemPaged[TableItem]

Exceções

HttpResponseError

Exemplos

Consultar tabelas numa conta de armazenamento


   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

Define propriedades para o ponto final de serviço Tabela de uma conta, incluindo propriedades para regras de Análise e CORS (Partilha de Recursos Transversais à Origem).

set_service_properties(**kwargs) -> None

Parâmetros

analytics_logging
TableAnalyticsLogging

Propriedades da análise

hour_metrics
TableMetrics

Métricas de nível de hora

minute_metrics
TableMetrics

Métricas de nível de minuto

cors
list[TableCorsRule]

Regras de partilha de recursos de várias origens

Devoluções

Nenhuma

Exceções

HttpResponseError

Atributos

api_version

A versão da API de Armazenamento utilizada para pedidos.

Devoluções

A versão da API de Armazenamento.

url

O URL de ponto final completo para esta entidade, incluindo o token de SAS, se utilizado.

Este pode ser o ponto final primário ou o ponto final secundário, dependendo do atual <xref:azure.data.tables.location_mode>.

Devoluções

O URL de ponto final completo, incluindo o token de SAS, se utilizado.

Tipo de retorno

str