TableServiceClient class

Creates a new instance of the TableServiceClient class.

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

Parameters

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
);

Creates a new instance of the TableServiceClient class.

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

Parameters

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
);

Creates a new instance of the TableServiceClient class.

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

Parameters

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

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

Creates a new instance of the TableServiceClient class.

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

Parameters

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
);

Represents a pipeline for making a HTTP request to a URL. Pipelines can have multiple policies to manage manipulating each request before and after it is made to the server.

pipeline: Pipeline

Property Value

Table Account URL

url: string

Property Value

Creates a new table under the given account.

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

Parameters

Returns

Operation permanently deletes the specified table.

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

Parameters

Returns

Creates an instance of TableServiceClient from connection string.

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

Parameters

Returns

A new TableServiceClient from the given connection string.

Gets the properties of an account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.

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

Parameters

Returns

Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the account.

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

Parameters

Returns

Queries tables under the given account.

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

Parameters

Returns

Sets properties for an account's Table service endpoint, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.

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

Parameters

Returns