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..7a292f1d683f9 100644 --- a/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs +++ b/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs @@ -16,6 +16,10 @@ public static class KeyClientBuilderExtensions /// /// Registers a instance with the provided /// + /// The type of builder to extend. + /// The builder to extend. + /// The URI to an Azure Key Vault, for example: https://my-vault.vault.azure.net + /// An Azure client builder. public static IAzureClientBuilder AddKeyClient(this TBuilder builder, Uri vaultUri) where TBuilder : IAzureClientFactoryBuilderWithCredential { @@ -25,6 +29,11 @@ public static IAzureClientBuilder AddKeyClient /// Registers a instance with connection options loaded from the provided instance. /// + /// The 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 AddKeyClient(this TBuilder builder, TConfiguration configuration) where TBuilder : IAzureClientFactoryBuilderWithConfiguration { @@ -34,6 +43,10 @@ public static IAzureClientBuilder AddKeyClient /// Registers a instance with the provided /// + /// The type of builder to extend. + /// The builder to extend. + /// The URI to a specific key in an Azure Key Vault, for example: https://my-vault.vault.azure.net/keys/my-key + /// An Azure client builder. public static IAzureClientBuilder AddCryptographyClient(this TBuilder builder, Uri vaultUri) where TBuilder : IAzureClientFactoryBuilderWithCredential { @@ -43,6 +56,11 @@ public static IAzureClientBuilder /// /// Registers a instance with connection options loaded from the provided instance. /// + /// The 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 {