Condividi tramite

TableServiceClient class

  • Riferimento
Pacchetto:
@azure/data-tables

TableServiceClient rappresenta un client per il servizio Tabelle di Azure che consente di eseguire operazioni sulle tabelle e sulle entità.

Costruttori

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)

Crea una nuova istanza della classe TableServiceClient.
TableServiceClient(string, SASCredential, TableServiceClientOptions)

Crea una nuova istanza della classe TableServiceClient.
TableServiceClient(string, TableServiceClientOptions)

Crea una nuova istanza della classe TableServiceClient.
TableServiceClient(string, TokenCredential, TableServiceClientOptions)

Crea una nuova istanza della classe TableServiceClient.

Proprietà

pipeline

Rappresenta una pipeline per effettuare una richiesta HTTP a un URL. Le pipeline possono avere più criteri per gestire la modifica di ogni richiesta prima e dopo che viene effettuata nel server.
url

URL account tabella

Metodi

createTable(string, OperationOptions)

Crea una nuova tabella nell'account specificato.
deleteTable(string, OperationOptions)

L'operazione elimina definitivamente la tabella specificata.
fromConnectionString(string, TableServiceClientOptions)

Crea un'istanza di TableServiceClient dalla stringa di connessione.
getProperties(OperationOptions)

Ottiene le proprietà del servizio tabelle di un account, incluse le proprietà per le regole analisi e CORS (Cross-Origin Resource Sharing).
getStatistics(OperationOptions)

Recupera le statistiche correlate alla replica per il servizio tabelle. È disponibile solo nell'endpoint della posizione secondaria quando la replica con ridondanza geografica di accesso in lettura è abilitata per l'account.
listTables(ListTableItemsOptions)

Esegue query sulle tabelle nell'account specificato.
setProperties(ServiceProperties, SetPropertiesOptions)

Imposta le proprietà per l'endpoint del servizio tabelle di un account, incluse le proprietà per le regole analisi e CORS (Cross-Origin Resource Sharing).

Dettagli costruttore

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)

Crea una nuova istanza della classe TableServiceClient.

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

Parametri

url

string

URL dell'account del servizio di destinazione dell'operazione desiderata, ad esempio "https://myaccount.table.core.windows.net".

credential
NamedKeyCredential

NamedKeyCredential | SASCredential usato per autenticare le richieste. Supportato solo per node

options
TableServiceClientOptions

Opzioni per configurare la pipeline HTTP.

Esempio con un nome/chiave dell'account:

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 nuova istanza della classe TableServiceClient.

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

Parametri

url

string

URL dell'account del servizio di destinazione dell'operazione desiderata, ad esempio "https://myaccount.table.core.windows.net".

credential
SASCredential

SASCredential usato per autenticare le richieste

options
TableServiceClientOptions

Opzioni per configurare la pipeline HTTP.

Esempio di uso di un token di firma di accesso condiviso.

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 nuova istanza della classe TableServiceClient.

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

Parametri

url

string

URL dell'account del servizio di destinazione dell'operazione desiderata, ad esempio "https://myaccount.table.core.windows.net". È possibile aggiungere una firma di accesso condiviso, ad esempio "https://myaccount.table.core.windows.net?sasString".

options
TableServiceClientOptions

Opzioni per configurare la pipeline HTTP. Esempio di aggiunta di un token di firma di accesso condiviso:

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 nuova istanza della classe TableServiceClient.

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

Parametri

url

string

URL dell'account del servizio di destinazione dell'operazione desiderata, ad esempio "https://myaccount.table.core.windows.net".

credential
TokenCredential

Credenziali di Azure Active Directory usate per autenticare le richieste

options
TableServiceClientOptions

Opzioni per configurare la pipeline HTTP.

Esempio di uso di credenziali di 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
);

Dettagli proprietà

pipeline

Rappresenta una pipeline per effettuare una richiesta HTTP a un URL. Le pipeline possono avere più criteri per gestire la modifica di ogni richiesta prima e dopo che viene effettuata nel server.

pipeline: Pipeline

Valore della proprietà

Pipeline

url

URL account tabella

url: string

Valore della proprietà

string

Dettagli metodo

createTable(string, OperationOptions)

Crea una nuova tabella nell'account specificato.

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

Parametri

name

string

Nome della tabella.

options
OperationOptions

Parametri delle opzioni.

Restituisce

Promise<void>

deleteTable(string, OperationOptions)

L'operazione elimina definitivamente la tabella specificata.

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

Parametri

name

string

Nome della tabella.

options
OperationOptions

Parametri delle opzioni.

Restituisce

Promise<void>

fromConnectionString(string, TableServiceClientOptions)

Crea un'istanza di TableServiceClient dalla stringa di connessione.

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

Parametri

connectionString

string

Stringa di connessione dell'account o stringa di connessione SAS di un account di archiviazione di Azure. [ Nota : la stringa di connessione dell'account può essere usata solo nel runtime di NODE.JS. ] Esempio di stringa di connessione account -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Esempio di stringa di connessione 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

Opzioni per configurare la pipeline HTTP.

Restituisce

TableServiceClient

Nuovo TableServiceClient dalla stringa di connessione specificata.

getProperties(OperationOptions)

Ottiene le proprietà del servizio tabelle di un account, incluse le proprietà per le regole analisi e CORS (Cross-Origin Resource Sharing).

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

Parametri

options
OperationOptions

Parametri delle opzioni.

Restituisce

Promise<GetPropertiesResponse>

getStatistics(OperationOptions)

Recupera le statistiche correlate alla replica per il servizio tabelle. È disponibile solo nell'endpoint della posizione secondaria quando la replica con ridondanza geografica di accesso in lettura è abilitata per l'account.

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

Parametri

options
OperationOptions

Parametri delle opzioni.

Restituisce

Promise<GetStatisticsResponse>

listTables(ListTableItemsOptions)

Esegue query sulle tabelle nell'account specificato.

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

Parametri

options
ListTableItemsOptions

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

setProperties(ServiceProperties, SetPropertiesOptions)

Imposta le proprietà per l'endpoint del servizio tabelle di un account, incluse le proprietà per le regole analisi e CORS (Cross-Origin Resource Sharing).

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

Parametri

properties
ServiceProperties

Proprietà del servizio tabelle.

options
SetPropertiesOptions

Parametri delle opzioni.

Restituisce

Promise<ServiceSetPropertiesHeaders>