Azure::Storage::Files::Shares::ShareServiceClient Class Reference

Public Member Functions
	ShareServiceClient (const std::string &serviceUrl, std::shared_ptr< StorageSharedKeyCredential > credential, const ShareClientOptions &options=ShareClientOptions())
	Initialize a new instance of ShareServiceClient using shared key authentication. More...
	ShareServiceClient (const std::string &serviceUrl, const ShareClientOptions &options=ShareClientOptions())
	Initialize a new instance of ShareServiceClient using anonymous access or shared access signature. More...
ShareClient	GetShareClient (const std::string &shareName) const
	Create a ShareClient from current ShareServiceClient. More...
std::string	GetUrl () const
	Gets the file share service's primary URL endpoint. More...
ListSharesPagedResponse	ListShares (const ListSharesOptions &options=ListSharesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Returns a paginated collection of the shares in the storage account. Enumerating the shares may make multiple requests to the service while fetching all the values. More...
Azure::Response< Models::SetServicePropertiesResult >	SetProperties (Models::ShareServiceProperties properties, const SetServicePropertiesOptions &options=SetServicePropertiesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Set the service's properties. More...
Azure::Response< Models::ShareServiceProperties >	GetProperties (const GetServicePropertiesOptions &options=GetServicePropertiesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Get the service's properties. More...

Static Public Member Functions
static ShareServiceClient	CreateFromConnectionString (const std::string &connectionString, const ShareClientOptions &options=ShareClientOptions())
	Create A ShareServiceClient from connection string to manage the service related attributes. More...

Constructor & Destructor Documentation

ShareServiceClient() [1/2]

Azure::Storage::Files::Shares::ShareServiceClient::ShareServiceClient ( const std::string &  serviceUrl, std::shared_ptr< StorageSharedKeyCredential >  credential, const ShareClientOptions &  options = ShareClientOptions()  )

explicit

Parameters

serviceUrl	The service URL this client's request targets.
credential	The shared key credential used to initialize the client.
options	Optional parameters used to initialize the client.

ShareServiceClient() [2/2]

Azure::Storage::Files::Shares::ShareServiceClient::ShareServiceClient ( const std::string &  serviceUrl, const ShareClientOptions &  options = ShareClientOptions()  )

explicit

Parameters

serviceUrl	The service URL this client's request targets.
options	Optional parameters used to initialize the client.

Member Function Documentation

CreateFromConnectionString()

ShareServiceClient Azure::Storage::Files::Shares::ShareServiceClient::CreateFromConnectionString ( const std::string &  connectionString, const ShareClientOptions &  options = ShareClientOptions()  )

static

Parameters

connectionString	Azure Storage connection string.
options	Optional parameters used to initialize the client.

Returns

ShareServiceClient

GetProperties()

Azure::Response< Models::ShareServiceProperties > Azure::Storage::Files::Shares::ShareServiceClient::GetProperties	(	const GetServicePropertiesOptions &	options = GetServicePropertiesOptions(),
		const Azure::Core::Context &	context = Azure::Core::Context()
	)		const

Parameters

options	Optional parameters to get the properties of the service.
context	Context for cancelling long running operations.

Returns

Azure::Response<Models::FileServiceProperties> The properties of the service.

GetShareClient()

ShareClient Azure::Storage::Files::Shares::ShareServiceClient::GetShareClient

(

const std::string &

shareName

)

const

Parameters

shareName

The name of the file share.

Returns

ShareClient A share client that can be used to manage a share resource.

GetUrl()

std::string Azure::Storage::Files::Shares::ShareServiceClient::GetUrl ( ) const

inline

Returns

The file share service's primary URL endpoint.

ListShares()

ListSharesPagedResponse Azure::Storage::Files::Shares::ShareServiceClient::ListShares	(	const ListSharesOptions &	options = ListSharesOptions(),
		const Azure::Core::Context &	context = Azure::Core::Context()
	)		const

Parameters

options	Optional parameters to list the shares.
context	Context for cancelling long running operations.

Returns

ListSharesPagedResponse describing the shares in this storage account.

SetProperties()

Azure::Response< Models::SetServicePropertiesResult > Azure::Storage::Files::Shares::ShareServiceClient::SetProperties	(	Models::ShareServiceProperties	properties,
		const SetServicePropertiesOptions &	options = SetServicePropertiesOptions(),
		const Azure::Core::Context &	context = Azure::Core::Context()
	)		const

Parameters

properties	The properties of the service that is to be set.
options	Optional parameters to set the properties of the service.
context	Context for cancelling long running operations.

Returns

Azure::Response<Models::SetServicePropertiesResult> The information returned when setting the service properties.

---

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

• inc/azure/storage/files/shares/share_service_client.hpp
• src/share_service_client.cpp