TableClient Class

Reference

Definition

Namespace:: Azure.Data.Tables

Assembly:: Azure.Data.Tables.dll

Package:: Azure.Data.Tables v12.8.3

Source:: TableClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The TableClient allows you to interact with Azure Tables hosted in either Azure storage accounts or Azure Cosmos DB table API.

public class TableClient

type TableClient = class

Public Class TableClient

Inheritance: Object
TableClient

Constructors

TableClient()	Initializes a new instance of the TableClient class for mocking.
TableClient(String, String)	Initializes a new instance of the TableClient using the specified connection string.
TableClient(String, String, TableClientOptions)	Initializes a new instance of the TableServiceClient. Initializes a new instance of the TableClient using the specified connection string.
TableClient(Uri, AzureSasCredential, TableClientOptions)	Initializes a new instance of the TableClient using the specified Uri and AzureSasCredential. See GetSasBuilder(TableSasPermissions, DateTimeOffset) for creating a SAS token.
TableClient(Uri, String, TableSharedKeyCredential)	Initializes a new instance of the TableClient using the specified table service Uri and TableSharedKeyCredential.
TableClient(Uri, String, TableSharedKeyCredential, TableClientOptions)	Initializes a new instance of the TableClient using the specified table service Uri and TableSharedKeyCredential.
TableClient(Uri, String, TokenCredential, TableClientOptions)	Initializes a new instance of the TableClient using the specified Uri and TokenCredential.
TableClient(Uri, TableClientOptions)	Initializes a new instance of the TableClient using the specified Uri which contains a SAS token. See GetSasBuilder(TableSasPermissions, DateTimeOffset) for creating a SAS token.

Properties

AccountName	The name of the table account with which this client instance will interact.
Name	The name of the table with which this client instance will interact.
Uri	The Uri of the table.

Methods

AddEntity<T>(T, CancellationToken)	Adds a Table Entity of type `T` into the Table.
AddEntityAsync<T>(T, CancellationToken)	Adds a Table Entity of type `T` into the Table.
Create(CancellationToken)	Creates a table with the name used to construct this client instance.
CreateAsync(CancellationToken)	Creates a table with the name used to construct this client instance.
CreateIfNotExists(CancellationToken)	Creates a table with the name used to construct this client instance if it does not already exist.
CreateIfNotExistsAsync(CancellationToken)	Creates a table with the name used to construct this client instance if it does not already exist.
CreateQueryFilter(FormattableString)	Create an OData filter expression from an interpolated string. The interpolated values will be quoted and escaped as necessary.
CreateQueryFilter<T>(Expression<Func<T,Boolean>>)	Creates an OData filter query string from the provided expression.
Delete(CancellationToken)	Deletes the table with the name used to construct this client instance.
DeleteAsync(CancellationToken)	Deletes the table with the name used to construct this client instance.
DeleteEntity(String, String, ETag, CancellationToken)	Deletes the specified table entity.
DeleteEntityAsync(String, String, ETag, CancellationToken)	Deletes the specified table entity.
GenerateSasUri(TableSasBuilder)	The GenerateSasUri(TableSasBuilder) returns a Uri that generates a Table Service SAS Uri based on the Client properties and builder passed. For more information, see Constructing a Service SAS
GenerateSasUri(TableSasPermissions, DateTimeOffset)	The GenerateSasUri(TableSasPermissions, DateTimeOffset) returns a Uri that generates a Table Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. For more information, see Constructing a Service SAS.
GetAccessPolicies(CancellationToken)	Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures.
GetAccessPoliciesAsync(CancellationToken)	Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures.
GetEntity<T>(String, String, IEnumerable<String>, CancellationToken)	Gets the specified table entity of type `T`.
GetEntityAsync<T>(String, String, IEnumerable<String>, CancellationToken)	Gets the specified table entity of type `T`.
GetEntityIfExists<T>(String, String, IEnumerable<String>, CancellationToken)	Gets the specified table entity of type `T`.
GetEntityIfExistsAsync<T>(String, String, IEnumerable<String>, CancellationToken)	Gets the specified table entity of type `T`.
GetSasBuilder(String, DateTimeOffset)	Gets a TableSasBuilder instance scoped to the current table which can be used to generate a Shared Access Signature (SAS) token capable of granting limited access to table resources. See Create a service SAS for more details.
GetSasBuilder(TableSasPermissions, DateTimeOffset)	Gets a TableSasBuilder instance scoped to the current table which can be used to generate a Shared Access Signature (SAS) token capable of granting limited access to table resources. See Create a service SAS for more details.
Query<T>(Expression<Func<T,Boolean>>, Nullable<Int32>, IEnumerable<String>, CancellationToken)	Queries entities in the table.
Query<T>(String, Nullable<Int32>, IEnumerable<String>, CancellationToken)	Queries entities in the table.
QueryAsync<T>(Expression<Func<T,Boolean>>, Nullable<Int32>, IEnumerable<String>, CancellationToken)	Queries entities in the table.
QueryAsync<T>(String, Nullable<Int32>, IEnumerable<String>, CancellationToken)	Queries entities in the table.
SetAccessPolicy(IEnumerable<TableSignedIdentifier>, CancellationToken)	sets stored access policies for the table that may be used with Shared Access Signatures.
SetAccessPolicyAsync(IEnumerable<TableSignedIdentifier>, CancellationToken)	sets stored access policies for the table that may be used with Shared Access Signatures.
SubmitTransaction(IEnumerable<TableTransactionAction>, CancellationToken)	Submits the batch transaction to the service for execution. The sub-operations contained in the batch will either succeed or fail together as a transaction.
SubmitTransactionAsync(IEnumerable<TableTransactionAction>, CancellationToken)	Submits the batch transaction to the service for execution. The sub-operations contained in the batch will either succeed or fail together as a transaction.
UpdateEntity<T>(T, ETag, TableUpdateMode, CancellationToken)	Updates the specified table entity of type `T`, if it exists. If the `mode` is Replace, the entity will be replaced. If the `mode` is Merge, the property values present in the `entity` will be merged with the existing entity.
UpdateEntityAsync<T>(T, ETag, TableUpdateMode, CancellationToken)	Updates the specified table entity of type `T`, if it exists. If the `mode` is Replace, the entity will be replaced. If the `mode` is Merge, the property values present in the `entity` will be merged with the existing entity.
UpsertEntity<T>(T, TableUpdateMode, CancellationToken)	Replaces the specified table entity of type `T`, if it exists. Creates the entity if it does not exist.
UpsertEntityAsync<T>(T, TableUpdateMode, CancellationToken)	Replaces the specified table entity of type `T`, if it exists. Creates the entity if it does not exist.

Applies to