Azure::Data::Tables::TableServiceClient Class Reference

Table Service Client.

#include <tables_clients.hpp>

Public Member Functions
	TableServiceClient (const TableClientOptions &options={})
	Initializes a new instance of tableServiceClient.
	TableServiceClient (const std::string &serviceUrl, const TableClientOptions &options={})
	Initializes a new instance of tableClient.
	TableServiceClient (const std::string &serviceUrl, std::shared_ptr< Core::Credentials::TokenCredential > credential, const TableClientOptions &options={})
	Initializes a new instance of tableClient.
	TableServiceClient (const std::string &serviceUrl, std::shared_ptr< Azure::Data::Tables::Credentials::NamedKeyCredential > credential, const TableClientOptions &options={})
	Initializes a new instance of tableClient.
	TableServiceClient (const std::string &serviceUrl, std::shared_ptr< Azure::Data::Tables::Credentials::AzureSasCredential > credential, const TableClientOptions &options={})
	Initializes a new instance of tableClient.
Response< Models::Table >	CreateTable (std::string const &tableName, Core::Context const &context={})
	Create the table indicated in the tableName field of the client.
Response< Models::DeleteTableResult >	DeleteTable (std::string const &tableName, Core::Context const &context={})
	Delete the table indicated in the tableName field of the client.
Models::QueryTablesPagedResponse	QueryTables (const Models::QueryTablesOptions &options={}, const Azure::Core::Context &context={}) const
	Query tables.
Response< Models::SetServicePropertiesResult >	SetServiceProperties (Models::SetServicePropertiesOptions const &options={}, Core::Context const &context={})
	Set service properties.
Response< Models::TableServiceProperties >	GetServiceProperties (Core::Context const &context={})
	Get service properties.
Response< Models::ServiceStatistics >	GetStatistics (Core::Context const &context={})
	Get service statistics.
Response< Models::PreflightCheckResult >	PreflightCheck (Models::PreflightCheckOptions const &options, Core::Context const &context={})
	Pre flight check.
TableClient	GetTableClient (const std::string &tableName, TableClientOptions const &options={}) const
	Get table client.

Static Public Member Functions
static TableServiceClient	CreateFromConnectionString (const std::string &connectionString, const TableClientOptions &options={})
	Initializes a new instance of tableClient.

Constructor & Destructor Documentation

TableServiceClient() [1/5]

TableServiceClient::TableServiceClient ( const TableClientOptions &  options = {} )

explicit

Parameters

options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

TableServiceClient() [2/5]

TableServiceClient::TableServiceClient ( const std::string &  serviceUrl, const TableClientOptions &  options = {}  )

explicit

Parameters

serviceUrl	A url referencing the table that includes the name of the account and the name of the table.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

TableServiceClient() [3/5]

TableServiceClient::TableServiceClient ( const std::string &  serviceUrl, std::shared_ptr< Core::Credentials::TokenCredential >  credential, const TableClientOptions &  options = {}  )

explicit

Parameters

serviceUrl	A url referencing the table that includes the name of the account and the name of the table.
credential	The shared key credential used to sign requests.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

TableServiceClient() [4/5]

TableServiceClient::TableServiceClient ( const std::string &  serviceUrl, std::shared_ptr< Azure::Data::Tables::Credentials::NamedKeyCredential >  credential, const TableClientOptions &  options = {}  )

explicit

Parameters

serviceUrl	A url referencing the table that includes the name of the account and the name of the table.
credential	The named key credential used to sign requests.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

TableServiceClient() [5/5]

TableServiceClient::TableServiceClient ( const std::string &  serviceUrl, std::shared_ptr< Azure::Data::Tables::Credentials::AzureSasCredential >  credential, const TableClientOptions &  options = {}  )

explicit

Parameters

serviceUrl	A url referencing the table that includes the name of the account and the name of the table.
credential	The SAS credential used to sign requests.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Member Function Documentation

CreateFromConnectionString()

TableServiceClient TableServiceClient::CreateFromConnectionString ( const std::string &  connectionString, const TableClientOptions &  options = {}  )

static

Parameters

connectionString	the connection string used to initialize.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Returns

TableServiceClient.

CreateTable()

Azure::Response< Models::Table > TableServiceClient::CreateTable	(	std::string const &	tableName,
		Core::Context const &	context = {}
	)

Parameters

context	for canceling long running operations.
tableName	The name of the table to be created.

Returns

Create table result.

DeleteTable()

Azure::Response< Models::DeleteTableResult > TableServiceClient::DeleteTable	(	std::string const &	tableName,
		Core::Context const &	context = {}
	)

Parameters

context	for canceling long running operations.
tableName	The name of the table to be deleted.

Returns

Delete table result.

GetServiceProperties()

Azure::Response< Models::TableServiceProperties > TableServiceClient::GetServiceProperties

(

Core::Context const &

context = {}

)

Parameters

context

for canceling long running operations.

Returns

Get service properties result.

GetStatistics()

Azure::Response< Models::ServiceStatistics > TableServiceClient::GetStatistics

(

Core::Context const &

context = {}

)

Parameters

context

for canceling long running operations.

Returns

Get service statistics result.

GetTableClient()

TableClient TableServiceClient::GetTableClient	(	const std::string &	tableName,
		TableClientOptions const &	options = {}
	)		const

Parameters

tableName	The name of the table.
options	Optional parameters for the table client.

Returns

TableClient.

Remarks

The TableClient can be used to perform operations on the table. This method will attempt to create a table client with the same credentials as the service client except the SAS token credential as the SAS token permissions varies from the service level permissions.

PreflightCheck()

Azure::Response< Models::PreflightCheckResult > TableServiceClient::PreflightCheck	(	Models::PreflightCheckOptions const &	options,
		Core::Context const &	context = {}
	)

Parameters

options	Optional parameters to execute this function.
context	for canceling long running operations.

Returns

Get service statistics result.

QueryTables()

Models::QueryTablesPagedResponse TableServiceClient::QueryTables	(	const Models::QueryTablesOptions &	options = {},
		const Azure::Core::Context &	context = {}
	)		const

Parameters

options	Optional parameters to execute this function.
context	for canceling long running operations.

Returns

List tables paged response.

SetServiceProperties()

Azure::Response< Models::SetServicePropertiesResult > TableServiceClient::SetServiceProperties	(	Models::SetServicePropertiesOptions const &	options = {},
		Core::Context const &	context = {}
	)

Parameters

options	Optional parameters to execute this function.
context	for canceling long running operations.

---

The documentation for this class was generated from the following files:

• inc/azure/data/tables/tables_clients.hpp
• src/tables_clients.cpp