Installation
Defaults
By default, theSecretClient
instance is resolved from service provider. AzureKeyVaultSecretsHealthCheckOptions
by default uses “AzureKeyVaultSecretsHealthCheck” secret name and does not try to create the secret when it’s not found.
Customization
You can additionally add the following parameters:clientFactory
: A factory method to provideSecretClient
instance.optionsFactory
: A factory method to provideAzureKeyVaultSecretsHealthCheckOptions
instance. It allows to specify the secret name and whether the secret should be created when it’s not found.name
: The health check name. The default isazure_key_vault_secret
.failureStatus
: TheHealthStatus
that should be reported when the health check fails. Default isHealthStatus.Unhealthy
.tags
: A list of tags that can be used to filter sets of health checks.timeout
: ASystem.TimeSpan
representing the timeout of the check.
Performance
When the secret is not found, the secret client throwsRequestFailedException
. The health check catches it, but it’s expensive in terms of performance.
That is why it’s recommended to create the secret before using the health check. It can be done by using AzureKeyVaultSecretsHealthCheckOptions.CreateWhenNotFound
, but it requires secret set permissions. Such permissions should not be assigned just for the purpose of using this health check!
For more information about credentials types please see Azure TokenCredentials