Skip to content

Commit 3dfda66

Browse files
authored
Clarify KeyClientBuilderExtension methods params (#14737)
* Clarify KeyClientBuilderExtension methods params Fixes #14695 * Resolve PR feedback
1 parent e4974c9 commit 3dfda66

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

sdk/keyvault/Azure.Security.KeyVault.Keys/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
- Added `KeyVaultKeyIdentifier` to parse key URIs.
88
- Added `LocalCryptographyClient` to do cryptography operations locally using a `JsonWebKey`.
99

10+
### Changed
11+
12+
- Clarified documentation for `KeyClientBuilderExtensions` methods.
13+
1014
## 4.1.0 (2020-08-11)
1115

1216
### Added

sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ public static class KeyClientBuilderExtensions
1616
/// <summary>
1717
/// Registers a <see cref="KeyClient"/> instance with the provided <paramref name="vaultUri"/>
1818
/// </summary>
19+
/// <typeparam name="TBuilder">The type of builder to extend.</typeparam>
20+
/// <param name="builder">The builder to extend.</param>
21+
/// <param name="vaultUri">The URI to an Azure Key Vault, for example: https://my-vault.vault.azure.net</param>
22+
/// <returns>An Azure client builder.</returns>
1923
public static IAzureClientBuilder<KeyClient, KeyClientOptions> AddKeyClient<TBuilder>(this TBuilder builder, Uri vaultUri)
2024
where TBuilder : IAzureClientFactoryBuilderWithCredential
2125
{
@@ -25,6 +29,11 @@ public static IAzureClientBuilder<KeyClient, KeyClientOptions> AddKeyClient<TBui
2529
/// <summary>
2630
/// Registers a <see cref="KeyClient"/> instance with connection options loaded from the provided <paramref name="configuration"/> instance.
2731
/// </summary>
32+
/// <typeparam name="TBuilder">The type of builder to extend.</typeparam>
33+
/// <typeparam name="TConfiguration">The type of configuration to use for the client builder.</typeparam>
34+
/// <param name="builder">The builder to extend.</param>
35+
/// <param name="configuration">The configuration to use for the client builder.</param>
36+
/// <returns>An Azure client builder.</returns>
2837
public static IAzureClientBuilder<KeyClient, KeyClientOptions> AddKeyClient<TBuilder, TConfiguration>(this TBuilder builder, TConfiguration configuration)
2938
where TBuilder : IAzureClientFactoryBuilderWithConfiguration<TConfiguration>
3039
{
@@ -34,6 +43,10 @@ public static IAzureClientBuilder<KeyClient, KeyClientOptions> AddKeyClient<TBui
3443
/// <summary>
3544
/// Registers a <see cref="KeyClient"/> instance with the provided <paramref name="vaultUri"/>
3645
/// </summary>
46+
/// <typeparam name="TBuilder">The type of builder to extend.</typeparam>
47+
/// <param name="builder">The builder to extend.</param>
48+
/// <param name="vaultUri">The URI to a specific key in an Azure Key Vault, for example: https://my-vault.vault.azure.net/keys/my-key</param>
49+
/// <returns>An Azure client builder.</returns>
3750
public static IAzureClientBuilder<CryptographyClient, CryptographyClientOptions> AddCryptographyClient<TBuilder>(this TBuilder builder, Uri vaultUri)
3851
where TBuilder : IAzureClientFactoryBuilderWithCredential
3952
{
@@ -43,6 +56,11 @@ public static IAzureClientBuilder<CryptographyClient, CryptographyClientOptions>
4356
/// <summary>
4457
/// Registers a <see cref="KeyClient"/> instance with connection options loaded from the provided <paramref name="configuration"/> instance.
4558
/// </summary>
59+
/// <typeparam name="TBuilder">The type of builder to extend.</typeparam>
60+
/// <typeparam name="TConfiguration">The type of configuration to use for the client builder.</typeparam>
61+
/// <param name="builder">The builder to extend.</param>
62+
/// <param name="configuration">The configuration to use for the client builder.</param>
63+
/// <returns>An Azure client builder.</returns>
4664
public static IAzureClientBuilder<CryptographyClient, CryptographyClientOptions> AddCryptographyClient<TBuilder, TConfiguration>(this TBuilder builder, TConfiguration configuration)
4765
where TBuilder : IAzureClientFactoryBuilderWithConfiguration<TConfiguration>
4866
{

0 commit comments

Comments
 (0)