Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify KeyClientBuilderExtension methods params #14737

Merged
merged 2 commits into from
Sep 1, 2020
+22 −0
Merged

Clarify KeyClientBuilderExtension methods params #14737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d2353e
Clarify KeyClientBuilderExtension methods params
heaths Sep 1, 2020
683017c
Resolve PR feedback
heaths Sep 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions sdk/keyvault/Azure.Security.KeyVault.Keys/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 18 additions & 0 deletions sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ public static class KeyClientBuilderExtensions
/// <summary>
/// Registers a <see cref="KeyClient"/> instance with the provided <paramref name="vaultUri"/>
/// </summary>
/// <typeparam name="TBuilder">The type of builder to extend.</typeparam>
/// <param name="builder">The builder to extend.</param>
/// <param name="vaultUri">The URI to an Azure Key Vault, for example: https://my-vault.vault.azure.net</param>
/// <returns>An Azure client builder.</returns>
public static IAzureClientBuilder<KeyClient, KeyClientOptions> AddKeyClient<TBuilder>(this TBuilder builder, Uri vaultUri)
where TBuilder : IAzureClientFactoryBuilderWithCredential
{
Expand All @@ -25,6 +29,11 @@ public static IAzureClientBuilder<KeyClient, KeyClientOptions> AddKeyClient<TBui
/// <summary>
/// Registers a <see cref="KeyClient"/> instance with connection options loaded from the provided <paramref name="configuration"/> instance.
/// </summary>
/// <typeparam name="TBuilder">The type of builder to extend.</typeparam>
/// <typeparam name="TConfiguration">The type of configuration to use for the client builder.</typeparam>
/// <param name="builder">The builder to extend.</param>
/// <param name="configuration">The configuration to use for the client builder.</param>
/// <returns>An Azure client builder.</returns>
public static IAzureClientBuilder<KeyClient, KeyClientOptions> AddKeyClient<TBuilder, TConfiguration>(this TBuilder builder, TConfiguration configuration)
where TBuilder : IAzureClientFactoryBuilderWithConfiguration<TConfiguration>
{
Expand All @@ -34,6 +43,10 @@ public static IAzureClientBuilder<KeyClient, KeyClientOptions> AddKeyClient<TBui
/// <summary>
/// Registers a <see cref="KeyClient"/> instance with the provided <paramref name="vaultUri"/>
/// </summary>
/// <typeparam name="TBuilder">The type of builder to extend.</typeparam>
/// <param name="builder">The builder to extend.</param>
/// <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>
/// <returns>An Azure client builder.</returns>
public static IAzureClientBuilder<CryptographyClient, CryptographyClientOptions> AddCryptographyClient<TBuilder>(this TBuilder builder, Uri vaultUri)
where TBuilder : IAzureClientFactoryBuilderWithCredential
{
Expand All @@ -43,6 +56,11 @@ public static IAzureClientBuilder<CryptographyClient, CryptographyClientOptions>
/// <summary>
/// Registers a <see cref="KeyClient"/> instance with connection options loaded from the provided <paramref name="configuration"/> instance.
/// </summary>
/// <typeparam name="TBuilder">The type of builder to extend.</typeparam>
/// <typeparam name="TConfiguration">The type of configuration to use for the client builder.</typeparam>
/// <param name="builder">The builder to extend.</param>
/// <param name="configuration">The configuration to use for the client builder.</param>
/// <returns>An Azure client builder.</returns>
public static IAzureClientBuilder<CryptographyClient, CryptographyClientOptions> AddCryptographyClient<TBuilder, TConfiguration>(this TBuilder builder, TConfiguration configuration)
where TBuilder : IAzureClientFactoryBuilderWithConfiguration<TConfiguration>
{
Expand Down