azure::storage::cloud_file_share Class Reference

Represents a share in the Windows Azure File service. More...

Public Member Functions
	cloud_file_share ()
	Initializes a new instance of the azure::storage::cloud_file_share class. More...
WASTORAGE_API	cloud_file_share (storage_uri uri)
	Initializes a new instance of the azure::storage::cloud_file_share class. More...
WASTORAGE_API	cloud_file_share (storage_uri uri, storage_credentials credentials)
	Initializes a new instance of the azure::storage::cloud_file_share class. More...
WASTORAGE_API	cloud_file_share (utility::string_t name, cloud_file_client client)
	Initializes a new instance of the azure::storage::cloud_file_share class. More...
WASTORAGE_API	cloud_file_share (utility::string_t name, cloud_file_client client, cloud_file_share_properties properties, cloud_metadata metadata)
	Initializes a new instance of the azure::storage::cloud_file_share class. More...
void	create ()
	Creates the share. More...
void	create (utility::size64_t max_size)
	Creates the share and specifies the size of the share. More...
void	create (const file_request_options &options, operation_context context)
	Creates the share. More...
void	create (utility::size64_t max_size, const file_request_options &options, operation_context context)
	Creates the share and specifies the size of the share. More...
pplx::task< void >	create_async ()
	Intitiates an asynchronous operation to create the share. More...
pplx::task< void >	create_async (utility::size64_t max_size)
	Intitiates an asynchronous operation to create the share. More...
WASTORAGE_API pplx::task< void >	create_async (const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the share. More...
WASTORAGE_API pplx::task< void >	create_async (utility::size64_t max_size, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the share. More...
bool	create_if_not_exists ()
	Creates the share if it does not already exist. More...
bool	create_if_not_exists (utility::size64_t max_size)
	Creates the share if it does not already exist. More...
bool	create_if_not_exists (const file_request_options &options, operation_context context)
	Creates the share if it does not already exist. More...
bool	create_if_not_exists (utility::size64_t max_size, const file_request_options &options, operation_context context)
	Creates the share if it does not already exist. More...
pplx::task< bool >	create_if_not_exists_async ()
	Intitiates an asynchronous operation to create the share. More...
pplx::task< bool >	create_if_not_exists_async (utility::size64_t max_size)
	Intitiates an asynchronous operation to create the share if it does not already exist and specify the size of the share. More...
WASTORAGE_API pplx::task< bool >	create_if_not_exists_async (const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the share. More...
WASTORAGE_API pplx::task< bool >	create_if_not_exists_async (utility::size64_t max_size, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the share if it does not already exist and specify the size of the share. More...
void	delete_share ()
	Deletes the share. More...
void	delete_share (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Deletes the share. More...
pplx::task< void >	delete_share_async ()
	Intitiates an asynchronous operation to delete the share. More...
WASTORAGE_API pplx::task< void >	delete_share_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to delete the share. More...
bool	delete_share_if_exists ()
	Deletes the share if it already exists. More...
bool	delete_share_if_exists (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Deletes the share if it already exists. More...
pplx::task< bool >	delete_share_if_exists_async ()
	Intitiates an asynchronous operation to delete the share if it already exists. More...
WASTORAGE_API pplx::task< bool >	delete_share_if_exists_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to delete the share if it already exists. More...
bool	exists ()
	Checks existence of the share. More...
bool	exists (const file_request_options &options, operation_context context)
	Checks existence of the share. More...
pplx::task< bool >	exists_async ()
	Intitiates an asynchronous operation to check the existence of the share. More...
pplx::task< bool >	exists_async (const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to check the existence of the share. More...
void	download_attributes ()
	Retrieves the share's attributes. More...
void	download_attributes (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Retrieves the share's attributes. More...
pplx::task< void >	download_attributes_async ()
	Intitiates an asynchronous operation to retrieve the share's attributes. More...
WASTORAGE_API pplx::task< void >	download_attributes_async (const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to retrieve the share's attributes. More...
void	upload_metadata () const
	Updates the share's metadata. More...
void	upload_metadata (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Updates the share's metadata. More...
pplx::task< void >	upload_metadata_async () const
	Intitiates an asynchronous operation to update the share's metadata. More...
WASTORAGE_API pplx::task< void >	upload_metadata_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to update the share's metadata. More...
int32_t	download_share_usage () const
	Retrieves the share's statistics. More...
int32_t	download_share_usage (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Retrieves the share's statistics. More...
pplx::task< int32_t >	download_share_usage_async () const
	Intitiates an asynchronous operation to retrieve the share's statistics. More...
WASTORAGE_API pplx::task< int32_t >	download_share_usage_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to retrieve the share's statistics. More...
int64_t	download_share_usage_in_bytes () const
	Retrieves the share's statistics. More...
int64_t	download_share_usage_in_bytes (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Retrieves the share's statistics. More...
pplx::task< int64_t >	download_share_usage_in_bytes_async () const
	Intitiates an asynchronous operation to retrieve the share's statistics. More...
WASTORAGE_API pplx::task< int64_t >	download_share_usage_in_bytes_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to retrieve the share's statistics. More...
file_share_permissions	download_permissions () const
	Gets permissions settings for the share. More...
file_share_permissions	download_permissions (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Gets permissions settings for the share. More...
pplx::task< file_share_permissions >	download_permissions_async () const
	Intitiates an asynchronous operation to get permissions settings for the share. More...
WASTORAGE_API pplx::task< file_share_permissions >	download_permissions_async (const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to get permissions settings for the share. More...
void	upload_permissions (const file_share_permissions &permissions) const
	Uploads permissions settings for the share. More...
void	upload_permissions (const file_share_permissions &permissions, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Uploads permissions settings for the share. More...
pplx::task< void >	upload_permissions_async (const file_share_permissions &permissions) const
	Intitiates an asynchronous operation to upload permissions settings for the share. More...
WASTORAGE_API pplx::task< void >	upload_permissions_async (const file_share_permissions &permissions, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to upload permissions settings for the share. More...
utility::string_t	download_file_permission (const utility::string_t &permission_key) const
	Gets the Security Descriptor Definition Language (SDDL) for a given security descriptor. More...
utility::string_t	download_file_permission (const utility::string_t &permission_key, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Gets the Security Descriptor Definition Language (SDDL) for a given security descriptor. More...
pplx::task< utility::string_t >	download_file_permission_async (const utility::string_t &permission_key) const
	Intitiates an asynchronous operation to get the Security Descriptor Definition Language (SDDL) for a given security descriptor. More...
WASTORAGE_API pplx::task< utility::string_t >	download_file_permission_async (const utility::string_t &permission_key, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to get the Security Descriptor Definition Language (SDDL) for a given security descriptor. More...
utility::string_t	upload_file_permission (const utility::string_t &permission) const
	Creates a permission in the share. The created security descriptor can be used for the files/directories in this share. More...
utility::string_t	upload_file_permission (const utility::string_t &permission, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Creates a permission in the share. The created security descriptor can be used for the files/directories in this share. More...
pplx::task< utility::string_t >	upload_file_permission_async (const utility::string_t &permission) const
	Intitiates an asynchronous operation to creates a permission in the share. The created security descriptor can be used for the files/directories in this share. More...
WASTORAGE_API pplx::task< utility::string_t >	upload_file_permission_async (const utility::string_t &permission, const file_access_condition &condition, const file_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to creates a permission in the share. The created security descriptor can be used for the files/directories in this share. More...
void	resize (utility::size64_t quota)
	Resize the share. More...
void	resize (utility::size64_t quota, const file_access_condition &condition, const file_request_options &options, operation_context context)
	Resize the share. More...
pplx::task< void >	resize_async (utility::size64_t quota)
	Intitiates an asynchronous operation to resize the share. More...
WASTORAGE_API pplx::task< void >	resize_async (utility::size64_t quota, const file_access_condition &condition, const file_request_options &options, operation_context context)
	Intitiates an asynchronous operation to resize the share. More...
utility::string_t	get_shared_access_signature (const file_shared_access_policy &policy) const
	Returns a shared access signature for the share. More...
WASTORAGE_API utility::string_t	get_shared_access_signature (const file_shared_access_policy &policy, const utility::string_t &stored_policy_identifier) const
	Returns a shared access signature for the share. More...
WASTORAGE_API utility::string_t	get_shared_access_signature (const file_shared_access_policy &policy, const utility::string_t &stored_policy_identifier, const cloud_file_shared_access_headers &headers) const
	Returns a shared access signature for the share. More...
WASTORAGE_API cloud_file_directory	get_root_directory_reference () const
	Returns a reference to an azure::storage::cloud_file_directory object. More...
WASTORAGE_API cloud_file_directory	get_directory_reference (utility::string_t name) const
	Returns a reference to an azure::storage::cloud_file_directory object with the specified name. More...
utility::string_t	name () const
	Gets the share's name. More...
const cloud_file_client &	service_client () const
	Gets the azure::storage::cloud_file_client object that represents the File service. More...
const storage_uri &	uri () const
	Gets the file URI for all locations. More...
cloud_metadata &	metadata ()
	Gets the share's system metadata. More...
const cloud_metadata &	metadata () const
	Gets the share's system metadata. More...
cloud_file_share_properties &	properties ()
	Gets the share's system properties. More...
const cloud_file_share_properties &	properties () const
	Gets the share's system properties. More...
bool	is_valid () const
	Indicates whether the azure::storage::cloud_file_share object is valid. More...

Detailed Description

Represents a share in the Windows Azure File service.

Constructor & Destructor Documentation

cloud_file_share() [1/5]

azure::storage::cloud_file_share::cloud_file_share ( )

inline

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

cloud_file_share() [2/5]

WASTORAGE_API azure::storage::cloud_file_share::cloud_file_share

(

storage_uri

uri

)

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

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the share for all locations.

cloud_file_share() [3/5]

WASTORAGE_API azure::storage::cloud_file_share::cloud_file_share	(	storage_uri	uri,
		storage_credentials	credentials
	)

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

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the share for all locations.
credentials	The azure::storage::storage_credentials to use.

cloud_file_share() [4/5]

WASTORAGE_API azure::storage::cloud_file_share::cloud_file_share	(	utility::string_t	name,
		cloud_file_client	client
	)

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

Parameters

name	The name of the share.
client	The File service client.

cloud_file_share() [5/5]

WASTORAGE_API azure::storage::cloud_file_share::cloud_file_share	(	utility::string_t	name,
		cloud_file_client	client,
		cloud_file_share_properties	properties,
		cloud_metadata	metadata
	)

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

Parameters

name	The name of the share.
client	The File service client.
properties	The properties for the container.
metadata	The metadata for the container.

Member Function Documentation

create() [1/4]

void azure::storage::cloud_file_share::create ( )

inline

Creates the share.

create() [2/4]

void azure::storage::cloud_file_share::create ( utility::size64_t  max_size )

inline

Creates the share and specifies the size of the share.

Parameters

max_size

An utility::size64_t value that specifies the size of the share.

create() [3/4]

void azure::storage::cloud_file_share::create ( const file_request_options &  options, operation_context  context  )

inline

Creates the share.

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. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

create() [4/4]

void azure::storage::cloud_file_share::create ( utility::size64_t  max_size, const file_request_options &  options, operation_context  context  )

inline

Creates the share and specifies the size of the share.

Parameters

max_size	An utility::size64_t value that specifies the size of the share.
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. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

create_async() [1/4]

pplx::task<void> azure::storage::cloud_file_share::create_async ( )

inline

Intitiates an asynchronous operation to create the share.

Returns

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

create_async() [2/4]

pplx::task<void> azure::storage::cloud_file_share::create_async ( utility::size64_t  max_size )

inline

Intitiates an asynchronous operation to create the share.

Parameters

max_size

An utility::size64_t value that specifies the size of the share.

Returns

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

create_async() [3/4]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_share::create_async	(	const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to create the share.

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. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

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

create_async() [4/4]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_share::create_async	(	utility::size64_t	max_size,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to create the share.

Parameters

max_size	An utility::size64_t value that specifies the size of the share.
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. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

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

create_if_not_exists() [1/4]

bool azure::storage::cloud_file_share::create_if_not_exists ( )

inline

Creates the share if it does not already exist.

Returns

true if the share did not already exist and was created; otherwise false.

create_if_not_exists() [2/4]

bool azure::storage::cloud_file_share::create_if_not_exists ( utility::size64_t  max_size )

inline

Creates the share if it does not already exist.

Parameters

max_size

An utility::size64_t value that specifies the size of the share.

Returns

true if the share did not already exist and was created; otherwise false.

create_if_not_exists() [3/4]

bool azure::storage::cloud_file_share::create_if_not_exists ( const file_request_options &  options, operation_context  context  )

inline

Creates the share if it does not already exist.

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. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

true if the share did not already exist and was created; otherwise false.

create_if_not_exists() [4/4]

bool azure::storage::cloud_file_share::create_if_not_exists ( utility::size64_t  max_size, const file_request_options &  options, operation_context  context  )

inline

Creates the share if it does not already exist.

Parameters

max_size	An utility::size64_t value that specifies the size of the share.
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. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

true if the share did not already exist and was created; otherwise false.

create_if_not_exists_async() [1/4]

pplx::task<bool> azure::storage::cloud_file_share::create_if_not_exists_async ( )

inline

Intitiates an asynchronous operation to create the share.

Returns

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

create_if_not_exists_async() [2/4]

pplx::task<bool> azure::storage::cloud_file_share::create_if_not_exists_async ( utility::size64_t  max_size )

inline

Intitiates an asynchronous operation to create the share if it does not already exist and specify the size of the share.

Parameters

max_size

An utility::size64_t value that specifies the size of the share.

Returns

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

create_if_not_exists_async() [3/4]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_file_share::create_if_not_exists_async	(	const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to create the share.

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. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

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

create_if_not_exists_async() [4/4]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_file_share::create_if_not_exists_async	(	utility::size64_t	max_size,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to create the share if it does not already exist and specify the size of the share.

Parameters

max_size	An utility::size64_t value that specifies the size of the share.
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. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns

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

delete_share() [1/2]

void azure::storage::cloud_file_share::delete_share ( )

inline

Deletes the share.

delete_share() [2/2]

void azure::storage::cloud_file_share::delete_share ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Deletes the share.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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.

delete_share_async() [1/2]

pplx::task<void> azure::storage::cloud_file_share::delete_share_async ( )

inline

Intitiates an asynchronous operation to delete the share.

delete_share_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_share::delete_share_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to delete the share.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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.

delete_share_if_exists() [1/2]

bool azure::storage::cloud_file_share::delete_share_if_exists ( )

inline

Deletes the share if it already exists.

Returns

true if the share did not already exist and was deleted; otherwise false.

delete_share_if_exists() [2/2]

bool azure::storage::cloud_file_share::delete_share_if_exists ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Deletes the share if it already exists.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

true if the share did not already exist and was deleted; otherwise false.

delete_share_if_exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_file_share::delete_share_if_exists_async ( )

inline

Intitiates an asynchronous operation to delete the share if it already exists.

Returns

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

delete_share_if_exists_async() [2/2]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_file_share::delete_share_if_exists_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to delete the share if it already exists.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

download_attributes() [1/2]

void azure::storage::cloud_file_share::download_attributes ( )

inline

Retrieves the share's attributes.

download_attributes() [2/2]

void azure::storage::cloud_file_share::download_attributes ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Retrieves the share's attributes.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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.

download_attributes_async() [1/2]

pplx::task<void> azure::storage::cloud_file_share::download_attributes_async ( )

inline

Intitiates an asynchronous operation to retrieve the share's attributes.

Returns

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

download_attributes_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_share::download_attributes_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to retrieve the share's attributes.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

download_file_permission() [1/2]

utility::string_t azure::storage::cloud_file_share::download_file_permission ( const utility::string_t &  permission_key ) const

inline

Gets the Security Descriptor Definition Language (SDDL) for a given security descriptor.

Parameters

permission_key

Security descriptor of the permission.

Returns

A utility::string_t object that contains permission in the Security Descriptor Definition Language (SDDL).

download_file_permission() [2/2]

utility::string_t azure::storage::cloud_file_share::download_file_permission ( const utility::string_t &  permission_key, const file_access_condition &  condition, const file_request_options &  options, operation_context  context  ) const

inline

Gets the Security Descriptor Definition Language (SDDL) for a given security descriptor.

Parameters

permission_key	Security descriptor of the permission.
condition	An azure::storage::file_access_condition object that represents the access condition for the 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

A utility::string_t object that contains permission in the Security Descriptor Definition Language (SDDL).

download_file_permission_async() [1/2]

pplx::task<utility::string_t> azure::storage::cloud_file_share::download_file_permission_async ( const utility::string_t &  permission_key ) const

inline

Intitiates an asynchronous operation to get the Security Descriptor Definition Language (SDDL) for a given security descriptor.

Parameters

permission_key

Security descriptor of the permission.

Returns

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

download_file_permission_async() [2/2]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file_share::download_file_permission_async	(	const utility::string_t &	permission_key,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to get the Security Descriptor Definition Language (SDDL) for a given security descriptor.

Parameters

permission_key	Security descriptor of the permission.
condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

download_permissions() [1/2]

file_share_permissions azure::storage::cloud_file_share::download_permissions ( ) const

inline

Gets permissions settings for the share.

Returns

The share's permissions.

download_permissions() [2/2]

file_share_permissions azure::storage::cloud_file_share::download_permissions ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  ) const

inline

Gets permissions settings for the share.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

The share's permissions.

download_permissions_async() [1/2]

pplx::task<file_share_permissions> azure::storage::cloud_file_share::download_permissions_async ( ) const

inline

Intitiates an asynchronous operation to get permissions settings for the share.

Returns

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

download_permissions_async() [2/2]

WASTORAGE_API pplx::task<file_share_permissions> azure::storage::cloud_file_share::download_permissions_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to get permissions settings for the share.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

download_share_usage() [1/2]

int32_t azure::storage::cloud_file_share::download_share_usage ( ) const

inline

Retrieves the share's statistics.

Returns

The size number in gigabyte of used data for this share.

This method is deprecated in favor of download_shared_usage_in_bytes.

download_share_usage() [2/2]

int32_t azure::storage::cloud_file_share::download_share_usage ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  ) const

inline

Retrieves the share's statistics.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

The size number in gigabyte of used data for this share.

This method is deprecated in favor of download_shared_usage_in_bytes.

download_share_usage_async() [1/2]

pplx::task<int32_t> azure::storage::cloud_file_share::download_share_usage_async ( ) const

inline

Intitiates an asynchronous operation to retrieve the share's statistics.

Returns

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

This method is deprecated in favor of download_shared_usage_in_bytes_async.

download_share_usage_async() [2/2]

WASTORAGE_API pplx::task<int32_t> azure::storage::cloud_file_share::download_share_usage_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to retrieve the share's statistics.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

This method is deprecated in favor of download_shared_usage_in_bytes_async.

download_share_usage_in_bytes() [1/2]

int64_t azure::storage::cloud_file_share::download_share_usage_in_bytes ( ) const

inline

Retrieves the share's statistics.

Returns

The size number in byte of used data for this share.

download_share_usage_in_bytes() [2/2]

int64_t azure::storage::cloud_file_share::download_share_usage_in_bytes ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  ) const

inline

Retrieves the share's statistics.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

The size number in byte of used data for this share.

download_share_usage_in_bytes_async() [1/2]

pplx::task<int64_t> azure::storage::cloud_file_share::download_share_usage_in_bytes_async ( ) const

inline

Intitiates an asynchronous operation to retrieve the share's statistics.

Returns

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

download_share_usage_in_bytes_async() [2/2]

WASTORAGE_API pplx::task<int64_t> azure::storage::cloud_file_share::download_share_usage_in_bytes_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to retrieve the share's statistics.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

exists() [1/2]

bool azure::storage::cloud_file_share::exists ( )

inline

Checks existence of the share.

Returns

true if the share exists.

exists() [2/2]

bool azure::storage::cloud_file_share::exists ( const file_request_options &  options, operation_context  context  )

inline

Checks existence of the share.

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

true if the share exists.

exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_file_share::exists_async ( )

inline

Intitiates an asynchronous operation to check the existence of the share.

Returns

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

exists_async() [2/2]

pplx::task<bool> azure::storage::cloud_file_share::exists_async ( const file_request_options &  options, operation_context  context  )

inline

Intitiates an asynchronous operation to check the existence of the share.

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 that that represents the current operation.

get_directory_reference()

WASTORAGE_API cloud_file_directory azure::storage::cloud_file_share::get_directory_reference

(

utility::string_t

name

)

const

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

Parameters

name	The name of the directory.

Returns

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

get_root_directory_reference()

WASTORAGE_API cloud_file_directory azure::storage::cloud_file_share::get_root_directory_reference

(

)

const

Returns a reference to an azure::storage::cloud_file_directory object.

Returns

A reference to the root directory, of type azure::storage::cloud_file_directory.

get_shared_access_signature() [1/3]

utility::string_t azure::storage::cloud_file_share::get_shared_access_signature ( const file_shared_access_policy &  policy ) const

inline

Returns a shared access signature for the share.

Parameters

policy

The access policy for the shared access signature.

Returns

A string containing a shared access signature.

get_shared_access_signature() [2/3]

WASTORAGE_API utility::string_t azure::storage::cloud_file_share::get_shared_access_signature ( const file_shared_access_policy &  policy, const utility::string_t &  stored_policy_identifier  ) const

inline

Returns a shared access signature for the share.

Parameters

policy	The access policy for the shared access signature.
stored_policy_identifier	A share-level access policy.

Returns

A string containing a shared access signature.

get_shared_access_signature() [3/3]

WASTORAGE_API utility::string_t azure::storage::cloud_file_share::get_shared_access_signature	(	const file_shared_access_policy &	policy,
		const utility::string_t &	stored_policy_identifier,
		const cloud_file_shared_access_headers &	headers
	)		const

Returns a shared access signature for the share.

Parameters

policy	The access policy for the shared access signature.
stored_policy_identifier	A share-level access policy.
headers	The optional header values to set for a share returned with this SAS.

Returns

A string containing a shared access signature.

is_valid()

bool azure::storage::cloud_file_share::is_valid ( ) const

inline

Indicates whether the azure::storage::cloud_file_share object is valid.

Returns

true if the azure::storage::cloud_file_share object is valid; otherwise, false.

metadata() [1/2]

cloud_metadata& azure::storage::cloud_file_share::metadata ( )

inline

Gets the share's system metadata.

Returns

The share's metadata.

metadata() [2/2]

const cloud_metadata& azure::storage::cloud_file_share::metadata ( ) const

inline

Gets the share's system metadata.

Returns

The share's metadata.

name()

utility::string_t azure::storage::cloud_file_share::name ( ) const

inline

Gets the share's name.

Returns

The share's name.

properties() [1/2]

cloud_file_share_properties& azure::storage::cloud_file_share::properties ( )

inline

Gets the share's system properties.

Returns

The share's properties.

properties() [2/2]

const cloud_file_share_properties& azure::storage::cloud_file_share::properties ( ) const

inline

Gets the share's system properties.

Returns

The share's properties.

resize() [1/2]

void azure::storage::cloud_file_share::resize ( utility::size64_t  quota )

inline

Resize the share.

Parameters

quota

The size to apply to the share.

resize() [2/2]

void azure::storage::cloud_file_share::resize ( utility::size64_t  quota, const file_access_condition &  condition, const file_request_options &  options, operation_context  context  )

inline

Resize the share.

Parameters

quota	The size to apply to the share.
condition	An azure::storage::file_access_condition object that represents the access condition for the 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.

resize_async() [1/2]

pplx::task<void> azure::storage::cloud_file_share::resize_async ( utility::size64_t  quota )

inline

Intitiates an asynchronous operation to resize the share.

Parameters

quota

The size to apply to the share.

Returns

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

resize_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_share::resize_async	(	utility::size64_t	quota,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to resize the share.

Parameters

quota	The size to apply to the share.
condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

service_client()

const cloud_file_client& azure::storage::cloud_file_share::service_client ( ) const

inline

Gets the azure::storage::cloud_file_client object that represents the File service.

Returns

A client object that specifies the File service endpoint.

upload_file_permission() [1/2]

utility::string_t azure::storage::cloud_file_share::upload_file_permission ( const utility::string_t &  permission ) const

inline

Creates a permission in the share. The created security descriptor can be used for the files/directories in this share.

Parameters

permission

A utility::string_t that contains permission in the Security Descriptor Definition Language (SDDL).

Returns

A utility::string_t that contains security descriptor of the permission.

upload_file_permission() [2/2]

utility::string_t azure::storage::cloud_file_share::upload_file_permission ( const utility::string_t &  permission, const file_access_condition &  condition, const file_request_options &  options, operation_context  context  ) const

inline

Creates a permission in the share. The created security descriptor can be used for the files/directories in this share.

Parameters

permission	A utility::string_t that contains permission in the Security Descriptor Definition Language (SDDL).
condition	An azure::storage::file_access_condition object that represents the access condition for the 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

A utility::string_t that contains security descriptor of the permission.

upload_file_permission_async() [1/2]

pplx::task<utility::string_t> azure::storage::cloud_file_share::upload_file_permission_async ( const utility::string_t &  permission ) const

inline

Intitiates an asynchronous operation to creates a permission in the share. The created security descriptor can be used for the files/directories in this share.

Parameters

permission

A utility::string_t that contains permission in the Security Descriptor Definition Language (SDDL).

Returns

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

upload_file_permission_async() [2/2]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_file_share::upload_file_permission_async	(	const utility::string_t &	permission,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to creates a permission in the share. The created security descriptor can be used for the files/directories in this share.

Parameters

permission	A utility::string_t that contains permission in the Security Descriptor Definition Language (SDDL).
condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

upload_metadata() [1/2]

void azure::storage::cloud_file_share::upload_metadata ( ) const

inline

Updates the share's metadata.

upload_metadata() [2/2]

void azure::storage::cloud_file_share::upload_metadata ( const file_access_condition &  condition, const file_request_options &  options, operation_context  context  ) const

inline

Updates the share's metadata.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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.

upload_metadata_async() [1/2]

pplx::task<void> azure::storage::cloud_file_share::upload_metadata_async ( ) const

inline

Intitiates an asynchronous operation to update the share's metadata.

Returns

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

upload_metadata_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_share::upload_metadata_async	(	const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to update the share's metadata.

Parameters

condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

upload_permissions() [1/2]

void azure::storage::cloud_file_share::upload_permissions ( const file_share_permissions &  permissions ) const

inline

Uploads permissions settings for the share.

Parameters

permissions

The permissions to apply to the share.

upload_permissions() [2/2]

void azure::storage::cloud_file_share::upload_permissions ( const file_share_permissions &  permissions, const file_access_condition &  condition, const file_request_options &  options, operation_context  context  ) const

inline

Uploads permissions settings for the share.

Parameters

permissions	The permissions to apply to the share.
condition	An azure::storage::file_access_condition object that represents the access condition for the 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.

upload_permissions_async() [1/2]

pplx::task<void> azure::storage::cloud_file_share::upload_permissions_async ( const file_share_permissions &  permissions ) const

inline

Intitiates an asynchronous operation to upload permissions settings for the share.

Parameters

permissions

The permissions to apply to the share.

Returns

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

upload_permissions_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_file_share::upload_permissions_async	(	const file_share_permissions &	permissions,
		const file_access_condition &	condition,
		const file_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to upload permissions settings for the share.

Parameters

permissions	The permissions to apply to the share.
condition	An azure::storage::file_access_condition object that represents the access condition for the 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

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

uri()

const storage_uri& azure::storage::cloud_file_share::uri ( ) const

inline

Gets the file URI for all locations.

Returns

An azure::storage::storage_uri containing the share URI for all locations.