Spring Cloud Configuration Server - Spring Cloud Azure KeyVault

Spring Cloud Configuration Server is able to use Microsoft Azure’s KeyVault Secrets to locate properties and settings. Support is provided via the following dependency in the WAR overlay:

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-configuration-cloud-azure-keyvault</artifactId>
    <version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-configuration-cloud-azure-keyvault:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-configuration-cloud-azure-keyvault"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
    /*
        The following platform references should be included automatically and are listed here for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-configuration-cloud-azure-keyvault"
}

IMPORTANT: The allowed name pattern in Azure Key Vault is ^[0-9a-zA-Z-]+$. For properties that contain that contain . in the name (i.e. cas.some.property), replace . with - when you store the setting in Azure Key Vault (i.e. cas-some-property). The module will handle the transformation for you.

:information_source: Usage

The configuration modules provided here may also be used verbatim inside a CAS server overlay and do not exclusively belong to a Spring Cloud Configuration server. While this module is primarily useful when inside the Spring Cloud Configuration server, it nonetheless may also be used inside a CAS server overlay directly to fetch settings from a source.

The following settings and properties are available from the CAS configuration catalog:

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.

  • spring.cloud.azure.keyvault.secret.challenge-resource-verification-enabled=true
  • Whether to enable the Azure Key Vault challenge resource verification, default: true. Calls the disableChallengeResourceVerification method of the Azure Key Vault Client Builder when set to false.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultSecretProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.application-id=
  • Represents current application and is used for telemetry/monitoring purposes.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.connect-timeout=
  • Amount of time(Duration) the request attempts to connect to the remote host and the connection is resolved.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.connection-idle-timeout=
  • Amount of time(Duration) before an idle connection.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.headers=
  • List of headers applied to each request sent with client. For instance, '"myCustomHeader", "myStaticValue"'.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.headers[0].name=
  • The name of the header.

    com.azure.spring.cloud.core.properties.client.HeaderProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.headers[0].values=
  • List of values of the header.

    com.azure.spring.cloud.core.properties.client.HeaderProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.logging.allowed-header-names=
  • Comma-delimited list of allowlist headers that should be logged. The default value is `"x-ms-request-id","x-ms-client-request-id","x-ms-return-client-request-id","traceparent","MS-CV","Accept","Cache-Control","Connection","Content-Length","Content-Type","Date","ETag","Expires","If-Match","If-Modified-Since","If-None-Match","If-Unmodified-Since","Last-Modified","Pragma","Request-Id","Retry-After","Server","Transfer-Encoding","User-Agent","WWW-Authenticate"`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpLoggingConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.logging.allowed-query-param-names=
  • Comma-delimited list of allowlist query parameters. The default value is `"api-version"`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpLoggingConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.logging.level=
  • The level of detail to log on HTTP messages. Supported types are: NONE, BASIC, HEADERS, BODY, BODY_AND_HEADERS. The default value is `NONE`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpLoggingConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.logging.pretty-print-body=
  • Whether to pretty print the message bodies. The default value is `false`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpLoggingConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.maximum-connection-pool-size=
  • Maximum connection pool size used by the underlying HTTP client.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.read-timeout=
  • Amount of time(Duration) used when reading the server response.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.response-timeout=
  • Amount of time(Duration) used when waiting for a server to reply.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.client.write-timeout=
  • Amount of time(Duration) each request being sent over the wire.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.credential.client-certificate-password=
  • Password of the certificate file.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.credential.client-certificate-path=
  • Path of a PEM certificate file to use when performing service principal authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.credential.client-id=
  • Client ID to use when performing service principal authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.credential.client-secret=
  • Client secret to use when performing service principal authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.credential.managed-identity-enabled=false
  • Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client ID as user assigned managed identity client ID.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.credential.password=
  • Password to use when performing username/password authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.credential.username=
  • Username to use when performing username/password authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.enabled=true
  • Whether an Azure Service is enabled.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultSecretProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.endpoint=
  • Azure Key Vault endpoint. For instance, 'https://{your-unique-keyvault-name}.vault.azure.net/'.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultSecretProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.cloud-type=
  • Name of the Azure cloud to connect to. Supported types are: AZURE, AZURE_CHINA, AZURE_US_GOVERNMENT, OTHER. The default value is `AZURE`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.active-directory-endpoint=
  • The Azure Active Directory endpoint to connect to.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.active-directory-graph-api-version=
  • The Azure Active Directory Graph API version.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.active-directory-graph-endpoint=
  • The Azure Active Directory Graph endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.active-directory-resource-id=
  • The Azure Active Directory resource ID.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.azure-application-insights-endpoint=
  • The Azure Application Insights endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix=
  • The Data Lake analytics catalog and job endpoint suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.azure-data-lake-store-file-system-endpoint-suffix=
  • The Data Lake storage file system endpoint suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.azure-log-analytics-endpoint=
  • The Azure Log Analytics endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.data-lake-endpoint-resource-id=
  • The Data Lake endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.gallery-endpoint=
  • The gallery endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.key-vault-dns-suffix=
  • The Key Vault DNS suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.management-endpoint=
  • The management service endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.microsoft-graph-endpoint=
  • The Microsoft Graph endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.portal=
  • The management portal URL.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.publishing-profile=
  • The publishing settings file URL.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.resource-manager-endpoint=
  • The resource management endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.service-bus-domain-name=
  • The domain name for Service Bus.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.sql-management-endpoint=
  • The SQL management endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.sql-server-hostname-suffix=
  • The SQL Server hostname suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.environment.storage-endpoint-suffix=
  • The Storage endpoint suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.subscription-id=
  • Subscription ID to use when connecting to Azure resources.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.profile.tenant-id=
  • Tenant ID for Azure resources.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-source-enabled=true
  • Whether to enable the Key Vault property source.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultSecretProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources=
  • List of Azure Key Vault property sources. For instance, ' property-sources[0].name=key-vault-property-source-1, property-sources[0].endpoint={ENDPOINT_1}, property-sources[1].name=key-vault-property-source-2, property-sources[1].endpoint={ENDPOINT_2} '.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultSecretProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].case-sensitive=
  • Whether to enable case-sensitive for secret keys. The default value is `false`.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultPropertySourceProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].challenge-resource-verification-enabled=true
  • Whether to enable the Azure Key Vault challenge resource verification, default: true. Calls the disableChallengeResourceVerification method of the Azure Key Vault Client Builder when set to false.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultPropertySourceProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.application-id=
  • Represents current application and is used for telemetry/monitoring purposes.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.ClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.connect-timeout=
  • Amount of time(Duration) the request attempts to connect to the remote host and the connection is resolved.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.connection-idle-timeout=
  • Amount of time(Duration) before an idle connection.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].name=
  • The name of the header.

    com.azure.spring.cloud.core.properties.client.HeaderProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].values=
  • List of values of the header.

    com.azure.spring.cloud.core.properties.client.HeaderProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-header-names=
  • Comma-delimited list of allowlist headers that should be logged. The default value is `'x-ms-request-id','x-ms-client-request-id','x-ms-return-client-request-id','traceparent','MS-CV','Accept','Cache-Control','Connection','Content-Length','Content-Type','Date','ETag','Expires','If-Match','If-Modified-Since','If-None-Match','If-Unmodified-Since','Last-Modified','Pragma','Request-Id','Retry-After','Server','Transfer-Encoding','User-Agent','WWW-Authenticate'`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpLoggingConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-query-param-names=
  • Comma-delimited list of allowlist query parameters. The default value is `'api-version'`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpLoggingConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.level=
  • The level of detail to log on HTTP messages. Supported types are: NONE, BASIC, HEADERS, BODY, BODY_AND_HEADERS. The default value is `NONE`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpLoggingConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.pretty-print-body=
  • Whether to pretty print the message bodies. The default value is `false`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpLoggingConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.maximum-connection-pool-size=
  • Maximum connection pool size used by the underlying HTTP client.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.read-timeout=
  • Amount of time(Duration) used when reading the server response.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.response-timeout=
  • Amount of time(Duration) used when waiting for a server to reply.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].client.write-timeout=
  • Amount of time(Duration) each request being sent over the wire.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.client.HttpClientConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-certificate-password=
  • Password of the certificate file.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-certificate-path=
  • Path of a PEM certificate file to use when performing service principal authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-id=
  • Client ID to use when performing service principal authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-secret=
  • Client secret to use when performing service principal authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].credential.managed-identity-enabled=false
  • Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client ID as user assigned managed identity client ID.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].credential.password=
  • Password to use when performing username/password authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].credential.username=
  • Username to use when performing username/password authentication with Azure.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.authentication.TokenCredentialConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].enabled=true
  • Whether an Azure Service is enabled.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.AbstractAzureServiceConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].endpoint=
  • Azure Key Vault endpoint. For instance, 'https://{your-unique-keyvault-name}.vault.azure.net/'.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultPropertySourceProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].name=
  • Name of this property source.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultPropertySourceProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.cloud-type=
  • Name of the Azure cloud to connect to. Supported types are: AZURE, AZURE_CHINA, AZURE_US_GOVERNMENT, OTHER. The default value is `AZURE`.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-endpoint=
  • The Microsoft Entra endpoint to connect to.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-api-version=
  • The Azure Active Directory Graph API version.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-endpoint=
  • The Azure Active Directory Graph endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-resource-id=
  • The Microsoft Entra resource ID.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-application-insights-endpoint=
  • The Azure Application Insights endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix=
  • The Data Lake analytics catalog and job endpoint suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-data-lake-store-file-system-endpoint-suffix=
  • The Data Lake storage file system endpoint suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-log-analytics-endpoint=
  • The Azure Log Analytics endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.data-lake-endpoint-resource-id=
  • The Data Lake endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.gallery-endpoint=
  • The gallery endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.key-vault-dns-suffix=
  • The Key Vault DNS suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.management-endpoint=
  • The management service endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.microsoft-graph-endpoint=
  • The Microsoft Graph endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.portal=
  • The management portal URL.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.publishing-profile=
  • The publishing settings file URL.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.resource-manager-endpoint=
  • The resource management endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-management-endpoint=
  • The SQL management endpoint.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-server-hostname-suffix=
  • The SQL Server hostname suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.storage-endpoint-suffix=
  • The Storage endpoint suffix.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties$AzureEnvironmentConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.subscription-id=
  • Subscription ID to use when connecting to Azure resources.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].profile.tenant-id=
  • Tenant ID for Azure resources.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].proxy.hostname=
  • The host of the proxy.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.ProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].proxy.non-proxy-hosts=
  • A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.HttpProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].proxy.password=
  • Password used to authenticate with the proxy.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.ProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].proxy.port=
  • The port of the proxy.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.ProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].proxy.type=
  • Type of the proxy. For instance of http, 'http', 'socks4', 'socks5'. For instance of amqp, 'http', 'socks'.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.ProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].proxy.username=
  • Username used to authenticate with the proxy.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.ProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].resource.region=
  • The region of an Azure resource. For instance, '"eastus"'.

    com.azure.spring.cloud.autoconfigure.implementation.properties.resourcemanager.AzureResourceMetadataConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-group=
  • The resource group holds an Azure resource.

    com.azure.spring.cloud.autoconfigure.implementation.properties.resourcemanager.AzureResourceMetadataConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-id=
  • ID of an Azure resource.

    com.azure.spring.cloud.autoconfigure.implementation.properties.resourcemanager.AzureResourceMetadataConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.base-delay=
  • Amount of time(Duration) to wait between retry attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.ExponentialRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-delay=
  • Maximum permissible amount of time(duration) between retry attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.ExponentialRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-retries=
  • The maximum number of attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.ExponentialRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.delay=
  • Amount of time(Duration) to wait between retry attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.FixedRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.max-retries=
  • The maximum number of attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.FixedRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].retry.mode=
  • The retry backoff mode when retrying. Supported types are: FIXED, EXPONENTIAL.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.RetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].secret-keys=
  • The configured secret keys will be loaded from Azure Key Vaults secret, if configured nothing, then load all the secrets. Only support exact value for secret names, For example, if you configured secret key name `SecretKey1` in Key Vaults secret, you should configure 'SecretKey1' here.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultPropertySourceProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.property-sources[0].service-version=
  • Secret service version used when making API requests.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultPropertySourceProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.proxy.hostname=
  • The host of the proxy.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.HttpProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.proxy.non-proxy-hosts=
  • A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.HttpProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.proxy.password=
  • Password used to authenticate with the proxy.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.HttpProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.proxy.port=
  • The port of the proxy.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.HttpProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.proxy.type=
  • Type of the proxy. For instance of http, 'http', 'socks4', 'socks5'. For instance of amqp, 'http', 'socks'.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.HttpProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.proxy.username=
  • Username used to authenticate with the proxy.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.HttpProxyConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.resource.region=
  • The region of an Azure resource. For instance, '"eastus"'.

    com.azure.spring.cloud.autoconfigure.implementation.properties.resourcemanager.AzureResourceMetadataConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.resource.resource-group=
  • The resource group holds an Azure resource.

    com.azure.spring.cloud.autoconfigure.implementation.properties.resourcemanager.AzureResourceMetadataConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.resource.resource-id=
  • ID of an Azure resource.

    com.azure.spring.cloud.autoconfigure.implementation.properties.resourcemanager.AzureResourceMetadataConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.retry.exponential.base-delay=
  • Amount of time(Duration) to wait between retry attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.ExponentialRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.retry.exponential.max-delay=
  • Maximum permissible amount of time(duration) between retry attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.ExponentialRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.retry.exponential.max-retries=
  • The maximum number of attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.ExponentialRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.retry.fixed.delay=
  • Amount of time(Duration) to wait between retry attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.FixedRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.retry.fixed.max-retries=
  • The maximum number of attempts.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.FixedRetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.retry.mode=
  • The retry backoff mode when retrying. Supported types are: FIXED, EXPONENTIAL.

    com.azure.spring.cloud.autoconfigure.implementation.properties.core.retry.RetryConfigurationProperties.

    How can I configure this property?

  • spring.cloud.azure.keyvault.secret.service-version=
  • Secret service version used when making API requests.

    com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultSecretProperties.

    How can I configure this property?

    Configuration Metadata

    The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

    Be Selective

    This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

    YAGNI

    Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

    Naming Convention

    Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

    :information_source: Note

    When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

    Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

    Validation

    Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

    Indexed Settings

    CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.