azure::storage::cloud_file_client Class Reference

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

Inheritance diagram for azure::storage::cloud_file_client:

Public Member Functions
	cloud_file_client ()
	Initializes a new instance of the azure::storage::cloud_file_client class. More...
	cloud_file_client (storage_uri base_uri)
	Initializes a new instance of the azure::storage::cloud_file_client class using the specified File service endpoint and anonymous credentials. More...
	cloud_file_client (storage_uri base_uri, storage_credentials credentials)
	Initializes a new instance of the azure::storage::cloud_file_client class using the specified File service endpoint and account credentials. More...
	cloud_file_client (storage_uri base_uri, storage_credentials credentials, file_request_options default_request_options)
	Initializes a new instance of the azure::storage::cloud_file_client class using the specified File 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...
share_result_iterator	list_shares ()
	Returns an azure::storage::share_result_iterator that can be used to to lazily enumerate a collection of shares. More...
share_result_iterator	list_shares (const utility::string_t &prefix)
	Returns an azure::storage::share_result_iterator that can be used to to lazily enumerate a collection of shares. More...
WASTORAGE_API share_result_iterator	list_shares (const utility::string_t &prefix, bool get_metadata, int max_results, const file_request_options &options, operation_context context)
	Returns an azure::storage::share_result_iterator that can be used to to lazily enumerate a collection of shares. More...
share_result_segment	list_shares_segmented (const continuation_token &token)
	Returns a result segment containing a collection of azure::storage::cloud_file_share objects. More...
share_result_segment	list_shares_segmented (const utility::string_t &prefix, const continuation_token &token)
	Returns a result segment containing a collection of azure::storage::cloud_file_share objects. More...
share_result_segment	list_shares_segmented (const utility::string_t &prefix, bool get_metadata, int max_results, const continuation_token &token, const file_request_options &options, operation_context context)
	Returns a result segment containing a collection of azure::storage::cloud_file_share objects. More...
pplx::task< share_result_segment >	list_shares_segmented_async (const continuation_token &token)
	Intitiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_file_share objects. More...
pplx::task< share_result_segment >	list_shares_segmented_async (const utility::string_t &prefix, const continuation_token &token)
	Intitiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_file_share objects. More...
WASTORAGE_API pplx::task< share_result_segment >	list_shares_segmented_async (const utility::string_t &prefix, bool get_metadata, int max_results, const continuation_token &token, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_file_share objects. More...
service_properties	download_service_properties () const
	Gets the service properties for the File service client. More...
service_properties	download_service_properties (const file_request_options &options, operation_context context) const
	Gets the service properties for the File 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 file_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 File service client. More...
void	upload_service_properties (const service_properties &properties, const service_properties_includes &includes, const file_request_options &options, operation_context context) const
	Sets the service properties for the File 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 File service client. More...
WASTORAGE_API pplx::task< void >	upload_service_properties_async (const service_properties &properties, const service_properties_includes &includes, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to set the service properties for the File service client. More...
WASTORAGE_API cloud_file_share	get_share_reference (utility::string_t share_name) const
	Returns a reference to an azure::storage::cloud_file_share object with the specified name. More...
const file_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 File Service. This client is used to configure and execute requests against the File Service.

The service client encapsulates the base URI for the File 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_file_client() [1/4]

azure::storage::cloud_file_client::cloud_file_client ( )

inline

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

cloud_file_client() [2/4]

azure::storage::cloud_file_client::cloud_file_client ( storage_uri  base_uri )

inlineexplicit

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

Parameters

base_uri

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

cloud_file_client() [3/4]

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

inline

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

Parameters

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

cloud_file_client() [4/4]

azure::storage::cloud_file_client::cloud_file_client ( storage_uri  base_uri, storage_credentials  credentials, file_request_options  default_request_options  )

inline

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

Parameters

base_uri	An azure::storage::storage_uri object containing the File service endpoint for all locations.
credentials	The azure::storage::storage_credentials to use.
default_request_options	The default azure::storage::file_request_options object to use for all requests made with this client object.

Member Function Documentation

default_request_options()

const file_request_options& azure::storage::cloud_file_client::default_request_options ( ) const

inline

Returns the default set of request options.

Returns

An azure::storage::file_request_options object.

download_service_properties() [1/2]

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

inline

Gets the service properties for the File service client.

Returns

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

download_service_properties() [2/2]

service_properties azure::storage::cloud_file_client::download_service_properties ( const file_request_options &  options, operation_context  context  ) const

inline

Gets the service properties for the File service client.

Parameters

options	An azure::storage::file_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 File service client.

download_service_properties_async() [1/2]

pplx::task<service_properties> azure::storage::cloud_file_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_file_client::download_service_properties_async	(	const file_request_options &	options,
		operation_context	context
	)		const

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

Parameters

options	An azure::storage::file_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.

get_share_reference()

WASTORAGE_API cloud_file_share azure::storage::cloud_file_client::get_share_reference

(

utility::string_t

share_name

)

const

Returns a reference to an azure::storage::cloud_file_share object with the specified name.

Parameters

container_name

The name of the share, or an absolute URI to the container.

Returns

A reference to an azure::storage::cloud_file_share.

list_shares() [1/3]

share_result_iterator azure::storage::cloud_file_client::list_shares ( )

inline

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

Returns

An azure::storage::share_result_iterator that can be used to to lazily enumerate a collection of shares.

list_shares() [2/3]

share_result_iterator azure::storage::cloud_file_client::list_shares ( const utility::string_t &  prefix )

inline

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

Parameters

prefix

The shares name prefix.

Returns

An azure::storage::share_result_iterator that can be used to to lazily enumerate a collection of shares.

list_shares() [3/3]

WASTORAGE_API share_result_iterator azure::storage::cloud_file_client::list_shares	(	const utility::string_t &	prefix,
		bool	get_metadata,
		int	max_results,
		const file_request_options &	options,
		operation_context	context
	)

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

Parameters

prefix	The share name prefix.
get_metadata	A flag that specifies whether to retrieve share metadata.
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::file_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::share_result_iterator that can be used to to lazily enumerate a collection of shares.

list_shares_segmented() [1/3]

share_result_segment azure::storage::cloud_file_client::list_shares_segmented ( const continuation_token &  token )

inline

Returns a result segment containing a collection of azure::storage::cloud_file_share objects.

Parameters

token

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

Returns

An azure::storage::share_result_segment containing a collection of shares.

list_shares_segmented() [2/3]

share_result_segment azure::storage::cloud_file_client::list_shares_segmented ( const utility::string_t &  prefix, const continuation_token &  token  )

inline

Returns a result segment containing a collection of azure::storage::cloud_file_share objects.

Parameters

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

Returns

An azure::storage::share_result_segment containing a collection of shares.

list_shares_segmented() [3/3]

share_result_segment azure::storage::cloud_file_client::list_shares_segmented ( const utility::string_t &  prefix, bool  get_metadata, int  max_results, const continuation_token &  token, const file_request_options &  options, operation_context  context  )

inline

Returns a result segment containing a collection of azure::storage::cloud_file_share objects.

Parameters

prefix	The share name prefix.
get_metadata	A flag that specifies whether to retrieve share metadata.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::file_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::share_result_segment containing a collection of shares.

list_shares_segmented_async() [1/3]

pplx::task<share_result_segment> azure::storage::cloud_file_client::list_shares_segmented_async ( const continuation_token &  token )

inline

Intitiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_file_share objects.

Parameters

token

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

Returns

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

list_shares_segmented_async() [2/3]

pplx::task<share_result_segment> azure::storage::cloud_file_client::list_shares_segmented_async ( const utility::string_t &  prefix, const continuation_token &  token  )

inline

Intitiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_file_share objects.

Parameters

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

Returns

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

list_shares_segmented_async() [3/3]

WASTORAGE_API pplx::task<share_result_segment> azure::storage::cloud_file_client::list_shares_segmented_async	(	const utility::string_t &	prefix,
		bool	get_metadata,
		int	max_results,
		const continuation_token &	token,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_file_share objects.

Parameters

prefix	The share name prefix.
get_metadata	A flag that specifies whether to retrieve share metadata.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::file_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::share_result_segment containing a collection of shares.

set_authentication_scheme()

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

overridevirtual

Sets the authentication scheme to use to sign HTTP requests.

Parameters

value

The authentication scheme.

Reimplemented from azure::storage::cloud_client.

upload_service_properties() [1/2]

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

inline

Sets the service properties for the File service client.

Parameters

properties	The azure::storage::service_properties for the File 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_file_client::upload_service_properties ( const service_properties &  properties, const service_properties_includes &  includes, const file_request_options &  options, operation_context  context  ) const

inline

Sets the service properties for the File service client.

Parameters

properties	The azure::storage::service_properties for the File service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
options	An azure::storage::file_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.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.

upload_service_properties_async() [1/2]

pplx::task<void> azure::storage::cloud_file_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 File service client.

Parameters

properties	The azure::storage::service_properties for the File service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
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_file_client::upload_service_properties_async	(	const service_properties &	properties,
		const service_properties_includes &	includes,
		const file_request_options &	options,
		operation_context	context
	)		const

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

Parameters

properties	The azure::storage::service_properties for the File service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
options	An azure::storage::file_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.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.