TableServiceClient Classe

Referência

Um cliente para interagir com o Serviço de Tabela no nível da conta.

Esse cliente fornece operações para recuperar e configurar as propriedades da conta, bem como listar, criar e excluir tabelas dentro da conta. Para operações relacionadas a uma tabela específica, um cliente para essa entidade pode ser recuperado usando a get_table_client função .

Crie TablesBaseClient 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

Obrigatório

A URL para o ponto de extremidade de serviço da tabela. Quaisquer outras entidades incluídas no caminho da URL (por exemplo, tabela) serão descartadas. Essa URL pode ser autenticada opcionalmente com um token SAS.

credential: AzureNamedKeyCredential ou AzureSasCredential ou TokenCredential ou None

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

api_version: str

A versão da API de Armazenamento a ser usada para solicitações. O valor padrão é '2019-02-02'. A configuração para uma versão mais antiga pode resultar em compatibilidade de recursos reduzida.

endpoint: str

Obrigatório

Uma URL para uma conta de Tabelas do Azure.

credential: AzureNamedKeyCredential ou AzureSasCredential ou TokenCredential ou None

api_version: str ou None

Especifica a versão da operação a ser usada para esta solicitação. O valor padrão é "2019-02-02".

Exemplos

Autenticando um TableServiceClient de uma chave de acesso compartilhado


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

Autenticando um TableServiceClient de uma chave de conta compartilhada


   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

A URL completa para a conta Tabelas.

Métodos

close	Esse método é fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto.
create_table	Cria uma nova tabela na conta atual.
create_table_if_not_exists	Criará uma nova tabela se ela não existir no momento. Se a tabela existir no momento, a tabela atual será retornada.
delete_table	Exclui a tabela na conta atual. Nenhum erro será gerado se a tabela fornecida não for encontrada.
from_connection_string	Crie TableServiceClient de uma cadeia de conexão.
get_service_properties	Obtém as propriedades do serviço Tabela de uma conta, incluindo propriedades para regras de Análise e CORS (Compartilhamento de Recursos entre Origens).
get_service_stats	Recupera as estatísticas relacionadas à replicação do serviço Tabela. Ele só está disponível no ponto de extremidade de localização secundário quando a replicação com redundância geográfica de acesso de leitura está habilitada para a conta.
get_table_client	Faça com que um cliente interaja com a tabela especificada. A tabela ainda não precisa existir.
list_tables	Consulta tabelas na conta fornecida.
query_tables	Consulta tabelas na conta fornecida.
set_service_properties	Define propriedades para o ponto de extremidade de serviço Table de uma conta, incluindo propriedades para regras de Análise e CORS (Compartilhamento de Recursos entre Origens).

close

Esse método é fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador 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

Obrigatório

O nome da tabela.

Retornos

TableClient

Tipo de retorno

TableClient

Exceções

ResourceExistsError

Exemplos

Criando uma tabela 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

Criará uma nova tabela se ela não existir no momento. Se a tabela existir no momento, a tabela atual será retornada.

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

Parâmetros

table_name: str

Obrigatório

O nome da tabela.

Retornos

TableClient

Tipo de retorno

TableClient

Exceções

HttpResponseError

Exemplos

Criar uma tabela se ela não existir, 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

Exclui a tabela na conta atual. Nenhum erro será gerado se a tabela fornecida não for encontrada.

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

Parâmetros

table_name: str

Obrigatório

O nome da tabela.

Retornos

Nenhum

Exceções

HttpResponseError

Exemplos

Excluindo 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 de uma cadeia de conexão.

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

Parâmetros

conn_str: str

Obrigatório

Uma cadeia de conexão com uma conta do Armazenamento do Azure ou do Cosmos.

Retornos

Um cliente de serviço tabela.

Tipo de retorno

TableServiceClient

Exemplos

Autenticando um TableServiceClient 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 propriedades para regras de Análise e CORS (Compartilhamento de Recursos entre Origens).

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

Retornos

Dicionário de propriedades de serviço

Tipo de retorno

dict[str, object]

Exceções

HttpResponseError

get_service_stats

Recupera as estatísticas relacionadas à replicação do serviço Tabela. Ele só está disponível no ponto de extremidade de localização secundário quando a replicação com redundância geográfica de acesso de leitura está habilitada para a conta.

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

Retornos

Dicionário de estatísticas de serviço

Tipo de retorno

dict[str, object]

Exceções

azure.core.exceptions.HttpResponseError:

get_table_client

Faça com que um cliente interaja com a tabela especificada.

A tabela ainda não precisa existir.

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

Parâmetros

table_name: str

Obrigatório

O nome da tabela

Retornos

Um objeto TableClient.

Tipo de retorno

TableClient

list_tables

Consulta tabelas na conta fornecida.

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

Parâmetros

results_per_page: int

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

Retornos

Um iterador de TableItem

Tipo de retorno

ItemPaged[TableItem]

Exceções

HttpResponseError

Exemplos

Listando todas as tabelas em uma 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 fornecida.

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

Parâmetros

query_filter: str

Obrigatório

Especifique um filtro para retornar determinadas tabelas.

results_per_page: int

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

parameters: dict[str, Any]

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

Retornos

Um iterador de TableItem

Tipo de retorno

ItemPaged[TableItem]

Exceções

HttpResponseError

Exemplos

Consultar tabelas em uma 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 de extremidade de serviço Table de uma conta, incluindo propriedades para regras de Análise e CORS (Compartilhamento de Recursos entre Origens).

set_service_properties(**kwargs) -> None

Parâmetros

analytics_logging: TableAnalyticsLogging

Propriedades para 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 compartilhamento de recursos entre origens

Retornos

Nenhum

Exceções

HttpResponseError

Atributos

api_version

A versão da API de Armazenamento usada para solicitações.

Retornos

A versão da API de Armazenamento.

url

A URL completa do ponto de extremidade para essa entidade, incluindo o token SAS, se usado.

Pode ser o ponto de extremidade primário ou o ponto de extremidade secundário, dependendo do atual <xref:azure.data.tables.location_mode>.

Retornos

A URL completa do ponto de extremidade, incluindo o token SAS, se usado.

Tipo de retorno

str

Compartilhar via

TableServiceClient Classe

Construtor

Parâmetros

Exemplos

Variáveis

Métodos

close

create_table

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

create_table_if_not_exists

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

delete_table

Parâmetros

Retornos

Exceções

Exemplos

from_connection_string

Parâmetros

Retornos

Tipo de retorno

Exemplos

get_service_properties

Retornos

Tipo de retorno

Exceções

get_service_stats

Retornos

Tipo de retorno

Exceções

get_table_client

Parâmetros

Retornos

Tipo de retorno

list_tables

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

query_tables

Parâmetros

Retornos

Tipo de retorno

Exceções

Exemplos

set_service_properties

Parâmetros

Retornos

Exceções

Atributos

api_version

Retornos

url

Retornos

Tipo de retorno

Recursos adicionais