github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

rename SetAccountKey->UpdateAccountKey (#955)

Browse Source 
* rename SetAccountKey->UpdateAccountKey

* add doc
This commit is contained in:
JinmingHu 2020-11-12 14:05:56 +08:00 committed by GitHub
parent b5005d910c
commit 3838944ab9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
sdk/storage/azure-storage-common/inc/azure/storage/common/storage_credential.hpp
View File

@ -25,19 +25,39 @@ namespace Azure { namespace Storage {
}
} // namespace Files
/**
* @brief A SharedKeyCredential is a credential backed by a storage account's name and one
* of its access keys.
*/
class SharedKeyCredential {
public:
/**
* @brief Initializes a new instance of the SharedKeyCredential.
*
* @param accountName Name of the storage account.
* @param accountKey Access key of the storage
* account.
*/
explicit SharedKeyCredential(std::string accountName, std::string accountKey)
: AccountName(std::move(accountName)), m_accountKey(std::move(accountKey))
{
}
void SetAccountKey(std::string accountKey)
/**
* @brief Update the storage account's access key. This intended to be used when you've
* regenerated your storage account's access keys and want to update long lived clients.
*
* @param accountKey A storage account access key.
*/
void UpdateAccountKey(std::string accountKey)
{
std::lock_guard<std::mutex> guard(m_mutex);
m_accountKey = std::move(accountKey);
}
/**
* @brief Gets the name of the Storage Account.
*/
const std::string AccountName;
private: