TableServiceClient class

Ссылка

Пакет:: @azure/data-tables

TableServiceClient представляет клиент в службу таблиц Azure, которая позволяет выполнять операции с таблицами и сущностями.

Конструкторы

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)	Создает новый экземпляр класса TableServiceClient.
TableServiceClient(string, SASCredential, TableServiceClientOptions)	Создает новый экземпляр класса TableServiceClient.
TableServiceClient(string, TableServiceClientOptions)	Создает новый экземпляр класса TableServiceClient.
TableServiceClient(string, TokenCredential, TableServiceClientOptions)	Создает новый экземпляр класса TableServiceClient.

Свойства

pipeline	Представляет конвейер для создания HTTP-запроса к URL-адресу. Конвейеры могут иметь несколько политик для управления обработкой каждого запроса до и после его выполнения на сервере.
url	URL-адрес учетной записи таблицы

Методы

createTable(string, OperationOptions)	Создает новую таблицу под данной учетной записью.
deleteTable(string, OperationOptions)	Операция окончательно удаляет указанную таблицу.
fromConnectionString(string, TableServiceClientOptions)	Создает экземпляр TableServiceClient из строки подключения.
getProperties(OperationOptions)	Возвращает свойства службы таблиц учетной записи, включая свойства для правил аналитики и CORS (совместного использования ресурсов между источниками).
getStatistics(OperationOptions)	Извлекает статистику, связанную с репликацией для службы таблиц. Он доступен только в конечной точке дополнительного расположения, если для учетной записи включена геоизбыточная репликация доступа для чтения.
listTables(ListTableItemsOptions)	Запросы таблиц в заданной учетной записи.
setProperties(ServiceProperties, SetPropertiesOptions)	Задает свойства для конечной точки службы таблиц учетной записи, включая свойства для правил аналитики и CORS (совместного использования ресурсов между источниками).

Сведения о конструкторе

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)

Создает новый экземпляр класса TableServiceClient.

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

Параметры

url: string

URL-адрес учетной записи службы, являющейся целью требуемой операции., например "https://myaccount.table.core.windows.net".

credential: NamedKeyCredential

NamedKeyCredential | SASCredential, используемый для проверки подлинности запросов. Поддерживается только для узла

options: TableServiceClientOptions

Параметры настройки конвейера HTTP.

Пример использования имени или ключа учетной записи:

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)

Создает новый экземпляр класса TableServiceClient.

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

Параметры

url: string

URL-адрес учетной записи службы, являющейся целью требуемой операции., например "https://myaccount.table.core.windows.net".

credential: SASCredential

SASCredential, используемый для проверки подлинности запросов

options: TableServiceClientOptions

Параметры настройки конвейера HTTP.

Пример использования маркера 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)

Создает новый экземпляр класса TableServiceClient.

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

Параметры

url: string

URL-адрес учетной записи службы, являющейся целью требуемой операции., например "https://myaccount.table.core.windows.net". Можно добавить SAS, например "https://myaccount.table.core.windows.net?sasString".

options: TableServiceClientOptions

Параметры настройки конвейера HTTP. Пример добавления маркера 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)

Создает новый экземпляр класса TableServiceClient.

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

Параметры

url: string

URL-адрес учетной записи службы, являющейся целью требуемой операции., например "https://myaccount.table.core.windows.net".

credential: TokenCredential

Учетные данные Azure Active Directory, используемые для проверки подлинности запросов

options: TableServiceClientOptions

Параметры настройки конвейера HTTP.

Пример использования учетных данных 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
);

Сведения о свойстве

pipeline

Представляет конвейер для создания HTTP-запроса к URL-адресу. Конвейеры могут иметь несколько политик для управления обработкой каждого запроса до и после его выполнения на сервере.

pipeline: Pipeline

Значение свойства

Pipeline

url

URL-адрес учетной записи таблицы

url: string

Значение свойства

string

Сведения о методе

createTable(string, OperationOptions)

Создает новую таблицу под данной учетной записью.

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

Параметры

name: string

Имя таблицы.

options: OperationOptions

Параметры параметров.

Возвращаемое значение

Promise<void>

deleteTable(string, OperationOptions)

Операция окончательно удаляет указанную таблицу.

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

Параметры

name: string

Имя таблицы.

options: OperationOptions

Параметры параметров.

Возвращаемое значение

Promise<void>

fromConnectionString(string, TableServiceClientOptions)

Создает экземпляр TableServiceClient из строки подключения.

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

Параметры

connectionString: string

Строка подключения учетной записи или строка подключения SAS учетной записи хранения Azure. [ Примечание. Строка подключения учетной записи может использоваться только в среде выполнения NODE.JS. ] Пример строки подключения учетной записи — пример строки подключения SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net — 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

Параметры настройки конвейера HTTP.

Возвращаемое значение

TableServiceClient

Новый TableServiceClient из заданной строки подключения.

getProperties(OperationOptions)

Возвращает свойства службы таблиц учетной записи, включая свойства для правил аналитики и CORS (совместного использования ресурсов между источниками).

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

Параметры

options: OperationOptions

Параметры параметров.

Возвращаемое значение

Promise<GetPropertiesResponse>

getStatistics(OperationOptions)

Извлекает статистику, связанную с репликацией для службы таблиц. Он доступен только в конечной точке дополнительного расположения, если для учетной записи включена геоизбыточная репликация доступа для чтения.

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

Параметры

options: OperationOptions

Параметры параметров.

Возвращаемое значение

Promise<GetStatisticsResponse>

listTables(ListTableItemsOptions)

Запросы таблиц в заданной учетной записи.

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

Параметры

options: ListTableItemsOptions

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

setProperties(ServiceProperties, SetPropertiesOptions)

Задает свойства для конечной точки службы таблиц учетной записи, включая свойства для правил аналитики и CORS (совместного использования ресурсов между источниками).

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

Параметры

properties: ServiceProperties

Свойства службы таблиц.

options: SetPropertiesOptions

Параметры параметров.

Возвращаемое значение

Promise<ServiceSetPropertiesHeaders>

Поделиться через

TableServiceClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)

Параметры

Пример использования имени или ключа учетной записи:

TableServiceClient(string, SASCredential, TableServiceClientOptions)

Параметры

Пример использования маркера SAS.

TableServiceClient(string, TableServiceClientOptions)

Параметры

TableServiceClient(string, TokenCredential, TableServiceClientOptions)

Параметры

Пример использования учетных данных Azure Active Directory:

Сведения о свойстве

pipeline

Значение свойства

url

Значение свойства

Сведения о методе

createTable(string, OperationOptions)

Параметры

Возвращаемое значение

deleteTable(string, OperationOptions)

Параметры

Возвращаемое значение

fromConnectionString(string, TableServiceClientOptions)

Параметры

Возвращаемое значение

getProperties(OperationOptions)

Параметры

Возвращаемое значение

getStatistics(OperationOptions)

Параметры

Возвращаемое значение

listTables(ListTableItemsOptions)

Параметры

Возвращаемое значение

setProperties(ServiceProperties, SetPropertiesOptions)

Параметры

Возвращаемое значение

Дополнительные ресурсы