microsoft
/
spring-cloud-azure
зеркало из
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Merge remote-tracking branch 'upstream/4.0.0-beta.4' into update-security-migration-guide

This commit is contained in:
Gary Liu 2022-03-29 10:18:03 +08:00
Родитель 5ae4cd8ab7 b87359fbc5
Коммит 042a47a5f9
35 изменённых файлов: 2541 добавлений и 815 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

417
docs/pom.xml
Просмотреть файл

@ -1,123 +1,302 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-aggregator</artifactId>
<version>4.0.0-beta.4</version>
<relativePath>../pom.xml</relativePath>
</parent>
<parent>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-aggregator</artifactId>
<version>4.0.0-beta.4</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>spring-cloud-azure-build-docs</artifactId>
<name>spring-cloud-azure-build-docs</name>
<packaging>jar</packaging>
<description>Spring Cloud Azure Build Docs</description>
<artifactId>spring-cloud-azure-build-docs</artifactId>
<name>spring-cloud-azure-build-docs</name>
<packaging>jar</packaging>
<description>Spring Cloud Azure Build Docs</description>
<properties>
<docs.main>spring-cloud-azure</docs.main>
<main.basedir>${basedir}/..</main.basedir>
<docs.whitelisted.branches>${project.version}</docs.whitelisted.branches>
<configprops.inclusionPattern>spring.jms.servicebus.*|spring.cloud.azure.*</configprops.inclusionPattern>
<upload-docs-zip.phase>none</upload-docs-zip.phase>
<generated-docs-multipage-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/html</generated-docs-multipage-output.dir>
<generated-docs-singlepage-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/htmlsingle</generated-docs-singlepage-output.dir>
<generated-docs-pdf-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/pdf</generated-docs-pdf-output.dir>
</properties>
<repositories>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>spring-releases</id>
<name>Spring Releases</name>
<url>https://repo.spring.io/release</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>spring-releases</id>
<name>Spring Releases</name>
<url>https://repo.spring.io/release</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
<dependencies>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter</artifactId>
</dependency>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-stream-eventhubs</artifactId>
</dependency>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-stream-servicebus</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>docs</id>
<build>
<plugins>
<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>
<properties>
<docs.main>spring-cloud-azure</docs.main>
<main.basedir>${basedir}/..</main.basedir>
<docs.whitelisted.branches>${project.version}</docs.whitelisted.branches>
<configprops.inclusionPattern>spring.jms.servicebus.*|spring.cloud.azure.*</configprops.inclusionPattern>
<upload-docs-zip.phase>none</upload-docs-zip.phase>
<generated-docs-multipage-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/html</generated-docs-multipage-output.dir>
<generated-docs-singlepage-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/htmlsingle</generated-docs-singlepage-output.dir>
<generated-docs-pdf-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/pdf</generated-docs-pdf-output.dir>
</properties>
<repositories>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>spring-releases</id>
<name>Spring Releases</name>
<url>https://repo.spring.io/release</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>spring-releases</id>
<name>Spring Releases</name>
<url>https://repo.spring.io/release</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
<dependencies>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter</artifactId>
</dependency>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-stream-eventhubs</artifactId>
</dependency>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-stream-servicebus</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>docs</id>
<build>
<plugins>
<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<executions>
<execution>
<id>generate-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
</execution>
<execution>
<id>generate-global-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_global.adoc</argument>
<argument>spring.cloud.azure.(client|credential|profile|proxy|retry).*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-aad-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_aad.adoc</argument>
<argument>spring.cloud.azure.active-directory.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-aadb2c-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_aadb2c.adoc</argument>
<argument>spring.cloud.azure.active-directory.b2c.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-appconf-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_appconf.adoc</argument>
<argument>spring.cloud.azure.appconfiguration.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-cosmos-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_cosmos.adoc</argument>
<argument>spring.cloud.azure.cosmos.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-eventhubs-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_eventhubs.adoc</argument>
<argument>spring.cloud.azure.eventhubs.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-kv-secret-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_kv_secret.adoc</argument>
<argument>spring.cloud.azure.keyvault.secret.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-kv-certificate-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_kv_certificate.adoc</argument>
<argument>spring.cloud.azure.keyvault.certificate.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-servicebus-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_servicebus.adoc</argument>
<argument>spring.cloud.azure.servicebus.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-servicebus-jms-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_servicebus_jms.adoc</argument>
<argument>spring.jms.servicebus.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-storage-blob-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_storage_blob.adoc</argument>
<argument>spring.cloud.azure.storage.blob.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-storage-fileshare-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_storage_fileshare.adoc</argument>
<argument>spring.cloud.azure.storage.fileshare.*</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-storage-queue-configprops</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/src/main/asciidoc/_configprops_storage_queue.adoc</argument>
<argument>spring.cloud.azure.storage.queue.*</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>

379
docs/src/main/asciidoc/_configprops.adoc
Просмотреть файл

@ -4,39 +4,42 @@
|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 | | Specify client configuration.
|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 | | AAD B2C credential information.
|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 | `false` | 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 | `sign-up-or-sign-in` | Specify the primary sign-in flow key.
|spring.cloud.azure.active-directory.b2c.logout-success-url | `http://localhost:8080/login` |
|spring.cloud.azure.active-directory.b2c.profile | | AAD B2C profile information.
|spring.cloud.azure.active-directory.b2c.reply-url | `{baseUrl}/login/oauth2/code/` |
|spring.cloud.azure.active-directory.b2c.logout-success-url | `http://localhost:8080/login` | Redirect url after logout.
|spring.cloud.azure.active-directory.b2c.profile.tenant-id | | Azure Tenant ID.
|spring.cloud.azure.active-directory.b2c.reply-url | `{baseUrl}/login/oauth2/code/` | 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.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.jwk-set-cache-lifespan | `5` | The lifespan of the cached JWK set before it expires, default is 5 minutes.
|spring.cloud.azure.active-directory.jwk-set-cache-refresh-time | `5` | The refresh time of the cached JWK set before it expires, default is 5 minutes.
|spring.cloud.azure.active-directory.enabled | `false` | Whether to enable Azure Active Directory related auto-configuration.
|spring.cloud.azure.active-directory.jwk-set-cache-lifespan | `5m` | The lifespan of the cached JWK set before it expires, default is 5 minutes.
|spring.cloud.azure.active-directory.jwk-set-cache-refresh-time | `5m` | 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 | | 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 | | Properties to Azure Active Directory endpoints.
|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 | `{baseUrl}/login/oauth2/code/` | 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_". @see org.springframework.security.core.GrantedAuthority
|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 | `false` | 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 | | Expected UserGroups that an authority will be granted to if found in the response from the MemberOf Graph API Call.
|spring.cloud.azure.active-directory.user-group.allowed-groups | | Default UserGroup configuration.
|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 | `false` | 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.
@ -56,12 +59,12 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.appconfiguration.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | Whether an Azure Service is enabled.
|spring.cloud.azure.appconfiguration.endpoint | | Endpoint of the Azure App Configuration instance.
|spring.cloud.azure.appconfiguration.profile.cloud | | Name of the Azure cloud to connect to.
|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.
@ -83,7 +86,6 @@
|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.authentication-type | | Authentication type used against the proxy.
|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.
@ -93,22 +95,21 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.appconfiguration.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.appconfiguration.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.appconfiguration.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.appconfiguration.retry.retry-after-header | | HTTP header, such as Retry-After or x-ms-retry-after-ms, to lookup for the retry delay. If the value is null, will calculate the delay using backoff and ignore the delay provided in response header.
|spring.cloud.azure.appconfiguration.retry.retry-after-time-unit | | Time unit to use when applying the retry delay.
|spring.cloud.azure.appconfiguration.retry.timeout | | Amount of time to wait until a timeout.
|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 | `false` | 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.headers | | Comma-delimited list of headers applied to each request sent with client.
|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.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.
@ -117,9 +118,10 @@
|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 | `true` | 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.client.headers | | Comma-delimited list of headers applied to each request sent with client.
|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.
@ -128,14 +130,14 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.cosmos.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 connection 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.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).
@ -144,13 +146,11 @@
|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.gateway-connection.proxy | | Proxy options for the gateway client.
|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.permissions | | Permission list which contains the resource tokens needed to access resources.
|spring.cloud.azure.cosmos.populate-query-metrics | `false` | 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 | | Name of the Azure cloud to connect to.
|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.
@ -172,7 +172,6 @@
|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.authentication-type | | Authentication type used against the proxy.
|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.
@ -191,7 +190,7 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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.
@ -201,11 +200,9 @@
|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.headers | | Comma-delimited list of headers applied to each request sent with client.
|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.headers | | Comma-delimited list of headers applied to each request sent with client.
|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.
@ -213,16 +210,16 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.eventhubs.consumer.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of an Event Hub namespace.
|spring.cloud.azure.eventhubs.consumer.enabled | `true` | 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.
|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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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 | | Name of the Azure cloud to connect to.
|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.
@ -253,23 +250,25 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.eventhubs.consumer.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.eventhubs.consumer.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.eventhubs.consumer.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.eventhubs.consumer.retry.timeout | | Amount of time to wait until a timeout.
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.eventhubs.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of an Event Hub namespace.
|spring.cloud.azure.eventhubs.enabled | `true` | 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.
|spring.cloud.azure.eventhubs.namespace | | The namespace of an event hub, which is the prefix of the FQDN. A FQDN should be composed of &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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.
@ -289,19 +288,19 @@
|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.create-container-if-not-exists | `false` | 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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.eventhubs.processor.checkpoint-store.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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 | | Name of the Azure cloud to connect to.
|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.
@ -323,7 +322,6 @@
|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.authentication-type | | Authentication type used against the proxy.
|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.
@ -333,18 +331,17 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.retry-after-header | | HTTP header, such as Retry-After or x-ms-retry-after-ms, to lookup for the retry delay. If the value is null, will calculate the delay using backoff and ignore the delay provided in response header.
|spring.cloud.azure.eventhubs.processor.checkpoint-store.retry.retry-after-time-unit | | Time unit to use when applying the retry delay.
|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.timeout | | Amount of time to wait until a timeout.
|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.headers | | Comma-delimited list of headers applied to each request sent with client.
|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.
@ -352,7 +349,7 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.eventhubs.processor.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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.
@ -363,10 +360,9 @@
|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.
|spring.cloud.azure.eventhubs.processor.partition-ownership-expiration-interval | | Duration after which the ownership of partition expires if it's not renewed.
|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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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 | | Name of the Azure cloud to connect to.
|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.
@ -397,29 +393,30 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.eventhubs.processor.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.eventhubs.processor.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.eventhubs.processor.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.eventhubs.processor.retry.timeout | | Amount of time to wait until a timeout.
|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.headers | | Comma-delimited list of headers applied to each request sent with client.
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.eventhubs.producer.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of an Event Hub namespace.
|spring.cloud.azure.eventhubs.producer.enabled | `true` | 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.
|spring.cloud.azure.eventhubs.producer.profile.cloud | | Name of the Azure cloud to connect to.
|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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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.
@ -450,12 +447,14 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.eventhubs.producer.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.eventhubs.producer.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.eventhubs.producer.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.eventhubs.producer.retry.timeout | | Amount of time to wait until a timeout.
|spring.cloud.azure.eventhubs.profile.cloud | | Name of the Azure cloud to connect to.
|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.
@ -487,11 +486,13 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.eventhubs.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.eventhubs.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.eventhubs.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.eventhubs.retry.timeout | | Amount of time to wait until a timeout.
|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.
@ -509,12 +510,12 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.keyvault.certificate.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | Whether an Azure Service is enabled.
|spring.cloud.azure.keyvault.certificate.endpoint | | Azure Key Vault endpoint.
|spring.cloud.azure.keyvault.certificate.profile.cloud | | Name of the Azure cloud to connect to.
|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.
@ -536,7 +537,6 @@
|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.authentication-type | | Authentication type used against the proxy.
|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.
@ -546,13 +546,12 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.keyvault.certificate.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.keyvault.certificate.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.keyvault.certificate.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.keyvault.certificate.retry.retry-after-header | | HTTP header, such as Retry-After or x-ms-retry-after-ms, to lookup for the retry delay. If the value is null, will calculate the delay using backoff and ignore the delay provided in response header.
|spring.cloud.azure.keyvault.certificate.retry.retry-after-time-unit | | Time unit to use when applying the retry delay.
|spring.cloud.azure.keyvault.certificate.retry.timeout | | Amount of time to wait until a timeout.
|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.
@ -570,12 +569,12 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.keyvault.secret.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | Whether an Azure Service is enabled.
|spring.cloud.azure.keyvault.secret.endpoint | | Azure Key Vault endpoint.
|spring.cloud.azure.keyvault.secret.profile.cloud | | Name of the Azure cloud to connect to.
|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.
@ -597,9 +596,8 @@
|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-source-enabled | `true` | 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.proxy.authentication-type | | Authentication type used against the proxy.
|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.
@ -609,16 +607,15 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.keyvault.secret.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.keyvault.secret.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.keyvault.secret.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.keyvault.secret.retry.retry-after-header | | HTTP header, such as Retry-After or x-ms-retry-after-ms, to lookup for the retry delay. If the value is null, will calculate the delay using backoff and ignore the delay provided in response header.
|spring.cloud.azure.keyvault.secret.retry.retry-after-time-unit | | Time unit to use when applying the retry delay.
|spring.cloud.azure.keyvault.secret.retry.timeout | | Amount of time to wait until a timeout.
|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 | `false` | Whether managed identity is enabled. This is a legacy property.
|spring.cloud.azure.profile.cloud | | Name of the Azure cloud to connect to.
|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.
@ -640,7 +637,7 @@
|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.authentication-type | | Authentication type used against the proxy.
|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.
@ -653,27 +650,25 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.retry.http.retry-after-header | | HTTP header, such as Retry-After or x-ms-retry-after-ms, to lookup for the retry delay. If the value is null, will calculate the delay using backoff and ignore the delay provided in response header.
|spring.cloud.azure.retry.http.retry-after-time-unit | | Time unit to use when applying the retry delay.
|spring.cloud.azure.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.retry.timeout | | Amount of time to wait until a timeout.
|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.headers | | Comma-delimited list of headers applied to each request sent with client.
|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.auto-complete | `true` | 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.headers | | Comma-delimited list of headers applied to each request sent with client.
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.servicebus.consumer.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of a Service Bus namespace.
@ -681,9 +676,9 @@
|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.
|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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|spring.cloud.azure.servicebus.consumer.prefetch-count | | Prefetch count of the consumer.
|spring.cloud.azure.servicebus.consumer.profile.cloud | | Name of the Azure cloud to connect to.
|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.
@ -715,11 +710,13 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.servicebus.consumer.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.servicebus.consumer.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.servicebus.consumer.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.servicebus.consumer.retry.timeout | | Amount of time to wait until a timeout.
|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.
@ -727,7 +724,7 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.servicebus.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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.
@ -735,17 +732,16 @@
|spring.cloud.azure.servicebus.enabled | `true` | 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.
|spring.cloud.azure.servicebus.processor.auto-complete | | Whether to enable auto-complete.
|spring.cloud.azure.servicebus.namespace | | The namespace of a service bus, which is the prefix of the FQDN. A FQDN should be composed of &lt;NamespaceName&gt;.&lt;DomainName&gt;
|spring.cloud.azure.servicebus.processor.auto-complete | `true` | 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.headers | | Comma-delimited list of headers applied to each request sent with client.
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.servicebus.processor.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of a Service Bus namespace.
@ -755,9 +751,9 @@
|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.
|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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|spring.cloud.azure.servicebus.processor.prefetch-count | | Prefetch count of the consumer.
|spring.cloud.azure.servicebus.processor.profile.cloud | | Name of the Azure cloud to connect to.
|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.
@ -789,31 +785,32 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.servicebus.processor.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.servicebus.processor.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.servicebus.processor.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.servicebus.processor.retry.timeout | | Amount of time to wait until a timeout.
|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.headers | | Comma-delimited list of headers applied to each request sent with client.
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.servicebus.producer.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of a Service Bus namespace.
|spring.cloud.azure.servicebus.producer.enabled | `true` | 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.
|spring.cloud.azure.servicebus.producer.profile.cloud | | Name of the Azure cloud to connect to.
|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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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.
@ -844,12 +841,14 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.servicebus.producer.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.servicebus.producer.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.servicebus.producer.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.servicebus.producer.retry.timeout | | Amount of time to wait until a timeout.
|spring.cloud.azure.servicebus.profile.cloud | | Name of the Azure cloud to connect to.
|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.
@ -886,11 +885,13 @@
|spring.cloud.azure.servicebus.retry-options.maxRetries | | The maximum number of attempts. This is a legacy property.
|spring.cloud.azure.servicebus.retry-options.retryMode | | The type of approach to apply when calculating the delay between retry attempts. This is a legacy property.
|spring.cloud.azure.servicebus.retry-options.tryTimeout | | Amount of time to wait until a timeout. This is a legacy property.
|spring.cloud.azure.servicebus.retry.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.servicebus.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.servicebus.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.servicebus.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.servicebus.retry.timeout | | Amount of time to wait until a timeout.
|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.
@ -915,14 +916,14 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.storage.blob.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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 | | Name of the Azure cloud to connect to.
|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.
@ -944,7 +945,6 @@
|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.authentication-type | | Authentication type used against the proxy.
|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.
@ -954,14 +954,14 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.storage.blob.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.storage.blob.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.storage.blob.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.storage.blob.retry.retry-after-header | | HTTP header, such as Retry-After or x-ms-retry-after-ms, to lookup for the retry delay. If the value is null, will calculate the delay using backoff and ignore the delay provided in response header.
|spring.cloud.azure.storage.blob.retry.retry-after-time-unit | | Time unit to use when applying the retry delay.
|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.timeout | | Amount of time to wait until a timeout.
|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.
@ -983,13 +983,14 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.storage.fileshare.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | Whether an Azure Service is enabled.
|spring.cloud.azure.storage.fileshare.endpoint | | Endpoint for Azure Storage service.
|spring.cloud.azure.storage.fileshare.file-name | | Name of the file.
|spring.cloud.azure.storage.fileshare.profile.cloud | | Name of the Azure cloud to connect to.
|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.
@ -1011,7 +1012,6 @@
|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.authentication-type | | Authentication type used against the proxy.
|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.
@ -1021,14 +1021,14 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.storage.fileshare.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.storage.fileshare.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.storage.fileshare.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.storage.fileshare.retry.retry-after-header | | HTTP header, such as Retry-After or x-ms-retry-after-ms, to lookup for the retry delay. If the value is null, will calculate the delay using backoff and ignore the delay provided in response header.
|spring.cloud.azure.storage.fileshare.retry.retry-after-time-unit | | Time unit to use when applying the retry delay.
|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.timeout | | Amount of time to wait until a timeout.
|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.
@ -1051,13 +1051,13 @@
|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-client-id | | Client id to use when using user-assigned managed identity or app registration (when working with AKS pod-identity) to authenticate with Azure.
|spring.cloud.azure.storage.queue.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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 | | Name of the Azure cloud to connect to.
|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.
@ -1079,7 +1079,6 @@
|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.authentication-type | | Authentication type used against the proxy.
|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.
@ -1091,14 +1090,14 @@
|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.backoff.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.storage.queue.retry.backoff.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.storage.queue.retry.backoff.multiplier | | Multiplier used to calculate the next backoff delay. If positive, then used as a multiplier for generating the next delay for backoff.
|spring.cloud.azure.storage.queue.retry.max-attempts | | The maximum number of attempts.
|spring.cloud.azure.storage.queue.retry.retry-after-header | | HTTP header, such as Retry-After or x-ms-retry-after-ms, to lookup for the retry delay. If the value is null, will calculate the delay using backoff and ignore the delay provided in response header.
|spring.cloud.azure.storage.queue.retry.retry-after-time-unit | | Time unit to use when applying the retry delay.
|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.timeout | | Amount of time to wait until a timeout.
|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.
@ -1106,20 +1105,20 @@
|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 | `30m` | Connection idle timeout duration.
|spring.jms.servicebus.listener.phase | | Specify the phase in which this container should be started and stopped.
|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 | | Configure the {@link QosSettings} to use when sending a reply.
|spring.jms.servicebus.listener.reply-qos-settings | | The QosSettings to use when sending a reply.
|spring.jms.servicebus.listener.subscription-durable | `true` | 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 | `true` | 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 | `-1s` | Blocking period before throwing an exception if the pool is still full.
|spring.jms.servicebus.pool.enabled | `false` | Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory.
|spring.jms.servicebus.pool.idle-timeout | `30s` | Connection idle timeout.
|spring.jms.servicebus.pool.max-connections | `1` | Maximum number of pooled connections.
|spring.jms.servicebus.pool.max-sessions-per-connection | `500` | Maximum number of pooled sessions per connection in the pool.
|spring.jms.servicebus.pool.time-between-expiration-check | `1` | 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 | `true` | Whether to use only one anonymous "MessageProducer" instance. Set it to false to create one "MessageProducer" every time one is required.
|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 | `0` | Fallback value for prefetch option in this Service Bus namespace.
|spring.jms.servicebus.prefetch-policy.durable-topic-prefetch | `0` | The number of prefetch for durable topic.
|spring.jms.servicebus.prefetch-policy.queue-browser-prefetch | `0` | The number of prefetch for queue browser.
@ -1130,4 +1129,4 @@
|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.
|===
|===

46
docs/src/main/asciidoc/_configprops_aad.adoc Normal file
Просмотреть файл

@ -0,0 +1,46 @@
|===
|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 | `false` | 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 | `sign-up-or-sign-in` | Specify the primary sign-in flow key.
|spring.cloud.azure.active-directory.b2c.logout-success-url | `http://localhost:8080/login` | Redirect url after logout.
|spring.cloud.azure.active-directory.b2c.profile.tenant-id | | Azure Tenant ID.
|spring.cloud.azure.active-directory.b2c.reply-url | `{baseUrl}/login/oauth2/code/` | 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 | `false` | Whether to enable Azure Active Directory related auto-configuration.
|spring.cloud.azure.active-directory.jwk-set-cache-lifespan | `5m` | The lifespan of the cached JWK set before it expires, default is 5 minutes.
|spring.cloud.azure.active-directory.jwk-set-cache-refresh-time | `5m` | 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 | `{baseUrl}/login/oauth2/code/` | 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 | `false` | 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 | `false` | 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.
|===

21
docs/src/main/asciidoc/_configprops_aadb2c.adoc Normal file
Просмотреть файл

@ -0,0 +1,21 @@
|===
|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 | `false` | 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 | `sign-up-or-sign-in` | Specify the primary sign-in flow key.
|spring.cloud.azure.active-directory.b2c.logout-success-url | `http://localhost:8080/login` | Redirect url after logout.
|spring.cloud.azure.active-directory.b2c.profile.tenant-id | | Azure Tenant ID.
|spring.cloud.azure.active-directory.b2c.reply-url | `{baseUrl}/login/oauth2/code/` | 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.
|===

65
docs/src/main/asciidoc/_configprops_appconf.adoc Normal file
Просмотреть файл

@ -0,0 +1,65 @@
|===
|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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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.
|===

71
docs/src/main/asciidoc/_configprops_cosmos.adoc Normal file
Просмотреть файл

@ -0,0 +1,71 @@
|===
|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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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 | `false` | 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.
|===

300
docs/src/main/asciidoc/_configprops_eventhubs.adoc Normal file
Просмотреть файл

@ -0,0 +1,300 @@
|===
|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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of an Event Hub namespace.
|spring.cloud.azure.eventhubs.consumer.enabled | `true` | 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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of an Event Hub namespace.
|spring.cloud.azure.eventhubs.enabled | `true` | 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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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.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 | `false` | 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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of an Event Hub namespace.
|spring.cloud.azure.eventhubs.processor.enabled | `true` | 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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of an Event Hub namespace.
|spring.cloud.azure.eventhubs.producer.enabled | `true` | 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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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.
|===

63
docs/src/main/asciidoc/_configprops_global.adoc Normal file
Просмотреть файл

@ -0,0 +1,63 @@
|===
|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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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.
|===

64
docs/src/main/asciidoc/_configprops_kv_certificate.adoc Normal file
Просмотреть файл

@ -0,0 +1,64 @@
|===
|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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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.
|===

66
docs/src/main/asciidoc/_configprops_kv_secret.adoc Normal file
Просмотреть файл

@ -0,0 +1,66 @@
|===
|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.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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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 | `true` | 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.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.
|===

241
docs/src/main/asciidoc/_configprops_servicebus.adoc Normal file
Просмотреть файл

@ -0,0 +1,241 @@
|===
|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 | `true` | 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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of a Service Bus namespace.
|spring.cloud.azure.servicebus.consumer.enabled | `true` | 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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of a Service Bus namespace.
|spring.cloud.azure.servicebus.enabled | `true` | 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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|spring.cloud.azure.servicebus.processor.auto-complete | `true` | 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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of a Service Bus namespace.
|spring.cloud.azure.servicebus.processor.enabled | `true` | 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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `servicebus.windows.net` | The domain name of a Service Bus namespace.
|spring.cloud.azure.servicebus.producer.enabled | `true` | 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 &lt;NamespaceName&gt;.&lt;DomainName&gt;
|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.maxDelay | | Maximum permissible amount of time between retry attempts. This is a legacy property.
|spring.cloud.azure.servicebus.retry-options.maxRetries | | The maximum number of attempts. This is a legacy property.
|spring.cloud.azure.servicebus.retry-options.retryMode | | The type of approach to apply when calculating the delay between retry attempts. This is a legacy property.
|spring.cloud.azure.servicebus.retry-options.tryTimeout | | 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.
|===

30
docs/src/main/asciidoc/_configprops_servicebus_jms.adoc Normal file
Просмотреть файл

@ -0,0 +1,30 @@
|===
|Name | Default | Description
|spring.jms.servicebus.connection-string | | Connection string to connect to a Service Bus namespace.
|spring.jms.servicebus.idle-timeout | `30m` | 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 | `true` | 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 | `0` | Fallback value for prefetch option in this Service Bus namespace.
|spring.jms.servicebus.prefetch-policy.durable-topic-prefetch | `0` | The number of prefetch for durable topic.
|spring.jms.servicebus.prefetch-policy.queue-browser-prefetch | `0` | The number of prefetch for queue browser.
|spring.jms.servicebus.prefetch-policy.queue-prefetch | `0` | The number of prefetch for queue.
|spring.jms.servicebus.prefetch-policy.topic-prefetch | `0` | The number of prefetch for topic.
|spring.jms.servicebus.pricing-tier | | Pricing tier for a Service Bus namespace.
|spring.jms.servicebus.remote-url | `amqp://localhost:5672` | 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.
|===

74
docs/src/main/asciidoc/_configprops_storage_blob.adoc Normal file
Просмотреть файл

@ -0,0 +1,74 @@
|===
|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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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.
|===

73
docs/src/main/asciidoc/_configprops_storage_fileshare.adoc Normal file
Просмотреть файл

@ -0,0 +1,73 @@
|===
|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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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.
|===

73
docs/src/main/asciidoc/_configprops_storage_queue.adoc Normal file
Просмотреть файл

@ -0,0 +1,73 @@
|===
|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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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.
|===

74
docs/src/main/asciidoc/_configprops_storageblob.adoc Normal file
Просмотреть файл

@ -0,0 +1,74 @@
|===
|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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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.
|===

73
docs/src/main/asciidoc/_configprops_storagefileshare.adoc Normal file
Просмотреть файл

@ -0,0 +1,73 @@
|===
|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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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.
|===

73
docs/src/main/asciidoc/_configprops_storagequeue.adoc Normal file
Просмотреть файл

@ -0,0 +1,73 @@
|===
|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.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 | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|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 | `true` | 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.
|===

3
docs/src/main/asciidoc/_known-issues.adoc
Просмотреть файл

@ -1,8 +1,5 @@
== Known Issues
=== Error Logs When Using Defaultazurecredential
There could be some `ERROR` logs be printed out while the `DefaultAzureCredential` running the chain and trying to find the first available credential. It doesn't mean the `DefaultAzureCredential` is broken or unavailable. Meanwhile, we'll keep improving this logging experience.

122
docs/src/main/asciidoc/_migration-guide-for-4.0.adoc
Просмотреть файл

@ -31,7 +31,7 @@ inconsistency of project naming, artifact Ids, versions, configurations made the
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 https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Cloud-Azure-4.0-design[design doc] for those interested.
details are available in the https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Cloud-Azure-4.0-design[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:
@ -57,7 +57,7 @@ This migration guide will consist following sections:
=== 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 developer confused. Since
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.
[#migration-guide-bom]
@ -113,10 +113,10 @@ spring-cloud-azure-starter-storage-file-share |Split into two separate artifacts
|azure-spring-boot |N/A |Deleted this artifact with merging all functionalities into the new `spring-cloud-azure-autoconfigure` artifact.
|azure-spring-cloud-autoconfigure |N/A |Deleted this artifact with merging all functionalities into the new `spring-cloud-azure-autoconfigure` artifact.
|azure-spring-cloud-context |N/A |Deleted this artifact with merging all functionalities into the new `spring-cloud-azure-autoconfigure` and `spring-cloud-azure-resourcemanager` artifacts.
|azure-spring-cloud-messaging |spring-messaging-azure | Deleted this artifact. The messaging listener annotation has been dropped.
|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.adoc#redis-support, 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.adoc#kafka-support, Kafka Support>> for more information about usage.
|azure-spring-cloud-starter-eventhubs |spring-cloud-azure-starter-integration-eventhubs |Renamed the artifact to add `integration`, indicating using Spring Integration with Event Hubs.
|azure-spring-cloud-starter-eventhubs |spring-cloud-azure-starter-integration-eventhubs |Renamed the artifact to add `integration`, indicating using Spring Integration with Event Hubs. Remove the functionalities of messaging listener annotations.
|azure-spring-cloud-starter-servicebus |spring-cloud-azure-starter-integration-servicebus |Renamed the artifact to add `integration`, indicating using Spring Integration with Service Bus.
|azure-spring-cloud-starter-storage-queue |spring-cloud-azure-starter-integration-storage-queue |Renamed the artifact to add `integration`, indicating using Spring Integration with Storage Queue.
|azure-spring-cloud-storage |N/A |Deleted this artifact with merging all functionalities into the new `spring-cloud-azure-autoconfigure` artifact.
@ -217,7 +217,7 @@ configurations can be divided into five categories:
|*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 `spring.cloud.azure.cosmos.retry`.
|===
Check link:appendix.html[here] for a full list of configurations.
Check link:appendix.html#_global_properties[Global Properties] for a full list of global configurations.
==== Each SDK Configurations
@ -751,7 +751,7 @@ This section includes the changes about the properties added, removed and change
==== From azure-spring-boot-starter-servicebus-jms to spring-cloud-azure-starter-servicebus-jms
This guide is intended to assist in the migration to
link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-servicebus-jms[spring-cloud-azure-starter-servicebus-jms] from
version 2 of link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-servicebus-jms[spring-cloud-azure-starter-servicebus-jms].
version 3 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-boot-starter-servicebus-jms[azure-spring-boot-starter-servicebus-jms].
* Please refer to <<migration-guide-introduction, introduction>> and <<migration-guide-benefits, migration benefits>> to get a whole picture of the changes in 4.0.
* Please refer to <<migration-guide-naming, naming changes>> to learn more about the strategy changes in the project naming.
@ -909,9 +909,9 @@ spring:
* Rename `EventHubInboundChannelAdapter` as `EventHubsInboundChannelAdapter` to keep consistent with the service of Azure
Event Hubs.
* Change the constructor from `EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String)` to `EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer)` and `EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode)`.
* Change `CheckpointConfig` instantiation style to simple constructor instead of build style.
* 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 method `EventHubsContainerProperties#setCheckpointConfig`.
* Drop API `EventHubOperation#setBatchConsumerConfig`. To set the checkpoint configuration for the inbound channel adapter, users can call the method `EventHubsContainerProperties#getBatch#setMaxSize` and `EventHubsContainerProperties#getBatch#setMaxWaitTime`.
* Drop API `EventHubOperation#setBatchConsumerConfig`. To set the batch-consuming configuration for the inbound channel adapter, users can call the two methods `EventHubsContainerProperties#getBatch#setMaxSize` and `EventHubsContainerProperties#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` to `azure_eventhubs_batch_converted_enqueued_time`.
- Change message header from `azure_eventhub_offset` to `azure_eventhubs_batch_converted_offset`.
@ -1054,9 +1054,9 @@ version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-sprin
* Rename `EventHubInboundChannelAdapter` as `EventHubsInboundChannelAdapter` to keep consistent with the service of Azure
Event Hubs.
* Change the constructor from `EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String)` to `EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer)` and `EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode)`.
* Change `CheckpointConfig` instantiation style to simple constructor instead of build style.
* 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 method `EventHubsContainerProperties#setCheckpointConfig`.
* Drop API `EventHubOperation#setBatchConsumerConfig`. To set the checkpoint configuration for the inbound channel adapter, users can call the method `EventHubsContainerProperties#getBatch#setMaxSize` and `EventHubsContainerProperties#getBatch#setMaxWaitTime`.
* Drop API `EventHubOperation#setBatchConsumerConfig`. To set the batch-consuming configuration for the inbound channel adapter, users can call the two methods `EventHubsContainerProperties#getBatch#setMaxSize` and `EventHubsContainerProperties#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` to `azure_eventhubs_batch_converted_enqueued_time`.
- Change message header from `azure_eventhub_offset` to `azure_eventhubs_batch_converted_offset`.
@ -1109,8 +1109,8 @@ the prefix remains to be as `spring.cloud.azure.servicebus`.
|*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 according to *spring.cloud.azure.servicebus*.retry.mode
|*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 according to *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
|===
@ -1118,13 +1118,14 @@ the prefix remains to be as `spring.cloud.azure.servicebus`.
[#api-spring-cloud-azure-starter-integration-servicebus]
===== API Changes
* Drop `ServiceBusQueueOperation` and `ServiceBusTopicOperation` with the subscribing function moved to class `ServiceBusMessageListenerContainer` and the sending function moved to `ServiceBusTemplate`.
* Drop `ServiceBusQueueInboundChannelAdapter` and `ServiceBusTopicInboundChannelAdapter`, and combine the function of listening to a Service Bus queue or topic entity to `ServiceBusInboundChannelAdapter`.
* Change the constructor from `ServiceBusXXXInboundChannelAdapter(String, SubscribeByGroupOperation, String)` to `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)` and `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)`.
* Drop API `setCheckpointConfig` of ServiceBusTopicOperation or ServiceBusQueueOperation. To set the checkpoint configuration for the inbound channel adapter, users can call the method `ServiceBusContainerProperties#setAutoComplete` instead. To disable the auto-complete mode is equivalent to `MANUAL` checkpoint mode and to enable it will trigger the `RECORD` mode.
* Drop API `setClientConfig` of `ServiceBusQueueOperation` and `ServiceBusTopicOperation`. To configure the underlying `ServiceBusProcessorClient` used by the inbound channel adapter, users can use `ServiceBusContainerProperties` instead.
* Drop `CompletableFuture` support of `ServiceBusTemplate` and `DefaultMessageHandler` and support Reactor instead.
* Add new API of `setDefaultEntityType` for `ServiceBusTemplate` to specify the entity type, which is required when no bean of `PropertiesSupplier&lt;String, ProducerProperties&gt;` is provided for the `ProducerProperties#entityType`.
* Drop message header of `AzureHeaders.RAW_ID`. Please use `ServiceBusMessageHeaders.MESSAGE_ID` instead.
* Drop `ServiceBusQueueInboundChannelAdapter` and `ServiceBusTopicInboundChannelAdapter`, and move the functionality to listen to a Service Bus queue/topic entity to ServiceBusInboundChannelAdapter.
* Change the constructor from `ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String)` to `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)` and `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)`.
* Change the constructor from `ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String)` to `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)` and `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)`.
* Drop APIs `ServiceBusQueueOperation#setCheckpointConfig` and `ServiceBusTopicOperation#setCheckpointConfig`. To set the checkpoint configuration for the inbound channel adapter, users can call the method `ServiceBusContainerProperties#setAutoComplete` instead. To disable the auto-complete mode is equivalent to `MANUAL` checkpoint mode and to enable it will trigger the `RECORD` mode.
* Drop APIs `ServiceBusQueueOperatio#setClientConfig` and `ServiceBusTopicOperation#setClientConfig`. To configure the underlying `ServiceBusProcessorClient` used by the inbound channel adapter, users can use `ServiceBusContainerProperties` instead.
* Drop `CompletableFuture` support in `ServiceBusTemplate` and `DefaultMessageHandler`, support `Reactor` instead.
* Add new API of `ServiceBusTemplate#setDefaultEntityType` to specify the entity type, which is required when no bean of `PropertiesSupplier&lt;String, ProducerProperties&gt;` is provided for the `ProducerProperties#entityType`.
* Drop message header `AzureHeaders.RAW_ID`. Please use `ServiceBusMessageHeaders.MESSAGE_ID` instead.
.Class mapping from azure-spring-cloud-starter-servicebus to spring-cloud-azure-starter-integration-servicebus
[cols="<,<", options="header"]
@ -1140,7 +1141,7 @@ the prefix remains to be as `spring.cloud.azure.servicebus`.
====== Sample Code Snippet
1. ServiceBusInboundChannelAdapter sample code:
1.ServiceBusInboundChannelAdapter sample code:
Legacy code of using `ServiceBusQueueInboundChannelAdapter` or `ServiceBusTopicInboundChannelAdapter`:
@ -1212,7 +1213,7 @@ public class Demo {
}
----
2. DefaultMessageHandler sample code:
2.DefaultMessageHandler sample code:
Legacy code, taking queue as example:
@ -1278,13 +1279,14 @@ version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-sprin
[#api-spring-integration-azure-servicebus]
===== API Changes
* Drop `ServiceBusQueueOperation` and `ServiceBusTopicOperation` with the subscribing function moved to class `ServiceBusMessageListenerContainer` and the sending function moved to `ServiceBusTemplate`.
* Drop `ServiceBusQueueInboundChannelAdapter` and `ServiceBusTopicInboundChannelAdapter`, and combine the function of listening to a Service Bus queue or topic entity to `ServiceBusInboundChannelAdapter`.
* Change the constructor from `ServiceBusXXXInboundChannelAdapter(String, SubscribeByGroupOperation, String)` to `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)` and `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)`.
* Drop API `setCheckpointConfig` of ServiceBusTopicOperation or ServiceBusQueueOperation. To set the checkpoint configuration for the inbound channel adapter, users can call the method `ServiceBusContainerProperties#setAutoComplete` instead. To disable the auto-complete mode is equivalent to `MANUAL` checkpoint mode and to enable it will trigger the `RECORD` mode.
* Drop API `setClientConfig` of `ServiceBusQueueOperation` and `ServiceBusTopicOperation`. To configure the underlying `ServiceBusProcessorClient` used by the inbound channel adapter, users can use `ServiceBusContainerProperties` instead.
* Drop `CompletableFuture` support of `ServiceBusTemplate` and `DefaultMessageHandler` and support Reactor instead.
* Add new API of `setDefaultEntityType` for `ServiceBusTemplate` to specify the entity type, which is required when no bean of `PropertiesSupplier&lt;String, ProducerProperties&gt;` is provided for the `ProducerProperties#entityType`.
* Drop message header of `AzureHeaders.RAW_ID`. Please use `ServiceBusMessageHeaders.MESSAGE_ID` instead.
* Drop `ServiceBusQueueInboundChannelAdapter` and `ServiceBusTopicInboundChannelAdapter`, and move the functionality to listen to a Service Bus queue/topic entity to ServiceBusInboundChannelAdapter.
* Change the constructor from `ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String)` to `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)` and `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)`.
* Change the constructor from `ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String)` to `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer)` and `ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)`.
* Drop APIs `ServiceBusQueueOperation#setCheckpointConfig` and `ServiceBusTopicOperation#setCheckpointConfig`. To set the checkpoint configuration for the inbound channel adapter, users can call the method `ServiceBusContainerProperties#setAutoComplete` instead. To disable the auto-complete mode is equivalent to `MANUAL` checkpoint mode and to enable it will trigger the `RECORD` mode.
* Drop APIs `ServiceBusQueueOperation#setClientConfig` and `ServiceBusTopicOperation#setClientConfig`. To configure the underlying `ServiceBusProcessorClient` used by the inbound channel adapter, users can use `ServiceBusContainerProperties` instead.
* Drop `CompletableFuture` support in `ServiceBusTemplate` and `DefaultMessageHandler`, support `Reactor` instead.
* Add new API of `ServiceBusTemplate#setDefaultEntityType` to specify the entity type, which is required when no bean of `PropertiesSupplier&lt;String, ProducerProperties&gt;` is provided for the `ProducerProperties#entityType`.
* Drop message header `AzureHeaders.RAW_ID`. Please use `ServiceBusMessageHeaders.MESSAGE_ID` instead.
.Class mapping from azure-spring-integration-servicebus to spring-integration-azure-servicebus
[cols="<,<", options="header"]
@ -1328,7 +1330,7 @@ All configuration property names changed the prefix from `spring.cloud.azure.sto
===== API Changes
* Drop `StorageQueueOperation` and provide `StorageQueueTemplate` instead.
* Do not support configuration of checkpoint mode in `StorageQueueTemplate`, only the `MANUAL` mode is supported.
* Drop `checkpoint-mode` configuration in `StorageQueueTemplate`, only support the `MANUAL` mode.
.Class mapping from azure-spring-cloud-starter-storage-queue to spring-cloud-azure-starter-integration-storage-queue
[cols="<~,<~", options="header"]
@ -1355,7 +1357,7 @@ version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-sprin
===== API Changes
* Drop `StorageQueueOperation` and provide `StorageQueueTemplate` instead.
* Do not support configuration of checkpoint mode in `StorageQueueTemplate`, only the `MANUAL` mode is supported.
* Drop `checkpoint-mode` configuration in `StorageQueueTemplate`, only support the `MANUAL` mode.
.Class mapping from azure-spring-integration-storage-queue to spring-integration-azure-storage-queue
[cols="<~,<~", options="header"]
@ -1372,7 +1374,7 @@ version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-sprin
==== From azure-spring-cloud-stream-binder-eventhubs to spring-cloud-azure-stream-binder-eventhubs
This guide is intended to assist in the migration to
link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-stream-binder-eventhubs[spring-cloud-azure-stream-binder-eventhubs] from
version 2 of link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-stream-binder-eventhubs[spring-cloud-azure-stream-binder-eventhubs].
version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-cloud-stream-binder-eventhubs[azure-spring-cloud-stream-binder-eventhubs].
* Please refer to <<migration-guide-introduction, introduction>> and <<migration-guide-benefits, migration benefits>> to get a whole picture of the changes in 4.0.
* Please refer to <<migration-guide-naming, naming changes>> to learn more about the strategy changes in the project naming.
@ -1407,7 +1409,7 @@ Changes for the child entries for following prefix, please refer the following t
|*spring.cloud.stream.eventhub.bindings.<binding-name>.consumer*.start-position |*spring.cloud.stream.eventhubs.bindings.<binding-name>.consumer*.initial-partition-event-position
|===
NOTE: The value type of the start position configuration is also changed. It's 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.
NOTE: 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 as below:
@ -1485,14 +1487,16 @@ while other `Data` related roles are required for messaging operations, please r
For authentication based on ARM, taking service principal as example, configuration migration is listed as below, where the assigned role should not change:
Legacy configuration:
[source,yaml]
----
spring:
cloud:
azure:
client-id: ${CLIENT_ID}
client-secret: ${CLIENT_SECRET}
tenant-id: ${TENANT_ID}
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
tenant-id: ${AZURE_TENANT_ID}
resource-group: ${EVENTHUB_RESOURCE_GROUP}
eventhub:
namespace: ${EVENTHUB_NAMESPACE}
@ -1506,18 +1510,18 @@ spring:
cloud:
azure:
credential:
client-id: ${CLIENT_ID}
client-secret: ${CLIENT_SECRET}
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${TENANT_ID}
subscription-id: ${SUBSCRIPTION_ID}
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 manged identity are listed as below:
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 as below:
* With a service principal
@ -1527,10 +1531,10 @@ spring:
cloud:
azure:
credential:
client-id: ${CLIENT_ID}
client-secret: ${CLIENT_SECRET}
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${TENANT_ID}
tenant-id: ${AZURE_TENANT_ID}
eventhubs:
namespace: ${EVENTHUB_NAMESPACE}
----
@ -1595,8 +1599,8 @@ IMPORTANT: The binder type is combined from `servicebus-queue` and `servicebus-t
|*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 according to *spring.cloud.azure.servicebus*.retry.mode
|*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 according to *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.*
@ -1607,7 +1611,9 @@ IMPORTANT: The binder type is combined from `servicebus-queue` and `servicebus-t
|*spring.cloud.stream.servicebus.topic*.bindings.<binding-name>.consumer.*checkpoint-mode* |*spring.cloud.stream.servicebus*.bindings.<binding-name>.consumer.*auto-complete*
|===
NOTE: The concurrency property will replace maxConcurrentSessions when sessionsEnabled is `true` and maxConcurrentCalls when sessionsEnabled is `false`. Enabling auto-complete is equal to `RECORD` checkpoint mode, and oppositely the `MANUAL` mode.
NOTE: The concurrency property will be replaced by the maxConcurrentSessions when sessionsEnabled is `true` and the maxConcurrentCalls when sessionsEnabled is `false`.
NOTE: Enabling auto-complete is equal to `RECORD` checkpoint mode, and oppositely the `MANUAL` mode.
====== Configuration migration examples
@ -1680,9 +1686,9 @@ Legacy configuration:
spring:
cloud:
azure:
client-id: ${CLIENT_ID}
client-secret: ${CLIENT_SECRET}
tenant-id: ${TENANT_ID}
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
tenant-id: ${AZURE_TENANT_ID}
resource-group: ${SERVICEBUS_RESOURCE_GROUP}
servicebus:
namespace: ${SERVICEBUS_NAMESPACE}
@ -1696,18 +1702,18 @@ spring:
cloud:
azure:
credential:
client-id: ${CLIENT_ID}
client-secret: ${CLIENT_SECRET}
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${TENANT_ID}
subscription-id: ${SUBSCRIPTION_ID}
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 manged identity are listed as below:
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 as below:
* With a service principal
@ -1717,10 +1723,10 @@ spring:
cloud:
azure:
credential:
client-id: ${CLIENT_ID}
client-secret: ${CLIENT_SECRET}
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${TENANT_ID}
tenant-id: ${AZURE_TENANT_ID}
servicebus:
namespace: ${SERVICEBUS_NAMESPACE}
----
@ -1742,7 +1748,7 @@ spring:
[#api-spring-cloud-azure-stream-binder-servicebus]
===== API Changes
* Drop message header of `AzureHeaders.RAW_ID`. Please use `ServiceBusMessageHeaders.MESSAGE_ID` instead.
* Drop message header `AzureHeaders.RAW_ID`. Please use `ServiceBusMessageHeaders.MESSAGE_ID` instead.
.Class mapping from azure-spring-cloud-stream-binder-servicebus to spring-cloud-azure-stream-binder-servicebus
[cols="<~,<~", options="header"]

28
docs/src/main/asciidoc/appendix.adoc
Просмотреть файл

@ -1,7 +1,33 @@
[appendix]
== Configuration Properties
=== Global Properties
include::_configprops_global.adoc[]
=== Azure Active Directory Properties
include::_configprops_aad.adoc[]
=== Azure Active Directory B2C Properties
include::_configprops_aadb2c.adoc[]
=== Azure App Configuration Proeprties
include::_configprops_appconf.adoc[]
=== Azure Cosmos Proeprties
include::_configprops_cosmos.adoc[]
=== Azure Event Hubs Proeprties
include::_configprops_eventhubs.adoc[]
=== Azure Key Vault Secrets Proeprties
include::_configprops_kv_secret.adoc[]
=== Azure Key Vault Certificates Proeprties
include::_configprops_kv_certificate.adoc[]
=== Azure Service Bus Proeprties
include::_configprops_servicebus.adoc[]
=== Azure Service Bus JMS Proeprties
include::_configprops_servicebus_jms.adoc[]
=== Azure Storage Blob Proeprties
include::_configprops_storage_blob.adoc[]
=== Azure Storage File Share Proeprties
include::_configprops_storage_fileshare.adoc[]
=== Azure Storage Queue Proeprties
include::_configprops_storage_queue.adoc[]
=== All Configuration Proeprties
include::_configprops.adoc[]
[appendix]

12
docs/src/main/asciidoc/authentication.adoc
Просмотреть файл

@ -41,7 +41,7 @@ TIP: Please refer to link:index.html#authorize-access-with-azure-active-director
A common challenge for developers is the management of secrets and credentials used to secure communication between different components making up a solution. Managed identities eliminate the need for developers to manage credentials. Managed identities provide an identity for applications to use when connecting to resources that support Azure Active Directory (Azure AD) authentication. Applications may use the managed identity to obtain Azure AD tokens. For example, an application may use a managed identity to access resources like Azure Key Vault where developers can store credentials in a secure manner or to access storage accounts.
We encourage using manged identity instead of using connection string or key in your application for it's more secure and will save the trouble of managing secrets and credentials. In this case, `DefaultAzureCredential` could better serve the scenario of developing locally using account information stored locally and deploying the application to Azure Cloud and using Manged Identity.
We encourage using managed identity instead of using connection string or key in your application for it's more secure and will save the trouble of managing secrets and credentials. In this case, `DefaultAzureCredential` could better serve the scenario of developing locally using account information stored locally and deploying the application to Azure Cloud and using Managed Identity.
==== Managed Identity Types
There are two types of managed identities:
@ -53,19 +53,19 @@ NOTE: When using a user-assigned managed identity, you can specify the client ID
TIP: Please refer to link:index.html#authorize-access-with-azure-active-directory[Authorize access with Azure AD] to make sure the security principal has been granted the sufficient permission to access the Azure resource.
TIP: Please refer to link:{managed-identity}[What are managed identities for Azure resources?] for more details about manged identity.
TIP: Please refer to link:{managed-identity}[What are managed identities for Azure resources?] for more details about managed identity.
=== Other Credential Types
Developers who want more control or whose scenario isn't served by the `DefaultAzureCredential` or whose scenario isn't served by the default settings should use other credential types.
==== Authentication and Authorization with Azure AD
With Azure AD, you can use Azure role-based access control (Azure RBAC) to grant permissions to a security principal, which may be a user, or an application service principal. When a security principal (a user, or an application) attempts to access an Azure resource, for example an Event Hubs resource, the request must be authorized. With Azure AD, access to a resource is a two-step process.
==== Authentication and Authorization with Azure Active Directory
With Azure AD, you can use Azure role-based access control (Azure RBAC) to grant permissions to a security principal, which may be a user or an application service principal. When a security principal (a user, or an application) attempts to access an Azure resource, for example, an Event Hubs resource, the request must be authorized. With Azure AD, access to a resource is a two-step process.
1. First, the security principal's identity is authenticated, and an OAuth 2.0 token is returned.
2. Next, the token is passed as part of a request to the Azure service to authorize access to the specified resource.
===== Authenticate with Azure AD
===== Authenticate with Azure Active Directory
For applications want to connect to resources that support Azure AD authentication, below configurations could be set with prefix `spring.cloud.azure.credential` or `spring.cloud.azure.<azure-service>.credential`.
.Authentication properties
@ -98,7 +98,7 @@ For applications want to connect to resources that support Azure AD authenticati
TIP: To see the list of all Spring Cloud Azure related configuration properties please check link:appendix.html[the Appendix page].
[#authorize-access-with-azure-active-directory]
===== Authorize Access with Azure AD
===== Authorize Access with Azure Active Directory
The authorization step requires that one or more Azure roles be assigned to the security principal. The roles that are assigned to a security principal decide the permissions that the principal will have.

21
docs/src/main/asciidoc/configuration.adoc
Просмотреть файл

@ -1,7 +1,7 @@
[#configuration]
== Configuration
Most of Azure SDKs could be divided into two categories by transport type, HTTP-based and AMQP-based. There are properties that are common to all SDKs such as authentication principals and Azure environment settings. Or common to HTTP-based clients, such as logging level to log http requests and responses. Spring Cloud Azure 4.0 provides five common categories of configuration properties, which could be specified to each Azure service.
Most of Azure SDKs could be divided into two categories by transport type, HTTP-based and AMQP-based. There are properties that are common to all SDKs such as authentication principals and Azure environment settings. Or common to HTTP-based clients, such as logging level to log HTTP requests and responses. Spring Cloud Azure 4.0 provides five common categories of configuration properties, which could be specified to each Azure service.
.Service common properties
[cols="2,3", options="header"]
@ -51,37 +51,46 @@ There are some properties that could be shared among different Azure services, f
NOTE: Properties configured under each Azure service will override the global configurations.
Spring Cloud Azure unifies configuration properties' prefixes to `spring.cloud.azure` since 4.0, which will make configuration properties more consistent and more intuitive. Here's a quick review of the prefixes of supported Azure services.
Spring Cloud Azure unifies configuration properties' prefixes to `spring.cloud.azure` since 4.0, which will make configuration properties more consistent and more intuitive. Here's a quick review of the serivce specific properties.
.Service specific properties
[cols="<50,<50", options="header"]
[cols="<3,<3,<3", options="header"]
|===
|Azure Service |Configuration Property Prefix
|Azure Service |Configuration Property Prefix | Configuration Properties Link
|Azure App Configuration
|spring.cloud.azure.*appconfiguration*
|link:appendix.html#_azure_app_configuration_proeprties[App Configuration Properties]
|Azure Cosmos DB
|spring.cloud.azure.*cosmos*
|link:appendix.html#_azure_cosmos_proeprties[Cosmos Properties]
|Azure Event Hubs
|spring.cloud.azure.*eventhubs*
|link:appendix.html#_azure_event_hubs_proeprties[Event Hubs Properties]
|Azure Key Vault Certificate
|Azure Key Vault Certificates
|spring.cloud.azure.*keyvault.certificate*
|link:appendix.html#_azure_key_vault_certificates_proeprties[Key Vault Certificates Properties]
|Azure Key Vault Secret
|Azure Key Vault Secrets
|spring.cloud.azure.*keyvault.secret*
|link:appendix.html#_azure_key_vault_secrets_proeprties[Key Vault Secrets Properties]
|Azure Service Bus
|spring.cloud.azure.*servicebus*
|link:appendix.html#_azure_service_bus_proeprties[Service Bus Properties]
|Azure Storage Blob
|spring.cloud.azure.*storage.blob*
|link:appendix.html#_azure_storage_blob_proeprties[Storage Blob Properties]
|Azure Storage File Share
|spring.cloud.azure.*storage.fileshare*
|link:appendix.html#_azure_storage_file_share_proeprties[Storage File Share Properties]
|Azure Storage Queue
|spring.cloud.azure.*storage.queue*
|link:appendix.html#_azure_storage_queue_proeprties[Storage Queue Properties]
|===

2
docs/src/main/asciidoc/getting-help.adoc
Просмотреть файл

@ -1,7 +1,7 @@
== Getting Help
If you have any questions about this doc, please ask by creating GitHub issue. And Pull Request is welcome.
If you have any questions about this document, please ask by creating GitHub issues. And Pull Request is welcome.
.GitHub repositories
[%autowidth.stretch]

2
docs/src/main/asciidoc/migration-guide-for-4.0.adoc
Просмотреть файл

@ -1,5 +1,5 @@
== Migration Guide for 4.0
To learn how to migration to 4.0, please check link:appendix.html#migration-guide-for-4-0[the Appendix page].
To learn how to migrate to 4.0, please check link:appendix.html#migration-guide-for-4-0[the Appendix page].

2
docs/src/main/asciidoc/production-ready.adoc
Просмотреть файл

@ -1,6 +1,6 @@
== Production Ready
Spring Cloud Azure 4.0 supports health indicators for App Configuration, Event Hubs, Cosmos, Key Vault, Storage Blob, Storage Queue, and Storage File Share. It also provides integrations with Spring Cloud Sleuth for all HTTP-based Azure SDKs. As an example, you now can prob if storage blob is up or down via Spring Boot actuator endpoint, as well as track dependencies and latencies going from your application to Key Vault.
Spring Cloud Azure 4.0 supports health indicators for App Configuration, Event Hubs, Cosmos, Key Vault Certificate, Key Vault Secret, Storage Blob, Storage Queue, and Storage File Share. It also provides integrations with Spring Cloud Sleuth for all HTTP-based Azure SDKs. As an example, you now can prob if storage blob is up or down via Spring Boot actuator endpoint, as well as track dependencies and latencies going from your application to Key Vault.
=== Enable Health Indicator

8
docs/src/main/asciidoc/resource-manager.adoc
Просмотреть файл

@ -51,11 +51,11 @@ spring:
cloud:
azure:
credential:
client-id: ${CLIENT_ID}
client-secret: ${CLIENT_SECRET}
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${TENANT_ID}
subscription-id: ${SUBSCRIPTION_ID}
tenant-id: ${AZURE_TENANT_ID}
subscription-id: ${AZURE_SUBSCRIPTION_ID}
<azure-service>:
namespace: ${SERVICEBUS_NAMESPACE}
resource:

13
docs/src/main/asciidoc/secret-management.adoc
Просмотреть файл

@ -65,7 +65,9 @@ public class SampleApplication implements CommandLineRunner {
Key Vault secret name only support characters in `[0-9a-zA-Z-]`. Refs: link:https://docs.microsoft.com/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name[Vault-name and Object-name]. If your property name contains other characters, you can use these workarounds:
- Use `-` instead of `.` in secret name. `.` is not supported in secret name. If your application have property name which contain `.`, like `spring.datasource.url`, just replace `.` to `-` when save secret in Azure Key Vault. For example: Save `spring-datasource-url` in Azure Key Vault. In your application, you can still use `spring.datasource.url` to retrieve property value. **NOTE**: This method can not satisfy requirement like `spring.datasource-url`. When you save `spring-datasource-url` in Key Vault, only `spring.datasource.url` and `spring-datasource-url` is supported to retrieve property value, `spring.datasource-url` is not supported. To handle this case, please refer to the following option: Use property placeholders.
- Use `-` instead of `.` in secret name. `.` isn't supported in secret name. If your application have property name which contains `.`, like `spring.datasource.url`, just replace `.` to `-` when save secret in Azure Key Vault. For example: Save `spring-datasource-url` in Azure Key Vault. In your application, you can still use `spring.datasource.url` to retrieve property value.
NOTE: This method can not satisfy requirement like `spring.datasource-url`. When you save `spring-datasource-url` in Key Vault, only `spring.datasource.url` and `spring-datasource-url` is supported to retrieve property value, `spring.datasource-url` isn't supported. To handle this case, please refer to the following option: Use property placeholders.
- Use property placeholders. For example: setting this property in your application.properties: `property.with.special.character_=${propertyWithoutSpecialCharacter}`. The application will get `propertyWithoutSpecialCharacter` key name and assign its value to `property.with.special.character_`.
@ -79,7 +81,7 @@ If you stored 1000 secrets in the Key Vault, and you just want to use 3 of them.
==== Setting Refresh Interval
By default, the secrets in `KeyVaultPropertySource` will refresh every 30 minutes. You can configure the time by `spring.cloud.azure.keyvault.secret.property-sources[].refresh-interval`. For example: `spring.cloud.azure.keyvault.secret.property-sources[].refresh-interval=60m` means refresh every 60 minutes. Set to `0` to disable auto-refresh.
By default, the secrets in `KeyVaultPropertySource` will refresh every 30 minutes. You can configure the time by `spring.cloud.azure.keyvault.secret.property-sources[].refresh-interval`. For example: `spring.cloud.azure.keyvault.secret.property-sources[].refresh-interval=60m` means refresh every 60 minutes. Set to `0` to disable auto refresh.
==== PropertySource Priority
@ -87,7 +89,7 @@ If key exists in multiple PropertySources, which will take effect is decided by
- If there is no `SystemEnvironmentPropertySource` in PropertySource list, then `KeyVaultPropertySource` will take the highest priority.
- If there is `SystemEnvironmentPropertySource` in PropertySource list, then `SystemEnvironmentPropertySource` have higher priority than KeyVaultPropertySource. Which means you can use environment variable to override the Key Vault secret value in your application.
- If there is multiple KeyVaultPropertySource in PropertySource list, then the definition order is the priority order. Take above sample as example, `key-vault-property-souece-1` has higher priority than `key-vault-property-souece-2`.
- If there are multiple KeyVaultPropertySource in PropertySource list, then the definition order is the priority order. Take above sample as example, `key-vault-property-souece-1` has higher priority than `key-vault-property-souece-2`.
==== All Configurable Properties
@ -99,7 +101,7 @@ If key exists in multiple PropertySources, which will take effect is decided by
| *spring.cloud.azure.keyvault.secret*.property-sources[].name | | Name of this property source.
| *spring.cloud.azure.keyvault.secret*.property-sources[].endpoint | | Azure Key Vault endpoint.
| *spring.cloud.azure.keyvault.secret*.property-sources[].case-sensitive | false | Whether the secret keys are case-sensitive.
| *spring.cloud.azure.keyvault.secret*.property-sources[].secret-keys | | The secret keys supported for this property source. All keys be retrieved if this property is not configured.
| *spring.cloud.azure.keyvault.secret*.property-sources[].secret-keys | | The secret keys supported for this property source. All keys be retrieved if this property is missing.
| *spring.cloud.azure.keyvault.secret*.property-sources[].refresh-interval| 30m | Time interval to refresh all Key Vault secrets.
| *spring.cloud.azure.keyvault.secret*.property-sources[].service-version | | Secret service version used when making API requests.
| *spring.cloud.azure.keyvault.secret*.property-sources[].client | | Client related properties.
@ -110,9 +112,10 @@ If key exists in multiple PropertySources, which will take effect is decided by
|===
- Please refer to link:index.html#authorize-access-with-azure-active-directory[Authorize access with Azure AD] to make sure the link:https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals#service-principal-object[security principal] has been granted the sufficient permission to access the Azure Key Vault Secrets.
- If common properties like `client`, `credential`, `profile`, `proxy`, `retry` are not configured in `spring.cloud.azure.keyvault.secret.property-sources[].xxx`, `spring.cloud.azure.xxx` will be used. Please refer to link:index.html#configuration[Configuration] to get more information about these common properties.
- If common properties like `client`, `credential`, `profile`, `proxy`, `retry` aren't configured in `spring.cloud.azure.keyvault.secret.property-sources[].xxx`, `spring.cloud.azure.xxx` will be used. Please refer to link:index.html#configuration[Configuration] to get more information about these common properties.
- Please refer to link:appendix.html#_configuration_properties[Configuration Properties] to get more information about nested properties.
=== Samples
Sample project: link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/keyvault/spring-cloud-azure-starter-keyvault-secrets/property-source[property-source].

36
docs/src/main/asciidoc/spring-cloud-stream-support.adoc
Просмотреть файл

@ -282,10 +282,10 @@ spring:
cloud:
azure:
credential:
client-id: ${SERVICE_PRINCIPAL_ID}
client-secret: ${SERVICE_PRINCIPAL_SECRET}
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${TENANT_ID}
tenant-id: ${AZURE_TENANT_ID}
eventhubs:
namespace: ${EVENTHUB_NAMESPACE}
processor:
@ -363,7 +363,7 @@ public Consumer<Message<String>> consume() {
checkpointer.success()
.doOnSuccess(success -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload()))
.doOnError(error -> LOGGER.error("Exception found", error))
.subscribe();
.block();
};
}
@ -456,7 +456,7 @@ public Consumer<Message<List<String>>> consume() {
checkpointer.success()
.doOnSuccess(success -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload()))
.doOnError(error -> LOGGER.error("Exception found", error))
.subscribe();
.block();
};
}
@ -518,8 +518,8 @@ public void producerError(Message<?> message) {
===== Event Hubs Message Headers
See the <<si-eh-headers, Event Hubs message headers>> for the basic message headers supported.
===== Multi Binder Support
Connection to mutiple Event Hubs namespaces is also supported by using multi binders.This sample takes connection string as example. Credentials of service principals and managed identities are also supported, users can set related properties in each binder's environment settings.
===== Multiple Binder Support
Connection to multiple Event Hubs namespaces is also supported by using multiple binders.This sample takes connection string as example. Credentials of service principals and managed identities are also supported, users can set related properties in each binder's environment settings.
Step 1. To use multiple binders of EventHubs, we need to configure below properties in application.yml
[source,yaml]
@ -612,7 +612,7 @@ public Consumer<Message<String>> consume1() {
checkpointer.success()
.doOnSuccess(success -> LOGGER.info("Message1 '{}' successfully checkpointed", message))
.doOnError(error -> LOGGER.error("Exception found", error))
.subscribe();
.block();
};
}
@ -624,7 +624,7 @@ public Consumer<Message<String>> consume2() {
checkpointer.success()
.doOnSuccess(success -> LOGGER.info("Message2 '{}' successfully checkpointed", message))
.doOnError(error -> LOGGER.error("Exception found", error))
.subscribe();
.block();
};
}
----
@ -844,10 +844,10 @@ spring:
cloud:
azure:
credential:
client-id: ${CLIENT_ID}
client-secret: ${CLIENT_SECRET}
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
profile:
tenant-id: ${TENANT_ID}
tenant-id: ${AZURE_TENANT_ID}
servicebus:
namespace: ${SERVICEBUS_NAMESPACE}
stream:
@ -920,7 +920,7 @@ public Consumer<Message<String>> consume() {
checkpointer.success()
.doOnSuccess(success -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload()))
.doOnError(error -> LOGGER.error("Exception found", error))
.subscribe();
.block();
};
}
@ -937,7 +937,7 @@ public Supplier<Message<String>> supply() {
The binder supports link:https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning[Service Bus partitioning] by allowing setting partition key and session id in the message header. This section introduces how to set partition key for messages.
Spring Cloud Stream provides a partition key SpEL expression property `spring.cloud.stream.bindings.<binding-name>.producer.partition-key-expression`. For example, setting this properts as `&quot;&#39;partitionKey-&#39; + headers[&lt;message-header-key&gt;]&quot;` and add a header called <message-header-key>. Spring Cloud Stream will use the value for this header when evaluating the above expression to assign a partition key. Here is an example producer code:
Spring Cloud Stream provides a partition key SpEL expression property `spring.cloud.stream.bindings.<binding-name>.producer.partition-key-expression`. For example, setting this property as `&quot;&#39;partitionKey-&#39; + headers[&lt;message-header-key&gt;]&quot;` and add a header called <message-header-key>. Spring Cloud Stream will use the value for this header when evaluating the above expression to assign a partition key. Here is an example producer code:
[source,java]
----
@ -1025,8 +1025,8 @@ See the <<si-sb-headers, Service Bus message headers>> for the basic message hea
NOTE: When setting the partiton key, the priority of message header is higher than Spring Cloud Stream property. So `spring.cloud.stream.bindings.<binding-name>.producer.partition-key-expression` will take effect only when none of the headers of `ServiceBusMessageHeaders#SESSION_ID`, `ServiceBusMessageHeaders#PARTITION_KEY`, `AzureHeaders#PARTITION_KEY` is configured.
===== Multi Binder Support
Connection to mutiple Service Bus namespaces is also supported by using multi binders. This sample takes connection string as example. Credentials of service principals and managed identities are also supported, users can set related properties in each binder's environment settings.
===== Multiple Binder Support
Connection to multiple Service Bus namespaces is also supported by using multiple binders. This sample takes connection string as example. Credentials of service principals and managed identities are also supported, users can set related properties in each binder's environment settings.
Step 1. To use multiple binders of ServiceBus, we need to configure below properties in application.yml
[source,yaml]
@ -1112,7 +1112,7 @@ public Consumer<Message<String>> consume1() {
checkpointer.success()
.doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload()))
.doOnError(e -> LOGGER.error("Error found", e))
.subscribe();
.block();
};
}
@ -1124,7 +1124,7 @@ public Consumer<Message<String>> consume2() {
checkpointer.success()
.doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload()))
.doOnError(e -> LOGGER.error("Error found", e))
.subscribe();
.block();
};
}

11
docs/src/main/asciidoc/spring-data-support.adoc
Просмотреть файл

@ -4,7 +4,6 @@
link:https://azure.microsoft.com/services/cosmos-db/[Azure Cosmos DB] is a globally-distributed database service that allows developers to work with data using a variety of standard APIs, such as SQL, MongoDB, Graph, and Azure Table storage.
Connect to Cosmos DB using Spring Data and CosmosDB libraries.
=== Dependency Setup
@ -32,15 +31,15 @@ NOTE: If you choose to use a security principal to authenticate and authorize wi
|*spring.cloud.azure.cosmos*.database
|
|The CosmosDB database id
|The Cosmos DB database id.
|*spring.cloud.azure.cosmos*.endpoint
|
|Uri to connect CosmosDB
|Uri to connect Cosmos DB.
|*spring.cloud.azure.cosmos*.key
|
|PrivateKey to connect CosmosDB
|Private key to connect Cosmos DB.
|*spring.cloud.azure.cosmos*.credential.client-certificate-password
|
@ -76,7 +75,7 @@ NOTE: If you choose to use a security principal to authenticate and authorize wi
|*spring.cloud.azure.cosmos*.consistency-level
|
| link:https://docs.microsoft.com/azure/cosmos-db/consistency-levels[Consistency levels] in Azure Cosmos DB
| link:https://docs.microsoft.com/azure/cosmos-db/consistency-levels[Consistency levels] in Azure Cosmos DB.
|===
@ -264,5 +263,5 @@ Autowired UserRepository interface, then can do save, delete and find operations
Please refer to link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/cosmos[azure-spring-boot-samples] for more details.
Besides, using this Azure Cosmos DB Spring Boot Starter, you can directly use Spring Data for Azure Cosmos DB package for more complex scenarios. Please refer to link:https://github.com/Azure/azure-sdk-for-java/tree/spring-cloud-azure-dependencies_{project-version}/sdk/cosmos/azure-spring-data-cosmos[Spring Data for Azure Cosmos DB] for more details.
Apart from using the `spring-cloud-azure-starter-data-cosmos` library, you can directly use `azure-spring-data-cosmos` library for more complex scenarios. Please refer to link:https://github.com/Azure/azure-sdk-for-java/tree/spring-cloud-azure-dependencies_{project-version}/sdk/cosmos/azure-spring-data-cosmos[Spring Data for Azure Cosmos DB] for more details.

159
docs/src/main/asciidoc/spring-integration-support.adoc
Просмотреть файл

@ -287,7 +287,7 @@ class Demo {
checkpointer.success()
.doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message))
.doOnError(e -> LOGGER.error("Error found", e))
.subscribe();
.block();
}
}
----
@ -634,7 +634,7 @@ class Demo {
checkpointer.success()
.doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message))
.doOnError(e -> LOGGER.error("Error found", e))
.subscribe();
.block();
}
}
----
@ -647,74 +647,153 @@ class Demo {
For some Service Bus headers that can be mapped to multiple Spring header constants, the priority of different Spring headers is listed.
.Mapping between Service Bus Headers and Spring Headers
[cols="<,<,<,<", options="header"]
[cols="<,<,<,<,<", options="header"]
|===
|Service Bus Message Headers and Properties | Spring Message Header Constants | Type | Priority Number (Descending priority)
|Service Bus Message Headers and Properties | Spring Message Header Constants | Type | Configurable | Description
|ContentType
| Content type
| MessageHeaders#CONTENT_TYPE
| String
| N/A
| Yes
| The RFC2045 Content-Type descriptor of the message.
|CorrelationId
| Correlation id
| ServiceBusMessageHeaders#CORRELATION_ID
|String
| N/A
| String
| Yes
| The correlation id of the message
|**MessageId**
| Message id
| ServiceBusMessageHeaders#MESSAGE_ID
| String
| 1
| Yes
| The message id of the message, this header has higher priority than `MessageHeaders#ID`.
|**MessageId**
| AzureHeaders#RAW_ID
| String
| 2
|**MessageId**
| Message id
| MessageHeaders#ID
| UUID
| 3
| Yes
| The message id of the message, this header has lower priority than `ServiceBusMessageHeaders#MESSAGE_ID`.
|PartitionKey
| Partition key
| ServiceBusMessageHeaders#PARTITION_KEY
|String
| N/A
| String
| Yes
| The partition key for sending the message to a partitioned entity.
|ReplyTo
| Reply to
| MessageHeaders#REPLY_CHANNEL
| String
| N/A
| Yes
| The address of an entity to send replies to.
|ReplyToSessionId
| Reply to session id
| ServiceBusMessageHeaders#REPLY_TO_SESSION_ID
| String
| N/A
| Yes
| The ReplyToGroupId property value of the message.
|**ScheduledEnqueueTimeUtc**
| Scheduled enqueue time utc
| ServiceBusMessageHeaders#SCHEDULED_ENQUEUE_TIME
| OffsetDateTime
| Yes
| The datetime at which the message should be enqueued in Service Bus, this header has higher priority than `AzureHeaders#SCHEDULED_ENQUEUE_MESSAGE`.
| Scheduled enqueue time utc
| AzureHeaders#SCHEDULED_ENQUEUE_MESSAGE
| Integer
| 1
| Yes
| The datetime at which the message should be enqueued in Service Bus, this header has lower priority than `ServiceBusMessageHeaders#SCHEDULED_ENQUEUE_TIME`.
|**ScheduledEnqueueTimeUtc**
| ServiceBusMessageHeaders#SCHEDULED_ENQUEUE_TIME
| Instant
| 2
|SessionID
| Session id
| ServiceBusMessageHeaders#SESSION_ID
| String
| N/A
| Yes
| The session identifier for a session-aware entity.
|TimeToLive
| Time to live
| ServiceBusMessageHeaders#TIME_TO_LIVE
|Duration
| N/A
| Duration
| Yes
| The duration of time before this message expires.
|To
| To
| ServiceBusMessageHeaders#TO
| String
| N/A
| Yes
| The "to" address of the message, reserved for future use in routing scenarios and presently ignored by the broker itself.
| Subject
| ServiceBusMessageHeaders#SUBJECT
| String
| Yes
| The subject for the message.
| Dead letter error description
| ServiceBusMessageHeaders#DEAD_LETTER_ERROR_DESCRIPTION
| String
| No
| The description for a message that has been dead-lettered.
| Dead letter reason
| ServiceBusMessageHeaders#DEAD_LETTER_REASON
| String
| No
| The reason a message was dead-lettered.
| Dead letter source
| ServiceBusMessageHeaders#DEAD_LETTER_SOURCE
| String
| No
| The entity in which the message was dead-lettered.
| Delivery count
| ServiceBusMessageHeaders#DELIVERY_COUNT
| long
| No
| The number of the times this message was delivered to clients.
| Enqueued sequence number
| ServiceBusMessageHeaders#ENQUEUED_SEQUENCE_NUMBER
| long
| No
| The enqueued sequence number assigned to a message by Service Bus.
| Enqueued time
| ServiceBusMessageHeaders#ENQUEUED_TIME
| OffsetDateTime
| No
| The datetime at which this message was enqueued in Service Bus.
| Expires at
| ServiceBusMessageHeaders#EXPIRES_AT
| OffsetDateTime
| No
| The datetime at which this message will expire.
| Lock token
| ServiceBusMessageHeaders#LOCK_TOKEN
| String
| No
| The lock token for the current message.
| Locked until
| ServiceBusMessageHeaders#LOCKED_UNTIL
| OffsetDateTime
| No
| The datetime at which the lock of this message expires.
| Sequence number
| ServiceBusMessageHeaders#SEQUENCE_NUMBER
| long
| No
| The unique number assigned to a message by Service Bus.
| State
| ServiceBusMessageHeaders#STATE
| ServiceBusMessageState
| No
| The state of the message, which can be Active, Deferred, or Scheduled.
|===
===== Partition Key Support
@ -960,7 +1039,7 @@ class Demo {
checkpointer.success()
.doOnError(Throwable::printStackTrace)
.doOnSuccess(t -> LOGGER.info("Message '{}' successfully checkpointed", message))
.subscribe();
.block();
}
}
----

2
docs/src/main/asciidoc/spring-jms-support.adoc
Просмотреть файл

@ -103,7 +103,7 @@ Adding below dependencies if you want to migrate your Spring JMS application to
|===
NOTE: Spring JMS general configuration is omited for short.
Please refer to link:https://docs.spring.io/spring-framework/docs/3.2.x/spring-framework-reference/html/jms.html[Spring JMS Doc] for more details.
Please refer to link:https://docs.spring.io/spring-framework/docs/3.2.x/spring-framework-reference/html/jms.html[Spring JMS Document] for more details.
=== Basic Usage

726
docs/src/main/asciidoc/spring-security-support.adoc
Просмотреть файл

@ -1,6 +1,6 @@
== Spring Security Support
=== Spring Security With Azure AD
=== Spring Security With Azure Active Directory
When you are building a web application, identity and access management will always be foundational pieces.
@ -8,83 +8,106 @@ Azure offers a great platform to democratize your application development journe
Spring Security has made it easy to secure your Spring based applications with powerful abstractions and extensible interfaces. However, as powerful as the Spring framework can be, it is not tailored to a specific identity provider.
The `spring-cloud-azure-starter-active-directory` (`aad-starter` for short) provides the most optimal way to connect your `web application` to an Azure Active Directory(AAD for short) tenant and protect `resource server` with AAD. It uses the Oauth 2.0 protocol to protect `web applications` and `resource servers`.
The `spring-cloud-azure-starter-active-directory` (`aad-starter` for short) provides the most optimal way to connect your `web application` to an Azure Active Directory (AAD for short) tenant and protect `resource server` with AAD. It uses the Oauth 2.0 protocol to protect `web applications` and `resource servers`.
==== Dependency Setup
==== Accessing a Web Application
This scenario uses https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow[The OAuth 2.0 authorization code grant] flow to log in a user with a Microsoft account.
===== System Diagram
image:https://user-images.githubusercontent.com/13167207/142617664-f1704adb-db64-49e0-b1b6-078c62b6945b.png[Standalone Web Application]
===== Create Required Resources in Azure
1. Read link:https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app[MS docs about register an application with the Microsoft identity platform].
2. Create app registration. Get `AZURE_TENANT_ID`, `AZURE_CLIENT_ID` and `AZURE_CLIENT_SECRET`.
3. Set `redirect URI` to `APPLICATION_BASE_URI/login/oauth2/code/`, for example `http://localhost:8080/login/oauth2/code/`. The tailing `/` is required.
===== Add Required Dependencies
[source,xml]
----
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-active-directory</artifactId>
</dependency>
<dependencies>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-active-directory</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>
</dependencies>
----
==== Configuration
===== Add Required Properties
.Configurable properties of spring-cloud-azure-starter-active-directory
[cols="<,<,<", options="header"]
|===
|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*.jwk-set-cache-lifespan | `5` | The lifespan of the cached JWK set before it expires, default is 5 minutes.
|*spring.cloud.azure.active-directory*.jwk-set-cache-refresh-time | `5` | 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 | | Properties to Azure Active Directory endpoints.
|*spring.cloud.azure.active-directory*.profile.tenant-id | | Azure Tenant ID.
|*spring.cloud.azure.active-directory*.redirect-uri-template | `{baseUrl}/login/oauth2/code/` | 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 | `false` | 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 | `false` | 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.
|===
Here are some examples about how to use these properties:
[#property-example-1-application-type]
===== Property Example 1: Application Type
This property(`spring.cloud.azure.active-directory.application-type`) is optional, its value can be inferred by dependencies, only `web_application_and_resource_server` must be configured manually: `spring.cloud.azure.active-directory.application-type=web_application_and_resource_server`.
.Application type of spring-cloud-azure-starter-active-directory
[cols="4*", options="header"]
|===
|Has dependency: spring-security-oauth2-client |Has dependency: spring-security-oauth2-resource-server |Valid values of application type |Default value
|Yes |No |`web_application` |`web_application`
|No |Yes |`resource_server` |`resource_server`
|Yes |Yes |`web_application`,`resource_server`,`resource_server_with_obo`, `web_application_and_resource_server` |`resource_server_with_obo`
|===
===== Property Example 2: Use https://docs.microsoft.com/azure/china/resources-developer-guide#check-endpoints-in-azure[Azure China] Instead of Azure Global
* Step 1: Add property in application.yml
[source,yaml]
----
spring:
cloud:
azure:
active-directory:
base-uri: https://login.partner.microsoftonline.cn
graph-base-uri: https://microsoftgraph.chinacloudapi.cn
profile:
tenant-id: ${AZURE_TENANT_ID}
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
----
===== Property Example 3: Use `Group Name` Or `Group ID` to Protect Some Method in Web Application
Now start you application and access your application by browser, then you will be redirected into Microsoft login page.
* Step 1: Add property in application.yml
===== Advanced Usages
====== Add Extra Security Configurations
[source,java]
----
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class AadOAuth2LoginSecurityConfig extends AadWebSecurityConfigurerAdapter {
/**
* Add configuration logic as needed.
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
super.configure(http);
http.authorizeRequests()
.anyRequest().authenticated();
// Do some custom configuration
}
}
----
====== Authorize Access by App Roles
* Step 1: Create Required Resources in Azure
1. Read link:https://docs.microsoft.com/azure/active-directory/develop/howto-add-app-roles-in-azure-ad-apps[MS docs about Add app roles to your application and receive them in the token].
2. Create an app role with the following parameters:
- Display name: Admin
- Allowed member types: Users/Groups
- Value: Admin
- Do you want to enable this app role: yes
NOTE: If you want to use app role based access control, you can't put group names in `role` claim . Refs: link:https://docs.microsoft.com/azure/active-directory/develop/active-directory-optional-claims#configuring-groups-optional-claims[Configuring groups optional claims].
* Step 2: Protect specific method.
[source,java]
----
class Demo {
@GetMapping("Admin")
@ResponseBody
@PreAuthorize("hasAuthority('APPROLE_Admin')")
public String admin() {
return "Admin message";
}
}
----
====== Authorize Access by Group Name Or Group ID
* Step 1: Add related configuration properties.
[source,yaml]
----
spring:
@ -99,29 +122,7 @@ spring:
allowed-group-ids: group_id_1, group_id_2
----
* Step 2: Add `@EnableGlobalMethodSecurity(prePostEnabled = true)` in web application:
[source,java]
----
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class AadOAuth2LoginSecurityConfig extends AadWebSecurityConfigurerAdapter {
/**
* Add configuration logic as needed.
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
super.configure(http);
http.authorizeRequests()
.anyRequest().authenticated();
// Do some custom configuration
}
}
----
Then we can protect the method by `@PreAuthorize` annotation:
* Step 2: Protect specific method.
[source,java]
----
@Controller
@ -156,9 +157,15 @@ public class RoleController {
}
----
===== Property Example 4: https://docs.microsoft.com/azure/active-directory/azuread-dev/azure-ad-endpoint-comparison#incremental-and-dynamic-consent[Incremental consent] In Web Application Visiting Resource Servers
====== Use National Azure Instead of Global Azure
* Step 1: Add property in application.yml
Now except global Azure cloud, Azure Active Directory is deployed in the following national clouds:
- Azure Government
- Azure China 21Vianet
- Azure Germany
Here is a sample of you want to use Azure China 21Vianet.
[source,yaml]
----
@ -166,129 +173,74 @@ spring:
cloud:
azure:
active-directory:
authorization-clients:
graph:
scopes: https://graph.microsoft.com/Analytics.Read, email
arm: # client registration id
on-demand: true # means incremental consent
scopes: https://management.core.windows.net/user_impersonation
base-uri: https://login.partner.microsoftonline.cn
graph-base-uri: https://microsoftgraph.chinacloudapi.cn
----
* Step 2: Write Java code:
You can refer to these MS doc to get more information from link:https://docs.microsoft.com/en-us/graph/deployments[MS docs about National cloud deployments].
After these steps. `arm`'s scopes (https://management.core.windows.net/user_impersonation) doesn't
need to be consented at login time. When user request `/arm` endpoint, user need to consent the
scope. That's `incremental consent` means.
====== Configure Redirect URI Template
After the scopes have been consented, AAD server will remember that this user has already granted
the permission to the web application. So incremental consent will not happen anymore after user
consented.
Developers can customize the redirect-uri.
===== Property Example 5: https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow[Client credential flow] In Resource Server Visiting Resource Servers
* Step 1: Add property in application.yml
image:https://user-images.githubusercontent.com/13167207/149295662-072ca3d5-f9e1-4f25-bb0e-be7bb751e9af.png[redirect-uri]
* Step 1: Add `redirect-uri-template` properties in application.yml.
[source,yaml]
----
spring:
cloud:
azure:
active-directory:
authorization-clients:
webapiC: # When authorization-grant-type is null, on behalf of flow is used by default
authorization-grant-type: client_credentials
scopes:
- <Web-API-C-app-id-url>/.default
active-directory
redirect-uri-template: ${REDIRECT-URI-TEMPLATE}
----
* Step 2: Write Java code:
* Step 2: Update redirect-uri in Azure portal.
==== Basic Usage
image:https://user-images.githubusercontent.com/13167207/149296913-a4259df9-e0c3-4e38-8d4e-77ee845de4ad.png[web-application-config-redirect-uri]
===== Usage 1: Accessing a Web Application
* Step 3: Update WebSecurityConfigurerAdapter
This scenario uses https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow[The OAuth 2.0 authorization code grant] flow to log in a user with a Microsoft account.
*System diagram*:
image:https://user-images.githubusercontent.com/13167207/142617664-f1704adb-db64-49e0-b1b6-078c62b6945b.png[Standalone Web Application]
* Step 1: Make sure `redirect URI` has been set to `APPLICATION_BASE_URI/login/oauth2/code/`, for
example `http://localhost:8080/login/oauth2/code/`.
CAUTION: The tailing `/` cannot be omitted.
image:https://user-images.githubusercontent.com/13167207/142617751-154c156c-9035-4641-9b79-b26380ddad72.png[web-application-set-redirect-uri-1.png]
image:https://user-images.githubusercontent.com/13167207/142617785-b4ca1afc-79f6-48ae-b7a3-99fba5856689.png[web-application-set-redirect-uri-2.png]
* Step 2: Add the following dependencies in your pom.xml.
[source,xml]
----
<dependencies>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-active-directory</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>
</dependencies>
----
* Step 3: Add properties in application.yml.
[source,yaml]
----
spring:
cloud:
azure:
active-directory:
profile:
tenant-id: ${AZURE_TENANT_ID}
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
----
* Step 4: Write your Java code:
The `AadWebSecurityConfigurerAdapter` contains necessary web security configuration for *aad-starter*.
(A). `DefaultAadWebSecurityConfigurerAdapter` is configured automatically if you not provide one.
(B). You can provide one by extending `AadWebSecurityConfigurerAdapter` and call `super.configure(http)` explicitly in the `configure(HttpSecurity http)` function. Here is an example:
After we set redirect-uri-template, we need to update `WebSecurityConfigurerAdapter`:
[source,java]
----
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class AadOAuth2LoginSecurityConfig extends AadWebSecurityConfigurerAdapter {
/**
* Add configuration logic as needed.
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
super.configure(http);
http.authorizeRequests()
.anyRequest().authenticated();
// Do some custom configuration
}
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class AadOAuth2LoginSecurityConfig extends AadWebSecurityConfigurerAdapter {
/**
* Add configuration logic as needed.
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
super.configure(http);
http.oauth2Login()
.loginProcessingUrl("${REDIRECT-URI-TEMPLATE}")
.and()
.authorizeRequests()
.anyRequest().authenticated();
}
}
----
===== Usage 2: Web Application Accessing Resource Servers
===== Samples
*System diagram*:
Sample project: link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory/web-client-access-resource-server/aad-web-application[aad-web-application].
==== Web Application Accessing Resource Servers
===== System Diagram
image:https://user-images.githubusercontent.com/13167207/142617853-0526205f-fdef-47f9-ac01-77963f8c34be.png[web-application-visiting-resource-servers.png]
* Step 1: Make sure `redirect URI` has been set.
===== Create Required Resources in Azure
* Step 2: Add the following dependencies in you pom.xml.
1. Read link:https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app[MS docs about register an application with the Microsoft identity platform].
2. Create app registration. Get `AZURE_TENANT_ID`, `AZURE_CLIENT_ID` and `AZURE_CLIENT_SECRET`.
3. Set `redirect URI` to `APPLICATION_BASE_URI/login/oauth2/code/`, for example `http://localhost:8080/login/oauth2/code/`. The tailing `/` is required.
===== Add Required Dependencies
[source,xml]
----
<dependencies>
@ -303,7 +255,7 @@ image:https://user-images.githubusercontent.com/13167207/142617853-0526205f-fdef
</dependencies>
----
* Step 3: Add properties in application.yml:
===== Add Required Properties
[source,yaml]
----
@ -323,7 +275,7 @@ spring:
Here, `graph` is the name of `OAuth2AuthorizedClient`, `scopes` means the scopes need to consent when login.
* Step 4: Write your Java code:
===== Use OAuth2AuthorizedClient in Your Application
[source,java]
----
public class Demo {
@ -338,19 +290,117 @@ public class Demo {
}
----
Here, `graph` is the client name configured in step 2. OAuth2AuthorizedClient contains access_token. access_token can be used to access resource server.
Now start you application and access your application by browser, then you will be redirected into Microsoft login page.
===== Usage 3: Accessing a Resource Server
===== Advanced Usages
This scenario doesn't support login, just protect the server by validating the access_token. If the access token is valid, the server serves the request.
====== Client Credential Flow
*System diagram*:
The default flow is link:https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow[authorization code flow], if you want to use link:https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow[client credentials flow], you can configure like this:
[source,yaml]
----
spring:
cloud:
azure:
active-directory:
profile:
tenant-id: ${AZURE_TENANT_ID}
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
authorization-clients:
graph:
authorization-grant-type: client_credentials # Change type to client_credentials
scopes: https://graph.microsoft.com/Analytics.Read, email
----
====== Access Multiple Resource Servers
In one web application, you can access multiple resource server by configuring like this:
[source,yaml]
----
spring:
cloud:
azure:
active-directory:
profile:
tenant-id: ${AZURE_TENANT_ID}
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
authorization-clients:
resource-server-1:
scopes: # Scopes for resource-server-1
resource-server-2:
scopes: # Scopes for resource-server-2
----
Then you can use OAuth2AuthorizedClient in application like this
[source,java]
----
public class Demo {
@GetMapping("/resource-server-1")
@ResponseBody
public String graph(
@RegisteredOAuth2AuthorizedClient("resource-server-1") OAuth2AuthorizedClient client) {
return callResourceServer1(client);
}
@GetMapping("/resource-server-2")
@ResponseBody
public String graph(
@RegisteredOAuth2AuthorizedClient("resource-server-2") OAuth2AuthorizedClient client) {
return callResourceServer2(client);
}
}
----
====== Incremental Consent
In previous sample, all scopes will be consented when customer first login, no matter it's belong to resource-server-1 or resource-server-2. If you don't want to let customer consent all scopes, you can do like this:
[source,yaml]
----
spring:
cloud:
azure:
active-directory:
profile:
tenant-id: ${AZURE_TENANT_ID}
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
authorization-clients:
resource-server-1:
scopes: # Scopes for resource-server-1
resource-server-2:
on-demand: true # means incremental consent
scopes: # Scopes for resource-server-2
----
===== Samples
Sample project: link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory/web-client-access-resource-server/aad-web-application[aad-web-application].
==== Accessing a Resource Server
This scenario doesn't support login, just protect the server by validating the access token. If the access token is valid, the server serves the request.
===== System Diagram
image:https://user-images.githubusercontent.com/13167207/142617910-1ee3eb6a-ddc7-4b85-af4e-71344c91b248.png[Standalone resource server usage]
To use *aad-starter* in this scenario, we need these steps:
===== Create Required Resources in Azure
* Step 1: Add the following dependencies in you pom.xml.
1. Read link:https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app[MS docs about register an application with the Microsoft identity platform].
2. Create app registration. Get `AZURE_CLIENT_ID`.
3. Read link:https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-configure-app-expose-web-apis[MS docs about configure an application to expose a web API].
4. Expose a web API with a scope named `Scope-1`.
===== Add Required Dependencies
[source,xml]
----
<dependencies>
@ -365,29 +415,31 @@ To use *aad-starter* in this scenario, we need these steps:
</dependencies>
----
* Step 2: Add properties in application.yml:
===== Add Required Properties
[source,yaml]
----
spring:
cloud:
azure:
active-directory:
client-id: ${AZURE_CLIENT_ID}
app-id-uri: ${AZURE_APP_ID_URI}
credential:
client-id: ${AZURE_CLIENT_ID}
----
Both `client-id` and `app-id-uri` can be used to verify access token. `app-id-uri` can be got in Azure Portal:
Now start your application and access your application's web api.
image:https://user-images.githubusercontent.com/13167207/142617979-167e7509-b82e-4475-99b7-91bcf0ec249c.png[get-app-id-uri-1.png]
image:https://user-images.githubusercontent.com/13167207/142618069-074289df-11aa-4d2c-ac8e-9a8a61c96288.png[get-app-id-uri-2.png]
1. You will get 401 without an access token.
2. Access your application with an access token, the following claims in access token will be validated:
- `iss`: The access token must be issued by Azure AD.
- `nbf`: Current time can not before `nbf`.
- `exp`: Current time can not after `exp`.
- `aud`: If `spring.cloud.azure.active-directory.credential.client-id` or `spring.cloud.azure.active-directory.credential.app-id-uri` configured, the audience must equal to the configured `client-id` or `app-id-uri`. If the 2 properties are not configured, this claim will not be validated.
* Step 3: Write Java code:
Refer to link:https://docs.microsoft.com/en-us/azure/active-directory/develop/access-tokens[MS docs about Microsoft identity platform access tokens] to get more information about access token.
The `AadResourceServerWebSecurityConfigurerAdapter` contains necessary web security configuration for resource server.
===== Advanced Usages
(A). `DefaultAadResourceServerWebSecurityConfigurerAdapter` is configured automatically if you not provide one.
(B). You can provide one by extending `AadResourceServerWebSecurityConfigurerAdapter` and call `super.configure(http)` explicitly in the `configure(HttpSecurity http)` function. Here is an example:
====== Add Extra Security Configurations
[source,java]
----
@ -405,17 +457,75 @@ public class AadOAuth2ResourceServerSecurityConfig extends AadResourceServerWebS
}
----
===== Usage 4: Resource Server Visiting Other Resource Servers
====== Validate Permission by Scopes
This scenario support visit other resource servers in resource servers.
* Step 1: : Create Required Resources in Azure
- Read link:https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-configure-app-expose-web-apis[MS docs about configure an application to expose a web API].
- Expose a web API with a scope named `Scope1`.
*System diagram*:
* Step 2: Protect specific method.
[source,java]
----
class Demo {
@GetMapping("scope1")
@ResponseBody
@PreAuthorize("hasAuthority('SCOPE_Scope1')")
public String scope1() {
return "Congratulations, you can access `scope1` endpoint.";
}
}
----
By doing this, when access `/scope1` endpoint, the following claims in access token will be validated:
- `scp`: The value must contains `Scope1`.
====== Validate Permission by App Roles
* Step 1: Create Required Resources in Azure
1. Read link:https://docs.microsoft.com/azure/active-directory/develop/howto-add-app-roles-in-azure-ad-apps[MS docs about Add app roles to your application and receive them in the token].
2. Create an app role with the following parameters:
- Display name: AppRole1
- Allowed member types: Users/Groups
- Value: AppRole1
- Do you want to enable this app role: yes
* Step 2: Protect specific method.
[source,java]
----
class Demo {
@GetMapping("app-role1")
@ResponseBody
@PreAuthorize("hasAuthority('APPROLE_AppRole1')")
public String appRole1() {
return "Congratulations, you can access `app-role1` endpoint.";
}
}
----
By doing this, when access `/app-role1` endpoint, the following claims in access token will be validated:
- `roles`: The value must contains `AppRole1`.
===== Samples
Sample project: link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory/web-client-access-resource-server/aad-resource-server[aad-resource-server].
==== Resource Server Visiting Other Resource Servers
===== System Diagram
image:https://user-images.githubusercontent.com/13167207/142618294-aa546ced-d241-4fbd-97ac-fb06881503b1.png[resource-server-visiting-other-resource-servers.png]
To use *aad-starter* in this scenario, we need these steps:
===== Create Required Resources in Azure
1. Read link:https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app[MS docs about register an application with the Microsoft identity platform].
2. Create app registration. Get `AZURE_TENANT_ID`, `AZURE_CLIENT_ID` and `AZURE_CLIENT_SECRET`.
===== Add Required Dependencies
* Step 1: Add the following dependencies in you pom.xml.
[source,xml]
----
<dependencies>
@ -434,7 +544,7 @@ To use *aad-starter* in this scenario, we need these steps:
</dependencies>
----
* Step 2: Add properties in application.yml:
===== Add Required Properties
[source,yaml]
----
@ -447,21 +557,17 @@ spring:
credential:
client-id: ${AZURE_CLIENT_ID}
client-secret: ${AZURE_CLIENT_SECRET}
app-id-uri: ${WEB_API_ID_URI}
authorization-clients:
graph:
scopes:
- https://graph.microsoft.com/User.Read
----
* Step 3: Write Java code:
Using `@RegisteredOAuth2AuthorizedClient` to access related resource server:
===== Use OAuth2AuthorizedClient in Your Application
[source,java]
----
public class SampleController {
@PreAuthorize("hasAuthority('SCOPE_Obo.Graph.Read')")
@GetMapping("call-graph")
public String callGraph(@RegisteredOAuth2AuthorizedClient("graph") OAuth2AuthorizedClient graph) {
return callMicrosoftGraphMeEndpoint(graph);
@ -469,13 +575,20 @@ public class SampleController {
}
----
===== Usage 5: Web Application and Resource Server in One Application
This scenario supports `Web application` and `Resource server` in one application.
===== Samples
To use *aad-starter* in this scenario, we need these steps:
Sample project: link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory/web-client-access-resource-server/aad-resource-server-obo[aad-resource-server-obo].
* Step 1: Add the following dependencies in you pom.xml.
==== Web Application and Resource Server in One Application
===== Create Required Resources in Azure
1. Read link:https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app[MS docs about register an application with the Microsoft identity platform].
2. Create app registration. Get `AZURE_TENANT_ID`, `AZURE_CLIENT_ID` and `AZURE_CLIENT_SECRET`.
===== Add Required Dependencies
[source,xml]
----
<dependencies>
@ -494,7 +607,7 @@ To use *aad-starter* in this scenario, we need these steps:
</dependencies>
----
* Step 2: Add properties in application.yml:
===== Add Required Properties
Set property `spring.cloud.azure.active-directory.application-type` to `web_application_and_resource_server`, and specify the authorization type for each authorization client.
@ -519,9 +632,9 @@ spring:
- https://graph.microsoft.com/Directory.Read.All
----
* Step 3: Write Java code:
===== Define SecurityConfigurationAdapter
Configure multiple HttpSecurity instances, `AadOAuth2SecurityMultiConfig` contain two security configurations for resource server and web application.
Configure multiple HttpSecurity instances, `AadWebApplicationAndResourceServerConfig` contain two security configurations for resource server and web application.
[source,java]
----
@ -556,146 +669,55 @@ public class AadWebApplicationAndResourceServerConfig {
}
----
==== Configuration
==== Advanced Features
.Configurable properties of spring-cloud-azure-starter-active-directory
===== Support Access Control by ID Token in Web Application
[cols="<,<,<", options="header"]
|===
|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*.jwk-set-cache-lifespan | `5` | The lifespan of the cached JWK set before it expires, default is 5 minutes.
|*spring.cloud.azure.active-directory*.jwk-set-cache-refresh-time | `5` | 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 | | Properties to Azure Active Directory endpoints.
|*spring.cloud.azure.active-directory*.profile.tenant-id | | Azure Tenant ID.
|*spring.cloud.azure.active-directory*.redirect-uri-template | `{baseUrl}/login/oauth2/code/` | 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 | `false` | 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 | `false` | 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.
|===
This starter supports creating `GrantedAuthority` from id_token's `roles` claim to allow using `id_token` for authorization in web application. Developers can use the `appRoles` feature of Azure Active Directory to create `roles` claim and implement access control.
Here are some examples about how to use these properties:
NOTE: The `roles` claim generated from `appRoles` is decorated with prefix `APPROLE_`. When using `appRoles` as `roles` claim, please avoid configuring group attribute as `roles` at the same time. The latter will override the claim to contain group information instead of `appRoles`. Below configuration in manifest should be avoided:
===== Application Type
[source,json]
----
{
"optionalClaims": {
"idtoken": [{
"name": "groups",
"additionalProperties": ["emit_as_roles"]
}]
}
}
----
THe application type can be inferred from the dependencies: spring-security-oauth2-client or spring-security-oauth2-resource-server. If the inferred value is not the value you want, you can specify the application type. Here is the table about valid values and inferred value:
Follow https://docs.microsoft.com/azure/active-directory/develop/howto-add-app-roles-in-azure-ad-apps[the guide] to add app roles in your application and assign to users or groups.
* Step 1: Add below `appRoles` configuration in your application's manifest:
[source,json]
----
{
"appRoles": [
{
"allowedMemberTypes": [
"User"
],
"displayName": "Admin",
"id": "2fa848d0-8054-4e11-8c73-7af5f1171001",
"isEnabled": true,
"description": "Full admin access",
"value": "Admin"
}
]
}
----
* Step 2: Write Java code:
[source,java]
----
class Demo {
@GetMapping("Admin")
@ResponseBody
@PreAuthorize("hasAuthority('APPROLE_Admin')")
public String admin() {
return "Admin message";
}
}
----
===== Support Conditional Access in Web Application
This starter supports https://docs.microsoft.com/azure/active-directory/conditional-access/[Conditional Access] policy. By using Conditional Access policies, you can apply the right **access controls** when needed to keep your organization secure. **Access controls** has many concepts, https://docs.microsoft.com/azure/active-directory/conditional-access/howto-conditional-access-policy-block-access[Block Access] and https://docs.microsoft.com/azure/active-directory/conditional-access/concept-conditional-access-grant[Grant Access] are important. In some scenarios, this stater will help you complete Grant Access controls.
In `Resource server visiting other resource server` scenario(For better description, we think that resource server with OBO function as **webapiA** and the other resource servers as **webapiB**), When we configure the webapiB application with Conditional Access(such as https://docs.microsoft.com/azure/active-directory/authentication/concept-mfa-howitworks[multi-factor authentication]), this stater will help us send the Conditional Access information of the webapiA to the web application and the web application will help us complete the Conditional Access Policy. As shown below:
image:https://user-images.githubusercontent.com/13167207/149291667-930e8559-b8ce-4955-b9ae-11a0a8013ea9.png[aad-conditional-access-flow.png]
We can use our sample to create a Conditional Access scenario.
**webapp**: https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory/aad-web-application[aad-web-application].
**webapiA**: https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory/aad-resource-server-obo[aad-resource-server-obo].
**webapiB**: https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory/aad-resource-server[aad-resource-server].
* Step 1: Follow the guide to create conditional access policy for webapiB.
image:https://user-images.githubusercontent.com/13167207/149294175-af143a10-a242-476d-a20b-5ab91b45cee3.png[aad-create-conditional-access]
image:https://user-images.githubusercontent.com/13167207/149294294-75af3386-89b6-43fa-84e6-7a21c3da0352.png[aad-conditional-access-add-application]
* Step 2: https://docs.microsoft.com/azure/active-directory/conditional-access/howto-conditional-access-policy-all-users-mfa[Require MFA for all users] or specify the user account in your policy.
image:https://user-images.githubusercontent.com/13167207/149294469-f2785eee-ddfc-49f0-b16e-efc29aca626e.png[aad-create-conditional-access]
* Step 3: Follow the guide, configure and run sample
1. **webapiB**: https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory/aad-resource-server#configure-web-api[configure webapiB]
2. **webapiA**: https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/aad/azure-spring-boot-starter-active-directory/aad-resource-server-obo#configure-your-middle-tier-web-api-a[configure webapiA]
3. **webapp**: https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/aad/azure-spring-boot-starter-active-directory/aad-web-application#configure-web-app[configure webapp]
===== Support Setting Redirect-URI-Template
Developers can customize the redirect-uri.
image:https://user-images.githubusercontent.com/13167207/149295662-072ca3d5-f9e1-4f25-bb0e-be7bb751e9af.png[redirect-uri]
* Step 1: Add `redirect-uri-template` properties in application.yml.
[source,yaml]
----
spring:
cloud:
azure:
active-directory
redirect-uri-template: ${REDIRECT-URI-TEMPLATE}
----
* Step 2: Update the configuration of the azure cloud platform in the portal.
We need to configure the same redirect-uri as application.yml:
image:https://user-images.githubusercontent.com/13167207/149296913-a4259df9-e0c3-4e38-8d4e-77ee845de4ad.png[web-application-config-redirect-uri]
* Step 3: Write your Java code:
After we set redirect-uri-template, we need to update `SecurityConfigurerAdapter`:
[source,java]
----
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class AadOAuth2LoginSecurityConfig extends AadWebSecurityConfigurerAdapter {
/**
* Add configuration logic as needed.
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
super.configure(http);
http.oauth2Login()
.loginProcessingUrl("${REDIRECT-URI-TEMPLATE}")
.and()
.authorizeRequests()
.anyRequest().authenticated();
}
}
----
.Application type of spring-cloud-azure-starter-active-directory
[cols="4*", options="header"]
|===
|Has dependency: spring-security-oauth2-client |Has dependency: spring-security-oauth2-resource-server |Valid values of application type |Inferred value
|Yes |No |`web_application` |`web_application`
|No |Yes |`resource_server` |`resource_server`
|Yes |Yes |`web_application`, `resource_server`, `resource_server_with_obo`, `web_application_and_resource_server` |`resource_server_with_obo`
|===
==== Samples
Please refer to link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}[azure-spring-boot-samples] for more details.
=== Spring Security With Azure AD B2C
=== Spring Security With Azure Active Directory B2C
Azure Active Directory (Azure AD) B2C is an identity management service that enables you to customize and control how customers sign up, sign in, and manage their profiles when using your applications. Azure AD B2C enables these actions while protecting the identities of your customers at the same time.
@ -1083,7 +1105,7 @@ Let `WebApiA` run on port _8081_.
Get the access token for `webApiA` resource and access `http://localhost:8081/webApiA/sample`
as the Bearer authorization header.
===== Usage 4:Resource Server Accessing Other Resource Servers
===== Usage 4: Resource Server Accessing Other Resource Servers
This scenario is an upgrade of *Accessing a resource server*, supports access to other application resources, based on OAuth2 client credentials flow.
@ -1208,6 +1230,6 @@ Let `WebApiA` and `WebApiB` run on port _8081_ and _8082_ respectively.
==== Samples
Please refer to link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}[azure-spring-boot-samples] for more details.
Please refer to link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory-b2c[spring-cloud-azure-starter-active-directory-b2c samples] for more details.

2
docs/src/main/asciidoc/version-information.adoc
Просмотреть файл

@ -1,2 +1,2 @@
This doc is only for Spring Cloud Azure: **{project-version}**. Please refer to https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping[Spring Versions Mapping] to get more information about supported versions.
This document is only for Spring Cloud Azure: **{project-version}**. Please refer to https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping[Spring Versions Mapping] to get more information about supported versions.

4
docs/src/main/asciidoc/whats-new-4.0.adoc
Просмотреть файл

@ -2,11 +2,11 @@
This page covers changes made in 4.0 since 3.10. With this major release, we aim to bring better security, leaner dependencies, support for production readiness, and more.
TIP: To learn how to migration to 4.0, please check link:appendix.html#migration-guide-for-4-0[the Appendix page].
TIP: To learn how to migrate to 4.0, please check link:appendix.html#migration-guide-for-4-0[the Appendix page].
=== Unified Development Experience
We constantly challenge ourselves on how we can make things more consistent and easier to understand, so our customers are not confronted with haphazard development choices. This is a long and self-evolving journey as consistency is relative and there will be things that are outside our control. We now humbly take another step in this direction to improve to our developer experience by unifying project name, artifact ID and properties.
We constantly challenge ourselves on how we can make things more consistent and easier to understand, so our customers are not confronted with haphazard development choices. This is a long and self-evolving journey as consistency is relative and there will be things that are outside our control. We now humbly take another step in this direction to improve our developer experience by unifying project name, artifact ID and properties.
=== Simplified Dependency Management