KeyVaultSecretProvider Class

Retrieves secrets from Azure Key Vault, failing over to ordinary configuration if not found.

Inheritance Hierarchy

SystemObject
InnerDrive.AzureKeyVaultSecretProvider

Namespace: InnerDrive.Azure
Assembly: InnerDrive.Azure (in InnerDrive.Azure.dll) Version: 5.0.8475.0

Syntax

public class KeyVaultSecretProvider : ISecretProvider

The KeyVaultSecretProvider type exposes the following members.

Constructors

	Name	Description
	KeyVaultSecretProvider	Creates a new instance of KeyVaultSecretProvider

Properties

	Name	Description
	Configuration	Gets the IConfiguration provider used by this class.
	Item	Gets or sets a secret configuration value
	KeyVaultTenantId	Gets the Azure tenant ID to use connecting to the Azure Key Vault identified by KeyVaultUrl
	KeyVaultUrl	Allows classes to get configuration settings from secrets providers, such as Azure Key Vault.
	ThrowOnFailure	Allows classes to get configuration settings from secrets providers, such as Azure Key Vault.
	TraceKeyVaultActivity	If true, turns on tracing in the DefaultAzureCredentialOptions used to connect to Azure Key Vault.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetSecretAsync	Gets a secret configuration value
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	SetSecretAsync	Gets a secret configuration value
	ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

	Name	Description
	CacheExpirationSetting	The Configuration setting containing the length of time in seconds to hold a secret in the internal cache
	DefaultCacheExpirationSeconds	The length of time in seconds to hold a secret in the internal cache if CacheExpirationSetting is not set
	KeyVaultTenantIdSettingName	Gets the name of the Azure Key Vault Tenant ID setting in appSettings.config
	KeyVaultUrlSettingName	Gets the name of the Azure Key Vault URL setting in appSettings.config
	ThrowExceptionsSettingName	The name of the appSettings.config setting that, if true, will cause the KeyVaultSecretProvider to throw exceptions instead of failing silently.
	TraceKeyVaultSettingName	The name of the appSettings.config setting that, if true, will turn on tracing in the DefaultAzureCredentialOptions used to connect to Azure Key Vault.

Remarks

The KeyVaultSecretProvider expects the following settings:

Setting	Purpose
keyVaultTenantId	The Azure tenant ID to use by default
keyVaultUrl	The Azure Key Vault URL to use by default
keyVaultSecretProviderThrowExceptions	If true, the class will throw exceptions on all failures. Default is false. Use only for debugging.
keyVaultSecretProviderTrace	If true, this will turn on native Key Vault tracing. Default is false.