TableServiceClient class

Pakiet:

@azure/data-tables

Obiekt TableServiceClient reprezentuje klienta w usłudze Azure Tables, umożliwiając wykonywanie operacji na tabelach i jednostkach.

Konstruktory

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)	Tworzy nowe wystąpienie klasy TableServiceClient.
TableServiceClient(string, SASCredential, TableServiceClientOptions)	Tworzy nowe wystąpienie klasy TableServiceClient.
TableServiceClient(string, TableServiceClientOptions)	Tworzy nowe wystąpienie klasy TableServiceClient.
TableServiceClient(string, TokenCredential, TableServiceClientOptions)	Tworzy nowe wystąpienie klasy TableServiceClient.

Właściwości

pipeline	Reprezentuje potok umożliwiający wysyłanie żądania HTTP do adresu URL. Potoki mogą mieć wiele zasad do zarządzania manipulowaniem każdym żądaniem przed i po jego wykonaniu na serwerze.
url	Adres URL konta tabeli

Metody

createTable(string, OperationOptions)	Tworzy nową tabelę w ramach danego konta.
deleteTable(string, OperationOptions)	Operacja trwale usuwa określoną tabelę.
fromConnectionString(string, TableServiceClientOptions)	Tworzy wystąpienie klasy TableServiceClient na podstawie parametrów połączenia.
getProperties(OperationOptions)	Pobiera właściwości usługi Table service konta, w tym właściwości reguł analizy i mechanizmu CORS (współużytkowanie zasobów między źródłami).
getStatistics(OperationOptions)	Pobiera statystyki związane z replikacją dla usługi Table Service. Jest on dostępny tylko w punkcie końcowym lokalizacji pomocniczej, gdy dla konta jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.
listTables(ListTableItemsOptions)	Wykonuje zapytania w tabelach w ramach danego konta.
setProperties(ServiceProperties, SetPropertiesOptions)	Ustawia właściwości punktu końcowego usługi table konta, w tym właściwości reguł analizy i mechanizmu CORS (współużytkowanie zasobów między źródłami).

Szczegóły konstruktora

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)

Tworzy nowe wystąpienie klasy TableServiceClient.

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

Parametry

url

string

Adres URL konta usługi, który jest obiektem docelowym żądanej operacji, na przykład "https://myaccount.table.core.windows.net"".

credential

NamedKeyCredential

NamedKeyCredential | Sygnatura dostępu współdzielonego używana do uwierzytelniania żądań. Obsługiwane tylko w przypadku węzła

options

TableServiceClientOptions

Opcje konfigurowania potoku HTTP.

Przykład użycia nazwy/klucza konta:

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)

Tworzy nowe wystąpienie klasy TableServiceClient.

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

Parametry

url

string

Adres URL konta usługi, który jest obiektem docelowym żądanej operacji, na przykład "https://myaccount.table.core.windows.net"".

credential

SASCredential

Sygnatura dostępu współdzielonego używana do uwierzytelniania żądań

options

TableServiceClientOptions

Opcje konfigurowania potoku HTTP.

Przykład użycia tokenu 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)

Tworzy nowe wystąpienie klasy TableServiceClient.

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

Parametry

url

string

Adres URL konta usługi, który jest obiektem docelowym żądanej operacji, na przykład "https://myaccount.table.core.windows.net"". Możesz dołączyć sygnaturę dostępu współdzielonego, taką jak "https://myaccount.table.core.windows.net?sasString".

options

TableServiceClientOptions

Opcje konfigurowania potoku HTTP. Przykład dołączania tokenu 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)

Tworzy nowe wystąpienie klasy TableServiceClient.

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

Parametry

url

string

Adres URL konta usługi, który jest obiektem docelowym żądanej operacji, na przykład "https://myaccount.table.core.windows.net"".

credential

TokenCredential

Poświadczenia usługi Azure Active Directory używane do uwierzytelniania żądań

options

TableServiceClientOptions

Opcje konfigurowania potoku HTTP.

Przykład użycia poświadczeń usługi 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
);

Szczegóły właściwości

pipeline

Reprezentuje potok umożliwiający wysyłanie żądania HTTP do adresu URL. Potoki mogą mieć wiele zasad do zarządzania manipulowaniem każdym żądaniem przed i po jego wykonaniu na serwerze.

pipeline: Pipeline

Wartość właściwości

Pipeline

url

Adres URL konta tabeli

url: string

Wartość właściwości

string

Szczegóły metody

createTable(string, OperationOptions)

Tworzy nową tabelę w ramach danego konta.

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

Parametry

name

string

Nazwa tabeli.

options

OperationOptions

Parametry opcji.

Zwraca

Promise<void>

deleteTable(string, OperationOptions)

Operacja trwale usuwa określoną tabelę.

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

Parametry

name

string

Nazwa tabeli.

options

OperationOptions

Parametry opcji.

Zwraca

Promise<void>

fromConnectionString(string, TableServiceClientOptions)

Tworzy wystąpienie klasy TableServiceClient na podstawie parametrów połączenia.

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

Parametry

connectionString

string

Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage. [ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Przykład parametrów połączenia sygnatury dostępu współdzielonego — 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

Opcje konfigurowania potoku HTTP.

Zwraca

TableServiceClient

Nowy obiekt TableServiceClient z podanych parametrów połączenia.

getProperties(OperationOptions)

Pobiera właściwości usługi Table service konta, w tym właściwości reguł analizy i mechanizmu CORS (współużytkowanie zasobów między źródłami).

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

Parametry

options

OperationOptions

Parametry opcji.

Zwraca

Promise<GetPropertiesResponse>

getStatistics(OperationOptions)

Pobiera statystyki związane z replikacją dla usługi Table Service. Jest on dostępny tylko w punkcie końcowym lokalizacji pomocniczej, gdy dla konta jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.

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

Parametry

options

OperationOptions

Parametry opcji.

Zwraca

Promise<GetStatisticsResponse>

listTables(ListTableItemsOptions)

Wykonuje zapytania w tabelach w ramach danego konta.

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

Parametry

options

ListTableItemsOptions

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

setProperties(ServiceProperties, SetPropertiesOptions)

Ustawia właściwości punktu końcowego usługi table konta, w tym właściwości reguł analizy i mechanizmu CORS (współużytkowanie zasobów między źródłami).

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

Parametry

properties

ServiceProperties

Właściwości usługi Table Service.

options

SetPropertiesOptions

Parametry opcji.

Zwraca

Promise<ServiceSetPropertiesHeaders>