AzureKeyVaultConfigurationExtensions.AddAzureKeyVault Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
AddAzureKeyVault(IConfigurationBuilder, AzureKeyVaultConfigurationOptions)
Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddAzureKeyVault(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, Microsoft::Extensions::Configuration::AzureKeyVault::AzureKeyVaultConfigurationOptions ^ options);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, Microsoft.Extensions.Configuration.AzureKeyVault.AzureKeyVaultConfigurationOptions options);static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * Microsoft.Extensions.Configuration.AzureKeyVault.AzureKeyVaultConfigurationOptions -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, options As AzureKeyVaultConfigurationOptions) As IConfigurationBuilderParameters
- configurationBuilder
- IConfigurationBuilder
The IConfigurationBuilder to add to.
The AzureKeyVaultConfigurationOptions to use.
Returns
Applies to
AddAzureKeyVault(IConfigurationBuilder, String)
Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddAzureKeyVault(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, System::String ^ vault);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string vault);static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * string -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vault As String) As IConfigurationBuilderParameters
- configurationBuilder
- IConfigurationBuilder
The IConfigurationBuilder to add to.
- vault
- String
Azure KeyVault uri.
Returns
Applies to
AddAzureKeyVault(IConfigurationBuilder, String, IKeyVaultSecretManager)
Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddAzureKeyVault(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, System::String ^ vault, Microsoft::Extensions::Configuration::AzureKeyVault::IKeyVaultSecretManager ^ manager);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string vault, Microsoft.Extensions.Configuration.AzureKeyVault.IKeyVaultSecretManager manager);static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * Microsoft.Extensions.Configuration.AzureKeyVault.IKeyVaultSecretManager -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vault As String, manager As IKeyVaultSecretManager) As IConfigurationBuilderParameters
- configurationBuilder
- IConfigurationBuilder
The IConfigurationBuilder to add to.
- vault
- String
Azure KeyVault uri.
- manager
- IKeyVaultSecretManager
The IKeyVaultSecretManager instance used to control secret loading.
Returns
Applies to
AddAzureKeyVault(IConfigurationBuilder, String, KeyVaultClient, IKeyVaultSecretManager)
Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddAzureKeyVault(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, System::String ^ vault, Microsoft::Azure::KeyVault::KeyVaultClient ^ client, Microsoft::Extensions::Configuration::AzureKeyVault::IKeyVaultSecretManager ^ manager);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string vault, Microsoft.Azure.KeyVault.KeyVaultClient client, Microsoft.Extensions.Configuration.AzureKeyVault.IKeyVaultSecretManager manager);static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * Microsoft.Azure.KeyVault.KeyVaultClient * Microsoft.Extensions.Configuration.AzureKeyVault.IKeyVaultSecretManager -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vault As String, client As KeyVaultClient, manager As IKeyVaultSecretManager) As IConfigurationBuilderParameters
- configurationBuilder
- IConfigurationBuilder
The IConfigurationBuilder to add to.
- vault
- String
Azure KeyVault uri.
- client
- KeyVaultClient
The KeyVaultClient to use for retrieving values.
- manager
- IKeyVaultSecretManager
The IKeyVaultSecretManager instance used to control secret loading.
Returns
Applies to
AddAzureKeyVault(IConfigurationBuilder, String, String, X509Certificate2)
Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddAzureKeyVault(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, System::String ^ vault, System::String ^ clientId, System::Security::Cryptography::X509Certificates::X509Certificate2 ^ certificate);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string vault, string clientId, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate);static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * string * System.Security.Cryptography.X509Certificates.X509Certificate2 -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vault As String, clientId As String, certificate As X509Certificate2) As IConfigurationBuilderParameters
- configurationBuilder
- IConfigurationBuilder
The IConfigurationBuilder to add to.
- vault
- String
Azure KeyVault uri.
- clientId
- String
The application client id.
- certificate
- X509Certificate2
The X509Certificate2 to use for authentication.
Returns
Applies to
AddAzureKeyVault(IConfigurationBuilder, String, String, String)
Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddAzureKeyVault(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, System::String ^ vault, System::String ^ clientId, System::String ^ clientSecret);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string vault, string clientId, string clientSecret);static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * string * string -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vault As String, clientId As String, clientSecret As String) As IConfigurationBuilderParameters
- configurationBuilder
- IConfigurationBuilder
The IConfigurationBuilder to add to.
- vault
- String
The Azure KeyVault uri.
- clientId
- String
The application client id.
- clientSecret
- String
The client secret to use for authentication.
Returns
Applies to
AddAzureKeyVault(IConfigurationBuilder, String, String, X509Certificate2, IKeyVaultSecretManager)
Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddAzureKeyVault(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, System::String ^ vault, System::String ^ clientId, System::Security::Cryptography::X509Certificates::X509Certificate2 ^ certificate, Microsoft::Extensions::Configuration::AzureKeyVault::IKeyVaultSecretManager ^ manager);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string vault, string clientId, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate, Microsoft.Extensions.Configuration.AzureKeyVault.IKeyVaultSecretManager manager);static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * string * System.Security.Cryptography.X509Certificates.X509Certificate2 * Microsoft.Extensions.Configuration.AzureKeyVault.IKeyVaultSecretManager -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vault As String, clientId As String, certificate As X509Certificate2, manager As IKeyVaultSecretManager) As IConfigurationBuilderParameters
- configurationBuilder
- IConfigurationBuilder
The IConfigurationBuilder to add to.
- vault
- String
Azure KeyVault uri.
- clientId
- String
The application client id.
- certificate
- X509Certificate2
The X509Certificate2 to use for authentication.
- manager
- IKeyVaultSecretManager
The IKeyVaultSecretManager instance used to control secret loading.
Returns
Applies to
AddAzureKeyVault(IConfigurationBuilder, String, String, String, IKeyVaultSecretManager)
Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddAzureKeyVault(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, System::String ^ vault, System::String ^ clientId, System::String ^ clientSecret, Microsoft::Extensions::Configuration::AzureKeyVault::IKeyVaultSecretManager ^ manager);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddAzureKeyVault (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string vault, string clientId, string clientSecret, Microsoft.Extensions.Configuration.AzureKeyVault.IKeyVaultSecretManager manager);static member AddAzureKeyVault : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * string * string * Microsoft.Extensions.Configuration.AzureKeyVault.IKeyVaultSecretManager -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddAzureKeyVault (configurationBuilder As IConfigurationBuilder, vault As String, clientId As String, clientSecret As String, manager As IKeyVaultSecretManager) As IConfigurationBuilderParameters
- configurationBuilder
- IConfigurationBuilder
The IConfigurationBuilder to add to.
- vault
- String
The Azure KeyVault uri.
- clientId
- String
The application client id.
- clientSecret
- String
The client secret to use for authentication.
- manager
- IKeyVaultSecretManager
The IKeyVaultSecretManager instance used to control secret loading.
Returns
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for