你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	表示向 URL 发出 HTTP 请求的管道。管道可以有多个策略来管理对服务器之前和之后每个请求的作。
url	表帐户 URL

方法

createTable(string, OperationOptions)	在给定帐户下创建新表。
deleteTable(string, OperationOptions)	作永久删除指定的表。
fromConnectionString(string, TableServiceClientOptions)	从连接字符串创建 TableServiceClient 的实例。
getProperties(OperationOptions)	获取帐户的表服务的属性，包括分析和 CORS（跨域资源共享）规则的属性。
getStatistics(OperationOptions)	检索与表服务的复制相关的统计信息。仅当为帐户启用读取访问异地冗余复制时，它才可用于辅助位置终结点。
listTables(ListTableItemsOptions)	查询给定帐户下的表。
setProperties(TableServiceProperties, ServiceSetPropertiesOptionalParams)	设置帐户的表服务终结点的属性，包括分析和 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。仅支持 Node

options: TableServiceClientOptions

用于配置 HTTP 管道的选项。

使用帐户名称/密钥的示例：

import { AzureNamedKeyCredential, TableServiceClient } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new AzureNamedKeyCredential(account, accountKey);
const serviceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  credential,
);

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 令牌的示例。

import { TableServiceClient, AzureSASCredential } from "@azure/data-tables";

const account = "<account name>";
const sas = "<service Shared Access Signature Token>";

const serviceClientWithSAS = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  new AzureSASCredential(sas),
);

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 令牌的示例：

import { TableServiceClient } from "@azure/data-tables";

const account = "<account name>";
const sasToken = "<SAS token>";
const tableName = "<tableName>";

const serviceClientWithSASURL = 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 凭据的示例：

import { DefaultAzureCredential } from "@azure/identity";
import { TableServiceClient } from "@azure/data-tables";

const credential = new DefaultAzureCredential();
const account = "<account name>";

const clientWithAAD = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  credential,
);

属性详细信息

pipeline

表示向 URL 发出 HTTP 请求的管道。管道可以有多个策略来管理对服务器之前和之后每个请求的作。

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

帐户连接字符串或 Azure 存储帐户的 SAS 连接字符串。 [ 注意 - 帐户连接字符串只能在NODE.JS运行时使用。 ] 帐户连接字符串示例 - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net 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

用于配置 HTTP 管道的选项。

TableServiceClient

给定连接字符串中的新 TableServiceClient。

getProperties(OperationOptions)

获取帐户的表服务的属性，包括分析和 CORS（跨域资源共享）规则的属性。

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

参数

options: OperationOptions

选项参数。

Promise<GetPropertiesResponse>

getStatistics(OperationOptions)

检索与表服务的复制相关的统计信息。仅当为帐户启用读取访问异地冗余复制时，它才可用于辅助位置终结点。

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

参数

options: OperationOptions

选项参数。

Promise<GetStatisticsResponse>

listTables(ListTableItemsOptions)

查询给定帐户下的表。

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

参数

options: ListTableItemsOptions

选项参数。

PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

setProperties(TableServiceProperties, ServiceSetPropertiesOptionalParams)

设置帐户的表服务终结点的属性，包括分析和 CORS（跨域资源共享）规则的属性。

function setProperties(properties: TableServiceProperties, options?: ServiceSetPropertiesOptionalParams): Promise<ServiceSetPropertiesHeaders>

参数

properties: ServiceProperties

表服务属性。

options: SetPropertiesOptions

选项参数。

Promise<ServiceSetPropertiesHeaders>

通过

构造函数

属性

方法

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(TableServiceProperties, ServiceSetPropertiesOptionalParams)

参数

返回