Class AzureKeyVaultConfigurationExtensions | Azure SDK for .NET

Inheritance

System.Object

AzureKeyVaultConfigurationExtensions

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Extensions.AspNetCore.Configuration.Secrets.dll

Syntax

public static class AzureKeyVaultConfigurationExtensions

Methods

AddAzureKeyVault(IConfigurationBuilder, SecretClient, AzureKeyVaultConfigurationOptions)

Adds an Microsoft.Extensions.Configuration.IConfigurationProvider that reads configuration values from the Azure KeyVault.

Declaration

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, Azure.Security.KeyVault.Secrets.SecretClient client, Azure.Extensions.AspNetCore.Configuration.Secrets.AzureKeyVaultConfigurationOptions options);

Parameters

Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder to add to.

Azure.Security.KeyVault.Secrets.SecretClient client The Azure.Security.KeyVault.Secrets.SecretClient to use for retrieving values.

AzureKeyVaultConfigurationOptions options The AzureKeyVaultConfigurationOptions to use.

Returns

Microsoft.Extensions.Configuration.IConfigurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder.

AddAzureKeyVault(IConfigurationBuilder, SecretClient, KeyVaultSecretManager)

Adds an Microsoft.Extensions.Configuration.IConfigurationProvider that reads configuration values from the Azure KeyVault.

Declaration

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, Azure.Security.KeyVault.Secrets.SecretClient client, Azure.Extensions.AspNetCore.Configuration.Secrets.KeyVaultSecretManager manager);

Parameters

Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder to add to.

Azure.Security.KeyVault.Secrets.SecretClient client The Azure.Security.KeyVault.Secrets.SecretClient to use for retrieving values.

KeyVaultSecretManager manager The KeyVaultSecretManager instance used to control secret loading.

Returns

Microsoft.Extensions.Configuration.IConfigurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder.

AddAzureKeyVault(IConfigurationBuilder, Uri, TokenCredential)

Adds an Microsoft.Extensions.Configuration.IConfigurationProvider that reads configuration values from the Azure KeyVault.

Declaration

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, Uri vaultUri, Azure.Core.TokenCredential credential);

Parameters

Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder to add to.

System.Uri vaultUri The Azure Key Vault uri.

Azure.Core.TokenCredential credential The credential to to use for authentication.

Returns

Microsoft.Extensions.Configuration.IConfigurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder.

AddAzureKeyVault(IConfigurationBuilder, Uri, TokenCredential, AzureKeyVaultConfigurationOptions)

Adds an Microsoft.Extensions.Configuration.IConfigurationProvider that reads configuration values from the Azure KeyVault.

Declaration

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, Uri vaultUri, Azure.Core.TokenCredential credential, Azure.Extensions.AspNetCore.Configuration.Secrets.AzureKeyVaultConfigurationOptions options);

Parameters

Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder to add to.

System.Uri vaultUri Azure Key Vault uri.

Azure.Core.TokenCredential credential The credential to to use for authentication.

AzureKeyVaultConfigurationOptions options The AzureKeyVaultConfigurationOptions to use.

Returns

Microsoft.Extensions.Configuration.IConfigurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder.

AddAzureKeyVault(IConfigurationBuilder, Uri, TokenCredential, KeyVaultSecretManager)

Adds an Microsoft.Extensions.Configuration.IConfigurationProvider that reads configuration values from the Azure KeyVault.

Declaration

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, Uri vaultUri, Azure.Core.TokenCredential credential, Azure.Extensions.AspNetCore.Configuration.Secrets.KeyVaultSecretManager manager);

Parameters

Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder to add to.

System.Uri vaultUri Azure Key Vault uri.

Azure.Core.TokenCredential credential The credential to to use for authentication.

KeyVaultSecretManager manager The KeyVaultSecretManager instance used to control secret loading.

Returns

Microsoft.Extensions.Configuration.IConfigurationBuilder The Microsoft.Extensions.Configuration.IConfigurationBuilder.