TableServiceClient class

Paquete:

@azure/data-tables

TableServiceClient representa un cliente para el servicio Azure Tables, lo que le permite realizar operaciones en las tablas y las entidades.

Constructores

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)	Crea una nueva instancia de la clase TableServiceClient.
TableServiceClient(string, SASCredential, TableServiceClientOptions)	Crea una nueva instancia de la clase TableServiceClient.
TableServiceClient(string, TableServiceClientOptions)	Crea una nueva instancia de la clase TableServiceClient.
TableServiceClient(string, TokenCredential, TableServiceClientOptions)	Crea una nueva instancia de la clase TableServiceClient.

Propiedades

pipeline	Representa una canalización para realizar una solicitud HTTP en una dirección URL. Las canalizaciones pueden tener varias directivas para administrar la manipulación de cada solicitud antes y después de que se realice en el servidor.
url	Dirección URL de la cuenta de tabla

Métodos

createTable(string, OperationOptions)	Crea una tabla en la cuenta especificada.
deleteTable(string, OperationOptions)	La operación elimina permanentemente la tabla especificada.
fromConnectionString(string, TableServiceClientOptions)	Crea una instancia de TableServiceClient a partir de la cadena de conexión.
getProperties(OperationOptions)	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).
getStatistics(OperationOptions)	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.
listTables(ListTableItemsOptions)	Consulta las tablas en la cuenta especificada.
setProperties(ServiceProperties, SetPropertiesOptions)	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).

Detalles del constructor

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)

Crea una nueva instancia de la clase TableServiceClient.

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

Parámetros

url

string

Dirección URL de la cuenta de servicio que es el destino de la operación deseada, como "https://myaccount.table.core.windows.net".

credential

NamedKeyCredential

NamedKeyCredential | SASCredential se usa para autenticar solicitudes. Solo se admite para Node

options

TableServiceClientOptions

Opciones para configurar la canalización HTTP.

Ejemplo de uso de un nombre o clave de cuenta:

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)

Crea una nueva instancia de la clase TableServiceClient.

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

Parámetros

url

string

Dirección URL de la cuenta de servicio que es el destino de la operación deseada, como "https://myaccount.table.core.windows.net".

credential

SASCredential

SASCredential usado para autenticar solicitudes

options

TableServiceClientOptions

Opciones para configurar la canalización HTTP.

Ejemplo de uso de un 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)

Crea una nueva instancia de la clase TableServiceClient.

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

Parámetros

url

string

Dirección URL de la cuenta de servicio que es el destino de la operación deseada, como "https://myaccount.table.core.windows.net". Puede anexar una SAS, como "https://myaccount.table.core.windows.net?sasString".

options

TableServiceClientOptions

Opciones para configurar la canalización HTTP. Ejemplo de anexión de un 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)

Crea una nueva instancia de la clase TableServiceClient.

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

Parámetros

url

string

Dirección URL de la cuenta de servicio que es el destino de la operación deseada, como "https://myaccount.table.core.windows.net".

credential

TokenCredential

Credencial de Azure Active Directory usada para autenticar solicitudes

options

TableServiceClientOptions

Opciones para configurar la canalización HTTP.

Ejemplo de uso de una credencial de 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
);

Detalles de las propiedades

pipeline

Representa una canalización para realizar una solicitud HTTP en una dirección URL. Las canalizaciones pueden tener varias directivas para administrar la manipulación de cada solicitud antes y después de que se realice en el servidor.

pipeline: Pipeline

Valor de propiedad

Pipeline

url

Dirección URL de la cuenta de tabla

url: string

Valor de propiedad

string

Detalles del método

createTable(string, OperationOptions)

Crea una tabla en la cuenta especificada.

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

Parámetros

name

string

Nombre de la tabla.

options

OperationOptions

Parámetros de opciones.

Devoluciones

Promise<void>

deleteTable(string, OperationOptions)

La operación elimina permanentemente la tabla especificada.

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

Parámetros

name

string

Nombre de la tabla.

options

OperationOptions

Parámetros de opciones.

Devoluciones

Promise<void>

fromConnectionString(string, TableServiceClientOptions)

Crea una instancia de TableServiceClient a partir de la cadena de conexión.

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

Parámetros

connectionString

string

Cadena de conexión de la cuenta o una cadena de conexión de SAS de una cuenta de almacenamiento de Azure. [ Nota: la cadena de conexión de la cuenta solo se puede usar en NODE.JS tiempo de ejecución. ] Ejemplo de cadena de conexión de cuenta:DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Ejemplo de cadena de conexión de 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

Opciones para configurar la canalización HTTP.

Devoluciones

TableServiceClient

TableServiceClient nuevo de la cadena de conexión especificada.

getProperties(OperationOptions)

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

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

Parámetros

options

OperationOptions

Parámetros de opciones.

Devoluciones

Promise<GetPropertiesResponse>

getStatistics(OperationOptions)

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.

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

Parámetros

options

OperationOptions

Parámetros de opciones.

Devoluciones

Promise<GetStatisticsResponse>

listTables(ListTableItemsOptions)

Consulta las tablas en la cuenta especificada.

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

Parámetros

options

ListTableItemsOptions

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

setProperties(ServiceProperties, SetPropertiesOptions)

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

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

Parámetros

properties

ServiceProperties

Las propiedades de Table Service.

options

SetPropertiesOptions

Parámetros de opciones.

Devoluciones

Promise<ServiceSetPropertiesHeaders>