TableServiceClient class

Pacote:

@azure/data-tables

Um TableServiceClient representa um Cliente para o serviço Tabelas do Azure, permitindo-lhe realizar 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 um pedido HTTP para um URL. Os pipelines podem ter várias políticas para gerir a manipulação de cada pedido antes e depois de ser efetuada ao servidor.
url	URL da Conta de Tabela

Métodos

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

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

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

credential

NamedKeyCredential

NamedKeyCredential | SASCredential utilizado para autenticar pedidos. Apenas Suportado para o Nó

options

TableServiceClientOptions

Opções para configurar o pipeline HTTP.

Exemplo com 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

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

credential

SASCredential

SASCredential utilizado para autenticar pedidos

options

TableServiceClientOptions

Opções para configurar o pipeline HTTP.

Exemplo a utilizar um Token de 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

O URL da conta de serviço que é o destino da operação pretendida., como "https://myaccount.table.core.windows.net". Pode acrescentar uma SAS, como "https://myaccount.table.core.windows.net?sasString".

options

TableServiceClientOptions

Opções para configurar o pipeline HTTP. Exemplo a acrescentar um token de 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

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

credential

TokenCredential

Credencial do Azure Active Directory utilizada para autenticar pedidos

options

TableServiceClientOptions

Opções para configurar o pipeline HTTP.

Exemplo com 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 de Propriedade

pipeline

Representa um pipeline para fazer um pedido HTTP para um URL. Os pipelines podem ter várias políticas para gerir a manipulação de cada pedido antes e depois de ser efetuada ao servidor.

pipeline: Pipeline

Valor de Propriedade

Pipeline

url

URL da Conta de Tabela

url: string

Valor de Propriedade

string

Detalhes de Método

createTable(string, OperationOptions)

Cria uma nova tabela na conta especificada.

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

Parâmetros

name

string

O nome da tabela.

options

OperationOptions

Os parâmetros de opções.

Devoluções

Promise<void>

deleteTable(string, OperationOptions)

A operação elimina 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.

Devoluções

Promise<void>

fromConnectionString(string, TableServiceClientOptions)

Cria uma instância de TableServiceClient a partir da cadeia de ligação.

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

Parâmetros

connectionString

string

Cadeia de ligação de conta ou uma cadeia de ligação SAS de uma conta de armazenamento do Azure. [ Nota - a cadeia de ligação da conta só pode ser utilizada no NODE.JS runtime. ] Exemplo de cadeia de ligação de conta -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de ligaçã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.

Devoluções

TableServiceClient

Um novo TableServiceClient da cadeia de ligação especificada.

getProperties(OperationOptions)

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

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

Parâmetros

options

OperationOptions

Os parâmetros de opções.

Devoluções

Promise<GetPropertiesResponse>

getStatistics(OperationOptions)

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.

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

Parâmetros

options

OperationOptions

Os parâmetros de opções.

Devoluções

Promise<GetStatisticsResponse>

listTables(ListTableItemsOptions)

Consulta tabelas na conta especificada.

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

Parâmetros

options

ListTableItemsOptions

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

setProperties(ServiceProperties, SetPropertiesOptions)

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

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

Parâmetros

properties

ServiceProperties

As propriedades do Serviço tabela.

options

SetPropertiesOptions

Os parâmetros de opções.

Devoluções

Promise<ServiceSetPropertiesHeaders>