TableServiceClient | @azure/data-tables

A TableServiceClient represents a Client to the Azure Tables service allowing you to perform operations on the tables and the entities.

Hierarchy

TableServiceClient

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in TableServiceClient.ts:46
Creates a new instance of the TableServiceClient class.

Parameters
- url: string
  
  The URL of the service account that is the target of the desired operation., such as "https://myaccount.table.core.windows.net". You can append a SAS, such as "https://myaccount.table.core.windows.net?sasString".
- credential: TablesSharedKeyCredential
  
  TablesSharedKeyCredential used to authenticate requests. Only Supported for Browsers
- Optional options: TableServiceClientOptions
  Optional. Options to configure the HTTP pipeline.
  
  Example using an account name/key:
```
const account = "<storage account name>"
const sharedKeyCredential = new TablesSharedKeyCredential(account, "<account key>");

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  sharedKeyCredential
);
```
Returns TableServiceClient
- Defined in TableServiceClient.ts:75
Creates a new instance of the TableServiceClient class.

Parameters
- url: string
  
  The URL of the service account that is the target of the desired operation., such as "https://myaccount.table.core.windows.net". You can append a SAS, such as "https://myaccount.table.core.windows.net?sasString".
- Optional options: TableServiceClientOptions
  Optional. Options to configure the HTTP pipeline.
  
  Example using an account name/key:
```
const account = "<storage account name>"
const sharedKeyCredential = new TablesSharedKeyCredential(account, "<account key>");

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

Methods

createTable

createTable(tableName: string, options?: CreateTableOptions): Promise<CreateTableItemResponse>

- Defined in TableServiceClient.ts:195
Creates a new table under the given account.

Parameters
- tableName: string
  
  The name of the table.
- Default value options: CreateTableOptions = {}
  
  The options parameters.
Returns Promise<CreateTableItemResponse>

deleteTable

deleteTable(tableName: string, options?: DeleteTableOptions): Promise<DeleteTableResponse>

- Defined in TableServiceClient.ts:218
Operation permanently deletes the specified table.

Parameters
- tableName: string
  
  The name of the table.
- Default value options: DeleteTableOptions = {}
  
  The options parameters.
Returns Promise<DeleteTableResponse>

getAccessPolicy

getAccessPolicy(tableName: string, options?: GetAccessPolicyOptions): Promise<GetAccessPolicyResponse>

- Defined in TableServiceClient.ts:319
Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures.

Parameters
- tableName: string
  
  The name of the table.
- Default value options: GetAccessPolicyOptions = {}
  
  The options parameters.
Returns Promise<GetAccessPolicyResponse>

getProperties

getProperties(options?: GetPropertiesOptions): Promise<GetPropertiesResponse>

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

Parameters
- Default value options: GetPropertiesOptions = {}
  
  The options parameters.
Returns Promise<GetPropertiesResponse>

getStatistics

getStatistics(options?: GetStatisticsOptions): Promise<GetStatisticsResponse>

- Defined in TableServiceClient.ts:140
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.

Parameters
- Default value options: GetStatisticsOptions = {}
  
  The options parameters.
Returns Promise<GetStatisticsResponse>

listTables

listTables(options?: ListTableItemsOptions): PagedAsyncIterableIterator<TableResponseProperties, ListTableItemsResponse>

- Defined in TableServiceClient.ts:237
Queries tables under the given account.

Parameters
- Optional options: ListTableItemsOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<TableResponseProperties, ListTableItemsResponse>

setAccessPolicy

setAccessPolicy(tableName: string, options?: SetAccessPolicyOptions): Promise<SetAccessPolicyResponse>

- Defined in TableServiceClient.ts:340
Sets stored access policies for the table that may be used with Shared Access Signatures.

Parameters
- tableName: string
  
  The name of the table.
- Default value options: SetAccessPolicyOptions = {}
  
  The options parameters.
Returns Promise<SetAccessPolicyResponse>

setProperties

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

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

Parameters
- properties: ServiceProperties
  
  The Table Service properties.
- Default value options: SetPropertiesOptions = {}
  
  The options parameters.
Returns Promise<SetPropertiesResponse>

Static fromConnectionString

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

- Defined in TableServiceClient.ts:368
Creates an instance of TableServiceClient from connection string.

Parameters
- connectionString: string
  
  Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - 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
- Optional options: TableServiceClientOptions
Returns TableServiceClient

A new TableServiceClient from the given connection string.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

url: string

credential: TablesSharedKeyCredential

Optional options: TableServiceClientOptions

Returns TableServiceClient

Parameters

url: string

Optional options: TableServiceClientOptions

Returns TableServiceClient

Methods

createTable

Parameters

tableName: string

Default value options: CreateTableOptions = {}

Returns Promise<CreateTableItemResponse>

deleteTable

Parameters

tableName: string

Default value options: DeleteTableOptions = {}

Returns Promise<DeleteTableResponse>

getAccessPolicy

Parameters

tableName: string

Default value options: GetAccessPolicyOptions = {}

Returns Promise<GetAccessPolicyResponse>

getProperties

Parameters

Default value options: GetPropertiesOptions = {}

Returns Promise<GetPropertiesResponse>

getStatistics

Parameters

Default value options: GetStatisticsOptions = {}

Returns Promise<GetStatisticsResponse>

listTables

Parameters

Optional options: ListTableItemsOptions

Returns PagedAsyncIterableIterator<TableResponseProperties, ListTableItemsResponse>

setAccessPolicy

Parameters

tableName: string

Default value options: SetAccessPolicyOptions = {}

Returns Promise<SetAccessPolicyResponse>

setProperties

Parameters

properties: ServiceProperties

Default value options: SetPropertiesOptions = {}

Returns Promise<SetPropertiesResponse>

Static fromConnectionString

Parameters

connectionString: string

Optional options: TableServiceClientOptions

Returns TableServiceClient