From 9d2353e59aacc9c207996cc214c698dab41d6962 Mon Sep 17 00:00:00 2001 From: Heath Stewart Date: Mon, 31 Aug 2020 20:12:38 -0700 Subject: [PATCH] Clarify KeyClientBuilderExtension methods params Fixes #14695 --- sdk/keyvault/Azure.Security.KeyVault.Keys/CHANGELOG.md | 4 ++++ .../src/KeyClientBuilderExtensions.cs | 9 +++++++++ 2 files changed, 13 insertions(+) diff --git a/sdk/keyvault/Azure.Security.KeyVault.Keys/CHANGELOG.md b/sdk/keyvault/Azure.Security.KeyVault.Keys/CHANGELOG.md index af28e1641ce78..e481c345267b5 100644 --- a/sdk/keyvault/Azure.Security.KeyVault.Keys/CHANGELOG.md +++ b/sdk/keyvault/Azure.Security.KeyVault.Keys/CHANGELOG.md @@ -7,6 +7,10 @@ - Added `KeyVaultKeyIdentifier` to parse key URIs. - Added `LocalCryptographyClient` to do cryptography operations locally using a `JsonWebKey`. +### Changed + +- Clarified documentation for `KeyClientBuilderExtensions` methods. + ## 4.1.0 (2020-08-11) ### Added diff --git a/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs b/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs index 8e3b39f2bb037..76de79deef538 100644 --- a/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs +++ b/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs @@ -34,6 +34,10 @@ public static IAzureClientBuilder AddKeyClient /// Registers a instance with the provided /// + /// Type of builder to extend. + /// The builder to extend. + /// The URI to a specific key in an Azure Key Vault. + /// An Azure client builder. public static IAzureClientBuilder AddCryptographyClient(this TBuilder builder, Uri vaultUri) where TBuilder : IAzureClientFactoryBuilderWithCredential { @@ -43,6 +47,11 @@ public static IAzureClientBuilder /// /// Registers a instance with connection options loaded from the provided instance. /// + /// Type of builder to extend. + /// The type of configuration to use for the client builder. + /// The builder to extend. + /// The configuration to use for the client builder. + /// An Azure client builder. public static IAzureClientBuilder AddCryptographyClient(this TBuilder builder, TConfiguration configuration) where TBuilder : IAzureClientFactoryBuilderWithConfiguration {