AzureKeyVaultConfigurationExtensions.AddAzureKeyVault Method

Definition

Namespace:

Microsoft.Extensions.Configuration

Assembly:

Azure.Extensions.AspNetCore.Configuration.Secrets.dll

Package:

Azure.Extensions.AspNetCore.Configuration.Secrets v1.3.2

Overloads

AddAzureKeyVault(IConfigurationBuilder, SecretClient, AzureKeyVaultConfigurationOptions)	Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
AddAzureKeyVault(IConfigurationBuilder, SecretClient, KeyVaultSecretManager)	Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
AddAzureKeyVault(IConfigurationBuilder, Uri, TokenCredential)	Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
AddAzureKeyVault(IConfigurationBuilder, Uri, TokenCredential, AzureKeyVaultConfigurationOptions)	Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
AddAzureKeyVault(IConfigurationBuilder, Uri, TokenCredential, KeyVaultSecretManager)	Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.

AddAzureKeyVault(IConfigurationBuilder, SecretClient, AzureKeyVaultConfigurationOptions)

Source:

AzureKeyVaultConfigurationExtensions.cs

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

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);

static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * Azure.Security.KeyVault.Secrets.SecretClient * Azure.Extensions.AspNetCore.Configuration.Secrets.AzureKeyVaultConfigurationOptions -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, client As SecretClient, options As AzureKeyVaultConfigurationOptions) As IConfigurationBuilder

Parameters

configurationBuilder

IConfigurationBuilder

The IConfigurationBuilder to add to.

client

SecretClient

The SecretClient to use for retrieving values.

options

AzureKeyVaultConfigurationOptions

The AzureKeyVaultConfigurationOptions to use.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

AddAzureKeyVault(IConfigurationBuilder, SecretClient, KeyVaultSecretManager)

Source:

AzureKeyVaultConfigurationExtensions.cs

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

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);

static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * Azure.Security.KeyVault.Secrets.SecretClient * Azure.Extensions.AspNetCore.Configuration.Secrets.KeyVaultSecretManager -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, client As SecretClient, manager As KeyVaultSecretManager) As IConfigurationBuilder

Parameters

configurationBuilder

IConfigurationBuilder

The IConfigurationBuilder to add to.

client

SecretClient

The SecretClient to use for retrieving values.

manager

KeyVaultSecretManager

The KeyVaultSecretManager instance used to control secret loading.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

AddAzureKeyVault(IConfigurationBuilder, Uri, TokenCredential)

Source:

AzureKeyVaultConfigurationExtensions.cs

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

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

static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * Uri * Azure.Core.TokenCredential -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vaultUri As Uri, credential As TokenCredential) As IConfigurationBuilder

Parameters

configurationBuilder

IConfigurationBuilder

The IConfigurationBuilder to add to.

vaultUri

Uri

The Azure Key Vault uri.

credential

TokenCredential

The credential to use for authentication.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

AddAzureKeyVault(IConfigurationBuilder, Uri, TokenCredential, AzureKeyVaultConfigurationOptions)

Source:

AzureKeyVaultConfigurationExtensions.cs

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

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);

static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * Uri * Azure.Core.TokenCredential * Azure.Extensions.AspNetCore.Configuration.Secrets.AzureKeyVaultConfigurationOptions -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vaultUri As Uri, credential As TokenCredential, options As AzureKeyVaultConfigurationOptions) As IConfigurationBuilder

Parameters

configurationBuilder

IConfigurationBuilder

The IConfigurationBuilder to add to.

vaultUri

Uri

Azure Key Vault uri.

credential

TokenCredential

The credential to use for authentication.

options

AzureKeyVaultConfigurationOptions

The AzureKeyVaultConfigurationOptions to use.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

AddAzureKeyVault(IConfigurationBuilder, Uri, TokenCredential, KeyVaultSecretManager)

Source:

AzureKeyVaultConfigurationExtensions.cs

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

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);

static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * Uri * Azure.Core.TokenCredential * Azure.Extensions.AspNetCore.Configuration.Secrets.KeyVaultSecretManager -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vaultUri As Uri, credential As TokenCredential, manager As KeyVaultSecretManager) As IConfigurationBuilder

Parameters

configurationBuilder

IConfigurationBuilder

The IConfigurationBuilder to add to.

vaultUri

Uri

Azure Key Vault uri.

credential

TokenCredential

The credential to use for authentication.

manager

KeyVaultSecretManager

The KeyVaultSecretManager instance used to control secret loading.

Returns

IConfigurationBuilder

The IConfigurationBuilder.