Appendix A: Configuration Properties
Global Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.client-id |
Client id to use when performing service principal authentication with Azure. This is a legacy property. |
|
spring.cloud.azure.client-secret |
Client secret to use when performing service principal authentication with Azure. This is a legacy property. |
|
spring.cloud.azure.client.amqp.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.client.http.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.client.http.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.client.http.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.client.http.headers[0].name |
The name of the header. |
|
spring.cloud.azure.client.http.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.client.http.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.client.http.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.client.http.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.client.http.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.client.http.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.client.http.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.client.http.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.client.http.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.proxy.amqp.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.proxy.http.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.retry.amqp.try-timeout |
How long to wait until a timeout. |
|
spring.cloud.azure.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.retry.mode |
Retry backoff mode. |
Azure Active Directory Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.active-directory.app-id-uri |
App ID URI which might be used in the "aud" claim of an id_token. |
|
spring.cloud.azure.active-directory.application-type |
Type of the AAD application. |
|
spring.cloud.azure.active-directory.authenticate-additional-parameters |
Add additional parameters to the Authorization URL. |
|
spring.cloud.azure.active-directory.authorization-clients |
The OAuth2 authorization clients. |
|
spring.cloud.azure.active-directory.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.active-directory.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.active-directory.enabled |
|
Whether to enable Azure Active Directory related auto-configuration. |
spring.cloud.azure.active-directory.jwk-set-cache-lifespan |
|
The lifespan of the cached JWK set before it expires, default is 5 minutes. |
spring.cloud.azure.active-directory.jwk-set-cache-refresh-time |
|
The refresh time of the cached JWK set before it expires, default is 5 minutes. |
spring.cloud.azure.active-directory.jwt-connect-timeout |
Connection Timeout for the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.jwt-read-timeout |
Read Timeout for the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.jwt-size-limit |
Size limit in Bytes of the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.post-logout-redirect-uri |
The redirect uri after logout. |
|
spring.cloud.azure.active-directory.profile.cloud-type |
Name of the Azure cloud to connect to. Supported types are: AZURE, AZURE_CHINA, AZURE_GERMANY, AZURE_US_GOVERNMENT, OTHER. |
|
spring.cloud.azure.active-directory.profile.environment.active-directory-endpoint |
Azure Active Directory endpoint. For example: https://login.microsoftonline.com/ |
|
spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint |
Microsoft Graph endpoint. For example: https://graph.microsoft.com/ |
|
spring.cloud.azure.active-directory.profile.tenant-id |
Azure Tenant ID. |
|
spring.cloud.azure.active-directory.redirect-uri-template |
|
Redirection Endpoint: Used by the authorization server to return responses containing authorization credentials to the client via the resource owner user-agent. |
spring.cloud.azure.active-directory.resource-server.claim-to-authority-prefix-map |
Configure which claim will be used to build GrantedAuthority, and prefix of the GrantedAuthority’s string value. Default value is: "scp" → "SCOPE_", "roles" → "APPROLE_". |
|
spring.cloud.azure.active-directory.resource-server.principal-claim-name |
Configure which claim in access token be returned in AuthenticatedPrincipal#getName. Default value is "sub". |
|
spring.cloud.azure.active-directory.session-stateless |
|
If true activates the stateless auth filter AADAppRoleStatelessAuthenticationFilter. The default is false which activates AADAuthenticationFilter. |
spring.cloud.azure.active-directory.user-group.allowed-group-ids |
The group ids can be used to construct GrantedAuthority. |
|
spring.cloud.azure.active-directory.user-group.allowed-group-names |
The group names can be used to construct GrantedAuthority. |
|
spring.cloud.azure.active-directory.user-group.use-transitive-members |
|
If "true", use "v1.0/me/transitiveMemberOf" to get members. Otherwise, use "v1.0/me/memberOf". |
spring.cloud.azure.active-directory.user-name-attribute |
Decide which claim to be principal’s name. |
Azure Active Directory B2C Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.active-directory.b2c.app-id-uri |
App ID URI which might be used in the "aud" claim of a token. |
|
spring.cloud.azure.active-directory.b2c.authenticate-additional-parameters |
Additional parameters for authentication. |
|
spring.cloud.azure.active-directory.b2c.authorization-clients |
Specify client configuration. |
|
spring.cloud.azure.active-directory.b2c.base-uri |
AAD B2C endpoint base uri. |
|
spring.cloud.azure.active-directory.b2c.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.active-directory.b2c.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.active-directory.b2c.enabled |
|
Whether to enable Azure Active Directory B2C related auto-configuration. |
spring.cloud.azure.active-directory.b2c.jwt-connect-timeout |
Connection Timeout for the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.b2c.jwt-read-timeout |
Read Timeout for the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.b2c.jwt-size-limit |
Size limit in Bytes of the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.b2c.login-flow |
|
Specify the primary sign-in flow key. |
spring.cloud.azure.active-directory.b2c.logout-success-url |
Redirect url after logout. |
|
spring.cloud.azure.active-directory.b2c.profile.tenant-id |
Azure Tenant ID. |
|
spring.cloud.azure.active-directory.b2c.reply-url |
|
Reply url after get authorization code. |
spring.cloud.azure.active-directory.b2c.user-flows |
User flows. |
|
spring.cloud.azure.active-directory.b2c.user-name-attribute-name |
User name attribute name. |
Azure App Configuration Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.appconfiguration.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.appconfiguration.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.appconfiguration.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.appconfiguration.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.appconfiguration.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.appconfiguration.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.appconfiguration.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.appconfiguration.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.appconfiguration.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.appconfiguration.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.appconfiguration.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.appconfiguration.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.appconfiguration.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.appconfiguration.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.appconfiguration.connection-string |
Connection string of the Azure App Configuration instance. |
|
spring.cloud.azure.appconfiguration.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.appconfiguration.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.appconfiguration.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.appconfiguration.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.appconfiguration.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.appconfiguration.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.appconfiguration.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.appconfiguration.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.appconfiguration.endpoint |
Endpoint of the Azure App Configuration instance. |
|
spring.cloud.azure.appconfiguration.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.appconfiguration.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.appconfiguration.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.appconfiguration.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.appconfiguration.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.appconfiguration.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.appconfiguration.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.appconfiguration.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.appconfiguration.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.appconfiguration.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.appconfiguration.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.appconfiguration.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.appconfiguration.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.appconfiguration.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.appconfiguration.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.appconfiguration.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.appconfiguration.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.appconfiguration.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.appconfiguration.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.appconfiguration.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.appconfiguration.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.appconfiguration.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.appconfiguration.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.appconfiguration.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.appconfiguration.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.appconfiguration.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.appconfiguration.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.appconfiguration.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.appconfiguration.service-version |
Version of the app configuration service to be used when making request. |
Azure Cosmos Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.cosmos.client-telemetry-enabled |
Whether to enable client telemetry which will periodically collect database operations aggregation statistics, system information like cpu/memory and send it to cosmos monitoring service, which will be helpful during debugging. |
|
spring.cloud.azure.cosmos.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.cosmos.connection-mode |
Connection mode to be used by the client in the Azure Cosmos DB database service. |
|
spring.cloud.azure.cosmos.connection-sharing-across-clients-enabled |
Whether to enable connections sharing across multiple Cosmos Clients. |
|
spring.cloud.azure.cosmos.consistency-level |
Consistency level. The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. |
|
spring.cloud.azure.cosmos.content-response-on-write-enabled |
Whether to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations on CosmosItem. If set to false, service doesn’t return payload in the response. |
|
spring.cloud.azure.cosmos.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.cosmos.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.cosmos.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.cosmos.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.cosmos.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.cosmos.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.cosmos.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.cosmos.database |
Database name of the cosmos db. |
|
spring.cloud.azure.cosmos.direct-connection.connect-timeout |
Connect timeout for direct client, represents timeout for establishing connections with an endpoint. |
|
spring.cloud.azure.cosmos.direct-connection.connection-endpoint-rediscovery-enabled |
Whether to enable the direct TCP connection endpoint rediscovery. |
|
spring.cloud.azure.cosmos.direct-connection.idle-connection-timeout |
Idle connection timeout for the direct client. Direct client doesn’t close a single connection to an endpoint by default unless specified. |
|
spring.cloud.azure.cosmos.direct-connection.idle-endpoint-timeout |
Idle endpoint timeout for the direct client. If there are no requests to a specific endpoint for idle endpoint timeout duration, direct client closes all connections to that endpoint to save resources and I/O cost. |
|
spring.cloud.azure.cosmos.direct-connection.max-connections-per-endpoint |
Max connections per endpoint, represents the size of connection pool for a specific endpoint. |
|
spring.cloud.azure.cosmos.direct-connection.max-requests-per-connection |
Max requests per connection, represents the number of requests that will be queued on a single connection for a specific endpoint. |
|
spring.cloud.azure.cosmos.direct-connection.network-request-timeout |
Network request timeout interval (time to wait for response from network peer). |
|
spring.cloud.azure.cosmos.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.cosmos.endpoint |
Endpoint of the cosmos db. |
|
spring.cloud.azure.cosmos.endpoint-discovery-enabled |
Whether to enable endpoint discovery for geo-replicated database accounts. |
|
spring.cloud.azure.cosmos.gateway-connection.idle-connection-timeout |
Timeout for an idle connection. After that time, the connection will be automatically closed. |
|
spring.cloud.azure.cosmos.gateway-connection.max-connection-pool-size |
Size of the connection pool. |
|
spring.cloud.azure.cosmos.key |
Key to authenticate for accessing the cosmos db. |
|
spring.cloud.azure.cosmos.multiple-write-regions-enabled |
Whether to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service. |
|
spring.cloud.azure.cosmos.populate-query-metrics |
|
Whether to populate diagnostics strings and query metrics. |
spring.cloud.azure.cosmos.preferred-regions |
Preferred regions for geo-replicated database accounts. For example, "East US" as the preferred region. |
|
spring.cloud.azure.cosmos.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.cosmos.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.cosmos.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.cosmos.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.cosmos.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.cosmos.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.cosmos.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.cosmos.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.cosmos.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.cosmos.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.cosmos.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.cosmos.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.cosmos.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.cosmos.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.cosmos.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.cosmos.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.cosmos.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.cosmos.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.cosmos.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.cosmos.read-requests-fallback-enabled |
Whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service. |
|
spring.cloud.azure.cosmos.resource-token |
Resource token to authenticate for accessing the cosmos db. |
|
spring.cloud.azure.cosmos.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.cosmos.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.cosmos.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.cosmos.session-capturing-override-enabled |
Whether to enable session capturing. Session capturing is enabled by default for SESSION consistency level. |
|
spring.cloud.azure.cosmos.throttling-retry-options.max-retry-attempts-on-throttled-requests |
Maximum number of retries in the case where the request fails because the service has applied rate limiting on the client. |
|
spring.cloud.azure.cosmos.throttling-retry-options.max-retry-wait-time |
Maximum retry time in seconds. When a request fails due to a throttle error, the service sends back a response that contains a value indicating the client should not retry before the time period has elapsed (Retry-After). The MaxRetryWaitTime flag allows the application to set a maximum wait time for all retry attempts. If the cumulative wait time exceeds the MaxRetryWaitTime, the SDK will stop retrying and return the error to the application. |
Azure Event Hubs Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.eventhubs.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.eventhubs.connection-string |
Connection string to connect to an event hub. |
|
spring.cloud.azure.eventhubs.consumer.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.consumer.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.eventhubs.consumer.connection-string |
Connection string to connect to an event hub. |
|
spring.cloud.azure.eventhubs.consumer.consumer-group |
Name of the consumer group this consumer is associated with. |
|
spring.cloud.azure.eventhubs.consumer.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.consumer.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.consumer.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.custom-endpoint-address |
A custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. For example: https://my.custom.endpoint.com:55300. |
|
spring.cloud.azure.eventhubs.consumer.domain-name |
|
The domain name of an Event Hub namespace. |
spring.cloud.azure.eventhubs.consumer.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.consumer.event-hub-name |
The name of an event hub. |
|
spring.cloud.azure.eventhubs.consumer.namespace |
The namespace of an event hub, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.eventhubs.consumer.prefetch-count |
The number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receiving operation is currently active. |
|
spring.cloud.azure.eventhubs.consumer.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.consumer.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.consumer.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.consumer.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.consumer.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.consumer.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.consumer.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.consumer.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.custom-endpoint-address |
A custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. For example: https://my.custom.endpoint.com:55300. |
|
spring.cloud.azure.eventhubs.domain-name |
|
The domain name of an Event Hub namespace. |
spring.cloud.azure.eventhubs.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.event-hub-name |
The name of an event hub. |
|
spring.cloud.azure.eventhubs.namespace |
The namespace of an event hub, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.eventhubs.processor.batch.max-size |
The maximum number of events that will be in the batch. |
|
spring.cloud.azure.eventhubs.processor.batch.max-wait-time |
The max time duration to wait to receive an event before processing events. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.account-key |
Storage account access key. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.account-name |
Name for the storage account. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.blob-name |
Name of the blob. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.connection-string |
Connection string to connect to the service. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.container-name |
Name of the container. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.create-container-if-not-exists |
|
Whether to create the container if it does not exist. |
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.customer-provided-key |
Customer provided key used to encrypt blob contents on the server. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.processor.checkpoint-store.encryption-scope |
Encryption scope used to encrypt blob contents on the server. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.endpoint |
Endpoint for Azure Storage service. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.secondary-host |
Secondary Storage account to retry requests against. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.sas-token |
Shared access signatures (SAS) token used to authorize requests sent to the service. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.service-version |
Blob service version used when making API requests. |
|
spring.cloud.azure.eventhubs.processor.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.processor.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.eventhubs.processor.connection-string |
Connection string to connect to an event hub. |
|
spring.cloud.azure.eventhubs.processor.consumer-group |
Name of the consumer group this consumer is associated with. |
|
spring.cloud.azure.eventhubs.processor.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.processor.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.processor.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.custom-endpoint-address |
A custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. For example: https://my.custom.endpoint.com:55300. |
|
spring.cloud.azure.eventhubs.processor.domain-name |
|
The domain name of an Event Hub namespace. |
spring.cloud.azure.eventhubs.processor.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.processor.event-hub-name |
The name of an event hub. |
|
spring.cloud.azure.eventhubs.processor.initial-partition-event-position |
Map event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore. |
|
spring.cloud.azure.eventhubs.processor.load-balancing.partition-ownership-expiration-interval |
The time duration after which the ownership of partition expires. |
|
spring.cloud.azure.eventhubs.processor.load-balancing.strategy |
The load balancing strategy for claiming partition ownership. |
|
spring.cloud.azure.eventhubs.processor.load-balancing.update-interval |
The time interval between load balancing update cycles. |
|
spring.cloud.azure.eventhubs.processor.namespace |
The namespace of an event hub, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.eventhubs.processor.prefetch-count |
The number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receiving operation is currently active. |
|
spring.cloud.azure.eventhubs.processor.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.processor.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.processor.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.processor.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.processor.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.processor.track-last-enqueued-event-properties |
Whether request information on the last enqueued event on its associated partition, and track that information as events are received. |
|
spring.cloud.azure.eventhubs.producer.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.producer.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.eventhubs.producer.connection-string |
Connection string to connect to an event hub. |
|
spring.cloud.azure.eventhubs.producer.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.producer.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.producer.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.custom-endpoint-address |
A custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. For example: https://my.custom.endpoint.com:55300. |
|
spring.cloud.azure.eventhubs.producer.domain-name |
|
The domain name of an Event Hub namespace. |
spring.cloud.azure.eventhubs.producer.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.producer.event-hub-name |
The name of an event hub. |
|
spring.cloud.azure.eventhubs.producer.namespace |
The namespace of an event hub, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.eventhubs.producer.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.producer.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.producer.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.producer.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.producer.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.producer.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.producer.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.producer.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.eventhubs.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.resource.name |
Namespace of the event hub. |
|
spring.cloud.azure.eventhubs.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.shared-connection |
Whether to share the same connection for producers or consumers. |
Azure Key Vault Secrets Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.keyvault.secret.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.keyvault.secret.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.keyvault.secret.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.keyvault.secret.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.keyvault.secret.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.keyvault.secret.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.keyvault.secret.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.keyvault.secret.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.keyvault.secret.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.keyvault.secret.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.keyvault.secret.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.keyvault.secret.client.property-sources[0].response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.keyvault.secret.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.keyvault.secret.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.keyvault.secret.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.keyvault.secret.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.keyvault.secret.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.keyvault.secret.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.keyvault.secret.endpoint |
Azure Key Vault endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.keyvault.secret.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.keyvault.secret.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.keyvault.secret.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.keyvault.secret.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
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. |
|
spring.cloud.azure.keyvault.secret.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.keyvault.secret.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.keyvault.secret.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.keyvault.secret.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.keyvault.secret.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.keyvault.secret.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.keyvault.secret.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.keyvault.secret.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.keyvault.secret.property-source-enabled |
|
Whether to enable the Key Vault property source. |
spring.cloud.azure.keyvault.secret.property-sources |
Azure Key Vault property sources. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].case-sensitive |
Defines the constant for the property that enables/disables case-sensitive keys. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-certificate-password |
Password of the certificate file. |
|
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. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.keyvault.secret.property-sources[0].credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.keyvault.secret.property-sources[0].endpoint |
Azure Key Vault endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].name |
Name of this property source. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
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. |
|
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. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.hostname |
The host of the proxy. |
|
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. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.port |
The port of the proxy. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.type |
Type of the proxy. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].secret-keys |
The secret keys supported for this property source. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].service-version |
Secret service version used when making API requests. |
|
spring.cloud.azure.keyvault.secret.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.keyvault.secret.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.keyvault.secret.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.secret.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.keyvault.secret.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.keyvault.secret.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.secret.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.keyvault.secret.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.keyvault.secret.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.keyvault.secret.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.secret.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.keyvault.secret.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.secret.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.secret.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.secret.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.keyvault.secret.service-version |
Secret service version used when making API requests. |
Azure Key Vault Certificates Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.keyvault.certificate.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.keyvault.certificate.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.keyvault.certificate.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.keyvault.certificate.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.keyvault.certificate.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.keyvault.certificate.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.keyvault.certificate.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.keyvault.certificate.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.keyvault.certificate.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.keyvault.certificate.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.keyvault.certificate.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.keyvault.certificate.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.keyvault.certificate.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.keyvault.certificate.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.keyvault.certificate.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.keyvault.certificate.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.keyvault.certificate.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.keyvault.certificate.endpoint |
Azure Key Vault endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.keyvault.certificate.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.keyvault.certificate.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.keyvault.certificate.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.keyvault.certificate.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.certificate.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.keyvault.certificate.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.keyvault.certificate.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.certificate.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.keyvault.certificate.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.keyvault.certificate.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.keyvault.certificate.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.keyvault.certificate.service-version |
The version of Azure Key Vault Certificate Service. |
Azure Service Bus Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.servicebus.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.servicebus.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.servicebus.connection-string |
Connection string to connect to a service bus. |
|
spring.cloud.azure.servicebus.consumer.auto-complete |
|
Whether to enable auto-complete. |
spring.cloud.azure.servicebus.consumer.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.servicebus.consumer.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.servicebus.consumer.connection-string |
Connection string to connect to a service bus. |
|
spring.cloud.azure.servicebus.consumer.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.servicebus.consumer.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.servicebus.consumer.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.domain-name |
|
The domain name of a Service Bus namespace. |
spring.cloud.azure.servicebus.consumer.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.servicebus.consumer.entity-name |
The name of a Service Bus Queue or Topic. |
|
spring.cloud.azure.servicebus.consumer.entity-type |
The type of Service Bus entity, which is a Queue or a Topic. |
|
spring.cloud.azure.servicebus.consumer.max-auto-lock-renew-duration |
Amount of time to continue auto-renewing the lock. |
|
spring.cloud.azure.servicebus.consumer.namespace |
The namespace of a service bus, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.servicebus.consumer.prefetch-count |
Prefetch count of the consumer. |
|
spring.cloud.azure.servicebus.consumer.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.servicebus.consumer.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.servicebus.consumer.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.consumer.receive-mode |
Mode for receiving messages. |
|
spring.cloud.azure.servicebus.consumer.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.servicebus.consumer.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.servicebus.consumer.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.servicebus.consumer.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.servicebus.consumer.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.servicebus.consumer.session-enabled |
Whether to enable session for the consumer. |
|
spring.cloud.azure.servicebus.consumer.sub-queue |
Type of the SubQueue to connect to. |
|
spring.cloud.azure.servicebus.consumer.subscription-name |
Name for a topic subscription. |
|
spring.cloud.azure.servicebus.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.servicebus.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.servicebus.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.cross-entity-transactions |
Whether to enable cross entity transaction on the connection to Service bus. |
|
spring.cloud.azure.servicebus.domain-name |
|
The domain name of a Service Bus namespace. |
spring.cloud.azure.servicebus.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.servicebus.entity-name |
The name of a Service Bus Queue or Topic. |
|
spring.cloud.azure.servicebus.entity-type |
The type of Service Bus entity, which is a Queue or a Topic. |
|
spring.cloud.azure.servicebus.namespace |
The namespace of a service bus, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.servicebus.processor.auto-complete |
|
Whether to enable auto-complete. |
spring.cloud.azure.servicebus.processor.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.servicebus.processor.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.servicebus.processor.connection-string |
Connection string to connect to a service bus. |
|
spring.cloud.azure.servicebus.processor.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.servicebus.processor.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.servicebus.processor.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.domain-name |
|
The domain name of a Service Bus namespace. |
spring.cloud.azure.servicebus.processor.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.servicebus.processor.entity-name |
The name of a Service Bus Queue or Topic. |
|
spring.cloud.azure.servicebus.processor.entity-type |
The type of Service Bus entity, which is a Queue or a Topic. |
|
spring.cloud.azure.servicebus.processor.max-auto-lock-renew-duration |
Amount of time to continue auto-renewing the lock. |
|
spring.cloud.azure.servicebus.processor.max-concurrent-calls |
Max concurrent messages to process. |
|
spring.cloud.azure.servicebus.processor.max-concurrent-sessions |
Maximum number of concurrent sessions to process at any given time. |
|
spring.cloud.azure.servicebus.processor.namespace |
The namespace of a service bus, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.servicebus.processor.prefetch-count |
Prefetch count of the consumer. |
|
spring.cloud.azure.servicebus.processor.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.servicebus.processor.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.servicebus.processor.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.servicebus.processor.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.servicebus.processor.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.servicebus.processor.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.servicebus.processor.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.servicebus.processor.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.servicebus.processor.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.servicebus.processor.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.servicebus.processor.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.servicebus.processor.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.servicebus.processor.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.servicebus.processor.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.processor.receive-mode |
Mode for receiving messages. |
|
spring.cloud.azure.servicebus.processor.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.servicebus.processor.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.servicebus.processor.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.servicebus.processor.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.processor.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.servicebus.processor.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.processor.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.processor.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.processor.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.servicebus.processor.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.servicebus.processor.session-enabled |
Whether to enable session for the consumer. |
|
spring.cloud.azure.servicebus.processor.sub-queue |
Type of the SubQueue to connect to. |
|
spring.cloud.azure.servicebus.processor.subscription-name |
Name for a topic subscription. |
|
spring.cloud.azure.servicebus.producer.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.servicebus.producer.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.servicebus.producer.connection-string |
Connection string to connect to a service bus. |
|
spring.cloud.azure.servicebus.producer.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.servicebus.producer.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.servicebus.producer.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.domain-name |
|
The domain name of a Service Bus namespace. |
spring.cloud.azure.servicebus.producer.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.servicebus.producer.entity-name |
The name of a Service Bus Queue or Topic. |
|
spring.cloud.azure.servicebus.producer.entity-type |
The type of Service Bus entity, which is a Queue or a Topic. |
|
spring.cloud.azure.servicebus.producer.namespace |
The namespace of a service bus, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.servicebus.producer.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.servicebus.producer.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.servicebus.producer.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.servicebus.producer.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.servicebus.producer.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.servicebus.producer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.servicebus.producer.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.servicebus.producer.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.servicebus.producer.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.servicebus.producer.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.servicebus.producer.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.servicebus.producer.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.servicebus.producer.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.servicebus.producer.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.producer.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.servicebus.producer.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.servicebus.producer.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.servicebus.producer.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.producer.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.servicebus.producer.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.producer.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.producer.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.producer.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.servicebus.producer.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.servicebus.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.servicebus.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.servicebus.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.servicebus.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.servicebus.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.servicebus.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.servicebus.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.servicebus.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.servicebus.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.servicebus.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.servicebus.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.servicebus.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.servicebus.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.servicebus.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.servicebus.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.servicebus.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.servicebus.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.servicebus.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.resource.name |
Namespace of the service bus. |
|
spring.cloud.azure.servicebus.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.servicebus.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.servicebus.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.servicebus.retry-options.delay |
Amount of time to wait between retry attempts. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry-options.max-delay |
Maximum permissible amount of time between retry attempts. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry-options.max-retries |
The maximum number of attempts. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry-options.retry-mode |
The type of approach to apply when calculating the delay between retry attempts. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry-options.try-timeout |
Amount of time to wait until a timeout. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.servicebus.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.servicebus.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.servicebus.transport-type |
Transport type for AMQP-based client. This is a legacy property. |
Azure Service Bus JMS Properties
Name | Default | Description |
---|---|---|
spring.jms.servicebus.connection-string |
Connection string to connect to a Service Bus namespace. |
|
spring.jms.servicebus.idle-timeout |
|
Connection idle timeout duration. |
spring.jms.servicebus.listener.phase |
The phase in which this container should be started and stopped. |
|
spring.jms.servicebus.listener.reply-pub-sub-domain |
Whether the reply destination type is topic. Only works for the bean of topicJmsListenerContainerFactory. |
|
spring.jms.servicebus.listener.reply-qos-settings |
The QosSettings to use when sending a reply. |
|
spring.jms.servicebus.listener.subscription-durable |
|
Whether to make the subscription durable. Only works for the bean of topicJmsListenerContainerFactory. |
spring.jms.servicebus.listener.subscription-shared |
Whether to make the subscription shared. Only works for the bean of topicJmsListenerContainerFactory. |
|
spring.jms.servicebus.password |
Login password of the AMQP broker. |
|
spring.jms.servicebus.pool.block-if-full |
Whether to block when a connection is requested and the pool is full. Set it to false to throw a 'JMSException' instead. |
|
spring.jms.servicebus.pool.block-if-full-timeout |
Blocking period before throwing an exception if the pool is still full. |
|
spring.jms.servicebus.pool.enabled |
Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory. |
|
spring.jms.servicebus.pool.idle-timeout |
Connection idle timeout. |
|
spring.jms.servicebus.pool.max-connections |
Maximum number of pooled connections. |
|
spring.jms.servicebus.pool.max-sessions-per-connection |
Maximum number of pooled sessions per connection in the pool. |
|
spring.jms.servicebus.pool.time-between-expiration-check |
Time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs. |
|
spring.jms.servicebus.pool.use-anonymous-producers |
Whether to use only one anonymous 'MessageProducer' instance. Set it to false to create one 'MessageProducer' every time one is required. |
|
spring.jms.servicebus.prefetch-policy.all |
|
Fallback value for prefetch option in this Service Bus namespace. |
spring.jms.servicebus.prefetch-policy.durable-topic-prefetch |
|
The number of prefetch for durable topic. |
spring.jms.servicebus.prefetch-policy.queue-browser-prefetch |
|
The number of prefetch for queue browser. |
spring.jms.servicebus.prefetch-policy.queue-prefetch |
|
The number of prefetch for queue. |
spring.jms.servicebus.prefetch-policy.topic-prefetch |
|
The number of prefetch for topic. |
spring.jms.servicebus.pricing-tier |
Pricing tier for a Service Bus namespace. |
|
spring.jms.servicebus.remote-url |
|
URL of the AMQP broker. Auto-generated by default. |
spring.jms.servicebus.topic-client-id |
Service Bus topic client ID. Only works for the bean of topicJmsListenerContainerFactory. |
|
spring.jms.servicebus.username |
Login user of the AMQP broker. |
Azure Storage Blob Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.storage.blob.account-key |
Storage account access key. |
|
spring.cloud.azure.storage.blob.account-name |
Name for the storage account. |
|
spring.cloud.azure.storage.blob.blob-name |
Name of the blob. |
|
spring.cloud.azure.storage.blob.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.storage.blob.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.storage.blob.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.storage.blob.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.storage.blob.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.storage.blob.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.storage.blob.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.storage.blob.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.storage.blob.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.storage.blob.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.storage.blob.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.storage.blob.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.storage.blob.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.storage.blob.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.storage.blob.connection-string |
Connection string to connect to the service. |
|
spring.cloud.azure.storage.blob.container-name |
Name of the container. |
|
spring.cloud.azure.storage.blob.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.storage.blob.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.blob.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.blob.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.blob.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.storage.blob.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.blob.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.blob.customer-provided-key |
Customer provided key used to encrypt blob contents on the server. |
|
spring.cloud.azure.storage.blob.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.storage.blob.encryption-scope |
Encryption scope used to encrypt blob contents on the server. |
|
spring.cloud.azure.storage.blob.endpoint |
Endpoint for Azure Storage service. |
|
spring.cloud.azure.storage.blob.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.storage.blob.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.storage.blob.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.storage.blob.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.storage.blob.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.storage.blob.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.storage.blob.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.storage.blob.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.storage.blob.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.storage.blob.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.storage.blob.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.storage.blob.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.storage.blob.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.storage.blob.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.storage.blob.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.storage.blob.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.storage.blob.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.storage.blob.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.storage.blob.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.storage.blob.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.storage.blob.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.storage.blob.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.storage.blob.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.blob.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.storage.blob.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.blob.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.blob.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.blob.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.storage.blob.retry.secondary-host |
Secondary Storage account to retry requests against. |
|
spring.cloud.azure.storage.blob.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.storage.blob.sas-token |
Shared access signatures (SAS) token used to authorize requests sent to the service. |
|
spring.cloud.azure.storage.blob.service-version |
Blob service version used when making API requests. |
Azure Storage File Share Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.storage.fileshare.account-key |
Storage account access key. |
|
spring.cloud.azure.storage.fileshare.account-name |
Name for the storage account. |
|
spring.cloud.azure.storage.fileshare.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.storage.fileshare.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.storage.fileshare.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.storage.fileshare.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.storage.fileshare.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.storage.fileshare.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.storage.fileshare.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.storage.fileshare.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.storage.fileshare.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.storage.fileshare.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.storage.fileshare.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.storage.fileshare.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.storage.fileshare.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.storage.fileshare.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.storage.fileshare.connection-string |
Connection string to connect to the service. |
|
spring.cloud.azure.storage.fileshare.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.storage.fileshare.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.storage.fileshare.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.directory-path |
Path to the directory. For instance, 'directory1/directory2'. |
|
spring.cloud.azure.storage.fileshare.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.storage.fileshare.endpoint |
Endpoint for Azure Storage service. |
|
spring.cloud.azure.storage.fileshare.file-path |
Path to the file. For instance, 'directory1/file1'. |
|
spring.cloud.azure.storage.fileshare.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.storage.fileshare.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.storage.fileshare.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.storage.fileshare.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.storage.fileshare.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.storage.fileshare.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.storage.fileshare.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.storage.fileshare.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.storage.fileshare.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.storage.fileshare.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.storage.fileshare.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.storage.fileshare.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.storage.fileshare.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.storage.fileshare.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.storage.fileshare.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.storage.fileshare.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.storage.fileshare.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.storage.fileshare.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.storage.fileshare.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.storage.fileshare.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.storage.fileshare.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.storage.fileshare.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.storage.fileshare.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.fileshare.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.storage.fileshare.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.fileshare.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.fileshare.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.fileshare.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.storage.fileshare.retry.secondary-host |
Secondary Storage account to retry requests against. |
|
spring.cloud.azure.storage.fileshare.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.storage.fileshare.sas-token |
Shared access signatures (SAS) token used to authorize requests sent to the service. |
|
spring.cloud.azure.storage.fileshare.service-version |
Share service version used when making API requests |
|
spring.cloud.azure.storage.fileshare.share-name |
Name of the share. |
Azure Storage Queue Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.storage.queue.account-key |
Storage account access key. |
|
spring.cloud.azure.storage.queue.account-name |
Name for the storage account. |
|
spring.cloud.azure.storage.queue.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.storage.queue.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.storage.queue.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.storage.queue.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.storage.queue.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.storage.queue.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.storage.queue.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.storage.queue.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.storage.queue.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.storage.queue.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.storage.queue.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.storage.queue.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.storage.queue.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.storage.queue.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.storage.queue.connection-string |
Connection string to connect to the service. |
|
spring.cloud.azure.storage.queue.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.storage.queue.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.queue.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.queue.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.queue.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.storage.queue.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.queue.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.queue.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.storage.queue.endpoint |
Endpoint for Azure Storage service. |
|
spring.cloud.azure.storage.queue.message-encoding |
How queue message body is represented in HTTP requests and responses. |
|
spring.cloud.azure.storage.queue.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.storage.queue.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.storage.queue.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.storage.queue.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.storage.queue.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.storage.queue.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.storage.queue.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.storage.queue.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.storage.queue.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.storage.queue.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.storage.queue.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.storage.queue.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.storage.queue.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.storage.queue.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.storage.queue.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.storage.queue.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.storage.queue.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.storage.queue.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.storage.queue.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.storage.queue.queue-name |
Name of the storage queue. |
|
spring.cloud.azure.storage.queue.resource.name |
Name of the storage account. |
|
spring.cloud.azure.storage.queue.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.storage.queue.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.storage.queue.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.storage.queue.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.queue.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.storage.queue.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.queue.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.queue.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.queue.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.storage.queue.retry.secondary-host |
Secondary Storage account to retry requests against. |
|
spring.cloud.azure.storage.queue.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.storage.queue.sas-token |
Shared access signatures (SAS) token used to authorize requests sent to the service. |
|
spring.cloud.azure.storage.queue.service-version |
Queue service version used when making API requests. |
All Configuration Properties
Name | Default | Description |
---|---|---|
spring.cloud.azure.active-directory.app-id-uri |
App ID URI which might be used in the "aud" claim of an id_token. |
|
spring.cloud.azure.active-directory.application-type |
Type of the AAD application. |
|
spring.cloud.azure.active-directory.authenticate-additional-parameters |
Add additional parameters to the Authorization URL. |
|
spring.cloud.azure.active-directory.authorization-clients |
The OAuth2 authorization clients. |
|
spring.cloud.azure.active-directory.b2c.app-id-uri |
App ID URI which might be used in the "aud" claim of a token. |
|
spring.cloud.azure.active-directory.b2c.authenticate-additional-parameters |
Additional parameters for authentication. |
|
spring.cloud.azure.active-directory.b2c.authorization-clients |
Specify client configuration. |
|
spring.cloud.azure.active-directory.b2c.base-uri |
AAD B2C endpoint base uri. |
|
spring.cloud.azure.active-directory.b2c.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.active-directory.b2c.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.active-directory.b2c.enabled |
|
Whether to enable Azure Active Directory B2C related auto-configuration. |
spring.cloud.azure.active-directory.b2c.jwt-connect-timeout |
Connection Timeout for the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.b2c.jwt-read-timeout |
Read Timeout for the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.b2c.jwt-size-limit |
Size limit in Bytes of the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.b2c.login-flow |
|
Specify the primary sign-in flow key. |
spring.cloud.azure.active-directory.b2c.logout-success-url |
Redirect url after logout. |
|
spring.cloud.azure.active-directory.b2c.profile.tenant-id |
Azure Tenant ID. |
|
spring.cloud.azure.active-directory.b2c.reply-url |
|
Reply url after get authorization code. |
spring.cloud.azure.active-directory.b2c.user-flows |
User flows. |
|
spring.cloud.azure.active-directory.b2c.user-name-attribute-name |
User name attribute name. |
|
spring.cloud.azure.active-directory.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.active-directory.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.active-directory.enabled |
|
Whether to enable Azure Active Directory related auto-configuration. |
spring.cloud.azure.active-directory.jwk-set-cache-lifespan |
|
The lifespan of the cached JWK set before it expires, default is 5 minutes. |
spring.cloud.azure.active-directory.jwk-set-cache-refresh-time |
|
The refresh time of the cached JWK set before it expires, default is 5 minutes. |
spring.cloud.azure.active-directory.jwt-connect-timeout |
Connection Timeout for the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.jwt-read-timeout |
Read Timeout for the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.jwt-size-limit |
Size limit in Bytes of the JWKSet Remote URL call. |
|
spring.cloud.azure.active-directory.post-logout-redirect-uri |
The redirect uri after logout. |
|
spring.cloud.azure.active-directory.profile.cloud-type |
Name of the Azure cloud to connect to. Supported types are: AZURE, AZURE_CHINA, AZURE_GERMANY, AZURE_US_GOVERNMENT, OTHER. |
|
spring.cloud.azure.active-directory.profile.environment.active-directory-endpoint |
Azure Active Directory endpoint. For example: https://login.microsoftonline.com/ |
|
spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint |
Microsoft Graph endpoint. For example: https://graph.microsoft.com/ |
|
spring.cloud.azure.active-directory.profile.tenant-id |
Azure Tenant ID. |
|
spring.cloud.azure.active-directory.redirect-uri-template |
|
Redirection Endpoint: Used by the authorization server to return responses containing authorization credentials to the client via the resource owner user-agent. |
spring.cloud.azure.active-directory.resource-server.claim-to-authority-prefix-map |
Configure which claim will be used to build GrantedAuthority, and prefix of the GrantedAuthority’s string value. Default value is: "scp" → "SCOPE_", "roles" → "APPROLE_". |
|
spring.cloud.azure.active-directory.resource-server.principal-claim-name |
Configure which claim in access token be returned in AuthenticatedPrincipal#getName. Default value is "sub". |
|
spring.cloud.azure.active-directory.session-stateless |
|
If true activates the stateless auth filter AADAppRoleStatelessAuthenticationFilter. The default is false which activates AADAuthenticationFilter. |
spring.cloud.azure.active-directory.user-group.allowed-group-ids |
The group ids can be used to construct GrantedAuthority. |
|
spring.cloud.azure.active-directory.user-group.allowed-group-names |
The group names can be used to construct GrantedAuthority. |
|
spring.cloud.azure.active-directory.user-group.use-transitive-members |
|
If "true", use "v1.0/me/transitiveMemberOf" to get members. Otherwise, use "v1.0/me/memberOf". |
spring.cloud.azure.active-directory.user-name-attribute |
Decide which claim to be principal’s name. |
|
spring.cloud.azure.appconfiguration.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.appconfiguration.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.appconfiguration.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.appconfiguration.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.appconfiguration.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.appconfiguration.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.appconfiguration.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.appconfiguration.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.appconfiguration.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.appconfiguration.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.appconfiguration.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.appconfiguration.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.appconfiguration.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.appconfiguration.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.appconfiguration.connection-string |
Connection string of the Azure App Configuration instance. |
|
spring.cloud.azure.appconfiguration.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.appconfiguration.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.appconfiguration.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.appconfiguration.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.appconfiguration.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.appconfiguration.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.appconfiguration.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.appconfiguration.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.appconfiguration.endpoint |
Endpoint of the Azure App Configuration instance. |
|
spring.cloud.azure.appconfiguration.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.appconfiguration.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.appconfiguration.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.appconfiguration.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.appconfiguration.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.appconfiguration.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.appconfiguration.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.appconfiguration.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.appconfiguration.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.appconfiguration.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.appconfiguration.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.appconfiguration.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.appconfiguration.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.appconfiguration.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.appconfiguration.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.appconfiguration.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.appconfiguration.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.appconfiguration.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.appconfiguration.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.appconfiguration.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.appconfiguration.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.appconfiguration.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.appconfiguration.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.appconfiguration.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.appconfiguration.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.appconfiguration.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.appconfiguration.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.appconfiguration.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.appconfiguration.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.appconfiguration.service-version |
Version of the app configuration service to be used when making request. |
|
spring.cloud.azure.auto-create-resources |
|
Whether to create Azure resources automatically. This is a legacy property. |
spring.cloud.azure.client-id |
Client id to use when performing service principal authentication with Azure. This is a legacy property. |
|
spring.cloud.azure.client-secret |
Client secret to use when performing service principal authentication with Azure. This is a legacy property. |
|
spring.cloud.azure.client.amqp.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.client.http.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.client.http.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.client.http.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.client.http.headers[0].name |
The name of the header. |
|
spring.cloud.azure.client.http.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.client.http.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.client.http.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.client.http.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.client.http.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.client.http.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.client.http.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.client.http.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.client.http.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.compatibility-verifier.compatible-boot-versions |
Comma-delimited list of Spring Boot versions that are compatible with current Spring Cloud Azure’s version. |
|
spring.cloud.azure.compatibility-verifier.enabled |
|
Whether to enable the Spring Cloud Azure compatibility verifier. |
spring.cloud.azure.cosmos.client-telemetry-enabled |
Whether to enable client telemetry which will periodically collect database operations aggregation statistics, system information like cpu/memory and send it to cosmos monitoring service, which will be helpful during debugging. |
|
spring.cloud.azure.cosmos.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.cosmos.connection-mode |
Connection mode to be used by the client in the Azure Cosmos DB database service. |
|
spring.cloud.azure.cosmos.connection-sharing-across-clients-enabled |
Whether to enable connections sharing across multiple Cosmos Clients. |
|
spring.cloud.azure.cosmos.consistency-level |
Consistency level. The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. |
|
spring.cloud.azure.cosmos.content-response-on-write-enabled |
Whether to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations on CosmosItem. If set to false, service doesn’t return payload in the response. |
|
spring.cloud.azure.cosmos.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.cosmos.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.cosmos.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.cosmos.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.cosmos.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.cosmos.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.cosmos.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.cosmos.database |
Database name of the cosmos db. |
|
spring.cloud.azure.cosmos.direct-connection.connect-timeout |
Connect timeout for direct client, represents timeout for establishing connections with an endpoint. |
|
spring.cloud.azure.cosmos.direct-connection.connection-endpoint-rediscovery-enabled |
Whether to enable the direct TCP connection endpoint rediscovery. |
|
spring.cloud.azure.cosmos.direct-connection.idle-connection-timeout |
Idle connection timeout for the direct client. Direct client doesn’t close a single connection to an endpoint by default unless specified. |
|
spring.cloud.azure.cosmos.direct-connection.idle-endpoint-timeout |
Idle endpoint timeout for the direct client. If there are no requests to a specific endpoint for idle endpoint timeout duration, direct client closes all connections to that endpoint to save resources and I/O cost. |
|
spring.cloud.azure.cosmos.direct-connection.max-connections-per-endpoint |
Max connections per endpoint, represents the size of connection pool for a specific endpoint. |
|
spring.cloud.azure.cosmos.direct-connection.max-requests-per-connection |
Max requests per connection, represents the number of requests that will be queued on a single connection for a specific endpoint. |
|
spring.cloud.azure.cosmos.direct-connection.network-request-timeout |
Network request timeout interval (time to wait for response from network peer). |
|
spring.cloud.azure.cosmos.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.cosmos.endpoint |
Endpoint of the cosmos db. |
|
spring.cloud.azure.cosmos.endpoint-discovery-enabled |
Whether to enable endpoint discovery for geo-replicated database accounts. |
|
spring.cloud.azure.cosmos.gateway-connection.idle-connection-timeout |
Timeout for an idle connection. After that time, the connection will be automatically closed. |
|
spring.cloud.azure.cosmos.gateway-connection.max-connection-pool-size |
Size of the connection pool. |
|
spring.cloud.azure.cosmos.key |
Key to authenticate for accessing the cosmos db. |
|
spring.cloud.azure.cosmos.multiple-write-regions-enabled |
Whether to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service. |
|
spring.cloud.azure.cosmos.populate-query-metrics |
|
Whether to populate diagnostics strings and query metrics. |
spring.cloud.azure.cosmos.preferred-regions |
Preferred regions for geo-replicated database accounts. For example, "East US" as the preferred region. |
|
spring.cloud.azure.cosmos.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.cosmos.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.cosmos.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.cosmos.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.cosmos.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.cosmos.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.cosmos.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.cosmos.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.cosmos.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.cosmos.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.cosmos.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.cosmos.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.cosmos.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.cosmos.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.cosmos.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.cosmos.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.cosmos.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.cosmos.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.cosmos.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.cosmos.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.cosmos.read-requests-fallback-enabled |
Whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service. |
|
spring.cloud.azure.cosmos.resource-token |
Resource token to authenticate for accessing the cosmos db. |
|
spring.cloud.azure.cosmos.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.cosmos.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.cosmos.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.cosmos.session-capturing-override-enabled |
Whether to enable session capturing. Session capturing is enabled by default for SESSION consistency level. |
|
spring.cloud.azure.cosmos.throttling-retry-options.max-retry-attempts-on-throttled-requests |
Maximum number of retries in the case where the request fails because the service has applied rate limiting on the client. |
|
spring.cloud.azure.cosmos.throttling-retry-options.max-retry-wait-time |
Maximum retry time in seconds. When a request fails due to a throttle error, the service sends back a response that contains a value indicating the client should not retry before the time period has elapsed (Retry-After). The MaxRetryWaitTime flag allows the application to set a maximum wait time for all retry attempts. If the cumulative wait time exceeds the MaxRetryWaitTime, the SDK will stop retrying and return the error to the application. |
|
spring.cloud.azure.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.environment |
The Azure environment, such as global Azure or Azure China. This is a legacy property. |
|
spring.cloud.azure.eventhub.checkpoint-access-key |
Storage account access key. This is a legacy property. |
|
spring.cloud.azure.eventhub.checkpoint-container |
Name of the container. This is a legacy property. |
|
spring.cloud.azure.eventhub.checkpoint-storage-account |
Name for the storage account. This is a legacy property. |
|
spring.cloud.azure.eventhub.connection-string |
Connection string to connect to an event hub. This is a legacy property. |
|
spring.cloud.azure.eventhub.namespace |
The namespace of an event hub. This is a legacy property. |
|
spring.cloud.azure.eventhubs.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.eventhubs.connection-string |
Connection string to connect to an event hub. |
|
spring.cloud.azure.eventhubs.consumer.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.consumer.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.eventhubs.consumer.connection-string |
Connection string to connect to an event hub. |
|
spring.cloud.azure.eventhubs.consumer.consumer-group |
Name of the consumer group this consumer is associated with. |
|
spring.cloud.azure.eventhubs.consumer.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.consumer.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.consumer.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.consumer.custom-endpoint-address |
A custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. For example: https://my.custom.endpoint.com:55300. |
|
spring.cloud.azure.eventhubs.consumer.domain-name |
|
The domain name of an Event Hub namespace. |
spring.cloud.azure.eventhubs.consumer.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.consumer.event-hub-name |
The name of an event hub. |
|
spring.cloud.azure.eventhubs.consumer.namespace |
The namespace of an event hub, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.eventhubs.consumer.prefetch-count |
The number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receiving operation is currently active. |
|
spring.cloud.azure.eventhubs.consumer.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.consumer.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.consumer.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.consumer.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.consumer.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.consumer.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.consumer.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.consumer.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.consumer.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.consumer.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.consumer.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.custom-endpoint-address |
A custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. For example: https://my.custom.endpoint.com:55300. |
|
spring.cloud.azure.eventhubs.domain-name |
|
The domain name of an Event Hub namespace. |
spring.cloud.azure.eventhubs.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.event-hub-name |
The name of an event hub. |
|
spring.cloud.azure.eventhubs.namespace |
The namespace of an event hub, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.eventhubs.processor.batch.max-size |
The maximum number of events that will be in the batch. |
|
spring.cloud.azure.eventhubs.processor.batch.max-wait-time |
The max time duration to wait to receive an event before processing events. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.account-key |
Storage account access key. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.account-name |
Name for the storage account. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.blob-name |
Name of the blob. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.connection-string |
Connection string to connect to the service. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.container-name |
Name of the container. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.create-container-if-not-exists |
|
Whether to create the container if it does not exist. |
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.customer-provided-key |
Customer provided key used to encrypt blob contents on the server. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.processor.checkpoint-store.encryption-scope |
Encryption scope used to encrypt blob contents on the server. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.endpoint |
Endpoint for Azure Storage service. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.secondary-host |
Secondary Storage account to retry requests against. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.sas-token |
Shared access signatures (SAS) token used to authorize requests sent to the service. |
|
spring.cloud.azure.eventhubs.processor.checkpoint-store.service-version |
Blob service version used when making API requests. |
|
spring.cloud.azure.eventhubs.processor.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.processor.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.eventhubs.processor.connection-string |
Connection string to connect to an event hub. |
|
spring.cloud.azure.eventhubs.processor.consumer-group |
Name of the consumer group this consumer is associated with. |
|
spring.cloud.azure.eventhubs.processor.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.processor.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.processor.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.processor.custom-endpoint-address |
A custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. For example: https://my.custom.endpoint.com:55300. |
|
spring.cloud.azure.eventhubs.processor.domain-name |
|
The domain name of an Event Hub namespace. |
spring.cloud.azure.eventhubs.processor.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.processor.event-hub-name |
The name of an event hub. |
|
spring.cloud.azure.eventhubs.processor.initial-partition-event-position |
Map event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore. |
|
spring.cloud.azure.eventhubs.processor.load-balancing.partition-ownership-expiration-interval |
The time duration after which the ownership of partition expires. |
|
spring.cloud.azure.eventhubs.processor.load-balancing.strategy |
The load balancing strategy for claiming partition ownership. |
|
spring.cloud.azure.eventhubs.processor.load-balancing.update-interval |
The time interval between load balancing update cycles. |
|
spring.cloud.azure.eventhubs.processor.namespace |
The namespace of an event hub, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.eventhubs.processor.prefetch-count |
The number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receiving operation is currently active. |
|
spring.cloud.azure.eventhubs.processor.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.processor.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.processor.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.processor.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.processor.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.processor.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.processor.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.processor.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.processor.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.processor.track-last-enqueued-event-properties |
Whether request information on the last enqueued event on its associated partition, and track that information as events are received. |
|
spring.cloud.azure.eventhubs.producer.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.eventhubs.producer.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.eventhubs.producer.connection-string |
Connection string to connect to an event hub. |
|
spring.cloud.azure.eventhubs.producer.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.eventhubs.producer.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.eventhubs.producer.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.eventhubs.producer.custom-endpoint-address |
A custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. For example: https://my.custom.endpoint.com:55300. |
|
spring.cloud.azure.eventhubs.producer.domain-name |
|
The domain name of an Event Hub namespace. |
spring.cloud.azure.eventhubs.producer.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.eventhubs.producer.event-hub-name |
The name of an event hub. |
|
spring.cloud.azure.eventhubs.producer.namespace |
The namespace of an event hub, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.eventhubs.producer.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.producer.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.producer.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.producer.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.producer.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.producer.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.producer.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.producer.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.producer.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.producer.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.producer.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.eventhubs.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.eventhubs.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.eventhubs.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.eventhubs.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.eventhubs.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.eventhubs.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.eventhubs.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.eventhubs.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.eventhubs.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.eventhubs.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.eventhubs.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.eventhubs.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.eventhubs.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.eventhubs.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.eventhubs.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.eventhubs.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.eventhubs.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.eventhubs.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.eventhubs.resource.name |
Namespace of the event hub. |
|
spring.cloud.azure.eventhubs.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.eventhubs.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.eventhubs.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.eventhubs.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.eventhubs.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.eventhubs.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.eventhubs.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.eventhubs.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.eventhubs.shared-connection |
Whether to share the same connection for producers or consumers. |
|
spring.cloud.azure.keyvault.certificate.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.keyvault.certificate.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.keyvault.certificate.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.keyvault.certificate.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.keyvault.certificate.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.keyvault.certificate.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.keyvault.certificate.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.keyvault.certificate.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.keyvault.certificate.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.keyvault.certificate.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.keyvault.certificate.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.keyvault.certificate.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.keyvault.certificate.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.keyvault.certificate.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.keyvault.certificate.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.keyvault.certificate.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.keyvault.certificate.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.certificate.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.keyvault.certificate.endpoint |
Azure Key Vault endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.keyvault.certificate.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.keyvault.certificate.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.keyvault.certificate.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.keyvault.certificate.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.keyvault.certificate.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.certificate.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.keyvault.certificate.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.keyvault.certificate.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.certificate.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.keyvault.certificate.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.keyvault.certificate.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.keyvault.certificate.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.certificate.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.keyvault.certificate.service-version |
The version of Azure Key Vault Certificate Service. |
|
spring.cloud.azure.keyvault.secret.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.keyvault.secret.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.keyvault.secret.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.keyvault.secret.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.keyvault.secret.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.keyvault.secret.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.keyvault.secret.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.keyvault.secret.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.keyvault.secret.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.keyvault.secret.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.keyvault.secret.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.keyvault.secret.client.property-sources[0].response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.keyvault.secret.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.keyvault.secret.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.keyvault.secret.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.keyvault.secret.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.keyvault.secret.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.keyvault.secret.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.keyvault.secret.endpoint |
Azure Key Vault endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.keyvault.secret.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.keyvault.secret.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.keyvault.secret.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.keyvault.secret.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
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. |
|
spring.cloud.azure.keyvault.secret.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.keyvault.secret.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.keyvault.secret.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.keyvault.secret.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.keyvault.secret.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.keyvault.secret.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.keyvault.secret.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.keyvault.secret.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.keyvault.secret.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.keyvault.secret.property-source-enabled |
|
Whether to enable the Key Vault property source. |
spring.cloud.azure.keyvault.secret.property-sources |
Azure Key Vault property sources. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].case-sensitive |
Defines the constant for the property that enables/disables case-sensitive keys. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-certificate-password |
Password of the certificate file. |
|
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. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.keyvault.secret.property-sources[0].credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.keyvault.secret.property-sources[0].endpoint |
Azure Key Vault endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].name |
Name of this property source. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
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. |
|
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. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.hostname |
The host of the proxy. |
|
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. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.port |
The port of the proxy. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.type |
Type of the proxy. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].secret-keys |
The secret keys supported for this property source. |
|
spring.cloud.azure.keyvault.secret.property-sources[0].service-version |
Secret service version used when making API requests. |
|
spring.cloud.azure.keyvault.secret.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.keyvault.secret.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.keyvault.secret.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.secret.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.keyvault.secret.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.keyvault.secret.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.keyvault.secret.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.keyvault.secret.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.keyvault.secret.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.keyvault.secret.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.secret.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.keyvault.secret.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.secret.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.keyvault.secret.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.keyvault.secret.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.keyvault.secret.service-version |
Secret service version used when making API requests. |
|
spring.cloud.azure.msi-enabled |
|
Whether managed identity is enabled. This is a legacy property. |
spring.cloud.azure.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.proxy.amqp.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.proxy.http.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.redis.name |
Name of the Azure Cache for Redis. |
|
spring.cloud.azure.redis.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.redis.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.redis.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.region |
The region of an Azure resource. This is a legacy property. |
|
spring.cloud.azure.resource-group |
The resource group holds an Azure resource. This is a legacy property. |
|
spring.cloud.azure.retry.amqp.try-timeout |
How long to wait until a timeout. |
|
spring.cloud.azure.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.servicebus.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.servicebus.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.servicebus.connection-string |
Connection string to connect to a service bus. |
|
spring.cloud.azure.servicebus.consumer.auto-complete |
|
Whether to enable auto-complete. |
spring.cloud.azure.servicebus.consumer.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.servicebus.consumer.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.servicebus.consumer.connection-string |
Connection string to connect to a service bus. |
|
spring.cloud.azure.servicebus.consumer.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.servicebus.consumer.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.servicebus.consumer.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.consumer.domain-name |
|
The domain name of a Service Bus namespace. |
spring.cloud.azure.servicebus.consumer.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.servicebus.consumer.entity-name |
The name of a Service Bus Queue or Topic. |
|
spring.cloud.azure.servicebus.consumer.entity-type |
The type of Service Bus entity, which is a Queue or a Topic. |
|
spring.cloud.azure.servicebus.consumer.max-auto-lock-renew-duration |
Amount of time to continue auto-renewing the lock. |
|
spring.cloud.azure.servicebus.consumer.namespace |
The namespace of a service bus, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.servicebus.consumer.prefetch-count |
Prefetch count of the consumer. |
|
spring.cloud.azure.servicebus.consumer.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.servicebus.consumer.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.servicebus.consumer.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.servicebus.consumer.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.servicebus.consumer.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.consumer.receive-mode |
Mode for receiving messages. |
|
spring.cloud.azure.servicebus.consumer.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.servicebus.consumer.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.servicebus.consumer.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.servicebus.consumer.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.consumer.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.servicebus.consumer.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.servicebus.consumer.session-enabled |
Whether to enable session for the consumer. |
|
spring.cloud.azure.servicebus.consumer.sub-queue |
Type of the SubQueue to connect to. |
|
spring.cloud.azure.servicebus.consumer.subscription-name |
Name for a topic subscription. |
|
spring.cloud.azure.servicebus.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.servicebus.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.servicebus.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.cross-entity-transactions |
Whether to enable cross entity transaction on the connection to Service bus. |
|
spring.cloud.azure.servicebus.domain-name |
|
The domain name of a Service Bus namespace. |
spring.cloud.azure.servicebus.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.servicebus.entity-name |
The name of a Service Bus Queue or Topic. |
|
spring.cloud.azure.servicebus.entity-type |
The type of Service Bus entity, which is a Queue or a Topic. |
|
spring.cloud.azure.servicebus.namespace |
The namespace of a service bus, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.servicebus.processor.auto-complete |
|
Whether to enable auto-complete. |
spring.cloud.azure.servicebus.processor.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.servicebus.processor.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.servicebus.processor.connection-string |
Connection string to connect to a service bus. |
|
spring.cloud.azure.servicebus.processor.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.servicebus.processor.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.servicebus.processor.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.processor.domain-name |
|
The domain name of a Service Bus namespace. |
spring.cloud.azure.servicebus.processor.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.servicebus.processor.entity-name |
The name of a Service Bus Queue or Topic. |
|
spring.cloud.azure.servicebus.processor.entity-type |
The type of Service Bus entity, which is a Queue or a Topic. |
|
spring.cloud.azure.servicebus.processor.max-auto-lock-renew-duration |
Amount of time to continue auto-renewing the lock. |
|
spring.cloud.azure.servicebus.processor.max-concurrent-calls |
Max concurrent messages to process. |
|
spring.cloud.azure.servicebus.processor.max-concurrent-sessions |
Maximum number of concurrent sessions to process at any given time. |
|
spring.cloud.azure.servicebus.processor.namespace |
The namespace of a service bus, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.servicebus.processor.prefetch-count |
Prefetch count of the consumer. |
|
spring.cloud.azure.servicebus.processor.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.servicebus.processor.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.servicebus.processor.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.servicebus.processor.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.servicebus.processor.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.servicebus.processor.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.servicebus.processor.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.servicebus.processor.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.servicebus.processor.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.servicebus.processor.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.servicebus.processor.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.servicebus.processor.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.servicebus.processor.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.servicebus.processor.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.servicebus.processor.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.servicebus.processor.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.processor.receive-mode |
Mode for receiving messages. |
|
spring.cloud.azure.servicebus.processor.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.servicebus.processor.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.servicebus.processor.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.servicebus.processor.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.processor.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.servicebus.processor.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.processor.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.processor.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.processor.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.servicebus.processor.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.servicebus.processor.session-enabled |
Whether to enable session for the consumer. |
|
spring.cloud.azure.servicebus.processor.sub-queue |
Type of the SubQueue to connect to. |
|
spring.cloud.azure.servicebus.processor.subscription-name |
Name for a topic subscription. |
|
spring.cloud.azure.servicebus.producer.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.servicebus.producer.client.transport-type |
Transport type for AMQP-based client. |
|
spring.cloud.azure.servicebus.producer.connection-string |
Connection string to connect to a service bus. |
|
spring.cloud.azure.servicebus.producer.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.servicebus.producer.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.servicebus.producer.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.servicebus.producer.domain-name |
|
The domain name of a Service Bus namespace. |
spring.cloud.azure.servicebus.producer.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.servicebus.producer.entity-name |
The name of a Service Bus Queue or Topic. |
|
spring.cloud.azure.servicebus.producer.entity-type |
The type of Service Bus entity, which is a Queue or a Topic. |
|
spring.cloud.azure.servicebus.producer.namespace |
The namespace of a service bus, which is the prefix of the FQDN. A FQDN should be composed of <NamespaceName>.<DomainName> |
|
spring.cloud.azure.servicebus.producer.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.servicebus.producer.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.servicebus.producer.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.servicebus.producer.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.servicebus.producer.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.servicebus.producer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.servicebus.producer.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.servicebus.producer.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.servicebus.producer.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.servicebus.producer.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.servicebus.producer.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.servicebus.producer.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.servicebus.producer.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.servicebus.producer.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.servicebus.producer.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.servicebus.producer.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.producer.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.servicebus.producer.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.servicebus.producer.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.servicebus.producer.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.producer.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.servicebus.producer.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.producer.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.producer.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.producer.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.servicebus.producer.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.servicebus.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.servicebus.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.servicebus.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.servicebus.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.servicebus.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.servicebus.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.servicebus.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.servicebus.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.servicebus.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.servicebus.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.servicebus.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.servicebus.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.servicebus.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.servicebus.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.servicebus.proxy.authentication-type |
Authentication type used against the proxy. |
|
spring.cloud.azure.servicebus.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.servicebus.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.servicebus.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.servicebus.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.servicebus.resource.name |
Namespace of the service bus. |
|
spring.cloud.azure.servicebus.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.servicebus.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.servicebus.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.servicebus.retry-options.delay |
Amount of time to wait between retry attempts. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry-options.max-delay |
Maximum permissible amount of time between retry attempts. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry-options.max-retries |
The maximum number of attempts. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry-options.retry-mode |
The type of approach to apply when calculating the delay between retry attempts. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry-options.try-timeout |
Amount of time to wait until a timeout. This is a legacy property. |
|
spring.cloud.azure.servicebus.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.servicebus.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.servicebus.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.servicebus.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.servicebus.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.servicebus.transport-type |
Transport type for AMQP-based client. This is a legacy property. |
|
spring.cloud.azure.storage.access-key |
Storage account access key. This is a legacy property. |
|
spring.cloud.azure.storage.account |
Name for the storage account. This is a legacy property. |
|
spring.cloud.azure.storage.blob.account-key |
Storage account access key. |
|
spring.cloud.azure.storage.blob.account-name |
Name for the storage account. |
|
spring.cloud.azure.storage.blob.blob-name |
Name of the blob. |
|
spring.cloud.azure.storage.blob.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.storage.blob.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.storage.blob.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.storage.blob.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.storage.blob.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.storage.blob.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.storage.blob.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.storage.blob.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.storage.blob.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.storage.blob.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.storage.blob.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.storage.blob.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.storage.blob.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.storage.blob.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.storage.blob.connection-string |
Connection string to connect to the service. |
|
spring.cloud.azure.storage.blob.container-name |
Name of the container. |
|
spring.cloud.azure.storage.blob.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.storage.blob.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.blob.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.blob.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.blob.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.storage.blob.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.blob.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.blob.customer-provided-key |
Customer provided key used to encrypt blob contents on the server. |
|
spring.cloud.azure.storage.blob.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.storage.blob.encryption-scope |
Encryption scope used to encrypt blob contents on the server. |
|
spring.cloud.azure.storage.blob.endpoint |
Endpoint for Azure Storage service. |
|
spring.cloud.azure.storage.blob.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.storage.blob.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.storage.blob.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.storage.blob.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.storage.blob.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.storage.blob.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.storage.blob.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.storage.blob.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.storage.blob.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.storage.blob.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.storage.blob.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.storage.blob.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.storage.blob.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.storage.blob.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.storage.blob.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.storage.blob.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.storage.blob.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.storage.blob.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.storage.blob.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.storage.blob.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.storage.blob.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.storage.blob.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.storage.blob.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.storage.blob.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.blob.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.storage.blob.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.blob.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.blob.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.blob.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.storage.blob.retry.secondary-host |
Secondary Storage account to retry requests against. |
|
spring.cloud.azure.storage.blob.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.storage.blob.sas-token |
Shared access signatures (SAS) token used to authorize requests sent to the service. |
|
spring.cloud.azure.storage.blob.service-version |
Blob service version used when making API requests. |
|
spring.cloud.azure.storage.fileshare.account-key |
Storage account access key. |
|
spring.cloud.azure.storage.fileshare.account-name |
Name for the storage account. |
|
spring.cloud.azure.storage.fileshare.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.storage.fileshare.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.storage.fileshare.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.storage.fileshare.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.storage.fileshare.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.storage.fileshare.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.storage.fileshare.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.storage.fileshare.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.storage.fileshare.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.storage.fileshare.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.storage.fileshare.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.storage.fileshare.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.storage.fileshare.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.storage.fileshare.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.storage.fileshare.connection-string |
Connection string to connect to the service. |
|
spring.cloud.azure.storage.fileshare.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.storage.fileshare.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.storage.fileshare.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.fileshare.directory-path |
Path to the directory. For instance, 'directory1/directory2'. |
|
spring.cloud.azure.storage.fileshare.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.storage.fileshare.endpoint |
Endpoint for Azure Storage service. |
|
spring.cloud.azure.storage.fileshare.file-path |
Path to the file. For instance, 'directory1/file1'. |
|
spring.cloud.azure.storage.fileshare.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.storage.fileshare.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.storage.fileshare.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.storage.fileshare.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.storage.fileshare.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.storage.fileshare.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.storage.fileshare.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.storage.fileshare.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.storage.fileshare.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.storage.fileshare.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.storage.fileshare.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.storage.fileshare.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.storage.fileshare.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.storage.fileshare.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.storage.fileshare.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.storage.fileshare.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.storage.fileshare.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.storage.fileshare.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.storage.fileshare.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.storage.fileshare.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.storage.fileshare.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.storage.fileshare.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.storage.fileshare.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.storage.fileshare.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.fileshare.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.storage.fileshare.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.fileshare.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.fileshare.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.fileshare.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.storage.fileshare.retry.secondary-host |
Secondary Storage account to retry requests against. |
|
spring.cloud.azure.storage.fileshare.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.storage.fileshare.sas-token |
Shared access signatures (SAS) token used to authorize requests sent to the service. |
|
spring.cloud.azure.storage.fileshare.service-version |
Share service version used when making API requests |
|
spring.cloud.azure.storage.fileshare.share-name |
Name of the share. |
|
spring.cloud.azure.storage.queue.account-key |
Storage account access key. |
|
spring.cloud.azure.storage.queue.account-name |
Name for the storage account. |
|
spring.cloud.azure.storage.queue.client.application-id |
Represents current application and is used for telemetry/monitoring purposes. |
|
spring.cloud.azure.storage.queue.client.connect-timeout |
Amount of time the request attempts to connect to the remote host and the connection is resolved. |
|
spring.cloud.azure.storage.queue.client.connection-idle-timeout |
Amount of time before an idle connection. |
|
spring.cloud.azure.storage.queue.client.headers |
Comma-delimited list of headers applied to each request sent with client. |
|
spring.cloud.azure.storage.queue.client.headers[0].name |
The name of the header. |
|
spring.cloud.azure.storage.queue.client.headers[0].values |
List of values of the header. |
|
spring.cloud.azure.storage.queue.client.logging.allowed-header-names |
Comma-delimited list of whitelisted headers that should be logged. |
|
spring.cloud.azure.storage.queue.client.logging.allowed-query-param-names |
Comma-delimited list of whitelisted query parameters. |
|
spring.cloud.azure.storage.queue.client.logging.level |
The level of detail to log on HTTP messages. |
|
spring.cloud.azure.storage.queue.client.logging.pretty-print-body |
Whether to pretty print the message bodies. |
|
spring.cloud.azure.storage.queue.client.maximum-connection-pool-size |
Maximum connection pool size used by the underlying HTTP client. |
|
spring.cloud.azure.storage.queue.client.read-timeout |
Amount of time used when reading the server response. |
|
spring.cloud.azure.storage.queue.client.response-timeout |
Amount of time used when waiting for a server to reply. |
|
spring.cloud.azure.storage.queue.client.write-timeout |
Amount of time each request being sent over the wire. |
|
spring.cloud.azure.storage.queue.connection-string |
Connection string to connect to the service. |
|
spring.cloud.azure.storage.queue.credential.client-certificate-password |
Password of the certificate file. |
|
spring.cloud.azure.storage.queue.credential.client-certificate-path |
Path of a PEM certificate file to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.queue.credential.client-id |
Client id to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.queue.credential.client-secret |
Client secret to use when performing service principal authentication with Azure. |
|
spring.cloud.azure.storage.queue.credential.managed-identity-enabled |
|
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. |
spring.cloud.azure.storage.queue.credential.password |
Password to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.queue.credential.username |
Username to use when performing username/password authentication with Azure. |
|
spring.cloud.azure.storage.queue.enabled |
|
Whether an Azure Service is enabled. |
spring.cloud.azure.storage.queue.endpoint |
Endpoint for Azure Storage service. |
|
spring.cloud.azure.storage.queue.message-encoding |
How queue message body is represented in HTTP requests and responses. |
|
spring.cloud.azure.storage.queue.profile.cloud-type |
Name of the Azure cloud to connect to. |
|
spring.cloud.azure.storage.queue.profile.environment.active-directory-endpoint |
The Azure Active Directory endpoint to connect to. |
|
spring.cloud.azure.storage.queue.profile.environment.active-directory-graph-api-version |
The Azure Active Directory Graph API version. |
|
spring.cloud.azure.storage.queue.profile.environment.active-directory-graph-endpoint |
The Azure Active Directory Graph endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.active-directory-resource-id |
The Azure Active Directory resource id. |
|
spring.cloud.azure.storage.queue.profile.environment.azure-application-insights-endpoint |
The Azure Application Insights endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix |
The Data Lake analytics catalog and job endpoint suffix. |
|
spring.cloud.azure.storage.queue.profile.environment.azure-data-lake-store-file-system-endpoint-suffix |
The Data Lake storage file system endpoint suffix. |
|
spring.cloud.azure.storage.queue.profile.environment.azure-log-analytics-endpoint |
The Azure Log Analytics endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.data-lake-endpoint-resource-id |
The Data Lake endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.gallery-endpoint |
The gallery endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.key-vault-dns-suffix |
The Key Vault DNS suffix. |
|
spring.cloud.azure.storage.queue.profile.environment.management-endpoint |
The management service endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.microsoft-graph-endpoint |
The Microsoft Graph endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.portal |
The management portal URL. |
|
spring.cloud.azure.storage.queue.profile.environment.publishing-profile |
The publishing settings file URL. |
|
spring.cloud.azure.storage.queue.profile.environment.resource-manager-endpoint |
The resource management endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.sql-management-endpoint |
The SQL management endpoint. |
|
spring.cloud.azure.storage.queue.profile.environment.sql-server-hostname-suffix |
The SQL Server hostname suffix. |
|
spring.cloud.azure.storage.queue.profile.environment.storage-endpoint-suffix |
The Storage endpoint suffix. |
|
spring.cloud.azure.storage.queue.profile.subscription-id |
Subscription id to use when connecting to Azure resources. |
|
spring.cloud.azure.storage.queue.profile.tenant-id |
Tenant id for Azure resources. |
|
spring.cloud.azure.storage.queue.proxy.hostname |
The host of the proxy. |
|
spring.cloud.azure.storage.queue.proxy.non-proxy-hosts |
A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |
|
spring.cloud.azure.storage.queue.proxy.password |
Password used to authenticate with the proxy. |
|
spring.cloud.azure.storage.queue.proxy.port |
The port of the proxy. |
|
spring.cloud.azure.storage.queue.proxy.type |
Type of the proxy. |
|
spring.cloud.azure.storage.queue.proxy.username |
Username used to authenticate with the proxy. |
|
spring.cloud.azure.storage.queue.queue-name |
Name of the storage queue. |
|
spring.cloud.azure.storage.queue.resource.name |
Name of the storage account. |
|
spring.cloud.azure.storage.queue.resource.region |
The region of an Azure resource. |
|
spring.cloud.azure.storage.queue.resource.resource-group |
The resource group holds an Azure resource. |
|
spring.cloud.azure.storage.queue.resource.resource-id |
ID of an Azure resource. |
|
spring.cloud.azure.storage.queue.retry.exponential.base-delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.queue.retry.exponential.max-delay |
Maximum permissible amount of time between retry attempts. |
|
spring.cloud.azure.storage.queue.retry.exponential.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.queue.retry.fixed.delay |
Amount of time to wait between retry attempts. |
|
spring.cloud.azure.storage.queue.retry.fixed.max-retries |
The maximum number of attempts. |
|
spring.cloud.azure.storage.queue.retry.mode |
Retry backoff mode. |
|
spring.cloud.azure.storage.queue.retry.secondary-host |
Secondary Storage account to retry requests against. |
|
spring.cloud.azure.storage.queue.retry.try-timeout |
Amount of time to wait until a timeout. |
|
spring.cloud.azure.storage.queue.sas-token |
Shared access signatures (SAS) token used to authorize requests sent to the service. |
|
spring.cloud.azure.storage.queue.service-version |
Queue service version used when making API requests. |
|
spring.cloud.azure.storage.resource-group |
Resource group the storage account belongs to. This is a legacy property. |
|
spring.cloud.azure.subscription-id |
Subscription id to use when connecting to Azure resources. This is a legacy property. |
|
spring.cloud.azure.tenant-id |
Tenant id for Azure resources. This is a legacy property. |
|
spring.jms.servicebus.connection-string |
Connection string to connect to a Service Bus namespace. |
|
spring.jms.servicebus.idle-timeout |
|
Connection idle timeout duration. |
spring.jms.servicebus.listener.phase |
The phase in which this container should be started and stopped. |
|
spring.jms.servicebus.listener.reply-pub-sub-domain |
Whether the reply destination type is topic. Only works for the bean of topicJmsListenerContainerFactory. |
|
spring.jms.servicebus.listener.reply-qos-settings |
The QosSettings to use when sending a reply. |
|
spring.jms.servicebus.listener.subscription-durable |
|
Whether to make the subscription durable. Only works for the bean of topicJmsListenerContainerFactory. |
spring.jms.servicebus.listener.subscription-shared |
Whether to make the subscription shared. Only works for the bean of topicJmsListenerContainerFactory. |
|
spring.jms.servicebus.password |
Login password of the AMQP broker. |
|
spring.jms.servicebus.pool.block-if-full |
Whether to block when a connection is requested and the pool is full. Set it to false to throw a 'JMSException' instead. |
|
spring.jms.servicebus.pool.block-if-full-timeout |
Blocking period before throwing an exception if the pool is still full. |
|
spring.jms.servicebus.pool.enabled |
Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory. |
|
spring.jms.servicebus.pool.idle-timeout |
Connection idle timeout. |
|
spring.jms.servicebus.pool.max-connections |
Maximum number of pooled connections. |
|
spring.jms.servicebus.pool.max-sessions-per-connection |
Maximum number of pooled sessions per connection in the pool. |
|
spring.jms.servicebus.pool.time-between-expiration-check |
Time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs. |
|
spring.jms.servicebus.pool.use-anonymous-producers |
Whether to use only one anonymous 'MessageProducer' instance. Set it to false to create one 'MessageProducer' every time one is required. |
|
spring.jms.servicebus.prefetch-policy.all |
|
Fallback value for prefetch option in this Service Bus namespace. |
spring.jms.servicebus.prefetch-policy.durable-topic-prefetch |
|
The number of prefetch for durable topic. |
spring.jms.servicebus.prefetch-policy.queue-browser-prefetch |
|
The number of prefetch for queue browser. |
spring.jms.servicebus.prefetch-policy.queue-prefetch |
|
The number of prefetch for queue. |
spring.jms.servicebus.prefetch-policy.topic-prefetch |
|
The number of prefetch for topic. |
spring.jms.servicebus.pricing-tier |
Pricing tier for a Service Bus namespace. |
|
spring.jms.servicebus.remote-url |
|
URL of the AMQP broker. Auto-generated by default. |
spring.jms.servicebus.topic-client-id |
Service Bus topic client ID. Only works for the bean of topicJmsListenerContainerFactory. |
|
spring.jms.servicebus.username |
Login user of the AMQP broker. |
Appendix B: Migration Guide for 4.0
Introduction
This guide assists in the migration to Spring Cloud Azure 4.0 from legacy Azure Spring libraries.
This guide will call libraries whose group Id and artifact Id following pattern com.azure.spring:spring-cloud-azure-*
the modern libraries,
and those with pattern com.azure.spring:azure-spring-boot-*
, com.azure.spring:azure-spring-cloud-*
,
or com.azure.spring:azure-spring-integration-*
the legacy ones.
This guide will focus the side-by-side comparisons for similar configurations between the modern and legacy libraries.
Familiarity with com.azure.spring:azure-spring-boot-*
, com.azure.spring:azure-spring-cloud-*
or com.azure.spring:azure-spring-integration-*
package is assumed.
For those new to the Spring Cloud Azure 4.0 libraries, please refer to the Spring Cloud Azure 4.0 Reference Doc rather than this guide.
Migration Benefits
A natural question to ask when considering whether to adopt a new version or library is its benefits. As Azure has matured and been embraced by a more diverse group of developers, we’ve been focused on learning the patterns and practices to best support developer productivity and to understand the gaps that the Spring Cloud Azure libraries have.
There were several areas of consistent feedback expressed across the Spring Cloud Azure libraries. The most important is that the libraries for different Azure services haven’t enabled the complete set of configurations. Additionally, the inconsistency of project naming, artifact Ids, versions, configurations made the learning curve steep.
To improve the development experience across Spring Cloud Azure libraries, a set of design guidelines was introduced to ensure that Spring Cloud Azure libraries have a natural and idiomatic feel with respect to the Spring ecosystem. Further details are available in the design document for those interested.
The Spring Cloud Azure 4.0 provides the shared experience across libraries integrating with different Spring projects, for example Spring Boot, Spring Integration, Spring Cloud Stream, etc. The shared experience includes:
-
A unified BOM to include all Spring Cloud Azure 4.0 libraries.
-
A consistent naming convention for artifacts.
-
A unified way to configure credential, proxy, retry, cloud environment, and transport layer settings.
-
Supporting all the authenticating methods an Azure Service or Azure Service SDK supports.
Overview
This migration guide will consist following sections:
-
Naming changes for Spring Cloud Azure 4.0
-
Artifact changes: renamed / added / deleted
-
Dependency changes
-
Authentication changes
-
Configuration properties
-
API breaking changes
-
Library changes
Naming Changes
There has never been a consistent or official name to call all the Spring Cloud Azure libraries, some of them were
called Azure Spring Boot
and some of them Spring on Azure
, and all these names will make developers confused. Since
4.0, we began to use the project name Spring Cloud Azure
to represent all the Azure Spring libraries.
BOM
We used to ship two BOMs for Spring Cloud Azure libraries, the azure-spring-boot-bom
and azure-spring-cloud-dependencies
, but we
combined these two BOMs into one BOM since 4.0, the spring-cloud-azure-dependencies
. Please add an entry in the
dependencyManagement of your project to benefit from the dependency management.
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-dependencies</artifactId>
<version>version</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
The version for spring-cloud-azure-dependencies is 4.2.0.
Artifact Changes: Renamed / Added / Deleted
Group Ids are the same for modern and legacy Spring Cloud Azure libraries, they’re all com.azure.spring
. Artifact Ids
for the modern Spring Cloud Azure libraries have changed. And according to which Spring project it belongs, Spring Boot,
Spring Integration or Spring Cloud Stream, the artifact ids pattern could be spring-cloud-azure-starter-[service]
, spring-integration-azure-[service]
and spring-cloud-azure-stream-binder-[service]
. The legacy starters each has an
artifact Id following the pattern azure-spring-*
. This provides a quick and accessible means to help understand, at a
glance, whether you are using modern or legacy starters.
In the process of developing Spring Cloud Azure 4.0, we renamed some artifacts to make them follow the new naming conventions, deleted some artifacts for its functionality could be put in a more appropriate artifact, and added some new artifacts to better serve some scenarios.
Legacy Artifact ID | Modern Artifact ID | Description |
---|---|---|
azure-spring-boot-starter |
spring-cloud-azure-starter |
Deleted this artifact with merging all functionalities into the new |
azure-spring-boot-starter-active-directory |
spring-cloud-azure-starter-active-directory |
Renamed the artifact. |
azure-spring-boot-starter-active-directory-b2c |
spring-cloud-azure-starter-active-directory-b2c |
Renamed the artifact. |
azure-spring-boot-starter-cosmos |
spring-cloud-azure-starter-data-cosmos |
Renamed the artifact to add |
azure-spring-boot-starter-keyvault-certificates |
N/A |
Not included in this release, but will be supported in later version. |
azure-spring-boot-starter-keyvault-secrets |
spring-cloud-azure-starter-keyvault-secrets |
Renamed the artifact. |
azure-spring-boot-starter-servicebus-jms |
spring-cloud-azure-starter-servicebus-jms |
Renamed the artifact. |
azure-spring-boot-starter-storage |
spring-cloud-azure-starter-storage-blob |
Split into two separate artifacts. The legacy artifact contains the functionality of both Storage Blob and File Share, which got split into spring-cloud-azure-starter-storage-blob and spring-cloud-azure-starter-storage-file-share in 4.0. |
azure-spring-boot |
N/A |
Deleted this artifact with merging all functionalities into the new |
azure-spring-cloud-autoconfigure |
N/A |
Deleted this artifact with merging all functionalities into the new |
azure-spring-cloud-context |
N/A |
Deleted this artifact with merging all functionalities into the new |
azure-spring-cloud-messaging |
spring-messaging-azure |
Deleted this artifact. The functionalities of messaging listener annotations are under refactoring and not ready in 4.0 yet. |
azure-spring-cloud-starter-cache |
N/A |
Deleted this artifact. For using redis, just add spring-boot-starter-data-redis, spring-boot-starter-cache, spring-cloud-azure-resourcemanager and spring-cloud-azure-starter. Please see Redis Support for more information about usage. |
azure-spring-cloud-starter-eventhubs-kafka |
N/A |
Deleted this artifact. For using kafka, import the dependencies of spring-kafka, spring-cloud-azure-resourcemanager and spring-cloud-azure-starter. Please see Kafka Support for more information about usage. |
azure-spring-cloud-starter-eventhubs |
spring-cloud-azure-starter-integration-eventhubs |
Renamed the artifact to add |
azure-spring-cloud-starter-servicebus |
spring-cloud-azure-starter-integration-servicebus |
Renamed the artifact to add |
azure-spring-cloud-starter-storage-queue |
spring-cloud-azure-starter-integration-storage-queue |
Renamed the artifact to add |
azure-spring-cloud-storage |
N/A |
Deleted this artifact with merging all functionalities into the new |
azure-spring-cloud-stream-binder-eventhubs |
spring-cloud-azure-stream-binder-eventhubs |
Renamed the artifact. This artifact has been refactored using new design, mainly |
azure-spring-cloud-stream-binder-service-core |
spring-cloud-azure-stream-binder-servicebus-core |
Renamed the artifact. |
azure-spring-cloud-stream-binder-servicebus-queue |
spring-cloud-azure-stream-binder-servicebus |
Deleted this artifact with merging all functionalities into the |
azure-spring-cloud-stream-binder-servicebus-topic |
spring-cloud-azure-stream-binder-servicebus |
Deleted this artifact with merging all functionalities into the |
azure-spring-integration-core |
spring-integration-azure-core |
Renamed the artifact. |
azure-spring-integration-eventhubs |
spring-integration-azure-eventhubs |
Renamed the artifact. |
azure-spring-integration-servicebus |
spring-integration-azure-servicebus |
Renamed the artifact. |
azure-spring-integration-storage-queue |
spring-integration-azure-storage-queue |
Renamed the artifact. |
N/A |
spring-cloud-azure-actuator |
The newly added Spring Cloud Azure Actuator artifact. |
N/A |
spring-cloud-azure-actuator-autoconfigure |
The newly added Spring Cloud Azure Actuator AutoConfigure artifact, including autoconfiguration for actuator. |
N/A |
spring-cloud-azure-autoconfigure |
The newly added Spring Cloud Azure AutoConfigure artifact, including all autoconfiguration for SDK clients, Spring Security support, Spring Data support and Spring Integration support. |
N/A |
spring-cloud-azure-core |
The newly added Spring Cloud Azure Core artifact, including all core functionality. |
N/A |
spring-cloud-azure-resourcemanager |
The newly added Resource Manager artifact. It’s the Core library using Azure Resource Manager to read metadata and create resources. |
N/A |
spring-cloud-azure-service |
The newly added Spring Cloud Azure Service artifact, including abstractions for Azure services. |
N/A |
spring-cloud-azure-starter-appconfiguration |
The newly added starter for using Azure App Configuration SDK client. |
N/A |
spring-cloud-azure-starter-cosmos |
The newly added starter for using Azure Cosmos SDK client. |
N/A |
spring-cloud-azure-starter-eventhubs |
The newly added starter for using Azure Event Hubs SDK client. |
N/A |
spring-cloud-azure-starter-servicebus |
The newly added starter for using Azure Service Bus SDK client. |
N/A |
spring-cloud-azure-starter-storage-blob |
The newly added starter for using Azure Storage Blob SDK client. |
N/A |
spring-cloud-azure-starter-storage-file-share |
The newly added starter for using Azure Storage File Share SDK client. |
N/A |
spring-cloud-azure-starter-storage-queue |
The newly added starter for using Azure Storage Queue SDK client. |
N/A |
spring-cloud-azure-starter-stream-eventhubs |
The newly added starter for using Azure Event Hubs Spring Cloud Stream Binder. |
N/A |
spring-cloud-azure-starter-stream-servicebus |
The newly added starter for using Azure Service Bus Spring Cloud Stream Binder |
N/A |
spring-cloud-azure-stream-binder-eventhubs-core |
The newly added Spring Cloud Stream core artifact for Azure Event Hubs. |
Dependency Changes
Some unnecessary dependencies were included in the legacy artifacts, which we’ve removed in the modern Spring Cloud Azure 4.0 libraries. Please make sure add the removed dependencies manually to your project to prevent unintentionally crash.
Libraries that have dependency changes include:
Authentication
Spring Cloud Azure 4.0 supports all the authentication methods each Azure Service SDK supports. It allows configuring a global token credential and providing the token credential at each service level. But credential isn’t required to configure in Spring Cloud Azure 4.0, it can leverage the credential stored in a local developing environment, or managed identity in Azure Services, just make sure the principal has been granted sufficient permission to access the target Azure resources.
When assign roles to the security principals to interact with Azure messaging services, the Data related roles are required to conduct messaging operations. For Spring Cloud Azure Stream Event Hubs / Service Bus Binder libraries, Contributor role is required when the function of auto creating resources is needed. See Azure built-in roles for more details.
|
A chained credential, the DefaultAzureCredential bean is autoconfigured by default and will be used by all components if no more authentication information is specified.
Configuration Properties
Properties migration
We’ve created an additional-spring-configuration-metadata.json
file to smooth the property migration when using with spring-boot-properties-migrator
. Before doing so, let’s add the property migrator to your application
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-properties-migrator</artifactId>
<scope>runtime</scope>
</dependency>
Or, if you’re using Gradle:
runtime("org.springframework.boot:spring-boot-properties-migrator")
If you run the app, it will identify the properties that are no longer managed by Spring Cloud Azure. If there is a replacement it will temporarily remap the property for you with a warning. If there isn’t a replacement, an error report will give you more information. Either way, the configuration has to be updated and the dependency removed once you have updated the configuration.
Before you move on, it’s a good idea to use the search feature of your IDE to double-check that you aren’t using one of the properties you’ve migrated in an integration test.
We’ve changed many configuration properties in this change, with using the spring-boot-properties-migrator will help smooth your migration.
|
Global Configurations
The modern spring-cloud-azure-starter
allows developers to define properties that apply to all Azure SDKs in the
namespace spring.cloud.azure
. It wasn’t supported in the legacy azure-spring-boot-starter
. The global
configurations can be divided into five categories:
Prefix | Description |
---|---|
spring.cloud.azure.client |
To configure the transport clients underneath each Azure SDK. |
spring.cloud.azure.credential |
To configure how to authenticate with Azure Active Directory. |
spring.cloud.azure.profile |
To configure the Azure cloud environment. |
spring.cloud.azure.proxy |
To configure the proxy options apply to all Azure SDK clients. |
spring.cloud.azure.retry |
To configure the retry options apply to all Azure SDK clients. The retry options have supported part of the SDKs, there’s no |
Check Global Properties for a full list of global configurations.
Each SDK Configurations
For the configuration options in SDK level, please refer to below links for details.
-
From azure-spring-boot-starter-active-directory to spring-cloud-azure-starter-active-directory
-
From azure-spring-boot-starter-cosmos to spring-cloud-azure-starter-data-cosmos
-
From azure-spring-boot-starter-keyvault-secrets to spring-cloud-azure-starter-keyvault-secrets
-
From azure-spring-boot-starter-servicebus-jms to spring-cloud-azure-starter-servicebus-jms
-
From azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-blob
-
From azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-file-share
-
From azure-spring-cloud-starter-eventhubs to spring-cloud-azure-starter-integration-eventhubs
-
From azure-spring-cloud-starter-servicebus to spring-cloud-azure-starter-integration-servicebus
-
From azure-spring-cloud-stream-binder-eventhubs to spring-cloud-azure-stream-binder-eventhubs
-
From azure-spring-cloud-stream-binder-servicebus-* to spring-cloud-azure-stream-binder-servicebus
API Breaking Changes
For API breaking changes in each libraries, please refer to below links for details.
-
From azure-spring-boot-starter-active-directory to spring-cloud-azure-starter-active-directory
-
From azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-blob
-
From azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-file-share
-
From azure-spring-cloud-starter-eventhubs to spring-cloud-azure-starter-integration-eventhubs
-
From azure-spring-integration-eventhubs to spring-integration-azure-eventhubs
-
From azure-spring-cloud-starter-servicebus to spring-cloud-azure-starter-integration-servicebus
-
From azure-spring-integration-servicebus to spring-integration-azure-servicebus
-
From azure-spring-integration-storage-queue to spring-integration-azure-storage-queue
-
From azure-spring-cloud-stream-binder-eventhubs to spring-cloud-azure-stream-binder-eventhubs
-
From azure-spring-cloud-stream-binder-servicebus-* to spring-cloud-azure-stream-binder-servicebus
Library Changes
Breaking changes in each library are introduced as follows.
From azure-spring-boot-starter to spring-cloud-azure-starter
This guide is intended to assist in the migration to spring-cloud-azure-starter from version 3 of azure-spring-boot-starter.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
Dependency Changes
Some unnecessary dependencies were included in the legacy artifacts, which we have removed in the modern Spring Cloud Azure 4.0 libraries. Please make sure add the removed dependencies manually to your project to prevent unintentionally crash.
Removed dependencies | Description |
---|---|
org.springframework.boot:spring-boot-starter-validation |
Please include the validation starter if you want to use Hibernate Validator. |
From azure-spring-boot-starter-active-directory to spring-cloud-azure-starter-active-directory
This guide is intended to assist the migration to spring-cloud-azure-starter-active-directory from version 3 of azure-spring-boot-starter-active-directory.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
Dependency Changes
Some unnecessary dependencies in the legacy artifact have been removed since the modern Spring Cloud Azure 4.0 library. Please add these removed dependencies to your project to prevent unintentional crash.
Removed Dependency | Description |
---|---|
com.fasterxml.jackson.core:jackson-databind |
Please add this dependency to your project if needed. |
io.projectreactor.netty:reactor-netty |
Please add this dependency to your project if needed. |
org.springframework.boot:spring-boot-starter-validation |
Please add this dependency to your project if needed. |
org.springframework.boot:spring-boot-starter-webflux |
Please add this dependency to your project if needed. |
SDK Configuration Changes
This section includes the changes about the properties added, removed and changed.
-
All configuration property names' prefix is changed from
azure.activedirectory
tospring.cloud.azure.active-directory
. -
New property
spring.cloud.azure.active-directory.enabled
is added to enable/disable AAD related features. The default value isfalse
.
Legacy properties | Modern properties |
---|---|
azure.activedirectory.app-id-uri |
spring.cloud.azure.active-directory.app-id-uri |
azure.activedirectory.application-type |
spring.cloud.azure.active-directory.application-type |
azure.activedirectory.authorization-clients |
spring.cloud.azure.active-directory.authorization-clients |
azure.activedirectory.authorization-clients.<AZURE_CLIENT_NAME>.authorization-grant-type |
spring.cloud.azure.active-directory.authorization-clients.<AZURE_CLIENT_NAME>.authorization-grant-type |
azure.activedirectory.authorization-clients.<AZURE_CLIENT_NAME>.on-demand |
spring.cloud.azure.active-directory.authorization-clients.<AZURE_CLIENT_NAME>.on-demand |
azure.activedirectory.authorization-clients.<AZURE_CLIENT_NAME>.scopes |
spring.cloud.azure.active-directory.authorization-clients.<AZURE_CLIENT_NAME>.scopes |
azure.activedirectory.authenticate-additional-parameters |
spring.cloud.azure.active-directory.authenticate-additional-parameters |
azure.activedirectory.base-uri |
spring.cloud.azure.active-directory.profile.environment.active-directory-endpoint |
azure.activedirectory.client-id |
spring.cloud.azure.active-directory.credential.client-id |
azure.activedirectory.client-secret |
spring.cloud.azure.active-directory.credential.client-secret |
azure.activedirectory.graph-membership-uri |
spring.cloud.azure.active-directory.graph-membership-uri |
azure.activedirectory.jwt-connect-timeout |
spring.cloud.azure.active-directory.jwt-connect-timeout |
azure.activedirectory.jwt-read-timeout |
spring.cloud.azure.active-directory.jwt-read-timeout |
azure.activedirectory.jwt-size-limit |
spring.cloud.azure.active-directory.jwt-size-limit |
azure.activedirectory.jwk-set-cache-lifespan |
spring.cloud.azure.active-directory.jwk-set-cache-lifespan |
azure.activedirectory.jwk-set-cache-refresh-time |
spring.cloud.azure.active-directory.jwk-set-cache-refresh-time |
azure.activedirectory.post-logout-redirect-uri |
spring.cloud.azure.active-directory.post-logout-redirect-uri |
azure.activedirectory.session-stateless |
spring.cloud.azure.active-directory.session-stateless |
azure.activedirectory.redirect-uri-template |
spring.cloud.azure.active-directory.redirect-uri-template |
azure.activedirectory.resource-server.claim-to-authority-prefix-map |
spring.cloud.azure.active-directory.resource-server.claim-to-authority-prefix-map |
azure.activedirectory.resource-server.principal-claim-name |
spring.cloud.azure.active-directory.resource-server.principal-claim-name |
azure.activedirectory.tenant-id |
spring.cloud.azure.active-directory.profile.tenant-id |
azure.activedirectory.user-group.allowed-group-ids |
spring.cloud.azure.active-directory.user-group.allowed-group-ids |
azure.activedirectory.user-group.allowed-group-names |
spring.cloud.azure.active-directory.user-group.allowed-group-names |
azure.activedirectory.user-name-attribute |
spring.cloud.azure.active-directory.user-name-attribute |
long
to Duration
:-
jwt-connect-timeout
-
jwt-read-timeout
-
jwk-set-cache-lifespan
-
jwk-set-cache-refresh-time
.
-
azure.activedirectory.allow-telemetry
-
azure.activedirectory.user-group.enable-full-list
-
azure.activedirectory.graph-base-uri
-
azure.activedirectory.graph-membership-uri
-
spring.cloud.azure.active-directory.enabled
-
spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint
-
spring.cloud.azure.active-directory.user-group.use-transitive-members
The function of azure.activedirectory.graph-membership-uri has been replaced by 2 properties: spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint and spring.cloud.azure.active-directory.user-group.use-transitive-members . The first property is used to specify the host name, and the second a flag for using the url path: v1.0/me/memberOf or v1.0/me/transitiveMemberOf .
|
Here are some examples of migration:
azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/memberOf
spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint=https://graph.microsoft.com/
spring.cloud.azure.active-directory.user-group.use-transitive-members=false
azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/transitiveMemberOf
spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint=https://graph.microsoft.com/
spring.cloud.azure.active-directory.user-group.use-transitive-members=true
API Changes
Legacy class | Modern class |
---|---|
com.azure.spring.aad.webapi.AADJwtBearerTokenAuthenticationConverter |
com.azure.spring.cloud.autoconfigure.aad.AadJwtBearerTokenAuthenticationConverter |
com.azure.spring.aad.webapi.AADResourceServerProperties |
com.azure.spring.cloud.autoconfigure.aad.properties.AadResourceServerProperties |
com.azure.spring.aad.webapi.AADResourceServerWebSecurityConfigurerAdapter |
com.azure.spring.cloud.autoconfigure.aad.AadResourceServerWebSecurityConfigurerAdapter |
com.azure.spring.aad.webapp.AADWebSecurityConfigurerAdapter |
com.azure.spring.cloud.autoconfigure.aad.AadWebSecurityConfigurerAdapter |
com.azure.spring.aad.webapp.AuthorizationClientProperties |
com.azure.spring.cloud.autoconfigure.aad.properties.AuthorizationClientProperties |
com.azure.spring.aad.AADApplicationType |
com.azure.spring.cloud.autoconfigure.aad.properties.AadApplicationType |
com.azure.spring.aad.AADAuthorizationGrantType |
com.azure.spring.cloud.autoconfigure.aad.properties.AadAuthorizationGrantType |
com.azure.spring.aad.AADAuthorizationServerEndpoints |
com.azure.spring.cloud.autoconfigure.aad.properties.AadAuthorizationServerEndpoints |
com.azure.spring.aad.AADClientRegistrationRepository |
com.azure.spring.cloud.autoconfigure.aad.AadClientRegistrationRepository |
com.azure.spring.aad.AADTrustedIssuerRepository |
com.azure.spring.cloud.autoconfigure.aad.AadTrustedIssuerRepository |
com.azure.spring.autoconfigure.aad.AADAppRoleStatelessAuthenticationFilter |
com.azure.spring.cloud.autoconfigure.aad.filter.AadAppRoleStatelessAuthenticationFilter |
com.azure.spring.autoconfigure.aad.AADAuthenticationFilter |
com.azure.spring.cloud.autoconfigure.aad.filter.AadAuthenticationFilter |
com.azure.spring.autoconfigure.aad.AADAuthenticationProperties |
com.azure.spring.cloud.autoconfigure.aad.properties.AadAuthenticationProperties |
com.azure.spring.autoconfigure.aad.UserPrincipal |
com.azure.spring.cloud.autoconfigure.aad.filter.UserPrincipal |
com.azure.spring.autoconfigure.aad.UserPrincipalManager |
com.azure.spring.cloud.autoconfigure.aad.filter.UserPrincipalManager |
This section lists the removed classes from azure-spring-boot-starter-active-directory
-
com.azure.spring.aad.webapp.AADHandleConditionalAccessFilter
-
com.azure.spring.aad.webapi.validator.AADJwtAudienceValidator
-
com.azure.spring.aad.webapi.validator.AADJwtClaimValidator
From azure-spring-boot-starter-active-directory-b2c to spring-cloud-azure-starter-active-directory-b2c
This guide is intended to assist the migration to spring-cloud-azure-starter-active-directory-b2c from version 3 of azure-spring-boot-starter-active-directory-b2c.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
Dependency Changes
Some unnecessary dependencies in the legacy artifact have been removed since the modern Spring Cloud Azure 4.0 library. Please add these removed dependencies to your project to prevent unintentional crash.
Removed Dependency | Description |
---|---|
org.springframework.boot:spring-boot-starter-validation |
Please include the validation starter if you want to use Hibernate Validator. |
SDK Configuration Changes
This section includes the changes about the properties added, removed and changed.
-
All configuration property names' prefix is changed from
azure.activedirectory.b2c
tospring.cloud.azure.active-directory.b2c
. -
New property
spring.cloud.azure.active-directory.b2c.enabled
is added to enable/disable AAD B2C related features. The default value is false.
Legacy properties | Modern properties |
---|---|
azure.activedirectory.b2c.authenticate-additional-parameters |
spring.cloud.azure.active-directory.b2c.authenticate-additional-parameters |
azure.activedirectory.b2c.authorization-clients |
spring.cloud.azure.active-directory.b2c.authorization-clients |
azure.activedirectory.b2c.authorization-clients.<AZURE_CLIENT_NAME>.authorization-grant-type |
spring.cloud.azure.active-directory.b2c.authorization-clients.<AZURE_CLIENT_NAME>.authorization-grant-type |
azure.activedirectory.b2c.authorization-clients.<AZURE_CLIENT_NAME>.scopes |
spring.cloud.azure.active-directory.b2c.authorization-clients.<AZURE_CLIENT_NAME>.scopes |
azure.activedirectory.b2c.app-id-uri |
spring.cloud.azure.active-directory.b2c.app-id-uri |
azure.activedirectory.b2c.base-uri |
spring.cloud.azure.active-directory.b2c.base-uri |
azure.activedirectory.b2c.client-id |
spring.cloud.azure.active-directory.b2c.credential.client-id |
azure.activedirectory.b2c.client-secret |
spring.cloud.azure.active-directory.b2c.credential.client-secret |
azure.activedirectory.b2c.jwt-connect-timeout |
spring.cloud.azure.active-directory.b2c.jwt-connect-timeout |
azure.activedirectory.b2c.jwt-read-timeout |
spring.cloud.azure.active-directory.b2c.jwt-read-timeout |
azure.activedirectory.b2c.jwt-size-limit |
spring.cloud.azure.active-directory.b2c.jwt-size-limit |
azure.activedirectory.b2c.login-flow |
spring.cloud.azure.active-directory.b2c.login-flow |
azure.activedirectory.b2c.logout-success-url |
spring.cloud.azure.active-directory.b2c.logout-success-url |
azure.activedirectory.b2c.reply-url |
spring.cloud.azure.active-directory.b2c.reply-url |
azure.activedirectory.b2c.tenant-id |
spring.cloud.azure.active-directory.b2c.profile.tenant-id |
azure.activedirectory.b2c.user-flows |
spring.cloud.azure.active-directory.b2c.user-flows |
azure.activedirectory.b2c.user-name-attribute-name |
spring.cloud.azure.active-directory.b2c.user-name-attribute-name |
-
azure.activedirectory.b2c.allow-telemetry
-
azure.activedirectory.b2c.tenant
long
to Duration
:-
jwt-connect-timeout
-
jwt-read-timeout
API Changes
Legacy class | Modern class |
---|---|
com.azure.spring.autoconfigure.b2c.AADB2CAuthorizationRequestResolver |
com.azure.spring.cloud.autoconfigure.aadb2c.AadB2cAuthorizationRequestResolver |
com.azure.spring.autoconfigure.b2c.AADB2CJwtBearerTokenAuthenticationConverter |
com.azure.spring.cloud.autoconfigure.aad.AadJwtBearerTokenAuthenticationConverter |
com.azure.spring.autoconfigure.b2c.AADB2CLogoutSuccessHandler |
com.azure.spring.cloud.autoconfigure.aadb2c.AadB2cLogoutSuccessHandler |
com.azure.spring.autoconfigure.b2c.AADB2COidcLoginConfigurer |
com.azure.spring.cloud.autoconfigure.aadb2c.AadB2cOidcLoginConfigurer |
com.azure.spring.autoconfigure.b2c.AADB2CProperties |
com.azure.spring.cloud.autoconfigure.aadb2c.properties.AadB2cProperties |
com.azure.spring.autoconfigure.b2c.AADB2CTrustedIssuerRepository |
com.azure.spring.cloud.autoconfigure.aadb2c.AadB2cTrustedIssuerRepository |
com.azure.spring.autoconfigure.b2c.AuthorizationClientProperties |
com.azure.spring.cloud.autoconfigure.aadb2c.properties.AuthorizationClientProperties |
From azure-spring-boot-starter-cosmos to spring-cloud-azure-starter-data-cosmos
This guide is intended to assist the migration to spring-cloud-azure-starter-data-cosmos from version 3 of azure-spring-boot-starter-cosmos.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.Please refer to the global configurations section for the global and common configuration changes.
SDK Configuration Changes
All configuration property names' prefix is changed from azure.cosmos
to spring.cloud.azure.cosmos
.
Legacy properties | Morden properties |
---|---|
azure.cosmos.connection-mode |
spring.cloud.azure.cosmos.connection-mode |
azure.cosmos.consistency-level |
spring.cloud.azure.cosmos.consistency-level |
azure.cosmos.database |
spring.cloud.azure.cosmos.database |
azure.cosmos.key |
spring.cloud.azure.cosmos.key |
azure.cosmos.populate-query-metrics |
spring.cloud.azure.cosmos.populate-query-metrics |
azure.cosmos.uri |
spring.cloud.azure.cosmos.endpoint |
From azure-spring-boot-starter-keyvault-secrets to spring-cloud-azure-starter-keyvault-secrets
This guide is intended to assist the migration to spring-cloud-azure-starter-keyvault-secrets from version 3 of azure-spring-boot-starter-keyvault-secrets.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
SDK Configuration Changes
This section includes the changes about the properties added, removed and changed.
Legacy properties | Modern properties |
---|---|
azure.keyvault.case-sensitive-keys |
spring.cloud.azure.keyvault.secret.property-sources[n].case-sensitive |
azure.keyvault.certificate-password |
spring.cloud.azure.keyvault.secret.property-sources[n].credential.client-certificate-password |
azure.keyvault.certificate-path |
spring.cloud.azure.keyvault.secret.property-sources[n].credential.client-certificate-path |
azure.keyvault.client-id |
spring.cloud.azure.keyvault.secret.property-sources[n].credential.client-id |
azure.keyvault.client-key |
spring.cloud.azure.keyvault.secret.property-sources[n].credential.client-secret |
azure.keyvault.enabled |
spring.cloud.azure.keyvault.secret.enabled and spring.cloud.azure.keyvault.secret.property-source-enabled |
azure.keyvault.refresh-interval |
spring.cloud.azure.keyvault.secret.property-sources[n].refresh-interval |
azure.keyvault.secret-keys |
spring.cloud.azure.keyvault.secret.property-sources[n].secret-keys |
azure.keyvault.tenant-id |
spring.cloud.azure.keyvault.secret.property-sources[n].profile.tenant-id |
azure.keyvault.uri |
spring.cloud.azure.keyvault.secret.property-sources[n].endpoint |
-
azure.keyvault.allow-telemetry
-
azure.keyvault.order
-
All configuration property names changed the prefix from
azure.keyvault
tospring.cloud.azure.keyvault.secret
. -
spring.cloud.azure.keyvault.secret.enabled
is used to enable the feature of configuring Key Vault secret client beans(like SecretClient and SecretAsyncClient). -
spring.cloud.azure.keyvault.secret.property-source-enabled
is used to enable allKeyVaultPropertySource
. -
For Azure common properties(like
client
,proxy
,retry
,credential
,profile
) and Key Vault properties(likeendpoint
,service-version
). Ifspring.cloud.azure.keyvault.secret.property-sources[n].PROPERTY_NAME
isn’t configured,spring.cloud.azure.keyvault.secret.PROPERTY_NAME
will be used. -
spring.cloud.azure.keyvault.secret.property-sources[n].resource
is specific to a unique Azure resource, so if it’s not configured, it won’t get value from other places.
From azure-spring-boot-starter-servicebus-jms to spring-cloud-azure-starter-servicebus-jms
This guide is intended to assist the migration to spring-cloud-azure-starter-servicebus-jms from version 3 of azure-spring-boot-starter-servicebus-jms.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
SDK Configuration Changes
The value type for spring.jms.servicebus.idle-timeout
is changed from long
(milliseconds) to Duration
for ease of readability.
From azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-blob
This guide is intended to assist in the migration to spring-cloud-azure-starter-storage-blob from version 3 of azure-spring-boot-starter-storage.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
SDK Configuration Changes
All configuration property names changed the prefix from azure.storage
to spring.cloud.azure.storage.blob
.
Legacy properties | Modern properties |
---|---|
azure.storage.account-name |
spring.cloud.azure.storage.blob.account-name |
azure.storage.account-key |
spring.cloud.azure.storage.blob.account-key |
azure.storage.blob-endpoint |
spring.cloud.azure.storage.blob.endpoint |
API Changes
Legacy class | Modern class |
---|---|
com.azure.spring.autoconfigure.storage.resource.AzureStorageProtocolResolver |
com.azure.spring.cloud.core.resource.AzureStorageBlobProtocolResolver |
com.azure.spring.autoconfigure.storage.resource.AzureStorageResourcePatternResolver |
com.azure.spring.cloud.core.resource.AzureStorageBlobProtocolResolver |
com.azure.spring.autoconfigure.storage.resource.BlobStorageResource |
com.azure.spring.cloud.core.resource.StorageBlobResource |
From azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-file-share
This guide is intended to assist in the migration to spring-cloud-azure-starter-storage-file-share from version 3 of azure-spring-boot-starter-storage.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
SDK Configuration Changes
All configuration property names changed the prefix from azure.storage
to spring.cloud.azure.storage.fileshare
.
Legacy properties | Modern properties |
---|---|
azure.storage.account-name |
spring.cloud.azure.storage.fileshare.account-name |
azure.storage.account-key |
spring.cloud.azure.storage.fileshare.account-key |
azure.storage.file-endpoint |
spring.cloud.azure.storage.fileshare.endpoint |
API Changes
Legacy class | Modern class |
---|---|
com.azure.spring.autoconfigure.storage.resource.AzureStorageProtocolResolver |
com.azure.spring.cloud.core.resource.AzureStorageFileProtocolResolver |
com.azure.spring.autoconfigure.storage.resource.AzureStorageResourcePatternResolver |
com.azure.spring.cloud.core.resource.AzureStorageFileProtocolResolver |
com.azure.spring.autoconfigure.storage.resource.FileStorageResource |
com.azure.spring.cloud.core.resource.StorageFileResource |
From azure-spring-cloud-starter-eventhubs to spring-cloud-azure-starter-integration-eventhubs
This guide is intended to assist in the migration to spring-cloud-azure-starter-integration-eventhubs from version 2 of azure-spring-cloud-starter-eventhubs.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
SDK Configuration Changes
Configuration prefix has been changed from spring.cloud.azure.eventhub to spring.cloud.azure.eventhubs.
|
Changes for the child entries for this prefix, please refer the following tables:
Legacy properties | Modern properties |
---|---|
spring.cloud.azure.resource-group |
spring.cloud.azure.eventhubs.resource.resource-group |
spring.cloud.azure.eventhub.namespace |
spring.cloud.azure.eventhubs.namespace |
spring.cloud.azure.eventhub.connection-string |
spring.cloud.azure.eventhubs.connection-string |
spring.cloud.azure.eventhub.checkpoint-storage-account |
spring.cloud.azure.eventhubs.processor.checkpoint-store.account-name |
spring.cloud.azure.eventhub.checkpoint-access-key |
spring.cloud.azure.eventhubs.processor.checkpoint-store.account-key |
spring.cloud.azure.eventhub.checkpoint-container |
spring.cloud.azure.eventhubs.processor.checkpoint-store.container-name |
For example, change from:
spring:
cloud:
azure:
eventhub:
connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
checkpoint-storage-account: ${AZURE_CHECKPOINT_STORAGE_ACCOUNT_NAME}
checkpoint-access-key: ${AZURE_CHECKPOINT_ACCOUNT_KEY}
checkpoint-container: ${AZURE_CHECKPOINT_CONTAINER_NAME}
to:
spring:
cloud:
azure:
eventhubs:
connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
processor:
checkpoint-store:
container-name: ${AZURE_STORAGE_CONTAINER_NAME}
account-name: ${AZURE_STORAGE_ACCOUNT_NAME}
account-key: ${AZURE_STORAGE_ACCOUNT_KEY}
API Changes
-
Please refer to the migration guide of azure-spring-cloud-messaging library for the changes of listener annotations.
-
Drop
EventHubOperation
with the subscribing function moved to classEventHubsMessageListenerContainer
and the sending function moved toEventHubsTemplate
. -
Rename
EventHubInboundChannelAdapter
asEventHubsInboundChannelAdapter
to keep consistent with the service of Azure Event Hubs. -
Change the constructor from
EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String)
toEventHubsInboundChannelAdapter(EventHubsMessageListenerContainer)
andEventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode)
. -
Change
CheckpointConfig
instantiation style to the simple constructor instead of build style. -
Drop API
EventHubOperation#setCheckpointConfig
. To set the checkpoint configuration for the inbound channel adapter, users can call the methodEventHubsContainerProperties#setCheckpointConfig
. -
Drop API
EventHubOperation#setBatchConsumerConfig
. To set the batch-consuming configuration for the inbound channel adapter, users can call the two methodsEventHubsContainerProperties#getBatch#setMaxSize
andEventHubsContainerProperties#getBatch#setMaxWaitTime
meanwhile. -
For the batch consuming mode, change the message header names converted from batched messages.
-
Change message header from
azure_eventhub_enqueued_time
toazure_eventhubs_batch_converted_enqueued_time
. -
Change message header from
azure_eventhub_offset
toazure_eventhubs_batch_converted_offset
. -
Change message header from
azure_eventhub_sequence_number
toazure_eventhubs_batch_converted_sequence_number
. -
Change message header from
azure_partition_key
toazure_batch_converted_partition_key
.
-
-
When publishing messages to Event Hubs, ignore all message headers converted from batched messages. Headers include:
-
azure_batch_converted_partition_key
-
azure_eventhubs_batch_converted_enqueued_time
-
azure_eventhubs_batch_converted_offset
-
azure_eventhubs_batch_converted_sequence_number
-
azure_eventhubs_batch_converted_system_properties
-
azure_eventhubs_batch_converted_application_properties
-
-
The
BATCH
checkpoint mode only works in the batch-consuming mode now, which can be enabled by passingListenerMode.BATCH
to EventHubsInboundChannelAdapter constructor.
Legacy class | Modern class |
---|---|
com.azure.spring.integration.core.AzureHeaders |
com.azure.spring.messaging.AzureHeaders |
com.azure.spring.integration.core.EventHubHeaders |
com.azure.spring.messaging.eventhubs.support.EventHubsHeaders |
com.azure.spring.integration.core.api.CheckpointConfig |
com.azure.spring.messaging.eventhubs.core.checkpoint.CheckpointConfig |
com.azure.spring.integration.core.api.CheckpointMode |
com.azure.spring.messaging.eventhubs.core.checkpoint.CheckpointMode |
com.azure.spring.integration.core.api.reactor.Checkpointer |
com.azure.spring.messaging.checkpoint.Checkpointer |
com.azure.spring.integration.core.api.reactor.DefaultMessageHandler |
com.azure.spring.integration.core.handler.DefaultMessageHandler |
com.azure.spring.integration.eventhub.inbound.EventHubInboundChannelAdapter |
com.azure.spring.integration.eventhubs.inbound.EventHubsInboundChannelAdapter |
Sample Code Snippet
1.EventHubsInboundChannelAdapter sample code:
Legacy code:
public class Demo {
@Bean
public EventHubInboundChannelAdapter messageChannelAdapter(
@Qualifier("INPUT_CHANNEL") MessageChannel inputChannel, EventHubOperation eventhubOperation) {
eventhubOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode(CheckpointMode.MANUAL).build());
EventHubInboundChannelAdapter adapter = new EventHubInboundChannelAdapter("EVENTHUB_NAME",
eventhubOperation, "CONSUMER_GROUP");
adapter.setOutputChannel(inputChannel);
return adapter;
}
}
Modern code:
public class Demo {
@Bean
public EventHubsMessageListenerContainer messageListenerContainer(EventHubsProcessorFactory processorFactory) {
EventHubsContainerProperties containerProperties = new EventHubsContainerProperties();
containerProperties.setEventHubName("EVENTHUB_NAME");
containerProperties.setConsumerGroup("CONSUMER_GROUP");
CheckpointConfig config = new CheckpointConfig(CheckpointMode.MANUAL);
containerProperties.setCheckpointConfig(config);
return new EventHubsMessageListenerContainer(processorFactory, containerProperties);
}
@Bean
public EventHubsInboundChannelAdapter messageChannelAdapter(@Qualifier("INPUT_CHANNEL") MessageChannel inputChannel,
EventHubsMessageListenerContainer listenerContainer) {
EventHubsInboundChannelAdapter adapter = new EventHubsInboundChannelAdapter(listenerContainer);
adapter.setOutputChannel(inputChannel);
return adapter;
}
}
2.DefaultMessageHandler sample code:
Legacy code:
public class Demo {
@Bean
@ServiceActivator(inputChannel = "OUTPUT_CHANNEL")
public MessageHandler messageSender(EventHubOperation eventhubOperation) {
DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation);
handler.setSendCallback(new ListenableFutureCallback<Void>() {
@Override
public void onSuccess(Void result) {
LOGGER.info("Message was sent successfully.");
}
@Override
public void onFailure(Throwable ex) {
LOGGER.error("There was an error sending the message.", ex);
}
});
return handler;
}
}
Modern code:
public class Demo {
@Bean
@ServiceActivator(inputChannel = "OUTPUT_CHANNEL")
public MessageHandler messageSender(EventHubsTemplate eventhubOperation) {
DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation);
handler.setSendCallback(new ListenableFutureCallback<Void>() {
@Override
public void onSuccess(Void result) {
LOGGER.info("Message was sent successfully.");
}
@Override
public void onFailure(Throwable ex) {
LOGGER.error("There was an error sending the message.", ex);
}
});
return handler;
}
}
From azure-spring-integration-eventhubs to spring-integration-azure-eventhubs
This guide is intended to assist in the migration to spring-integration-azure-eventhubs from version 2 of azure-spring-integration-eventhubs.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
API Changes
-
Drop
EventHubOperation
with the subscribing function moved to classEventHubsMessageListenerContainer
and the sending function moved toEventHubsTemplate
. -
Rename
EventHubInboundChannelAdapter
asEventHubsInboundChannelAdapter
to keep consistent with the service of Azure Event Hubs. -
Change the constructor from
EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String)
toEventHubsInboundChannelAdapter(EventHubsMessageListenerContainer)
andEventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode)
. -
Change
CheckpointConfig
instantiation style to the simple constructor instead of build style. -
Drop API
EventHubOperation#setCheckpointConfig
. To set the checkpoint configuration for the inbound channel adapter, users can call the methodEventHubsContainerProperties#setCheckpointConfig
. -
Drop API
EventHubOperation#setBatchConsumerConfig
. To set the batch-consuming configuration for the inbound channel adapter, users can call the two methodsEventHubsContainerProperties#getBatch#setMaxSize
andEventHubsContainerProperties#getBatch#setMaxWaitTime
meanwhile. -
For the batch consuming mode, change the message header names converted from batched messages.
-
Change message header from
azure_eventhub_enqueued_time
toazure_eventhubs_batch_converted_enqueued_time
. -
Change message header from
azure_eventhub_offset
toazure_eventhubs_batch_converted_offset
. -
Change message header from
azure_eventhub_sequence_number
toazure_eventhubs_batch_converted_sequence_number
. -
Change message header from
azure_partition_key
toazure_batch_converted_partition_key
.
-
-
When publishing messages to Event Hubs, ignore all message headers converted from batched messages. Headers include:
-
azure_batch_converted_partition_key
-
azure_eventhubs_batch_converted_enqueued_time
-
azure_eventhubs_batch_converted_offset
-
azure_eventhubs_batch_converted_sequence_number
-
azure_eventhubs_batch_converted_system_properties
-
azure_eventhubs_batch_converted_application_properties
-
-
The
BATCH
checkpoint mode only works in the batch-consuming mode now, which can be enabled by passingListenerMode.BATCH
to EventHubsInboundChannelAdapter constructor.
Legacy class | Modern class |
---|---|
com.azure.spring.integration.core.AzureHeaders |
com.azure.spring.messaging.AzureHeaders |
com.azure.spring.integration.core.EventHubHeaders |
com.azure.spring.messaging.eventhubs.support.EventHubsHeaders |
com.azure.spring.integration.core.api.CheckpointConfig |
com.azure.spring.messaging.eventhubs.core.checkpoint.CheckpointConfig |
com.azure.spring.integration.core.api.CheckpointMode |
com.azure.spring.messaging.eventhubs.core.checkpoint.CheckpointMode |
com.azure.spring.integration.core.api.reactor.Checkpointer |
com.azure.spring.messaging.checkpoint.Checkpointer |
com.azure.spring.integration.core.api.reactor.DefaultMessageHandler |
com.azure.spring.integration.core.handler.DefaultMessageHandler |
com.azure.spring.integration.eventhub.inbound.EventHubInboundChannelAdapter |
com.azure.spring.integration.eventhubs.inbound.EventHubsInboundChannelAdapter |
From azure-spring-cloud-starter-servicebus to spring-cloud-azure-starter-integration-servicebus
This guide is intended to assist in the migration to spring-cloud-azure-starter-integration-servicebus from version 2 of azure-spring-cloud-starter-servicebus.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
SDK Configuration Changes
For all configuration options supported in spring-cloud-azure-starter-integration-servicebus,
the prefix remains to be as spring.cloud.azure.servicebus
.
Legacy properties | Modern properties |
---|---|
spring.cloud.azure.resource-group |
spring.cloud.azure.servicebus.resource.resource-group |
spring.cloud.azure.servicebus.transport-type |
spring.cloud.azure.servicebus.client.transport-type |
spring.cloud.azure.servicebus.retry-options.retry-mode |
spring.cloud.azure.servicebus.retry.mode |
spring.cloud.azure.servicebus.retry-options.max-retries |
spring.cloud.azure.servicebus.retry.exponential.max-retries or spring.cloud.azure.servicebus.retry.fixed.max-retries, should be configured depending on spring.cloud.azure.servicebus.retry.mode=fixed or exponential |
spring.cloud.azure.servicebus.retry-options.delay |
spring.cloud.azure.servicebus.retry.exponential.base-delay or spring.cloud.azure.servicebus.retry.fixed.delay, should be configured depending on spring.cloud.azure.servicebus.retry.mode=fixed or exponential |
spring.cloud.azure.servicebus.retry-options.max-delay |
spring.cloud.azure.servicebus.retry.exponential.max-delay |
spring.cloud.azure.servicebus.retry-options.try-timeout |
spring.cloud.azure.servicebus.retry.try-timeout |
API Changes
-
Drop
ServiceBusQueueOperation
andServiceBusTopicOperation
with the subscribing function moved to classServiceBusMessageListenerContainer
and the sending function moved toServiceBusTemplate
. -
Drop
ServiceBusQueueInboundChannelAdapter
andServiceBusTopicInboundChannelAdapter
, and move the functionality to listen to a Service Bus queue/topic entity to ServiceBusInboundChannelAdapter. -
Change the constructor from
ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String)
toServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)
andServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)
. -
Change the constructor from
ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String)
toServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)
andServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)
. -
Drop APIs
ServiceBusQueueOperation#setCheckpointConfig
andServiceBusTopicOperation#setCheckpointConfig
. To set the checkpoint configuration for the inbound channel adapter, users can call the methodServiceBusContainerProperties#setAutoComplete
instead. To disable the auto-complete mode is equivalent toMANUAL
checkpoint mode and to enable it will trigger theRECORD
mode. -
Drop APIs
ServiceBusQueueOperatio#setClientConfig
andServiceBusTopicOperation#setClientConfig
. To configure the underlyingServiceBusProcessorClient
used by the inbound channel adapter, users can useServiceBusContainerProperties
instead. -
Drop
CompletableFuture
support inServiceBusTemplate
andDefaultMessageHandler
, supportReactor
instead. -
Add new API of
ServiceBusTemplate#setDefaultEntityType
to specify the entity type, which is required when no bean ofPropertiesSupplier<String, ProducerProperties>
is provided for theProducerProperties#entityType
. -
Drop message header
AzureHeaders.RAW_ID
. Please useServiceBusMessageHeaders.MESSAGE_ID
instead.
Legacy class | Modern class |
---|---|
com.azure.spring.integration.core.AzureHeaders |
com.azure.spring.messaging.AzureHeaders |
com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders |
com.azure.spring.messaging.servicebus.support.ServiceBusMessageHeaders |
com.azure.spring.integration.servicebus.converter.ServiceBusMessageConverter |
com.azure.spring.messaging.servicebus.support.converter.ServiceBusMessageConverter |
com.azure.spring.integration.core.DefaultMessageHandler |
com.azure.spring.integration.core.handler.DefaultMessageHandler |
com.azure.spring.integration.servicebus.inbound.ServiceBusQueueInboundChannelAdapter |
com.azure.spring.integration.servicebus.inbound.ServiceBusInboundChannelAdapter |
com.azure.spring.integration.servicebus.inbound.ServiceBusTopicInboundChannelAdapter |
com.azure.spring.integration.servicebus.inbound.ServiceBusInboundChannelAdapter |
Sample Code Snippet
1.ServiceBusInboundChannelAdapter sample code:
Legacy code of using ServiceBusQueueInboundChannelAdapter
or ServiceBusTopicInboundChannelAdapter
:
public class Demo {
@Bean
public ServiceBusQueueInboundChannelAdapter queueMessageChannelAdapter(
@Qualifier("INPUT_CHANNEL_NAME") MessageChannel inputChannel, ServiceBusQueueOperation queueOperation) {
queueOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode(CheckpointMode.MANUAL).build());
ServiceBusQueueInboundChannelAdapter adapter = new ServiceBusQueueInboundChannelAdapter("QUEUE_NAME",
queueOperation);
adapter.setOutputChannel(inputChannel);
return adapter;
}
@Bean
public ServiceBusTopicInboundChannelAdapter topicMessageChannelAdapter(
@Qualifier("INPUT_CHANNEL_NAME") MessageChannel inputChannel, ServiceBusTopicOperation topicOperation) {
topicOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode(CheckpointMode.MANUAL).build());
ServiceBusTopicInboundChannelAdapter adapter = new ServiceBusTopicInboundChannelAdapter("TOPIC_NAME",
topicOperation, "SUBSCRIPTION_NAME");
adapter.setOutputChannel(inputChannel);
return adapter;
}
}
Modern code:
public class Demo {
@Bean("queue-listener-container")
public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) {
ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties();
containerProperties.setEntityName("QUEUE_NAME");
containerProperties.setAutoComplete(false);
return new ServiceBusMessageListenerContainer(processorFactory, containerProperties);
}
@Bean
public ServiceBusInboundChannelAdapter queueMessageChannelAdapter(
@Qualifier("INPUT_CHANNEL") MessageChannel inputChannel,
@Qualifier("queue-listener-container") ServiceBusMessageListenerContainer listenerContainer) {
ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer);
adapter.setOutputChannel(inputChannel);
return adapter;
}
@Bean("topic-listener-container")
public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) {
ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties();
containerProperties.setEntityName("TOPIC_NAME");
containerProperties.setSubscriptionName("SUBSCRIPTION_NAME");
containerProperties.setAutoComplete(false);
return new ServiceBusMessageListenerContainer(processorFactory, containerProperties);
}
@Bean
public ServiceBusInboundChannelAdapter topicMessageChannelAdapter(
@Qualifier("INPUT_CHANNEL") MessageChannel inputChannel,
@Qualifier("topic-listener-container") ServiceBusMessageListenerContainer listenerContainer) {
ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer);
adapter.setOutputChannel(inputChannel);
return adapter;
}
}
2.DefaultMessageHandler sample code:
Legacy code, taking queue as example:
public class Demo {
@Bean
@ServiceActivator(inputChannel = "OUTPUT_CHANNEL_NAME")
public MessageHandler queueMessageSender(ServiceBusQueueOperation queueOperation) {
DefaultMessageHandler handler = new DefaultMessageHandler("QUEUE_NAME", queueOperation);
handler.setSendCallback(new ListenableFutureCallback<Void>() {
@Override
public void onSuccess(Void result) {
LOGGER.info("Message was sent successfully.");
}
@Override
public void onFailure(Throwable ex) {
LOGGER.info("There was an error sending the message.");
}
});
return handler;
}
}
Modern code:
public class Demo {
@Bean
@ServiceActivator(inputChannel = "OUTPUT_CHANNEL_NAME")
public MessageHandler queueMessageSender(ServiceBusTemplate serviceBusTemplate) {
serviceBusTemplate.setDefaultEntityType(ServiceBusEntityType.QUEUE);
DefaultMessageHandler handler = new DefaultMessageHandler("QUEUE_NAME", serviceBusTemplate);
handler.setSendCallback(new ListenableFutureCallback<Void>() {
@Override
public void onSuccess(Void result) {
LOGGER.info("Message was sent successfully for {}.", "QUEUE_NAME");
}
@Override
public void onFailure(Throwable ex) {
LOGGER.info("There was an error sending the message.");
}
});
return handler;
}
}
From azure-spring-integration-servicebus to spring-integration-azure-servicebus
This guide is intended to assist in the migration to spring-integration-azure-servicebus from version 2 of azure-spring-integration-servicebus.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
API Changes
-
Drop
ServiceBusQueueOperation
andServiceBusTopicOperation
with the subscribing function moved to classServiceBusMessageListenerContainer
and the sending function moved toServiceBusTemplate
. -
Drop
ServiceBusQueueInboundChannelAdapter
andServiceBusTopicInboundChannelAdapter
, and move the functionality to listen to a Service Bus queue/topic entity to ServiceBusInboundChannelAdapter. -
Change the constructor from
ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String)
toServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)
andServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)
. -
Change the constructor from
ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String)
toServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)
andServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)
. -
Drop APIs
ServiceBusQueueOperation#setCheckpointConfig
andServiceBusTopicOperation#setCheckpointConfig
. To set the checkpoint configuration for the inbound channel adapter, users can call the methodServiceBusContainerProperties#setAutoComplete
instead. To disable the auto-complete mode is equivalent toMANUAL
checkpoint mode and to enable it will trigger theRECORD
mode. -
Drop APIs
ServiceBusQueueOperation#setClientConfig
andServiceBusTopicOperation#setClientConfig
. To configure the underlyingServiceBusProcessorClient
used by the inbound channel adapter, users can useServiceBusContainerProperties
instead. -
Drop
CompletableFuture
support inServiceBusTemplate
andDefaultMessageHandler
, supportReactor
instead. -
Add new API of
ServiceBusTemplate#setDefaultEntityType
to specify the entity type, which is required when no bean ofPropertiesSupplier<String, ProducerProperties>
is provided for theProducerProperties#entityType
. -
Drop message header
AzureHeaders.RAW_ID
. Please useServiceBusMessageHeaders.MESSAGE_ID
instead.
Legacy class | Modern class |
---|---|
com.azure.spring.integration.core.AzureHeaders |
com.azure.spring.messaging.AzureHeaders |
com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders |
com.azure.spring.messaging.servicebus.support.ServiceBusMessageHeaders |
com.azure.spring.integration.servicebus.converter.ServiceBusMessageConverter |
com.azure.spring.messaging.servicebus.support.converter.ServiceBusMessageConverter |
com.azure.spring.integration.core.DefaultMessageHandler |
com.azure.spring.integration.core.handler.DefaultMessageHandler |
com.azure.spring.integration.servicebus.inbound.ServiceBusQueueInboundChannelAdapter |
com.azure.spring.integration.servicebus.inbound.ServiceBusInboundChannelAdapter |
com.azure.spring.integration.servicebus.inbound.ServiceBusTopicInboundChannelAdapter |
com.azure.spring.integration.servicebus.inbound.ServiceBusInboundChannelAdapter |
From azure-spring-cloud-starter-storage-queue to spring-cloud-azure-starter-integration-storage-queue
This guide is intended to assist in the migration to spring-cloud-azure-starter-integration-storage-queue from version 2 of azure-spring-cloud-starter-storage-queue.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
SDK Configuration Changes
All configuration property names changed the prefix from spring.cloud.azure.storage
to spring.cloud.azure.storage.queue
.
Legacy properties | Modern properties |
---|---|
spring.cloud.azure.storage.account |
spring.cloud.azure.storage.queue.account-name |
spring.cloud.azure.storage.access-key |
spring.cloud.azure.storage.queue.account-key |
spring.cloud.azure.storage.resource-group |
spring.cloud.azure.storage.queue.resource.resource-group |
API Changes
-
Drop
StorageQueueOperation
and provideStorageQueueTemplate
instead. -
Drop
checkpoint-mode
configuration inStorageQueueTemplate
, only support theMANUAL
mode.
Legacy class | Modern class |
---|---|
com.azure.spring.integration.core.AzureHeaders |
com.azure.spring.messaging.AzureHeaders |
com.azure.spring.integration.storage.queue.converter.StorageQueueMessageConverter |
com.azure.spring.messaging.storage.queue.support.converter.StorageQueueMessageConverter |
com.azure.spring.integration.core.api.reactor.Checkpointer |
com.azure.spring.messaging.checkpoint.Checkpointer |
com.azure.spring.integration.storage.queue.StorageQueueTemplate |
com.azure.spring.messaging.storage.queue.core.StorageQueueTemplate |
com.azure.spring.integration.core.api.reactor.DefaultMessageHandler |
com.azure.spring.integration.core.handler.DefaultMessageHandler |
com.azure.spring.integration.storage.queue.inbound.StorageQueueMessageSource |
com.azure.spring.integration.storage.queue.inbound.StorageQueueMessageSource |
From azure-spring-integration-storage-queue to spring-integration-azure-storage-queue
This guide is intended to assist in the migration to spring-integration-azure-storage-queue from version 2 of azure-spring-integration-storage-queue.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
API Changes
-
Drop
StorageQueueOperation
and provideStorageQueueTemplate
instead. -
Drop
checkpoint-mode
configuration inStorageQueueTemplate
, only support theMANUAL
mode.
Legacy class | Modern class |
---|---|
com.azure.spring.integration.core.AzureHeaders |
com.azure.spring.messaging.AzureHeaders |
com.azure.spring.integration.storage.queue.converter.StorageQueueMessageConverter |
com.azure.spring.messaging.storage.queue.support.converter.StorageQueueMessageConverter |
com.azure.spring.integration.core.api.reactor.Checkpointer |
com.azure.spring.messaging.checkpoint.Checkpointer |
com.azure.spring.integration.storage.queue.StorageQueueTemplate |
com.azure.spring.messaging.storage.queue.core.StorageQueueTemplate |
com.azure.spring.integration.core.api.reactor.DefaultMessageHandler |
com.azure.spring.integration.core.handler.DefaultMessageHandler |
com.azure.spring.integration.storage.queue.inbound.StorageQueueMessageSource |
com.azure.spring.integration.storage.queue.inbound.StorageQueueMessageSource |
From azure-spring-cloud-stream-binder-eventhubs to spring-cloud-azure-stream-binder-eventhubs
This guide is intended to assist in the migration to spring-cloud-azure-stream-binder-eventhubs from version 2 of azure-spring-cloud-stream-binder-eventhubs.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
SDK Configuration Changes
Configuration prefix has been changed from spring.cloud.azure.eventhub to spring.cloud.azure.eventhubs.
|
The binder type is renamed from: eventhub to eventhubs .
|
Changes for the child entries for following prefix, please refer the following table:
Legacy properties | Modern properties |
---|---|
spring.cloud.azure.resource-group |
spring.cloud.azure.eventhubs.resource.resource-group |
spring.cloud.azure.eventhub.namespace |
spring.cloud.azure.eventhubs.namespace |
spring.cloud.azure.eventhub.connection-string |
spring.cloud.azure.eventhubs.connection-string |
spring.cloud.azure.eventhub.checkpoint-storage-account |
spring.cloud.azure.eventhubs.processor.checkpoint-store.account-name |
spring.cloud.azure.eventhub.checkpoint-access-key |
spring.cloud.azure.eventhubs.processor.checkpoint-store.account-key |
spring.cloud.azure.eventhub.checkpoint-container |
spring.cloud.azure.eventhubs.processor.checkpoint-store.container-name |
spring.cloud.stream.eventhub.bindings.<binding-name>.consumer.max-batch-size |
spring.cloud.stream.eventhubs.bindings.<binding-name>.consumer.batch.max-size |
spring.cloud.stream.eventhub.bindings.<binding-name>.consumer.max-wait-time |
spring.cloud.stream.eventhubs.bindings.<binding-name>.consumer.batch.max-wait-time |
spring.cloud.stream.eventhub.bindings.<binding-name>.consumer.checkpoint-mode |
spring.cloud.stream.eventhubs.bindings.<binding-name>.consumer.checkpoint.mode |
spring.cloud.stream.eventhub.bindings.<binding-name>.consumer.checkpoint-count |
spring.cloud.stream.eventhubs.bindings.<binding-name>.consumer.checkpoint.count |
spring.cloud.stream.eventhub.bindings.<binding-name>.consumer.checkpoint-interval |
spring.cloud.stream.eventhubs.bindings.<binding-name>.consumer.checkpoint.interval |
spring.cloud.stream.eventhub.bindings.<binding-name>.consumer.start-position |
spring.cloud.stream.eventhubs.bindings.<binding-name>.consumer.initial-partition-event-position |
The value type of the start-position configuration is also changed from an enum of com.azure.spring.integration.core.api.StartPosition to a map of StartPositionProperties for each partition. Thus, the key is the partition id, and the value is of com.azure.spring.cloud.service.eventhubs.properties.StartPositionProperties which includes properties of offset, sequence number, enqueued date time and whether inclusive.
|
Configuration migration examples
To use the connection string for authentication and migrate the above mentioned properties, configuration changes are listed the follows:
Legacy configuration:
spring:
cloud:
azure:
eventhub:
connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
checkpoint-storage-account: ${AZURE_CHECKPOINT_STORAGE_ACCOUNT_NAME}
checkpoint-access-key: ${AZURE_CHECKPOINT_ACCOUNT_KEY}
checkpoint-container: ${AZURE_CHECKPOINT_CONTAINER_NAME}
stream:
eventhub:
bindings:
<binding-name>:
consumer:
max-batch-size: ${AZURE_MAX_BATCH_SIZE}
max-wait-time: ${AZURE_MAX_WAIT_TIME}
checkpoint-mode: ${AZURE_CHECKPOINT_MODE}
checkpoint-count: ${AZURE_CHECKPOINT_COUNT}
checkpoint-interval: ${AZURE_CHECKPOINT_INTERVAL}
start-position: EARLIEST
Modern configuration:
spring:
cloud:
azure:
eventhubs:
connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
processor:
checkpoint-store:
container-name: ${AZURE_STORAGE_CONTAINER_NAME}
account-name: ${AZURE_STORAGE_ACCOUNT_NAME}
account-key: ${AZURE_STORAGE_ACCOUNT_KEY}
stream:
eventhubs:
bindings:
<binding-name>:
consumer:
batch:
max-size: ${AZURE_MAX_BATCH_SIZE}
max-wait-time: ${AZURE_MAX_WAIT_TIME}
checkpoint:
mode: ${AZURE_CHECKPOINT_MODE}
count: ${AZURE_CHECKPOINT_COUNT}
interval: ${AZURE_CHECKPOINT_INTERVAL}
initial-partition-event-position:
0:
offset: earliest
1:
sequence-number: 100
2:
enqueued-date-time: 2022-01-12T13:32:47.650005Z
4:
inclusive: false
If you use security principals instead of connection strings, in versions before 4.0 the application will firstly connect to Azure Resource Manager (ARM) with the provided security principal, and then retrieve the connection string of the specified namespace with ARM. In the end the application uses the retrieved connection string to connect to Azure Event Hubs. In this way the provided security principal should be granted with the Contributor role to retrieve of the associated Azure Event Hubs namespace.
For Azure Spring Cloud 4.0, we provide two ways of leveraging security principals for authentication. One is still using the principals to connect to ARM and retrieve the connection strings where the Contributor
role is required for the principals.
The other leverages security principals to authenticate to Azure Active Directory (Azure AD) and then connect to Azure Event Hubs directly, in this case the Contributor
role is not necessary anymore
while other Data
related roles are required for messaging operations, please refer to Authorize access with Azure AD to make sure the security principal has been granted the sufficient permission to access the Azure resource.
For authentication based on ARM, taking service principal as example, configuration migration is listed the follows, where the assigned role should not change:
Legacy configuration:
spring:
cloud:
azure:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
tenant-id: ${AZURE_TENANT_ID}
resource-group: ${EVENTHUB_RESOURCE_GROUP}
eventhub:
namespace: ${EVENTHUB_NAMESPACE}
Modern configuration, properties for Azure subscription ID and resource group are required:
spring:
cloud:
azure:
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${AZURE_TENANT_ID}
subscription-id: ${AZURE_SUBSCRIPTION_ID}
eventhubs:
namespace: ${EVENTHUB_NAMESPACE}
resource:
resource-group: ${RESOURCE_GROUP}
You can also migrate to authenticate and authorize with Azure AD directly without making a detour to ARM. Make sure to grant the security principal necessary Data
roles for messaging operations. The configuration examples of the service principal and the managed identity are listed the follows:
-
With a service principal
spring:
cloud:
azure:
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${AZURE_TENANT_ID}
eventhubs:
namespace: ${EVENTHUB_NAMESPACE}
-
With a managed identity
spring:
cloud:
azure:
credential:
managed-identity-enabled: true
client-id: ${AZURE_MANAGED_IDENTITY_CLIENT_ID} # Only needed when using a user-assigned managed identity
eventhubs:
namespace: ${EVENTHUB_NAMESPACE}
API Changes
Legacy class | Modern class |
---|---|
com.azure.spring.integration.core.api.reactor.Checkpointer |
com.azure.spring.messaging.checkpoint.Checkpointer |
com.azure.spring.integration.core.AzureHeaders |
com.azure.spring.messaging.AzureHeaders |
com.azure.spring.integration.core.EventHubHeaders |
com.azure.spring.messaging.eventhubs.support.EventHubsHeaders |
From azure-spring-cloud-stream-binder-servicebus-* to spring-cloud-azure-stream-binder-servicebus
This guide is intended to assist in the migration to spring-cloud-azure-stream-binder-servicebus from version 2 of azure-spring-cloud-stream-binder-servicebus-queue or azure-spring-cloud-stream-binder-servicebus-topic.
-
Please refer to introduction and migration benefits to get a whole picture of the changes in 4.0.
-
Please refer to naming changes to learn more about the strategy changes in the project naming.
-
Please refer to bom to learn how to using one BOM for all Spring Cloud Azure libraries.
-
Please refer to authentication to learn how to handle authentication in Spring Cloud Azure 4.0.
-
Please refer to properties migration to learn how to leverage
spring-boot-properties-migrator
during migration. -
Please refer to global configurations to learn more about the global and common configuration changes.
SDK Configuration changes
Legacy binder libraries are azure-spring-cloud-stream-binder-servicebus-queue and azure-spring-cloud-stream-binder-servicebus-topic , and now they’re merged into one spring-cloud-azure-stream-binder-servicebus
to support both Service Bus Queue and Topic.
|
The binder type is combined from servicebus-queue and servicebus-topic as servicebus .
|
Modern properties | description |
---|---|
spring.cloud.stream.servicebus.bindings.<binding-name>.producer.entity-type |
If you use the sending function, the entity-type property is required, which can be set to topic or queue. |
Legacy properties | Modern properties |
---|---|
spring.cloud.azure.resource-group |
spring.cloud.azure.servicebus.resource.resource-group |
spring.cloud.azure.servicebus.transport-type |
spring.cloud.azure.servicebus.client.transport-type |
spring.cloud.azure.servicebus.retry-options.retry-mode |
spring.cloud.azure.servicebus.retry.mode |
spring.cloud.azure.servicebus.retry-options.max-retries |
spring.cloud.azure.servicebus.retry.exponential.max-retries or spring.cloud.azure.servicebus.retry.fixed.max-retries, should be configured depending on spring.cloud.azure.servicebus.retry.mode=fixed or exponential |
spring.cloud.azure.servicebus.retry-options.delay |
spring.cloud.azure.servicebus.retry.exponential.base-delay or spring.cloud.azure.servicebus.retry.fixed.delay, should be configured depending on spring.cloud.azure.servicebus.retry.mode=fixed or exponential |
spring.cloud.azure.servicebus.retry-options.max-delay |
spring.cloud.azure.servicebus.retry.exponential.max-delay |
spring.cloud.azure.servicebus.retry-options.try-timeout |
spring.cloud.azure.servicebus.retry.try-timeout |
spring.cloud.stream.servicebus.queue.bindings.* |
spring.cloud.stream.servicebus.bindings.* |
spring.cloud.stream.servicebus.queue.bindings.<binding-name>.consumer.concurrency |
spring.cloud.stream.servicebus.bindings.<binding-name>.consumer.max-concurrent-sessions/max-concurrent-calls |
spring.cloud.stream.servicebus.queue.bindings.<binding-name>.consumer.checkpoint-mode |
spring.cloud.stream.servicebus.bindings.<binding-name>.consumer.auto-complete |
spring.cloud.stream.servicebus.topic.bindings.* |
spring.cloud.stream.servicebus.bindings.* |
spring.cloud.stream.servicebus.topic.bindings.<binding-name>.consumer.concurrency |
spring.cloud.stream.servicebus.bindings.<binding-name>.consumer.max-concurrent-sessions/max-concurrent-calls |
spring.cloud.stream.servicebus.topic.bindings.<binding-name>.consumer.checkpoint-mode |
spring.cloud.stream.servicebus.bindings.<binding-name>.consumer.auto-complete |
The concurrency property will be replaced by the maxConcurrentSessions when sessionsEnabled is true and the maxConcurrentCalls when sessionsEnabled is false .
|
Enabling auto-complete is equal to RECORD checkpoint mode, and oppositely the MANUAL mode.
|
Configuration migration examples
Legacy configuration, taking queue as example:
spring:
cloud:
azure:
servicebus:
connection-string: ${AZURE_SERVICEBUS_BINDER_CONNECTION_STRING}
stream:
function:
definition: consume;supply
bindings:
consume-in-0:
destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
supply-out-0:
destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
servicebus:
queue:
bindings:
consume-in-0:
consumer:
checkpoint-mode: MANUAL
Modern configuration:
spring:
cloud:
azure:
servicebus:
connection-string: ${AZURE_SERVICEBUS_BINDER_CONNECTION_STRING}
stream:
function:
definition: consume;supply
bindings:
consume-in-0:
destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
supply-out-0:
destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
servicebus:
bindings:
consume-in-0:
consumer:
auto-complete: false
supply-out-0:
producer:
entity-type: queue #set as topic if needed
If you use security principals instead of connection strings, in versions before 4.0 the application will firstly connect to Azure Resource Manager (ARM) with the provided security principal, and then retrieve the connection string of the specified namespace with ARM. In the end the application uses the retrieved connection string to connect to Azure Service Bus. In this way the provided security principal should be granted with the Contributor role to retrieve of the associated Azure Service Bus namespace.
For Azure Spring Cloud 4.0, we provide two ways of leveraging security principals for authentication. One is still using the principals to connect to ARM and retrieve the connection strings where the Contributor
role is required for the principals.
The other leverages security principals to authenticate to Azure Active Directory (Azure AD) and then connect to the Azure Service Bus directly, in this case the Contributor
role is not necessary anymore
while other Data
related roles are required for messaging operations, please refer to Authorize access with Azure AD to make sure the security principal has been granted the sufficient permission to access the Azure resource.
For authentication based on ARM, taking service principal as example, configuration migration is listed the follows, where the assigned role should not change:
Legacy configuration:
spring:
cloud:
azure:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
tenant-id: ${AZURE_TENANT_ID}
resource-group: ${SERVICEBUS_RESOURCE_GROUP}
servicebus:
namespace: ${SERVICEBUS_NAMESPACE}
Modern configuration, properties for Azure subscription ID and resource group are required:
spring:
cloud:
azure:
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${AZURE_TENANT_ID}
subscription-id: ${AZURE_SUBSCRIPTION_ID}
servicebus:
namespace: ${SERVICEBUS_NAMESPACE}
resource:
resource-group: ${SERVICEBUS_RESOURCE_GROUP}
You can also migrate to authenticate and authorize with Azure AD directly without making a detour to ARM. Make sure to grant the security principal necessary Data
roles for messaging operations. The configuration examples of the service principal and the managed identity are listed the follows:
-
With a service principal
spring:
cloud:
azure:
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${AZURE_TENANT_ID}
servicebus:
namespace: ${SERVICEBUS_NAMESPACE}
-
With a managed identity
spring:
cloud:
azure:
credential:
managed-identity-enabled: true
client-id: ${AZURE_MANAGED_IDENTITY_CLIENT_ID} # Only needed when using a user-assigned managed identity
servicebus:
namespace: ${SERVICEBUS_NAMESPACE}
API Changes
-
Drop message header
AzureHeaders.RAW_ID
. Please useServiceBusMessageHeaders.MESSAGE_ID
instead.
Legacy class | Modern class |
---|---|
com.azure.spring.integration.core.AzureHeaders |
com.azure.spring.messaging.AzureHeaders |
com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders |
com.azure.spring.messaging.servicebus.support.ServiceBusMessageHeaders |
com.azure.spring.integration.core.api.Checkpointer |
com.azure.spring.messaging.checkpoint.Checkpointer |
azure-spring-cloud-messaging
Library of com.azure.spring:azure-spring-cloud-messaging
is not ready for 4.0. The function of listener annotations is under redesign,
so annotations of @AzureMessageListener
, @AzureMessageListeners
and @EnableAzureMessaging
are not supported now.