TableServiceClient class

パッケージ:

@azure/data-tables

TableServiceClient は、テーブルとエンティティに対する操作を実行できる Azure Tables サービスへのクライアントを表します。

コンストラクター

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)	Analytics ルールと CORS (クロスオリジン リソース共有) ルールのプロパティを含む、アカウントの Table サービスのプロパティを取得します。
getStatistics(OperationOptions)	Table Service のレプリケーションに関連する統計情報を取得します。 これは、アカウントに対して読み取りアクセス geo 冗長レプリケーションが有効になっている場合にのみ、セカンダリ ロケーション エンドポイントで使用できます。
listTables(ListTableItemsOptions)	指定されたアカウントのテーブルに対してクエリを実行します。
setProperties(ServiceProperties, SetPropertiesOptions)	Analytics ルールと CORS (クロスオリジン リソース共有) ルールのプロパティを含む、アカウントの Table Service エンドポイントのプロパティを設定します。

コンストラクターの詳細

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

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

options パラメーター。

戻り値

Promise<void>

deleteTable(string, OperationOptions)

操作により、指定したテーブルが完全に削除されます。

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

パラメーター

name

string

テーブルの名前。

options

OperationOptions

options パラメーター。

戻り値

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)

Analytics ルールと CORS (クロスオリジン リソース共有) ルールのプロパティを含む、アカウントの Table サービスのプロパティを取得します。

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

パラメーター

options

OperationOptions

options パラメーター。

戻り値

Promise<GetPropertiesResponse>

getStatistics(OperationOptions)

Table Service のレプリケーションに関連する統計情報を取得します。 これは、アカウントに対して読み取りアクセス geo 冗長レプリケーションが有効になっている場合にのみ、セカンダリ ロケーション エンドポイントで使用できます。

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

パラメーター

options

OperationOptions

options パラメーター。

戻り値

Promise<GetStatisticsResponse>

listTables(ListTableItemsOptions)

指定されたアカウントのテーブルに対してクエリを実行します。

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

パラメーター

options

ListTableItemsOptions

options パラメーター。

戻り値

PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

setProperties(ServiceProperties, SetPropertiesOptions)

Analytics ルールと CORS (クロスオリジン リソース共有) ルールのプロパティを含む、アカウントの Table Service エンドポイントのプロパティを設定します。

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

パラメーター

properties

ServiceProperties

Table Service プロパティ。

options

SetPropertiesOptions

options パラメーター。

戻り値

Promise<ServiceSetPropertiesHeaders>