你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
TableServiceClient class
TableServiceClient 表示 Azure 表服务的客户端，允许对表和实体执行操作。
构造函数
| Table |
创建 TableServiceClient 类的新实例。 |
| Table |
创建 TableServiceClient 类的新实例。 |
| Table |
创建 TableServiceClient 类的新实例。 |
| Table |
创建 TableServiceClient 类的新实例。 |
属性
| pipeline | 表示用于向 URL 发出 HTTP 请求的管道。 管道可以有多个策略来管理在向服务器发出请求之前和之后对请求的操作。 |
| url | 表帐户 URL |
方法
| create |
在给定帐户下创建新表。 |
| delete |
操作将永久删除指定的表。 |
| from |
从连接字符串创建 TableServiceClient 的实例。 |
| get |
获取帐户表服务的属性，包括 Analytics 和 CORS (跨域资源共享) 规则的属性。 |
| get |
检索与表服务的复制有关的统计信息。 仅当为帐户启用了读取访问异地冗余复制时，它才可在辅助位置终结点上使用。 |
| list |
查询给定帐户下的表。 |
| set |
设置帐户的表服务终结点的属性，包括分析和 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 管道的选项。
使用帐户名称/密钥的示例：
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
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。
getProperties(OperationOptions)
获取帐户表服务的属性，包括 Analytics 和 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
选项参数。
返回
setProperties(ServiceProperties, SetPropertiesOptions)
设置帐户的表服务终结点的属性，包括分析和 CORS (跨域资源共享) 规则的属性。
function setProperties(properties: ServiceProperties, options?: SetPropertiesOptions): Promise<ServiceSetPropertiesHeaders>参数
- properties
- ServiceProperties
表服务属性。
- options
- SetPropertiesOptions
选项参数。
返回
Promise<ServiceSetPropertiesHeaders>