TableServiceClient class

Pacote:

@azure/data-tables

Um TableServiceClient representa um cliente para o serviço Tabelas do Azure, permitindo que você execute operações nas tabelas e nas entidades.

Construtores

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)	Cria uma nova instância da classe TableServiceClient.
TableServiceClient(string, SASCredential, TableServiceClientOptions)	Cria uma nova instância da classe TableServiceClient.
TableServiceClient(string, TableServiceClientOptions)	Cria uma nova instância da classe TableServiceClient.
TableServiceClient(string, TokenCredential, TableServiceClientOptions)	Cria uma nova instância da classe TableServiceClient.

Propriedades

pipeline	Representa um pipeline para fazer uma solicitação HTTP para uma URL. Os pipelines podem ter várias políticas para gerenciar a manipulação de cada solicitação antes e depois que ela é feita no servidor.
url	URL da Conta de Tabela

Métodos

createTable(string, OperationOptions)	Cria uma nova tabela na conta fornecida.
deleteTable(string, OperationOptions)	A operação exclui permanentemente a tabela especificada.
fromConnectionString(string, TableServiceClientOptions)	Cria uma instância de TableServiceClient da cadeia de conexão.
getProperties(OperationOptions)	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).
getStatistics(OperationOptions)	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.
listTables(ListTableItemsOptions)	Consulta tabelas na conta fornecida.
setProperties(ServiceProperties, SetPropertiesOptions)	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).

Detalhes do construtor

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)

Cria uma nova instância da classe TableServiceClient.

new TableServiceClient(url: string, credential: NamedKeyCredential, options?: TableServiceClientOptions)

Parâmetros

url

string

A URL da conta de serviço que é o destino da operação desejada, como "https://myaccount.table.core.windows.net".

credential

NamedKeyCredential

NamedKeyCredential | SASCredential usado para autenticar solicitações. Somente com suporte para nó

options

TableServiceClientOptions

Opções para configurar o pipeline HTTP.

Exemplo usando um nome/chave de conta:

const { AzureNamedKeyCredential, TableServiceClient } = require("@azure/data-tables")
const account = "<storage account name>"
const sharedKeyCredential = new AzureNamedKeyCredential(account, "<account key>");

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  sharedKeyCredential
);

TableServiceClient(string, SASCredential, TableServiceClientOptions)

Cria uma nova instância da classe TableServiceClient.

new TableServiceClient(url: string, credential: SASCredential, options?: TableServiceClientOptions)

Parâmetros

url

string

A URL da conta de serviço que é o destino da operação desejada, como "https://myaccount.table.core.windows.net".

credential

SASCredential

SASCredential usado para autenticar solicitações

options

TableServiceClientOptions

Opções para configurar o pipeline HTTP.

Exemplo usando um token SAS.

const { AzureSASCredential, TableServiceClient } = require("@azure/data-tables")
const account = "<storage account name>"
const sasCredential = new AzureSASCredential(account, "<account key>");

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  sasCredential
);

TableServiceClient(string, TableServiceClientOptions)

Cria uma nova instância da classe TableServiceClient.

new TableServiceClient(url: string, options?: TableServiceClientOptions)

Parâmetros

url

string

A URL da conta de serviço que é o destino da operação desejada, como "https://myaccount.table.core.windows.net". Você pode acrescentar uma SAS, como "https://myaccount.table.core.windows.net?sasString".

options

TableServiceClientOptions

Opções para configurar o pipeline HTTP. Exemplo acrescentando um token SAS:

const account = "<storage account name>";
const sasToken = "<SAS token>";

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net?${sasToken}`,
);

TableServiceClient(string, TokenCredential, TableServiceClientOptions)

Cria uma nova instância da classe TableServiceClient.

new TableServiceClient(url: string, credential: TokenCredential, options?: TableServiceClientOptions)

Parâmetros

url

string

A URL da conta de serviço que é o destino da operação desejada, como "https://myaccount.table.core.windows.net".

credential

TokenCredential

Credencial do Azure Active Directory usada para autenticar solicitações

options

TableServiceClientOptions

Opções para configurar o pipeline HTTP.

Exemplo usando uma credencial do Azure Active Directory:

cons { DefaultAzureCredential } = require("@azure/identity");
const { TableServiceClient } = require("@azure/data-tables")
const account = "<storage account name>"
const credential = new DefaultAzureCredential();

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  credential
);

Detalhes da propriedade

pipeline

Representa um pipeline para fazer uma solicitação HTTP para uma URL. Os pipelines podem ter várias políticas para gerenciar a manipulação de cada solicitação antes e depois que ela é feita no servidor.

pipeline: Pipeline

Valor da propriedade

Pipeline

url

URL da Conta de Tabela

url: string

Valor da propriedade

string

Detalhes do método

createTable(string, OperationOptions)

Cria uma nova tabela na conta fornecida.

function createTable(name: string, options?: OperationOptions): Promise<void>

Parâmetros

name

string

O nome da tabela.

options

OperationOptions

Os parâmetros de opções.

Retornos

Promise<void>

deleteTable(string, OperationOptions)

A operação exclui permanentemente a tabela especificada.

function deleteTable(name: string, options?: OperationOptions): Promise<void>

Parâmetros

name

string

O nome da tabela.

options

OperationOptions

Os parâmetros de opções.

Retornos

Promise<void>

fromConnectionString(string, TableServiceClientOptions)

Cria uma instância de TableServiceClient da cadeia de conexão.

static function fromConnectionString(connectionString: string, options?: TableServiceClientOptions): TableServiceClient

Parâmetros

connectionString

string

Cadeia de conexão de conta ou uma cadeia de conexão SAS de uma conta de armazenamento do Azure. [ Observação - A cadeia de conexão da conta só pode ser usada em NODE.JS runtime. ] Exemplo de cadeia de conexão de conta –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de conexão SAS – BlobEndpoint=https://myaccount.table.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

options

TableServiceClientOptions

Opções para configurar o pipeline HTTP.

Retornos

TableServiceClient

Um novo TableServiceClient da cadeia de conexão fornecida.

getProperties(OperationOptions)

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

function getProperties(options?: OperationOptions): Promise<GetPropertiesResponse>

Parâmetros

options

OperationOptions

Os parâmetros de opções.

Retornos

Promise<GetPropertiesResponse>

getStatistics(OperationOptions)

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.

function getStatistics(options?: OperationOptions): Promise<GetStatisticsResponse>

Parâmetros

options

OperationOptions

Os parâmetros de opções.

Retornos

Promise<GetStatisticsResponse>

listTables(ListTableItemsOptions)

Consulta tabelas na conta fornecida.

function listTables(options?: ListTableItemsOptions): PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

Parâmetros

options

ListTableItemsOptions

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

setProperties(ServiceProperties, SetPropertiesOptions)

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

function setProperties(properties: ServiceProperties, options?: SetPropertiesOptions): Promise<ServiceSetPropertiesHeaders>

Parâmetros

properties

ServiceProperties

As propriedades do Serviço de Tabela.

options

SetPropertiesOptions

Os parâmetros de opções.

Retornos

Promise<ServiceSetPropertiesHeaders>