azure::storage::cloud_table_client Class Reference

Provides a client-side logical representation of the Windows Azure Table service. This client is used to configure and execute requests against the Table service. More...

Inheritance diagram for azure::storage::cloud_table_client:

Public Member Functions
	cloud_table_client ()
	Initializes a new instance of the azure::storage::cloud_table_client class. More...
	cloud_table_client (storage_uri base_uri)
	Initializes a new instance of the azure::storage::cloud_table_client class using the specified Table service endpoint and anonymous credentials. More...
	cloud_table_client (storage_uri base_uri, storage_credentials credentials)
	Initializes a new instance of the azure::storage::cloud_table_client class using the specified Table service endpoint and account credentials. More...
	cloud_table_client (storage_uri base_uri, storage_credentials credentials, table_request_options default_request_options)
	Initializes a new instance of the azure::storage::cloud_table_client class using the specified Table service endpoint and account credentials. More...
WASTORAGE_API void	set_authentication_scheme (azure::storage::authentication_scheme value) override
	Sets the authentication scheme to use to sign HTTP requests. More...
table_result_iterator	list_tables () const
	Returns an azure::storage::table_result_iterator that can be used to to lazily enumerate a collection of tables. More...
table_result_iterator	list_tables (const utility::string_t &prefix) const
	Returns an azure::storage::table_result_iterator that can be used to to lazily enumerate a collection of tables that begin with the specified prefix. More...
WASTORAGE_API table_result_iterator	list_tables (const utility::string_t &prefix, utility::size64_t max_results, const table_request_options &options, operation_context context) const
	Returns an azure::storage::table_result_iterator that can be used to to lazily enumerate a collection of tables that begin with the specified prefix. More...
table_result_segment	list_tables_segmented (const continuation_token &token) const
	Returns an azure::storage::table_result_segment containing an enumerable collection of tables. More...
table_result_segment	list_tables_segmented (const utility::string_t &prefix, const continuation_token &token) const
	Returns an azure::storage::table_result_segment containing an enumerable collection of tables that begin with the specified prefix. More...
table_result_segment	list_tables_segmented (const utility::string_t &prefix, int max_results, const continuation_token &token, const table_request_options &options, operation_context context) const
	Returns an azure::storage::table_result_segment containing an enumerable collection of tables that begin with the specified prefix. More...
pplx::task< table_result_segment >	list_tables_segmented_async (const continuation_token &token) const
	Intitiates an asynchronous operation that returns an azure::storage::table_result_segment containing an enumerable collection of tables. More...
pplx::task< table_result_segment >	list_tables_segmented_async (const utility::string_t &prefix, const continuation_token &token) const
	Intitiates an asynchronous operation that returns an azure::storage::table_result_segment containing an enumerable collection of tables that begin with the specified prefix. More...
WASTORAGE_API pplx::task< table_result_segment >	list_tables_segmented_async (const utility::string_t &prefix, int max_results, const continuation_token &token, const table_request_options &options, operation_context context) const
	Intitiates an asynchronous operation that returns an azure::storage::table_result_segment containing an enumerable collection of tables that begin with the specified prefix. More...
service_properties	download_service_properties () const
	Gets the service properties for the Table service client. More...
service_properties	download_service_properties (const table_request_options &options, operation_context context) const
	Gets the service properties for the Table service client. More...
pplx::task< service_properties >	download_service_properties_async () const
	Intitiates an asynchronous operation to get the properties of the service. More...
WASTORAGE_API pplx::task< service_properties >	download_service_properties_async (const table_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to get the properties of the service. More...
void	upload_service_properties (const service_properties &properties, const service_properties_includes &includes) const
	Sets the service properties for the Table service client. More...
void	upload_service_properties (const service_properties &properties, const service_properties_includes &includes, const table_request_options &options, operation_context context) const
	Sets the service properties for the Table service client. More...
pplx::task< void >	upload_service_properties_async (const service_properties &properties, const service_properties_includes &includes) const
	Intitiates an asynchronous operation to set the service properties for the Table service client. More...
WASTORAGE_API pplx::task< void >	upload_service_properties_async (const service_properties &properties, const service_properties_includes &includes, const table_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to set the service properties for the Table service client. More...
service_stats	download_service_stats () const
	Gets the service stats for the Table service client. More...
service_stats	download_service_stats (const table_request_options &options, operation_context context) const
	Gets the service stats for the Table service client. More...
pplx::task< service_stats >	download_service_stats_async () const
	Intitiates an asynchronous operation to get the stats of the service. More...
WASTORAGE_API pplx::task< service_stats >	download_service_stats_async (const table_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to get the stats of the service. More...
WASTORAGE_API cloud_table	get_table_reference (utility::string_t table_name) const
	Gets a reference to the specified table. More...
const table_request_options &	default_request_options () const
	Returns the default set of request options. More...
Public Member Functions inherited from azure::storage::cloud_client
const storage_uri &	base_uri () const
	Gets the base URI for the service client. More...
const azure::storage::storage_credentials &	credentials () const
	Gets the storage account credentials for the service client. More...
azure::storage::authentication_scheme	authentication_scheme () const
	Gets the authentication scheme to use to sign HTTP requests for the service client. More...
std::shared_ptr< protocol::authentication_handler >	authentication_handler () const
	Gets the authentication handler to use to sign HTTP requests. More...

Detailed Description

Provides a client-side logical representation of the Windows Azure Table service. This client is used to configure and execute requests against the Table service.

The service client encapsulates the base URI for the Table service. If the service client will be used for authenticated access, it also encapsulates the credentials for accessing the storage account.

Constructor & Destructor Documentation

cloud_table_client() [1/4]

azure::storage::cloud_table_client::cloud_table_client ( )

inline

Initializes a new instance of the azure::storage::cloud_table_client class.

cloud_table_client() [2/4]

azure::storage::cloud_table_client::cloud_table_client ( storage_uri  base_uri )

inlineexplicit

Initializes a new instance of the azure::storage::cloud_table_client class using the specified Table service endpoint and anonymous credentials.

Parameters

base_uri

An azure::storage::storage_uri object containing the Table service endpoint for all locations.

cloud_table_client() [3/4]

azure::storage::cloud_table_client::cloud_table_client ( storage_uri  base_uri, storage_credentials  credentials  )

inline

Initializes a new instance of the azure::storage::cloud_table_client class using the specified Table service endpoint and account credentials.

Parameters

base_uri	An azure::storage::storage_uri object containing the Table service endpoint for all locations.
credentials	The azure::storage::storage_credentials to use.

cloud_table_client() [4/4]

azure::storage::cloud_table_client::cloud_table_client ( storage_uri  base_uri, storage_credentials  credentials, table_request_options  default_request_options  )

inline

Initializes a new instance of the azure::storage::cloud_table_client class using the specified Table service endpoint and account credentials.

Parameters

base_uri	An azure::storage::storage_uri object containing the Table service endpoint for all locations.
credentials	The azure::storage::storage_credentials to use.
default_request_options	The default azure::storage::table_request_options to use.

Member Function Documentation

default_request_options()

const table_request_options& azure::storage::cloud_table_client::default_request_options ( ) const

inline

Returns the default set of request options.

Returns

An azure::storage::table_request_options object.

download_service_properties() [1/2]

service_properties azure::storage::cloud_table_client::download_service_properties ( ) const

inline

Gets the service properties for the Table service client.

Returns

The azure::storage::service_properties for the Table service client.

download_service_properties() [2/2]

service_properties azure::storage::cloud_table_client::download_service_properties ( const table_request_options &  options, operation_context  context  ) const

inline

Gets the service properties for the Table service client.

Parameters

options	An azure::storage::table_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The azure::storage::service_properties for the Table service client.

download_service_properties_async() [1/2]

pplx::task<service_properties> azure::storage::cloud_table_client::download_service_properties_async ( ) const

inline

Intitiates an asynchronous operation to get the properties of the service.

Returns

A pplx::task object of type azure::storage::service_properties that represents the current operation.

download_service_properties_async() [2/2]

WASTORAGE_API pplx::task<service_properties> azure::storage::cloud_table_client::download_service_properties_async	(	const table_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to get the properties of the service.

Parameters

options	An azure::storage::table_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::service_properties that represents the current operation.

download_service_stats() [1/2]

service_stats azure::storage::cloud_table_client::download_service_stats ( ) const

inline

Gets the service stats for the Table service client.

Returns

The azure::storage::service_stats for the Table service client.

download_service_stats() [2/2]

service_stats azure::storage::cloud_table_client::download_service_stats ( const table_request_options &  options, operation_context  context  ) const

inline

Gets the service stats for the Table service client.

Parameters

options	An azure::storage::table_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The azure::storage::service_stats for the Table service client.

download_service_stats_async() [1/2]

pplx::task<service_stats> azure::storage::cloud_table_client::download_service_stats_async ( ) const

inline

Intitiates an asynchronous operation to get the stats of the service.

Returns

A pplx::task object of type azure::storage::service_stats that represents the current operation.

download_service_stats_async() [2/2]

WASTORAGE_API pplx::task<service_stats> azure::storage::cloud_table_client::download_service_stats_async	(	const table_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to get the stats of the service.

Parameters

options	An azure::storage::table_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::service_stats that represents the current operation.

get_table_reference()

WASTORAGE_API cloud_table azure::storage::cloud_table_client::get_table_reference

(

utility::string_t

table_name

)

const

Gets a reference to the specified table.

Parameters

table_name

The name of the table.

Returns

A reference to an azure::storage::cloud_table object.

list_tables() [1/3]

table_result_iterator azure::storage::cloud_table_client::list_tables ( ) const

inline

Returns an azure::storage::table_result_iterator that can be used to to lazily enumerate a collection of tables.

Returns

An azure::storage::table_result_iterator that can be used to to lazily enumerate a collection of tables.

list_tables() [2/3]

table_result_iterator azure::storage::cloud_table_client::list_tables ( const utility::string_t &  prefix ) const

inline

Returns an azure::storage::table_result_iterator that can be used to to lazily enumerate a collection of tables that begin with the specified prefix.

Returns

An azure::storage::table_result_iterator that can be used to to lazily enumerate a collection of tables.

list_tables() [3/3]

WASTORAGE_API table_result_iterator azure::storage::cloud_table_client::list_tables	(	const utility::string_t &	prefix,
		utility::size64_t	max_results,
		const table_request_options &	options,
		operation_context	context
	)		const

Returns an azure::storage::table_result_iterator that can be used to to lazily enumerate a collection of tables that begin with the specified prefix.

Parameters

prefix	The table name prefix.
max_results	A non-negative integer value that indicates the maximum number of results to be returned. If this value is zero, the maximum possible number of results will be returned.
options	An azure::storage::table_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::table_result_iterator that can be used to to lazily enumerate a collection of tables.

list_tables_segmented() [1/3]

table_result_segment azure::storage::cloud_table_client::list_tables_segmented ( const continuation_token &  token ) const

inline

Returns an azure::storage::table_result_segment containing an enumerable collection of tables.

Parameters

token

An azure::storage::continuation_token returned by a previous listing operation.

Returns

An azure::storage::table_result_segment containing an enumerable collection of tables.

list_tables_segmented() [2/3]

table_result_segment azure::storage::cloud_table_client::list_tables_segmented ( const utility::string_t &  prefix, const continuation_token &  token  ) const

inline

Returns an azure::storage::table_result_segment containing an enumerable collection of tables that begin with the specified prefix.

Parameters

prefix	The table name prefix.
token	An azure::storage::continuation_token returned by a previous listing operation.

Returns

An azure::storage::table_result_segment containing an enumerable collection of tables.

list_tables_segmented() [3/3]

table_result_segment azure::storage::cloud_table_client::list_tables_segmented ( const utility::string_t &  prefix, int  max_results, const continuation_token &  token, const table_request_options &  options, operation_context  context  ) const

inline

Returns an azure::storage::table_result_segment containing an enumerable collection of tables that begin with the specified prefix.

Parameters

prefix	The table name prefix.
max_results	A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 1000. If this value is zero the maximum possible number of results will be returned, up to 1000.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::table_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::table_result_segment containing an enumerable collection of tables.

list_tables_segmented_async() [1/3]

pplx::task<table_result_segment> azure::storage::cloud_table_client::list_tables_segmented_async ( const continuation_token &  token ) const

inline

Intitiates an asynchronous operation that returns an azure::storage::table_result_segment containing an enumerable collection of tables.

Parameters

token

An azure::storage::continuation_token returned by a previous listing operation.

Returns

A pplx::task object of type azure::storage::table_result_segment that represents the current operation.

list_tables_segmented_async() [2/3]

pplx::task<table_result_segment> azure::storage::cloud_table_client::list_tables_segmented_async ( const utility::string_t &  prefix, const continuation_token &  token  ) const

inline

Intitiates an asynchronous operation that returns an azure::storage::table_result_segment containing an enumerable collection of tables that begin with the specified prefix.

Parameters

prefix	The table name prefix.
token	An azure::storage::continuation_token returned by a previous listing operation.

Returns

A pplx::task object of type azure::storage::table_result_segment that represents the current operation.

list_tables_segmented_async() [3/3]

WASTORAGE_API pplx::task<table_result_segment> azure::storage::cloud_table_client::list_tables_segmented_async	(	const utility::string_t &	prefix,
		int	max_results,
		const continuation_token &	token,
		const table_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation that returns an azure::storage::table_result_segment containing an enumerable collection of tables that begin with the specified prefix.

Parameters

prefix	The table name prefix.
max_results	A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 1000. If this value is zero the maximum possible number of results will be returned, up to 1000.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::table_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::table_result_segment that represents the current operation.

set_authentication_scheme()

WASTORAGE_API void azure::storage::cloud_table_client::set_authentication_scheme ( azure::storage::authentication_scheme  value )

overridevirtual

Sets the authentication scheme to use to sign HTTP requests.

Parameters

value

An azure::storage::authentication_scheme object that specifies the authentication scheme.

Reimplemented from azure::storage::cloud_client.

upload_service_properties() [1/2]

void azure::storage::cloud_table_client::upload_service_properties ( const service_properties &  properties, const service_properties_includes &  includes  ) const

inline

Sets the service properties for the Table service client.

Parameters

properties	The azure::storage::service_properties for the Table service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.

upload_service_properties() [2/2]

void azure::storage::cloud_table_client::upload_service_properties ( const service_properties &  properties, const service_properties_includes &  includes, const table_request_options &  options, operation_context  context  ) const

inline

Sets the service properties for the Table service client.

Parameters

properties	The azure::storage::service_properties for the Table service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
options	An azure::storage::table_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

upload_service_properties_async() [1/2]

pplx::task<void> azure::storage::cloud_table_client::upload_service_properties_async ( const service_properties &  properties, const service_properties_includes &  includes  ) const

inline

Intitiates an asynchronous operation to set the service properties for the Table service client.

Parameters

properties	The azure::storage::service_properties for the Table service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.

Returns

A pplx::task object that represents the current operation.

upload_service_properties_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_table_client::upload_service_properties_async	(	const service_properties &	properties,
		const service_properties_includes &	includes,
		const table_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to set the service properties for the Table service client.

Parameters

properties	The azure::storage::service_properties for the Table service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
options	An azure::storage::table_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.