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

startsOn parameter for GetUserDelegationKey was changed to optional. (#1451)

Browse Source 
* GetUserDelegationKey startsOn is optional

* changelog

* clang-format
This commit is contained in:
JinmingHu 2021-01-25 14:49:11 +08:00 committed by GitHub
parent 0df1cfa90f
commit 4c8232e9cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
sdk/storage/azure-storage-blobs/CHANGELOG.md
View File

@ -13,6 +13,7 @@
- `ListType` in `GetBlockListOptions` was changed to non-nullable.
- Added `BlobLeaseClient`, all lease related APIs are moved to `BlobLeaseClient`.
- Type for lease duration in requests was changed to `std::chrono::seconds`, in response was changed to enum.
- `startsOn` parameter for `GetUserDelegationKey` was changed to optional.
## 12.0.0-beta.6 (2020-01-14)

6
sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_options.hpp
View File

@ -203,6 +203,12 @@ namespace Azure { namespace Storage { namespace Blobs {
* @brief Context for cancelling long running operations.
*/
Azure::Core::Context Context;
/**
* @brief Start time for the key's validity. The time should be specified in UTC, and
* will be truncated to second.
*/
Azure::Core::DateTime startsOn = std::chrono::system_clock::now();
};
/**

3
sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_service_client.hpp
View File

@ -104,15 +104,12 @@ namespace Azure { namespace Storage { namespace Blobs {
* @brief Retrieves a key that can be used to delegate Active Directory authorization to
* shared access signatures.
*
* @param startsOn Start time for the key's validity. The time should be specified in UTC, and
* will be truncated to second.
* @param expiresOn Expiration of the key's validity. The time should be specified in UTC, and
* will be truncated to second.
* @param options Optional parameters to execute this function.
* @return A deserialized GetUserDelegationKeyResult instance.
*/
Azure::Core::Response<Models::GetUserDelegationKeyResult> GetUserDelegationKey(
const Azure::Core::DateTime& startsOn,
const Azure::Core::DateTime& expiresOn,
const GetUserDelegationKeyOptions& options = GetUserDelegationKeyOptions()) const;

3
sdk/storage/azure-storage-blobs/src/blob_service_client.cpp
View File

@ -134,12 +134,11 @@ namespace Azure { namespace Storage { namespace Blobs {
}
Azure::Core::Response<Models::GetUserDelegationKeyResult> BlobServiceClient::GetUserDelegationKey(
const Azure::Core::DateTime& startsOn,
const Azure::Core::DateTime& expiresOn,
const GetUserDelegationKeyOptions& options) const
{
Details::BlobRestClient::Service::GetUserDelegationKeyOptions protocolLayerOptions;
protocolLayerOptions.StartsOn = startsOn;
protocolLayerOptions.StartsOn = options.startsOn;
protocolLayerOptions.ExpiresOn = expiresOn;
return Details::BlobRestClient::Service::GetUserDelegationKey(
options.Context, *m_pipeline, m_serviceUrl, protocolLayerOptions);

3
sdk/storage/azure-storage-blobs/test/blob_sas_test.cpp
View File

@ -52,8 +52,7 @@ namespace Azure { namespace Storage { namespace Test {
serviceUrl,
std::make_shared<Azure::Identity::ClientSecretCredential>(
AadTenantId(), AadClientId(), AadClientSecret()));
auto userDelegationKey
= blobServiceClient1.GetUserDelegationKey(sasStartsOn, sasExpiresOn)->Key;
auto userDelegationKey = blobServiceClient1.GetUserDelegationKey(sasExpiresOn)->Key;
auto verify_blob_read = [&](const std::string& sas) {
EXPECT_NO_THROW(blobClient0.Create());

4
sdk/storage/azure-storage-blobs/test/blob_service_client_test.cpp
View File

@ -425,7 +425,6 @@ namespace Azure { namespace Storage { namespace Test {
TEST_F(BlobServiceClientTest, UserDelegationKey)
{
auto sasStartsOn = std::chrono::system_clock::now() - std::chrono::minutes(5);
auto sasExpiresOn = std::chrono::system_clock::now() + std::chrono::minutes(60);
auto blobServiceClient1 = Blobs::BlobServiceClient(
@ -433,8 +432,7 @@ namespace Azure { namespace Storage { namespace Test {
std::make_shared<Azure::Identity::ClientSecretCredential>(
AadTenantId(), AadClientId(), AadClientSecret()));
auto getUserDelegationKeyResult
= blobServiceClient1.GetUserDelegationKey(sasStartsOn, sasExpiresOn);
auto getUserDelegationKeyResult = blobServiceClient1.GetUserDelegationKey(sasExpiresOn);
EXPECT_FALSE(getUserDelegationKeyResult->RequestId.empty());

1
sdk/storage/azure-storage-files-datalake/CHANGELOG.md
View File

@ -30,6 +30,7 @@
- Removed `Directory` in `ListPathsSinglePageOptions`.
- Removed unused type `AccountResourceType` and `PathLeaseAction`.
- Changed all previous `LeaseDuration` members to a new type named `LeaseDurationType`.
- `startsOn` parameter for `GetUserDelegationKey` was changed to optional.
### Other Changes and Improvements

5
sdk/storage/azure-storage-files-datalake/inc/azure/storage/files/datalake/datalake_service_client.hpp
View File

@ -92,8 +92,6 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
* @brief Retrieves a key that can be used to delegate Active Directory authorization to
* shared access signatures.
*
* @param startsOn Start time for the key's validity. The time should be specified in UTC, and
* will be truncated to second.
* @param expiresOn Expiration of the key's validity. The time should be specified in UTC, and
* will be truncated to second.
* @param options Optional parameters to execute
@ -103,11 +101,10 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
* @remark This request is sent to blob endpoint.
*/
Azure::Core::Response<Models::GetUserDelegationKeyResult> GetUserDelegationKey(
const Azure::Core::DateTime& startsOn,
const Azure::Core::DateTime& expiresOn,
const GetUserDelegationKeyOptions& options = GetUserDelegationKeyOptions()) const
{
return m_blobServiceClient.GetUserDelegationKey(startsOn, expiresOn, options);
return m_blobServiceClient.GetUserDelegationKey(expiresOn, options);
}
private:

2
sdk/storage/azure-storage-files-datalake/test/datalake_sas_test.cpp
View File

@ -62,7 +62,7 @@ namespace Azure { namespace Storage { namespace Test {
serviceUrl,
std::make_shared<Azure::Identity::ClientSecretCredential>(
AadTenantId(), AadClientId(), AadClientSecret()));
auto userDelegationKey = serviceClient1.GetUserDelegationKey(sasStartsOn, sasExpiresOn)->Key;
auto userDelegationKey = serviceClient1.GetUserDelegationKey(sasExpiresOn)->Key;
auto verify_file_read = [&](const std::string& sas) {
EXPECT_NO_THROW(fileClient0.Create());