Repository: microsoft/spring-cloud-azure Branch: main Commit: ecab55c8f9ad Files: 129 Total size: 800.4 KB Directory structure: gitextract_d9n50_wm/ ├── .github/ │ ├── CODEOWNERS │ ├── ISSUE_TEMPLATE/ │ │ ├── bug_report.md │ │ ├── feature_request.md │ │ └── question-query-template.md │ ├── dependabot.yml │ └── workflows/ │ ├── broken-link-check.yml │ ├── markdown-link-check-config.json │ ├── schedule-current-link-check.yaml │ ├── sync-label-from-azsdk-repo.yml │ ├── update-docs.yaml │ └── update-properties-table-in-ms-docs.yaml ├── .gitignore ├── .mvn/ │ └── wrapper/ │ ├── MavenWrapperDownloader.java │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── .settings.xml ├── .springformat ├── .springjavaformatconfig ├── LICENSE ├── LICENSE-CODE ├── LICENSE.txt ├── README.md ├── SECURITY.md ├── azure-spring-cloud-appconfiguration.md ├── docs/ │ ├── .vale-styles/ │ │ └── Microsoft/ │ │ ├── AMPM.yml │ │ ├── Accessibility.yml │ │ ├── Acronyms.yml │ │ ├── Adverbs.yml │ │ ├── Auto.yml │ │ ├── Avoid.yml │ │ ├── ComplexWords.yml │ │ ├── Contractions.yml │ │ ├── Dashes.yml │ │ ├── DateFormat.yml │ │ ├── DateNumbers.yml │ │ ├── DateOrder.yml │ │ ├── Ellipses.yml │ │ ├── FirstPerson.yml │ │ ├── Foreign.yml │ │ ├── Gender.yml │ │ ├── GenderBias.yml │ │ ├── GeneralURL.yml │ │ ├── HeadingAcronyms.yml │ │ ├── HeadingColons.yml │ │ ├── HeadingPunctuation.yml │ │ ├── Headings.yml │ │ ├── Hyphens.yml │ │ ├── Negative.yml │ │ ├── Ordinal.yml │ │ ├── OxfordComma.yml │ │ ├── Passive.yml │ │ ├── Percentages.yml │ │ ├── Quotes.yml │ │ ├── RangeFormat.yml │ │ ├── RangeTime.yml │ │ ├── Ranges.yml │ │ ├── Semicolon.yml │ │ ├── SentenceLength.yml │ │ ├── Spacing.yml │ │ ├── Suspended.yml │ │ ├── Terms.yml │ │ ├── URLFormat.yml │ │ ├── Units.yml │ │ ├── Vocab.yml │ │ ├── We.yml │ │ ├── Wordiness.yml │ │ └── meta.json │ ├── .vale.ini │ ├── README.adoc │ ├── generate-docs.sh │ ├── pom.xml │ └── src/ │ └── main/ │ ├── .gitignore │ └── asciidoc/ │ ├── _attributes.adoc │ ├── _configuration-properties-all.adoc │ ├── _configuration-properties-azure-active-directory-b2c.adoc │ ├── _configuration-properties-azure-active-directory.adoc │ ├── _configuration-properties-azure-app-configuration.adoc │ ├── _configuration-properties-azure-cosmos-db.adoc │ ├── _configuration-properties-azure-event-hubs.adoc │ ├── _configuration-properties-azure-key-vault-certificates.adoc │ ├── _configuration-properties-azure-key-vault-secrets.adoc │ ├── _configuration-properties-azure-key-vault.adoc │ ├── _configuration-properties-azure-service-bus-jms.adoc │ ├── _configuration-properties-azure-service-bus.adoc │ ├── _configuration-properties-azure-storage-blob.adoc │ ├── _configuration-properties-azure-storage-file-share.adoc │ ├── _configuration-properties-azure-storage-queue.adoc │ ├── _configuration-properties-azure-storage.adoc │ ├── _configuration-properties-global.adoc │ ├── _known-issues.adoc │ ├── _migration-guide-for-4.0.adoc │ ├── appendix.adoc │ ├── authentication.adoc │ ├── auto-configure-azure-sdk-clients.adoc │ ├── configuration-properties.adoc │ ├── configuration.adoc │ ├── create-and-configure-managed-identity.adoc │ ├── deploy-applications-to-azure-hosting-environments.adoc │ ├── docinfo.html │ ├── getting-help.adoc │ ├── getting-started.adoc │ ├── ghpages.sh │ ├── index.adoc │ ├── intro.adoc │ ├── kafka-support.adoc │ ├── legal.adoc │ ├── migration-guide-for-4.0.adoc │ ├── production-ready.adoc │ ├── redis-support.adoc │ ├── resource-handling.adoc │ ├── resource-manager.adoc │ ├── secret-management.adoc │ ├── spring-cloud-stream-support.adoc │ ├── spring-data-support.adoc │ ├── spring-integration-support.adoc │ ├── spring-jms-support.adoc │ ├── spring-native-support.adoc │ ├── spring-security-support.adoc │ ├── version-information.adoc │ └── whats-new-4.0.adoc ├── mvnw ├── mvnw.cmd ├── pom.xml └── spring-cloud-azure-markdown-appdendix-generator/ ├── pom.xml └── src/ ├── main/ │ └── java/ │ └── com/ │ └── azure/ │ └── spring/ │ └── cloud/ │ └── internal/ │ └── Main.java └── test/ ├── java/ │ └── com/ │ └── azure/ │ └── spring/ │ └── cloud/ │ └── internal/ │ ├── GeneratorTests.java │ └── MainTests.java └── resources/ ├── configuration-properties-output.md └── with-azure-in-name.json ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/CODEOWNERS ================================================ # Instructions for CODEOWNERS file format and automatic build failure notifications: # https://github.blog/2017-07-06-introducing-code-owners/ # https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners * @backwind1233 @chenrujun @hui1110 @moarychan @netyyyy @saragluna @stliu @yiliuTo docs/src/main/asciidoc/ @chenrujun @hui1110 @yiliuTo ================================================ FILE: .github/ISSUE_TEMPLATE/bug_report.md ================================================ --- name: Bug report about: Create a report to help us improve title: "[BUG]" labels: azure-spring assignees: '' --- **Describe the bug** ***Exception or Stack Trace*** **To Reproduce** ***Code Snippet*** **Expected behavior** **Screenshots** **Content (please complete the following information if possible):** **Additional context** **Information Checklist** - [ ] Bug Description Added - [ ] Repro Steps Added - [ ] Setup information Added ================================================ FILE: .github/ISSUE_TEMPLATE/feature_request.md ================================================ --- name: Feature request about: Suggest an idea for this project title: "[FEATURE REQ]" labels: azure-spring assignees: '' --- **Is your feature request related to a problem? Please describe.** **Describe the solution you'd like** **Describe alternatives you've considered** **Additional context** **Information Checklist** - [ ] Description Added - [ ] Expected solution specified ================================================ FILE: .github/ISSUE_TEMPLATE/question-query-template.md ================================================ --- name: Question/Query template about: Use this template to file a question/query title: "[QUERY]" labels: azure-spring assignees: '' --- **Query/Question** ***Why is this not a Bug or a feature Request?*** **Content (please complete the following information if possible):** ================================================ FILE: .github/dependabot.yml ================================================ version: 2 updates: - package-ecosystem: maven directory: "/" schedule: interval: daily open-pull-requests-limit: 10 ================================================ FILE: .github/workflows/broken-link-check.yml ================================================ # This is a basic workflow to help you get started with Actions name: Broken Link Checker # Controls when the workflow will run on: # Triggers the workflow on push or pull request events but only for the main branch push: branches: - main pull_request: branches: - main workflow_dispatch: jobs: check_html_links_job: runs-on: ubuntu-latest name: Check-Links-Action steps: - uses: actions/checkout@v4 name: Checkout Azure/azure-sdk-for-java with: repository: 'Azure/azure-sdk-for-java' path: 'azure-sdk-for-java' ref: main fetch-depth: 0 - name: Set up JDK 17 uses: actions/setup-java@v4.2.2 with: java-version: '17' distribution: 'temurin' cache: maven - name: Build latest azure-sdk-for-java repository run: | cd azure-sdk-for-java mvn clean install \ -Dcheckstyle.skip=true \ -Dcodesnippet.skip \ -Denforcer.skip \ -Djacoco.skip=true \ -Dmaven.javadoc.skip=true \ -Drevapi.skip=true \ -DskipTests \ -Dspotbugs.skip=true \ -Pdev -T 4 -ntp -f sdk/spring/pom.xml - uses: actions/checkout@v4 - name: Build Docs run: | ./mvnw clean install -P docs -pl docs -DskipTests - name: Check link in generated html files id: html-link-report uses: peter-evans/link-checker@v1 with: args: -d --document-root ./docs/target/generated-docs -r -x "https://my.custom.endpoint.com:55300|localhost" - name: Replace bata to main in html-link-report result run: | if [ -d "link-checker/" ] ; then cd link-checker sudo sed -i 's/spring-cloud-azure_*.*.*-beta.[0-9]/main/g' * sudo sed -i 's/```/ /g' * sudo mv out.md ../ fi - name: Remove files generated at build-time. run: | ./mvnw clean - name: Check link in all markdown files uses: gaurav-nelson/github-action-markdown-link-check@1.0.13 with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' config-file: '.github/workflows/markdown-link-check-config.json' ================================================ FILE: .github/workflows/markdown-link-check-config.json ================================================ { "ignorePatterns": [ { "pattern": "^http://localhost" }, { "pattern": "^https://localhost" }, { "pattern": "https://my.custom.endpoint.com:55300" } ], "timeout": "20s", "aliveStatusCodes": [200], "retryOn429": true, "retryCount": 5 } ================================================ FILE: .github/workflows/schedule-current-link-check.yaml ================================================ # This is a basic workflow to help you get started with Actions name: GH Pages Broken Link Checker # Controls when the workflow will run on: # The schedule event allows you to trigger a workflow at a scheduled time. workflow_dispatch: schedule: - cron: '0 0 * * *' jobs: broken_link_checker_job: runs-on: ubuntu-latest name: Check for broken links steps: - name: Check for broken links id: link-report uses: ScholliYT/Broken-Links-Crawler-Action@v3 with: website_url: 'https://microsoft.github.io/spring-cloud-azure/' exclude_url_prefix: 'http://localhost:,http://HOST_NAME:,https://my.custom.endpoint.com:55300' verbose: 'true' ================================================ FILE: .github/workflows/sync-label-from-azsdk-repo.yml ================================================ name: Sync Labels on: workflow_dispatch: jobs: build: runs-on: ubuntu-latest steps: - name: Fetch Labels run: curl https://api.github.com/repos/Azure/azure-sdk-for-java/labels\?per_page\=1000 | jq -c '.[] | select(.name | contains("spring"))' | jq -s >> labels.json - name: Label Sync uses: EndBug/label-sync@v2.1.0 with: config-file: ./labels.json dry-run: false ================================================ FILE: .github/workflows/update-docs.yaml ================================================ name: Update Docs on: push: branches: - main # paths: # - 'docs/**' # release: # types: [published] # includes pre-release and regular releases, but does not include draft releases. # workflow_dispatch: # inputs: # committish: # description: Tag or branch of the docs to be created or updated. Using `main` will update the landing page. Using anything else will create or update a versioned copy of the docs. # required: true # default: main jobs: updateDocs: runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v3 name: Checkout Azure/azure-sdk-for-java with: repository: Azure/azure-sdk-for-java ref: main fetch-depth: 0 - name: Set up JDK 17 uses: actions/setup-java@v4.2.2 with: java-version: '17' distribution: 'temurin' cache: maven - name: Build latest azure-sdk-for-java repository run: | mvn clean install \ -Dcheckstyle.skip=true \ -Dcodesnippet.skip \ -Denforcer.skip \ -Djacoco.skip=true \ -Dmaven.javadoc.skip=true \ -Drevapi.skip=true \ -DskipTests \ -Dspotbugs.skip=true \ -Pdev -T 4 -ntp -f sdk/spring/pom.xml - name: Get current date id: date run: echo "date=$(date +'%Y-%m-%d' --utc)" >> $GITHUB_OUTPUT - uses: actions/checkout@v3 with: token: ${{ secrets.ACCESS_TOKEN }} - run: | git config user.name github-actions git config user.email github-actions@github.com - uses: actions/setup-java@v4.2.2 with: java-version: 17 distribution: 'temurin' - uses: actions/cache@v3 id: mvn-cache with: path: ~/.m2/repository key: ${{ runner.os }}-maven-unified-${{ steps.date.outputs.date }} - name: Maven go offline id: mvn-offline if: steps.mvn-cache.outputs.cache-hit != 'true' run: ./mvnw compile dependency:go-offline - name: Mvn install # Need this when the version/directory/pom structure changes run: | ./mvnw \ --batch-mode \ --show-version \ --threads 1.5C \ --define maven.test.skip=true \ --define maven.javadoc.skip=true \ install - name: Remove SNAPSHOT # Needed for releases run: | if [[ -n "${{ github.event.release.tag_name }}" ]] ; then ./mvnw versions:set --batch-mode -DremoveSnapshot -DprocessAllModules fi - name: Update Docs run: | if [[ -n "${{ github.event.release.tag_name }}" ]] ; then ./docs/src/main/asciidoc/ghpages.sh --version ${{ github.event.release.tag_name }} --destination . --build elif [[ -n "${{ github.event.inputs.committish }}" ]] && [[ "${{ github.event.inputs.committish }}" != "main" ]] ; then ./docs/src/main/asciidoc/ghpages.sh --version ${{ github.event.inputs.committish }} --destination . --build else ./mvnw install -P docs -P '!CI' -pl docs -DskipTests # Simplified PR check fi ================================================ FILE: .github/workflows/update-properties-table-in-ms-docs.yaml ================================================ # This workflow will create PR to update the configuration properties files in MS docs repository: https://github.com/MicrosoftDocs/azure-dev-docs-pr/tree/main/articles/java/spring-framework/includes/spring-cloud-azure # For example, this PR is created by this workflow: https://github.com/MicrosoftDocs/azure-dev-docs-pr/pull/3035 name: Update Properties Table In Microsoft Docs on: push: branches: - main workflow_dispatch: jobs: update_properties_table_in_ms_docs_job: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 name: Checkout Azure/azure-sdk-for-java with: repository: 'Azure/azure-sdk-for-java' path: 'azure-sdk-for-java' ref: main fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis - name: Set up JDK 17 uses: actions/setup-java@v4.2.2 with: java-version: '17' distribution: 'temurin' - name: Build latest azure-sdk-for-java repository run: | cd azure-sdk-for-java mvn clean install \ -Dcheckstyle.skip=true \ -Dcodesnippet.skip \ -Denforcer.skip \ -Djacoco.skip=true \ -Dmaven.javadoc.skip=true \ -Drevapi.skip=true \ -DskipTests \ -Dspotbugs.skip=true \ -T 4 -ntp -Pdev -f sdk/spring/pom.xml - uses: actions/checkout@v3 name: Checkout microsoft/spring-cloud-azure - name: Generate configuration properties files run: | mkdir spring-cloud-azure-markdown-appdendix-generator/src/main/asciidoc # Output files to asciidoc directory configured in parent pom. ./mvnw clean install -P markdown-docs -pl spring-cloud-azure-markdown-appdendix-generator -DskipTests -ntp - name: Get project_version and branch_name id: get_project_version_and_branch_name run: | project_version=$(mvn -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive exec:exec) echo branch_name=spring-cloud-azure_${project_version%-*} >> $GITHUB_OUTPUT echo project_version=${project_version%-*} >> $GITHUB_OUTPUT - uses: actions/checkout@v3 name: Checkout MicrosoftDocs/azure-dev-docs-pr with: repository: MicrosoftDocs/azure-dev-docs-pr ref: 'main' path: 'azure-dev-docs-pr' token: ${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_ACCESS_TOKEN }} fetch-depth: '0' - name: Check whether topic branch exist id: check-whether-topic-branch-exist run: | cd azure-dev-docs-pr git config --global user.email github-actions@github.com git config --global user.name github-actions git remote add ${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_USERNAME }} https://github.com/${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_USERNAME }}/azure-dev-docs-pr.git git fetch ${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_USERNAME }} echo topic_branch_exists=$(git ls-remote --heads ${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_USERNAME }} ${{ steps.get_project_version_and_branch_name.outputs.branch_name }} | wc -l) >> $GITHUB_OUTPUT - name: Commit files changes to topic branch id: commit_files_changes_to_topic_branch run: | cd azure-dev-docs-pr if [[ ${{ steps.check-whether-topic-branch-exist.outputs.topic_branch_exists }} -eq 1 ]] ; then echo "The branch ${{ steps.get_project_version_and_branch_name.outputs.branch_name }} already exists." git checkout ${{ steps.get_project_version_and_branch_name.outputs.branch_name }} elif [[ ${{ steps.check-whether-topic-branch-exist.outputs.topic_branch_exists }} -eq 0 ]] ; then echo "The branch ${{ steps.get_project_version_and_branch_name.outputs.branch_name }} does not exist, create." git checkout -b ${{ steps.get_project_version_and_branch_name.outputs.branch_name }} fi cp -f ../spring-cloud-azure-markdown-appdendix-generator/src/main/asciidoc/configuration-*.md articles/java/spring-framework/includes/spring-cloud-azure if [[ -n "$(git status -s)" ]] ;then echo "added_a_commit_in_topic_branch=true" >> $GITHUB_OUTPUT git add ./articles/java/spring-framework/includes/spring-cloud-azure/configuration-*.md git commit -m "Update the configuration properties for Spring Cloud Azure: ${{ steps.get_project_version_and_branch_name.outputs.project_version }}. This commit is created by GitHub Action: https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}" git push "https://${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_USERNAME }}:${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_ACCESS_TOKEN }}@github.com/${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_USERNAME }}/azure-dev-docs-pr.git" else echo "No file changes, no commits." fi - name: Create Pull Request if: ${{ steps.check-whether-topic-branch-exist.outputs.topic_branch_exists == '0' && steps.commit_files_changes_to_topic_branch.outputs.added_a_commit_in_topic_branch == 'true' }} uses: vsoch/pull-request-action@master env: PULL_REQUEST_TOKEN: ${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_ACCESS_TOKEN }} PULL_REQUEST_REPOSITORY: MicrosoftDocs/azure-dev-docs-pr PULL_REQUEST_TITLE: "Update the configuration properties for Spring Cloud Azure: ${{ steps.get_project_version_and_branch_name.outputs.project_version }}" PULL_REQUEST_FROM_BRANCH: ${{ secrets.UPDATE_PROPERTIES_TABLE_IN_MS_DOCS_GITHUB_USERNAME }}:${{ steps.get_project_version_and_branch_name.outputs.branch_name }} PULL_REQUEST_BRANCH: "main" PULL_REQUEST_BODY: "Update the configuration properties for Spring Cloud Azure: ${{ steps.get_project_version_and_branch_name.outputs.project_version }}. This PR is created by GitHub Actions: https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}" PULL_REQUEST_DRAFT: true ================================================ FILE: .gitignore ================================================ *~ #* *# .#* .classpath .project .settings .springBeans .gradle build bin target/ asciidoctor.css _site/ *.swp .idea *.iml .factorypath .vscode/ .flattened-pom.xml .DS_Store .sdkmanrc ================================================ FILE: .mvn/wrapper/MavenWrapperDownloader.java ================================================ /* * Copyright 2007-present the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import java.net.*; import java.io.*; import java.nio.channels.*; import java.util.Properties; public class MavenWrapperDownloader { private static final String WRAPPER_VERSION = "0.5.6"; /** * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided. */ private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/" + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar"; /** * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to * use instead of the default one. */ private static final String MAVEN_WRAPPER_PROPERTIES_PATH = ".mvn/wrapper/maven-wrapper.properties"; /** * Path where the maven-wrapper.jar will be saved to. */ private static final String MAVEN_WRAPPER_JAR_PATH = ".mvn/wrapper/maven-wrapper.jar"; /** * Name of the property which should be used to override the default download url for the wrapper. */ private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl"; public static void main(String args[]) { System.out.println("- Downloader started"); File baseDirectory = new File(args[0]); System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath()); // If the maven-wrapper.properties exists, read it and check if it contains a custom // wrapperUrl parameter. File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH); String url = DEFAULT_DOWNLOAD_URL; if(mavenWrapperPropertyFile.exists()) { FileInputStream mavenWrapperPropertyFileInputStream = null; try { mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile); Properties mavenWrapperProperties = new Properties(); mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream); url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url); } catch (IOException e) { System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'"); } finally { try { if(mavenWrapperPropertyFileInputStream != null) { mavenWrapperPropertyFileInputStream.close(); } } catch (IOException e) { // Ignore ... } } } System.out.println("- Downloading from: " + url); File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH); if(!outputFile.getParentFile().exists()) { if(!outputFile.getParentFile().mkdirs()) { System.out.println( "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'"); } } System.out.println("- Downloading to: " + outputFile.getAbsolutePath()); try { downloadFileFromURL(url, outputFile); System.out.println("Done"); System.exit(0); } catch (Throwable e) { System.out.println("- Error downloading"); e.printStackTrace(); System.exit(1); } } private static void downloadFileFromURL(String urlString, File destination) throws Exception { if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) { String username = System.getenv("MVNW_USERNAME"); char[] password = System.getenv("MVNW_PASSWORD").toCharArray(); Authenticator.setDefault(new Authenticator() { @Override protected PasswordAuthentication getPasswordAuthentication() { return new PasswordAuthentication(username, password); } }); } URL website = new URL(urlString); ReadableByteChannel rbc; rbc = Channels.newChannel(website.openStream()); FileOutputStream fos = new FileOutputStream(destination); fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE); fos.close(); rbc.close(); } } ================================================ FILE: .mvn/wrapper/maven-wrapper.properties ================================================ distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.3/apache-maven-3.8.3-bin.zip wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar ================================================ FILE: .settings.xml ================================================ repo.spring.io ${env.CI_DEPLOY_USERNAME} ${env.CI_DEPLOY_PASSWORD} spring true spring-snapshots Spring Snapshots https://repo.spring.io/libs-snapshot-local true spring-milestones Spring Milestones https://repo.spring.io/libs-milestone-local false spring-releases Spring Releases https://repo.spring.io/release false maven2-central Maven2 Mirror https://repo1.maven.org/maven2 spring-snapshots Spring Snapshots https://repo.spring.io/libs-snapshot-local true spring-milestones Spring Milestones https://repo.spring.io/libs-milestone-local false io.spring.javaformat ================================================ FILE: .springformat ================================================ ================================================ FILE: .springjavaformatconfig ================================================ java-baseline=8 ================================================ FILE: LICENSE ================================================ MIT License Copyright (c) Microsoft Corporation. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE ================================================ FILE: LICENSE-CODE ================================================ The MIT License (MIT) Copyright (c) Microsoft Corporation Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: LICENSE.txt ================================================ ------------------------------------------- START OF LICENSE ----------------------------------------- Spring Cloud Azure Copyright (c) Microsoft Corporation All rights reserved. MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ----------------------------------------------- END OF LICENSE ------------------------------------------ ================================================ FILE: README.md ================================================ > [!IMPORTANT] > [microsoft/spring-cloud-azure](https://github.com/microsoft/spring-cloud-azure) is deprecated. To get the latest docs of Spring Cloud Azure, please refer to [Documentation in Microsoft docs](https://docs.microsoft.com/azure/developer/java/spring-framework/). For new issues, please report to [Azure SDK for Java repo](https://github.com/Azure/azure-sdk-for-java/). # Spring Cloud Azure [![Update Properties Table In Microsoft Docs](https://github.com/microsoft/spring-cloud-azure/actions/workflows/update-properties-table-in-ms-docs.yaml/badge.svg)](https://github.com/microsoft/spring-cloud-azure/actions/workflows/update-properties-table-in-ms-docs.yaml) [![Broken Link Checker](https://github.com/microsoft/spring-cloud-azure/actions/workflows/broken-link-check.yml/badge.svg)](https://github.com/microsoft/spring-cloud-azure/actions/workflows/broken-link-check.yml) [![GH Pages Broken Link Checker](https://github.com/microsoft/spring-cloud-azure/actions/workflows/schedule-current-link-check.yaml/badge.svg)](https://github.com/microsoft/spring-cloud-azure/actions/workflows/schedule-current-link-check.yaml) [![Update Docs](https://github.com/microsoft/spring-cloud-azure/actions/workflows/update-docs.yaml/badge.svg)](https://github.com/microsoft/spring-cloud-azure/actions/workflows/update-docs.yaml) [![pages-build-deployment](https://github.com/microsoft/spring-cloud-azure/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/microsoft/spring-cloud-azure/actions/workflows/pages/pages-build-deployment) Spring Cloud Azure is an open-source project that provides seamless Spring integration with Azure services. - Documentation: - [Documentation in GitHub pages](https://microsoft.github.io/spring-cloud-azure). - [Documentation in Microsoft docs](https://docs.microsoft.com/azure/developer/java/spring-framework/). - Samples: [Azure-Samples/azure-spring-boot-samples](https://github.com/Azure-Samples/azure-spring-boot-samples). - Source code: [Azure/azure-sdk-for-java/sdk/spring](https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/spring). ================================================ FILE: SECURITY.md ================================================ ## Security Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. ## Reporting Security Issues **Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) * Full paths of source file(s) related to the manifestation of the issue * The location of the affected source code (tag/branch/commit or direct URL) * Any special configuration required to reproduce the issue * Step-by-step instructions to reproduce the issue * Proof-of-concept or exploit code (if possible) * Impact of the issue, including how an attacker might exploit the issue This information will help us triage your report more quickly. If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs. ## Preferred Languages We prefer all communications to be in English. ## Policy Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). ================================================ FILE: azure-spring-cloud-appconfiguration.md ================================================ --- title: Azure Spring Cloud App Configuration description: An in-depth guide on the Azure Spring Cloud App Configuration Library services: azure-app-configuration documentationcenter: '' author: mrm9084 editor: '' ms.service: azure-app-configuration ms.topic: guide ms.date: 09/16/2021 ms.custom: devx-track-java ms.author: mametcal # Customer intent: As a Java Spring developer, know how to setup, authenticate, and select keys using the library. --- # Azure Spring Cloud App Configuration Client Library The Azure Spring Cloud App Configuration Client Library loads configurations and feature flags from the Azure App Configuration service. The client library generates `PropertySource` abstractions, to match those already being generated by the Spring environment such as; Environment Variables, Command-line configurations, local configuration files, and so on. ## Setting up your App Configuration Store To create your Azure App Configuration store, you can use: ```azurecli az appconfig create --resource-group --name --sku Standard ``` This command will create you a new empty configuration store. You can upload you configurations using the import command: ```azurecli az appconfig kv import -n -s file --path --format properties --prefix /application/ ``` It will have you confirm your configurations before loading them. You can upload yaml files by changing the format to yaml. The prefix field is important as it is the default prefix loaded by the client library. ## Client Usage To use the feature in an application, you can build it as a Spring Boot application. The most convenient way to add the dependency is with our Spring Boot starter `com.azure.spring:azure-spring-cloud-starter-appconfiguration-config`. The following example `pom.xml` file uses Azure App Configuration: ```xml org.springframework.boot spring-boot-starter-parent {spring-boot-version} org.springframework.cloud spring-cloud-dependencies {spring-cloud-version} pom import org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-web com.azure.spring azure-spring-cloud-starter-appconfiguration-config {azure-appconfiguration-version} org.springframework.boot spring-boot-maven-plugin ``` A basic Spring Boot application using App Configuration: ```java @SpringBootApplication @RestController public class Application { @RequestMapping("/") public String home() { return "Hello World!"; } public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` with `bootstrap.properties` containing: ```properties spring.cloud.azure.appconfiguration.stores[0].connection-string=${CONFIG_STORE_CONNECTION_STRING} ``` where `CONFIG_STORE_CONNECTION_STRING` is an Environment Variable with the connection string to your Azure App Configuration Store. You can access your connection string by running: ```azurecli az appconfig credential list --name ``` By default, if no configurations are set, then the configurations starting with `/application/` are loaded with a default label of `(No Label)` unless a Spring Profile is set in which case the default label is your Spring Profile. Because the store is empty no configurations are loaded, but the Azure App Configuration Property Source is still generated. A property source named `/application/https://.azconfig.io/` is created containing the properties of that store.The label used in the request is appended to the end of the name, if no label is set the character `\0` is there, as an empty space. ## Loading Configuration The library supports the loading of one or multiple App Configuration stores. This allows for complex configuration scenarios, such as loading of configurations from multiple stores at once or having fallbacks for added resilience. In the situation where a key is duplicated across multiple stores, loading all stores will result in the highest priority, last one wins, stores configuration being loaded. Example: ```properties spring.cloud.azure.appconfiguration.stores[0].connection-string=[first-store-connection-string] spring.cloud.azure.appconfiguration.stores[1].connection-string=[second-store-connection-string] ``` In the example, if both the first and second stores have the same configuration, the configuration in the second store has the highest priority, last one wins. ### Selecting Configurations Configurations are loaded by their key and label. By default, the configurations that start with the key `/application/` are loaded. The default label is `${spring.profiles.active}`. If `${spring.profiles.active}` is not set then configuration with the null label seen as `(No Label)` in the portal are loaded. The configurations that are loaded can be configured by selecting different key and label filters. ```properties spring.cloud.azure.appconfiguration.stores[0].selects[0].key-filter=[my-key] spring.cloud.azure.appconfiguration.stores[0].selects[0].label-filter=[my-label] ``` `key-filter` supports the following filters: | Key Filter | Effect | | -- | -- | |`*`|Matches **any** key| |`abc`|Matches a key named **abc**| |`abc*`|Matches key names that start with **abc**| |`abc,xyz`|Matches key names **abc** or **xyz** (limited to 5 CSV)| `label-filter` supports the following filters: | Label | Description | |---|---| | `*` | Matches **any** label, which includes `\0` | | `\0` | Matches `null` labels, seen as `(No Label)` in the portal | | `1.0.0` | Matches label **1.0.0** exactly | | `1.0.*` | Matches labels that start with **1.0.** | | `,1.0.0` | Matches labels `null` or **1.0.0**, limited to five CSVs | If you are using yaml with label filters and need to start with `null`, then the label filter needs to be surrounded by single quotes. ```yml spring: cloud: azure: appconfiguration: stores: - selects: - label-filter: ',1.0.0' ``` > [!NOTE] > You are unable to combine `*` with `,` in filters. In that case you need to use an additional select. ### Spring Profiles By default, `spring.profiles.active` is set as the default `label-filter` for all selected configurations. This functionality can be overridden by the `label-filter`. The Spring Profiles can be used in the `label-filter` by using `${spring.profiles.active}` in the `label-filter`. ```properties spring.cloud.azure.appconfiguration.stores[0].selects[0].label-filter=,${spring.profiles.active} spring.cloud.azure.appconfiguration.stores[0].selects[1].label-filter=${spring.profiles.active}_local ``` In the first `label-filter`, all configurations with `null` label are loaded, then all configurations matching the Spring Profiles. Spring Profiles have priority over the `null` configurations, because they are at the end. In the second `label-filter`, the string `_local` is appended to the end of the Spring Profiles, though only to the last Spring Profile. ### Disabled Stores Using the configuration `spring.cloud.azure.appconfiguration.enabled` you can disable loading all configuration stores. With the `spring.cloud.azure.appconfiguration.stores[0].enabled` configuration, you can disable an individual store. In addition to disabling all stores, stores can be configured to be disabled if they fail to load using the `spring.cloud.azure.appconfiguration.stores[0].fail-fast`. When `fail-fast` is enabled, set to `true`, a `RuntimeException` that would result in the application not starting up will instead have the store disabled with no configurations from it loaded. If a configuration store is disabled on startup it will not be checked for changes with refresh, or attempted to be loaded from if configurations are updated. If, an error resulting in a `RuntimeException` happens during a refresh check or a reload of configuration the refresh attempt is ended and will be retried after the `refresh-interval` has passed. ## Authentication The client library supports all forms of Identity supported by the [Azure Identity Library](https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.3.6/sdk/identity/azure-identity). Authentication can be done through configuration for Connection Strings and Managed Identity. All other forms of Identity can be done by using the `TokenCredentialProvider`. ### Connection String Authentication through connection string is the simplest form to setup. You can access a stores connection strings using: ```azurecli az appconfig credential list --name ``` The connection string can be then set to the property `spring.cloud.azure.appconfiguration.stores[0].connection-string`. It is highly recommended that the connection string in the local configuration file should be a placeholder value, which should map to an Environment Variable to avoid having it added to source control. ### User Assigned Identity If you already don't have one, you can create a new Managed Identity using: ```azurecli az identity create -g myResourceGroup -n myUserAssignedIdentity ``` Connecting to Azure app configuration with any authentication method other connection string requires three steps to setup. 1. Adding the Identity to the resource connecting to your App Configuration store 1. Adding the required information to your client application. 1. Authorizing the Identity to use App Configuration. For user assigned, the identity needs to be added to the azure resource. How the user assigned identity is added varies between resources so you will need to check the specific docs of that resource. Configuration of the client application just needs two values to be set. ```properties spring.cloud.azure.appconfiguration.managed-identity.client-id= spring.cloud.azure.appconfiguration.stores[0].endpoint= ``` The first property tells us which of the configured User Assigned identities to use. The second is which configuration store we are connecting to. With this method, all configuration stores need to use the same User Assigned Identity. Next, the User Assigned Identity needs to be setup in your configuration store. Setup can be done through IAM in the Azure Portal or using the cli: ```azurecli az role assignment create --role "App Configuration Data Reader" --assignee --scope /subscriptions//resourceGroups//providers/Microsoft.AppConfiguration/configurationStores/ ``` ### System Assigned Identity Setting up System Assigned Identity involves enabling it on the azure resource. How the identity is enabled depends on the resource, so you will need to check the documentation for that resource. Once it is enabled, you need to configure your client application to use it. ```properties spring.cloud.azure.appconfiguration.stores[0].endpoint= ``` You will then need to assign the System Assigned Identity to read configurations. ```azurecli az role assignment create --role "App Configuration Data Reader" --assignee --scope /subscriptions//resourceGroups//providers/Microsoft.AppConfiguration/configurationStores/ ``` ### Token Credential To authenticate with any other method supported by the [Azure Identity Library](https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.3.6/sdk/identity/azure-identity), you can use `AppConfigurationCredentialProvider`. `AppConfigurationCredentialProvider` allows you to dynamically return any `TokenCredential` for any given URI to connect to your Configuration stores. ```java @Bean public AppConfigurationCredentialProvider appConfigurationCredentialProvider() { return new AppConfigurationCredentialProvider() { @Override public TokenCredential getAppConfigCredential(String uri) { ... return myTokenCredential; } }; } ``` You will also need to configure the endpoints that you will be connecting too. ```properties spring.cloud.azure.appconfiguration.stores[0].endpoint= ``` > [!NOTE] > Only 1 authentication method can be defined per endpoint; Connection String, User Assigned Identity, Token Credential. If you need to mix and match you can have `AppConfigurationCredentialProvider` return `null` for stores that use a different method. ## For more information See [Starter Readme](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/spring/spring-cloud-azure-starter-appconfiguration-config) for more details and compete documentation of all settings. ================================================ FILE: docs/.vale-styles/Microsoft/AMPM.yml ================================================ extends: existence message: Use 'AM' or 'PM' (preceded by a space). link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms level: error nonword: true tokens: - '\d{1,2}[AP]M' - '\d{1,2} ?[ap]m' - '\d{1,2} ?[aApP]\.[mM]\.' ================================================ FILE: docs/.vale-styles/Microsoft/Accessibility.yml ================================================ extends: existence message: "Don't use language (such as '%s') that defines people by their disability." link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms level: suggestion ignorecase: true tokens: - a victim of - able-bodied - affected by - an epileptic - crippled - disabled - dumb - handicapped - handicaps - healthy - lame - maimed - missing a limb - mute - normal - sight-impaired - stricken with - suffers from - vision-impaired ================================================ FILE: docs/.vale-styles/Microsoft/Acronyms.yml ================================================ extends: conditional message: "'%s' has no definition." link: https://docs.microsoft.com/en-us/style-guide/acronyms level: suggestion ignorecase: false # Ensures that the existence of 'first' implies the existence of 'second'. first: '\b([A-Z]{3,5})\b' second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' # ... with the exception of these: exceptions: - API - ASP - CLI - CPU - CSS - CSV - DEBUG - DOM - DPI - FAQ - GCC - GDB - GET - GPU - GTK - GUI - HTML - HTTP - HTTPS - IDE - JAR - JSON - JSX - LESS - LLDB - NET - NOTE - NVDA - OSS - PATH - PDF - PHP - POST - RAM - REPL - RSA - SCM - SCSS - SDK - SQL - SSH - SSL - SVG - TBD - TCP - TODO - URI - URL - USB - UTF - XML - XSS - YAML - ZIP - BOM - AMQP - AAD - POSIX - AKS - PEM - CRUD - SAS - JMS ================================================ FILE: docs/.vale-styles/Microsoft/Adverbs.yml ================================================ extends: existence message: "Consider removing '%s'." link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences ignorecase: true level: warning action: name: remove tokens: - abnormally - absentmindedly - accidentally - adventurously - anxiously - arrogantly - awkwardly - bashfully - beautifully - bitterly - bleakly - blindly - blissfully - boastfully - boldly - bravely - briefly - brightly - briskly - broadly - busily - calmly - carefully - carelessly - cautiously - cheerfully - cleverly - closely - coaxingly - colorfully - continually - coolly - courageously - crossly - cruelly - curiously - daintily - dearly - deceivingly - deeply - defiantly - deliberately - delightfully - diligently - dimly - doubtfully - dreamily - easily - elegantly - energetically - enormously - enthusiastically - excitedly - extremely - fairly - faithfully - famously - ferociously - fervently - fiercely - fondly - foolishly - fortunately - frankly - frantically - freely - frenetically - frightfully - furiously - generally - generously - gently - gladly - gleefully - gracefully - gratefully - greatly - greedily - happily - hastily - healthily - heavily - helplessly - honestly - hopelessly - hungrily - innocently - inquisitively - intensely - intently - interestingly - inwardly - irritably - jaggedly - jealously - jovially - joyfully - joyously - jubilantly - judgmentally - justly - keenly - kiddingly - kindheartedly - knavishly - knowingly - knowledgeably - lazily - lightly - limply - lively - loftily - longingly - loosely - loudly - lovingly - loyally - madly - majestically - meaningfully - mechanically - merrily - miserably - mockingly - mortally - mysteriously - naturally - nearly - neatly - nervously - nicely - noisily - obediently - obnoxiously - oddly - offensively - optimistically - overconfidently - painfully - partially - patiently - perfectly - playfully - politely - poorly - positively - potentially - powerfully - promptly - properly - punctually - quaintly - queasily - queerly - questionably - quickly - quietly - quirkily - quizzically - randomly - rapidly - rarely - readily - really - reassuringly - recklessly - regularly - reluctantly - repeatedly - reproachfully - restfully - righteously - rightfully - rigidly - roughly - rudely - safely - scarcely - scarily - searchingly - sedately - seemingly - selfishly - separately - seriously - shakily - sharply - sheepishly - shrilly - shyly - silently - sleepily - slowly - smoothly - softly - solemnly - solidly - speedily - stealthily - sternly - strictly - suddenly - supposedly - surprisingly - suspiciously - sweetly - swiftly - sympathetically - tenderly - tensely - terribly - thankfully - thoroughly - thoughtfully - tightly - tremendously - triumphantly - truthfully - ultimately - unabashedly - unaccountably - unbearably - unethically - unexpectedly - unfortunately - unimpressively - unnaturally - unnecessarily - urgently - usefully - uselessly - utterly - vacantly - vaguely - vainly - valiantly - vastly - verbally - very - viciously - victoriously - violently - vivaciously - voluntarily - warmly - weakly - wearily - wetly - wholly - wildly - willfully - wisely - woefully - wonderfully - worriedly - yawningly - yearningly - yieldingly - youthfully - zealously - zestfully - zestily ================================================ FILE: docs/.vale-styles/Microsoft/Auto.yml ================================================ extends: existence message: "In general, don't hyphenate '%s'." link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto ignorecase: true level: error action: name: convert params: - simple tokens: - 'auto-\w+' ================================================ FILE: docs/.vale-styles/Microsoft/Avoid.yml ================================================ extends: existence message: "Don't use '%s'. See the A-Z word list for details." # See the A-Z word list link: https://docs.microsoft.com/en-us/style-guide ignorecase: true level: error tokens: - abortion - and so on - app(?:lication)?s? (?:developer|program) - app(?:lication)? file - backbone - backend - contiguous selection ================================================ FILE: docs/.vale-styles/Microsoft/ComplexWords.yml ================================================ extends: substitution message: "Consider using '%s' instead of '%s'." link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences ignorecase: true level: suggestion action: name: replace swap: "approximate(?:ly)?": about abundance: plenty accelerate: speed up accentuate: stress accompany: go with accomplish: carry out|do accorded: given accordingly: so accrue: add accurate: right|exact acquiesce: agree acquire: get|buy additional: more|extra address: discuss addressees: you adjacent to: next to adjustment: change admissible: allowed advantageous: helpful advise: tell aggregate: total aircraft: plane alleviate: ease allocate: assign|divide alternatively: or alternatives: choices|options ameliorate: improve amend: change anticipate: expect apparent: clear|plain ascertain: discover|find out assistance: help attain: meet attempt: try authorize: allow belated: late bestow: give cease: stop|end collaborate: work together commence: begin compensate: pay component: part comprise: form|include concept: idea concerning: about confer: give|award consequently: so consolidate: merge constitutes: forms contains: has convene: meet demonstrate: show|prove depart: leave designate: choose desire: want|wish determine: decide|find detrimental: bad|harmful disclose: share|tell discontinue: stop disseminate: send|give eliminate: end elucidate: explain employ: use enclosed: inside|included encounter: meet endeavor: try enumerate: count equitable: fair equivalent: equal exclusively: only expedite: hurry facilitate: ease females: women finalize: complete|finish frequently: often identical: same incorrect: wrong indication: sign initiate: start|begin itemized: listed jeopardize: risk liaise: work with|partner with maintain: keep|support methodology: method modify: change monitor: check|watch multiple: many necessitate: cause notify: tell numerous: many objective: aim|goal obligate: bind|compel optimum: best|most permit: let portion: part possess: own previous: earlier previously: before prioritize: rank procure: buy provide: give|offer purchase: buy relocate: move solicit: request state-of-the-art: latest subsequent: later|next substantial: large sufficient: enough terminate: end transmit: send utilization: use utilize: use ================================================ FILE: docs/.vale-styles/Microsoft/Contractions.yml ================================================ extends: substitution message: "Use '%s' instead of '%s'." link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions level: error ignorecase: true action: name: replace swap: are not: aren't cannot: can't could not: couldn't did not: didn't do not: don't does not: doesn't has not: hasn't have not: haven't how is: how's is not: isn't 'it is(?!\.)': it's 'it''s(?=\.)': it is should not: shouldn't 'that is(?!\.)': that's 'that''s(?=\.)': that is 'they are(?!\.)': they're 'they''re(?=\.)': they are was not: wasn't 'we are(?!\.)': we're 'we''re(?=\.)': we are 'we have(?!\.)': we've 'we''ve(?=\.)': we have were not: weren't 'what is(?!\.)': what's 'what''s(?=\.)': what is 'when is(?!\.)': when's 'when''s(?=\.)': when is 'where is(?!\.)': where's 'where''s(?=\.)': where is will not: won't ================================================ FILE: docs/.vale-styles/Microsoft/Dashes.yml ================================================ extends: existence message: "Remove the spaces around '%s'." link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes ignorecase: true nonword: true level: error action: name: edit params: - remove - ' ' tokens: - '[—–]\s|\s[—–]' ================================================ FILE: docs/.vale-styles/Microsoft/DateFormat.yml ================================================ extends: existence message: Use 'July 31, 2016' format, not '%s'. link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms ignorecase: true level: error nonword: true tokens: - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' ================================================ FILE: docs/.vale-styles/Microsoft/DateNumbers.yml ================================================ extends: existence message: "Don't use ordinal numbers for dates." link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates level: error nonword: true ignorecase: true raw: - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* tokens: - first - second - third - fourth - fifth - sixth - seventh - eighth - ninth - tenth - eleventh - twelfth - thirteenth - fourteenth - fifteenth - sixteenth - seventeenth - eighteenth - nineteenth - twentieth - twenty-first - twenty-second - twenty-third - twenty-fourth - twenty-fifth - twenty-sixth - twenty-seventh - twenty-eighth - twenty-ninth - thirtieth - thirty-first ================================================ FILE: docs/.vale-styles/Microsoft/DateOrder.yml ================================================ extends: existence message: "Always spell out the name of the month." link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates ignorecase: true level: error nonword: true tokens: - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' ================================================ FILE: docs/.vale-styles/Microsoft/Ellipses.yml ================================================ extends: existence message: "In general, don't use an ellipsis." link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses nonword: true level: warning action: name: remove tokens: - '\.\.\.' ================================================ FILE: docs/.vale-styles/Microsoft/FirstPerson.yml ================================================ extends: existence message: "Use first person (such as '%s') sparingly." link: https://docs.microsoft.com/en-us/style-guide/grammar/person ignorecase: true level: warning nonword: true tokens: - (?:^|\s)I\s - (?:^|\s)I,\s - \bI'd\b - \bI'll\b - \bI'm\b - \bI've\b - \bme\b - \bmy\b - \bmine\b ================================================ FILE: docs/.vale-styles/Microsoft/Foreign.yml ================================================ extends: substitution message: "Use '%s' instead of '%s'." link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words ignorecase: true level: error nonword: true action: name: replace swap: '\b(?:eg|e\.g\.)[\s,]': for example '\b(?:ie|i\.e\.)[\s,]': that is ================================================ FILE: docs/.vale-styles/Microsoft/Gender.yml ================================================ extends: existence message: "Don't use '%s'." link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender level: error ignorecase: true tokens: - he/she - s/he ================================================ FILE: docs/.vale-styles/Microsoft/GenderBias.yml ================================================ extends: substitution message: "Consider using '%s' instead of '%s'." ignorecase: true level: error swap: (?:alumna|alumnus): graduate (?:alumnae|alumni): graduates air(?:m[ae]n|wom[ae]n): pilot(s) anchor(?:m[ae]n|wom[ae]n): anchor(s) authoress: author camera(?:m[ae]n|wom[ae]n): camera operator(s) chair(?:m[ae]n|wom[ae]n): chair(s) congress(?:m[ae]n|wom[ae]n): member(s) of congress door(?:m[ae]|wom[ae]n): concierge(s) draft(?:m[ae]n|wom[ae]n): drafter(s) fire(?:m[ae]n|wom[ae]n): firefighter(s) fisher(?:m[ae]n|wom[ae]n): fisher(s) fresh(?:m[ae]n|wom[ae]n): first-year student(s) garbage(?:m[ae]n|wom[ae]n): waste collector(s) lady lawyer: lawyer ladylike: courteous landlord: building manager mail(?:m[ae]n|wom[ae]n): mail carriers man and wife: husband and wife man enough: strong enough mankind: human kind manmade: manufactured manpower: personnel men and girls: men and women middle(?:m[ae]n|wom[ae]n): intermediary news(?:m[ae]n|wom[ae]n): journalist(s) ombuds(?:man|woman): ombuds oneupmanship: upstaging poetess: poet police(?:m[ae]n|wom[ae]n): police officer(s) repair(?:m[ae]n|wom[ae]n): technician(s) sales(?:m[ae]n|wom[ae]n): salesperson or sales people service(?:m[ae]n|wom[ae]n): soldier(s) steward(?:ess)?: flight attendant tribes(?:m[ae]n|wom[ae]n): tribe member(s) waitress: waiter woman doctor: doctor woman scientist[s]?: scientist(s) work(?:m[ae]n|wom[ae]n): worker(s) ================================================ FILE: docs/.vale-styles/Microsoft/GeneralURL.yml ================================================ extends: existence message: "For a general audience, use 'address' rather than 'URL'." link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses level: warning action: name: replace params: - URL - address tokens: - URL ================================================ FILE: docs/.vale-styles/Microsoft/HeadingAcronyms.yml ================================================ extends: existence message: "Avoid using acronyms in a title or heading." link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings level: warning scope: heading tokens: - '[A-Z]{2,4}' exceptions: - SDK - AD - SAS - BOM - JMS - API ================================================ FILE: docs/.vale-styles/Microsoft/HeadingColons.yml ================================================ extends: existence message: "Capitalize '%s'." link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons nonword: true level: error scope: heading tokens: - ':\s[a-z]' ================================================ FILE: docs/.vale-styles/Microsoft/HeadingPunctuation.yml ================================================ extends: existence message: "Don't use end punctuation in headings." link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods nonword: true level: warning scope: heading action: name: edit params: - remove - '.?!' tokens: - '[a-z][.?!](?:\s|$)' ================================================ FILE: docs/.vale-styles/Microsoft/Headings.yml ================================================ extends: capitalization message: "'%s' should use sentence-style capitalization." link: https://docs.microsoft.com/en-us/style-guide/capitalization level: suggestion scope: heading match: $sentence indicators: - ':' exceptions: - Azure - CLI - Code - Cosmos - Docker - Emmet - I - Kubernetes - Linux - macOS - Marketplace - MongoDB - REPL - Studio - TypeScript - URLs - Visual - VS - Windows ================================================ FILE: docs/.vale-styles/Microsoft/Hyphens.yml ================================================ extends: existence message: "'%s' doesn't need a hyphen." link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens level: warning ignorecase: false nonword: true action: name: edit params: - replace - '-' - ' ' tokens: - '\s[^\s-]+ly-' ================================================ FILE: docs/.vale-styles/Microsoft/Negative.yml ================================================ extends: existence message: "Form a negative number with an en dash, not a hyphen." link: https://docs.microsoft.com/en-us/style-guide/numbers nonword: true level: error action: name: edit params: - replace - '-' - '–' tokens: - '\s-\d+\s' ================================================ FILE: docs/.vale-styles/Microsoft/Ordinal.yml ================================================ extends: existence message: "Don't add -ly to an ordinal number." link: https://docs.microsoft.com/en-us/style-guide/numbers level: error action: name: edit params: - trim - ly tokens: - firstly - secondly - thirdly ================================================ FILE: docs/.vale-styles/Microsoft/OxfordComma.yml ================================================ extends: existence message: "Use the Oxford comma in '%s'." link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas scope: sentence level: suggestion nonword: true tokens: - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' ================================================ FILE: docs/.vale-styles/Microsoft/Passive.yml ================================================ extends: existence message: "'%s' looks like passive voice." ignorecase: true level: suggestion raw: - \b(am|are|were|being|is|been|was|be)\b\s* tokens: - '[\w]+ed' - awoken - beat - become - been - begun - bent - beset - bet - bid - bidden - bitten - bled - blown - born - bought - bound - bred - broadcast - broken - brought - built - burnt - burst - cast - caught - chosen - clung - come - cost - crept - cut - dealt - dived - done - drawn - dreamt - driven - drunk - dug - eaten - fallen - fed - felt - fit - fled - flown - flung - forbidden - foregone - forgiven - forgotten - forsaken - fought - found - frozen - given - gone - gotten - ground - grown - heard - held - hidden - hit - hung - hurt - kept - knelt - knit - known - laid - lain - leapt - learnt - led - left - lent - let - lighted - lost - made - meant - met - misspelt - mistaken - mown - overcome - overdone - overtaken - overthrown - paid - pled - proven - put - quit - read - rid - ridden - risen - run - rung - said - sat - sawn - seen - sent - set - sewn - shaken - shaven - shed - shod - shone - shorn - shot - shown - shrunk - shut - slain - slept - slid - slit - slung - smitten - sold - sought - sown - sped - spent - spilt - spit - split - spoken - spread - sprung - spun - stolen - stood - stridden - striven - struck - strung - stuck - stung - stunk - sung - sunk - swept - swollen - sworn - swum - swung - taken - taught - thought - thrived - thrown - thrust - told - torn - trodden - understood - upheld - upset - wed - wept - withheld - withstood - woken - won - worn - wound - woven - written - wrung ================================================ FILE: docs/.vale-styles/Microsoft/Percentages.yml ================================================ extends: existence message: "Use a numeral plus the units." link: https://docs.microsoft.com/en-us/style-guide/numbers nonword: true level: error tokens: - '\b[a-zA-z]+\spercent\b' ================================================ FILE: docs/.vale-styles/Microsoft/Quotes.yml ================================================ extends: existence message: 'Punctuation should be inside the quotes.' link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks level: error nonword: true tokens: - '["“][^"”“]+["”][.,]' ================================================ FILE: docs/.vale-styles/Microsoft/RangeFormat.yml ================================================ extends: existence message: "Use an en dash in a range of numbers." link: https://docs.microsoft.com/en-us/style-guide/numbers nonword: true level: error action: name: edit params: - replace - '-' - '–' tokens: - '\b\d+\s?[-]\s?\d+\b' ================================================ FILE: docs/.vale-styles/Microsoft/RangeTime.yml ================================================ extends: existence message: "Use 'to' instead of a dash in '%s'." link: https://docs.microsoft.com/en-us/style-guide/numbers nonword: true level: error action: name: edit params: - replace - '[-–]' - 'to' tokens: - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' ================================================ FILE: docs/.vale-styles/Microsoft/Ranges.yml ================================================ extends: existence message: "In most cases, use 'from' or 'through' to describe a range of numbers." link: 'https://docs.microsoft.com/en-us/style-guide/numbers' nonword: true level: warning tokens: - '\b\d+\s?[-–]\s?\d+\b' ================================================ FILE: docs/.vale-styles/Microsoft/Semicolon.yml ================================================ extends: existence message: "Try to simplify this sentence." link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons nonword: true scope: sentence level: suggestion tokens: - ';' ================================================ FILE: docs/.vale-styles/Microsoft/SentenceLength.yml ================================================ extends: occurrence message: "Try to keep sentences short (< 30 words)." scope: sentence level: suggestion max: 30 token: \b(\w+)\b ================================================ FILE: docs/.vale-styles/Microsoft/Spacing.yml ================================================ extends: existence message: "'%s' should have one space." link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods level: error nonword: true tokens: - '[a-z][.?!] {2,}[A-Z]' - '[a-z][.?!][A-Z]' exceptions: - ================================================ FILE: docs/.vale-styles/Microsoft/Suspended.yml ================================================ extends: existence message: "Don't use '%s' unless space is limited." link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens ignorecase: true level: warning tokens: - '\w+- and \w+-' ================================================ FILE: docs/.vale-styles/Microsoft/Terms.yml ================================================ extends: substitution message: "Prefer '%s' over '%s'." level: warning ignorecase: true action: name: replace swap: '(?:agent|virtual assistant|intelligent personal assistant)': personal digital assistant '(?:drive C:|drive C>|C: drive)': drive C '(?:internet bot|web robot)s?': bot(s) '(?:microsoft cloud|the cloud)': cloud '(?:mobile|smart) ?phone': phone '24/7': every day 'audio(?:-| )book': audiobook 'back(?:-| )light': backlight 'chat ?bots?': chatbot(s) adaptor: adapter administrate: administer afterwards: afterward alphabetic: alphabetical alphanumerical: alphanumeric anti-aliasing: antialiasing anti-malware: antimalware anti-spyware: antispyware anti-virus: antivirus appendixes: appendices artificial intelligence: artificial intelligence assembler: assembly language bpp: bpp bps: bps caap: CaaP conversation-as-a-platform: conversation as a platform eb: EB gb: GB gbps: Gbps kb: KB keypress: keystroke mb: MB pb: PB tb: TB zb: ZB viz: namely ergo: therefore ================================================ FILE: docs/.vale-styles/Microsoft/URLFormat.yml ================================================ extends: substitution message: "Use '%s' instead of '%s'." ignorecase: true level: error action: name: replace swap: URL for: URL of an URL: a URL ================================================ FILE: docs/.vale-styles/Microsoft/Units.yml ================================================ extends: existence message: "Don't spell out the number in '%s'." link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms level: error raw: - '[a-zA-Z]+\s' tokens: - '(?:centi|milli)?meters' - '(?:kilo)?grams' - '(?:kilo)?meters' - '(?:mega)?pixels' - cm - inches - lb - miles - pounds ================================================ FILE: docs/.vale-styles/Microsoft/Vocab.yml ================================================ extends: existence message: "Verify your use of '%s' with the A-Z word list." link: 'https://docs.microsoft.com/en-us/style-guide' level: suggestion ignorecase: true tokens: - above - accessible - actionable - against - alarm - alert - alias - allows? - and/or - as well as - assure - author - avg - beta - ensure - he - insure - sample - she ================================================ FILE: docs/.vale-styles/Microsoft/We.yml ================================================ extends: existence message: "Try to avoid using first-person plural like '%s'." link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural level: warning ignorecase: true tokens: - we - we'(?:ve|re) - ours? - us - let's ================================================ FILE: docs/.vale-styles/Microsoft/Wordiness.yml ================================================ extends: substitution message: "Consider using '%s' instead of '%s'." link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences ignorecase: true level: warning action: name: replace swap: (?:give|gave) rise to: lead to (?:previous|prior) to: before a (?:large)? majority of: most a (?:large)? number of: many a myriad of: myriad adversely impact: hurt all across: across all of a sudden: suddenly all of these: these all of: all all-time record: record almost all: most almost never: seldom along the lines of: similar to an adequate number of: enough an appreciable number of: many an estimated: about any and all: all are in agreement: agree as a matter of fact: in fact as a means of: to as a result of: because of as of yet: yet as per: per at a later date: later at all times: always at the present time: now at this point in time: at this point based in large part on: based on based on the fact that: because basic necessity: necessity because of the fact that: because came to a realization: realized came to an abrupt end: ended abruptly carry out an evaluation of: evaluate close down: close closed down: closed complete stranger: stranger completely separate: separate concerning the matter of: regarding conduct a review of: review conduct an investigation: investigate conduct experiments: experiment continue on: continue despite the fact that: although disappear from sight: disappear drag and drop: drag drag-and-drop: drag doomed to fail: doomed due to the fact that: because during the period of: during during the time that: while emergency situation: emergency except when: unless excessive number: too many extend an invitation: invite fall down: fall fell down: fell for the duration of: during gather together: gather has the ability to: can has the capacity to: can has the opportunity to: could hold a meeting: meet if this is not the case: if not in a careful manner: carefully in a thoughtful manner: thoughtfully in a timely manner: timely in an effort to: to in between: between in lieu of: instead of in many cases: often in most cases: usually in order to: to in some cases: sometimes in spite of the fact that: although in spite of: despite in the (?:very)? near future: soon in the event that: if in the neighborhood of: roughly in the vicinity of: close to it would appear that: apparently lift up: lift made reference to: referred to make reference to: refer to mix together: mix none at all: none not in a position to: unable not possible: impossible of major importance: important perform an assessment of: assess pertaining to: about place an order: order plays a key role in: is essential to present time: now readily apparent: apparent some of the: some span across: span subsequent to: after successfully complete: complete sufficient number (?:of)?: enough take action: act take into account: consider the question as to whether: whether there is no doubt but that: doubtless this day and age: this age this is a subject that: this subject time (?:frame|period): time under the provisions of: under until such time as: until used for fuel purposes: used for fuel whether or not: whether with regard to: regarding with the exception of: except for ================================================ FILE: docs/.vale-styles/Microsoft/meta.json ================================================ { "feed": "https://github.com/errata-ai/Microsoft/releases.atom", "vale_version": ">=1.0.0" } ================================================ FILE: docs/.vale.ini ================================================ # Core properties #---------------- # Specify where to find styles StylesPath = .vale-styles # Specify the minimum alert level to report # Alerts are assigned a level of suggestion, warning, or error. # For local use it's good to see all the suggestions and warnings. MinAlertLevel = suggestion # Specify how to test a particular type of files #----------------------------------------------- [*.{adoc,md}] # Vale comes with three built-in styles: write-good, proselint, and Joblint. # You could enable all rules in the "Microsoft" style guide as follows: # BasedOnStyles = Microsoft BasedOnStyles = Microsoft Microsoft.Headings = NO ================================================ FILE: docs/README.adoc ================================================ This project is used to manage docs displayed in the https://microsoft.github.io/spring-cloud-azure[GitHub Pages] ================================================ FILE: docs/generate-docs.sh ================================================ #!/bin/bash -x # This command regenerates the docs after editing. # You'll have to run this after editing the src/main/asciidoc/README.adoc mvn clean install -Pdocs ================================================ FILE: docs/pom.xml ================================================ 4.0.0 com.azure.spring spring-cloud-azure-aggregator 4.4.1 ../pom.xml spring-cloud-azure-build-docs spring-cloud-azure-build-docs jar Spring Cloud Azure Build Docs ${basedir}/.. true / spring.jms.servicebus.*|spring.cloud.azure.* none ${project.build.directory}/generated-docs/${project.version}/reference/html ${project.build.directory}/generated-docs/${project.version}/reference/htmlsingle ${project.build.directory}/generated-docs/${project.version}/reference/pdf spring-milestones Spring Milestones https://repo.spring.io/milestone false spring-releases Spring Releases https://repo.spring.io/release false spring-milestones Spring Milestones https://repo.spring.io/milestone false spring-releases Spring Releases https://repo.spring.io/release false com.azure.spring spring-cloud-azure-starter com.azure.spring spring-cloud-azure-starter-stream-eventhubs com.azure.spring spring-cloud-azure-starter-stream-servicebus maven-deploy-plugin true docs pl.project13.maven git-commit-id-plugin org.apache.maven.plugins maven-dependency-plugin org.apache.maven.plugins maven-resources-plugin org.codehaus.mojo exec-maven-plugin org.asciidoctor asciidoctor-maven-plugin org.apache.maven.plugins maven-antrun-plugin maven-deploy-plugin ================================================ FILE: docs/src/main/.gitignore ================================================ META-INF/ org/ ================================================ FILE: docs/src/main/asciidoc/_attributes.adoc ================================================ :doctype: book :idprefix: :idseparator: - :toc: left :toclevels: 4 :tabsize: 4 :numbered: :sectanchors: :sectnums: :icons: font :hide-uri-scheme: :docinfo: shared,private :sc-ext: java :project-full-name: Spring Cloud Azure :all: {asterisk}{asterisk} :azure-sdk-java-issues: https://github.com/Azure/azure-sdk-for-java/issues :spring-boot-version: 2.6.6 // Start for Spring Native Support :graalvm-version: 22.0.0 :graalvm: https://www.graalvm.org/ :graalvm-docs: {graalvm}/reference-manual :graalvm-native-docs: {graalvm-docs}/native-image :graalvm-native-buildtools: https://github.com/graalvm/native-build-tools :spring-native-version: 0.11.4 :spring-cloud-azure-native-configuration: https://github.com/Azure/azure-sdk-for-java/tree/spring-cloud-azure_4.4.1/sdk/spring-experimental/spring-cloud-azure-native-configuration :spring-cloud-azure-native-configuration-version: 4.0.0-beta.1 // End for Spring Native Support ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-all.adoc ================================================ |=== |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 Azure AD 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 | | Azure AD 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-certificate-password | | Password of the certificate file. |spring.cloud.azure.active-directory.credential.client-certificate-path | | Path of a PFX or P12 certificate file to use when performing service principal authentication with Azure. |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. |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.appconfiguration.client.headers[0].name | | The name of the header. |spring.cloud.azure.appconfiguration.client.headers[0].values | | List of values of the header. |spring.cloud.azure.appconfiguration.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.appconfiguration.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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. |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.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 | | List of headers applied to each request sent with client. |spring.cloud.azure.client.http.headers[0].name | | The name of the header. |spring.cloud.azure.client.http.headers[0].values | | List of values of the header. |spring.cloud.azure.client.http.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.client.http.logging.allowed-query-param-names | | Comma-delimited list of allowlist query parameters. |spring.cloud.azure.client.http.logging.level | | The level of detail to log on HTTP messages. |spring.cloud.azure.client.http.logging.pretty-print-body | | Whether to pretty print the message bodies. |spring.cloud.azure.client.http.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. |spring.cloud.azure.client.http.read-timeout | | Amount of time used when reading the server response. |spring.cloud.azure.client.http.response-timeout | | Amount of time used when waiting for a server to reply. |spring.cloud.azure.client.http.write-timeout | | Amount of time each request being sent over the wire. |spring.cloud.azure.compatibility-verifier.compatible-boot-versions | | Comma-delimited list of Spring Boot versions that are compatible with current Spring Cloud Azure's version. |spring.cloud.azure.compatibility-verifier.enabled | `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.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. |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.environment | | The Azure environment, such as global Azure or Azure China. This is a legacy property. |spring.cloud.azure.eventhub.checkpoint-access-key | | Storage account access key. This is a legacy property. |spring.cloud.azure.eventhub.checkpoint-container | | Name of the container. This is a legacy property. |spring.cloud.azure.eventhub.checkpoint-storage-account | | Name for the storage account. This is a legacy property. |spring.cloud.azure.eventhub.connection-string | | Connection string to connect to an event hub. This is a legacy property. |spring.cloud.azure.eventhub.namespace | | The namespace of an event hub. This is a legacy property. |spring.cloud.azure.eventhubs.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.eventhubs.client.transport-type | | Transport type for AMQP-based client. |spring.cloud.azure.eventhubs.connection-string | | Connection string to connect to an event hub. |spring.cloud.azure.eventhubs.consumer.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.eventhubs.consumer.client.transport-type | | Transport type for AMQP-based client. |spring.cloud.azure.eventhubs.consumer.connection-string | | Connection string to connect to an event hub. |spring.cloud.azure.eventhubs.consumer.consumer-group | | Name of the consumer group this consumer is associated with. |spring.cloud.azure.eventhubs.consumer.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.eventhubs.consumer.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.consumer.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.consumer.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.consumer.credential.managed-identity-enabled | `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 <NamespaceName>.<DomainName> |spring.cloud.azure.eventhubs.consumer.prefetch-count | | The number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receiving operation is currently active. |spring.cloud.azure.eventhubs.consumer.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.eventhubs.consumer.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.eventhubs.consumer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.eventhubs.consumer.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.eventhubs.consumer.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.portal | | The management portal URL. |spring.cloud.azure.eventhubs.consumer.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.eventhubs.consumer.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.eventhubs.consumer.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.eventhubs.consumer.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.eventhubs.consumer.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.eventhubs.consumer.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.hostname | | The host of the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.port | | The port of the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.type | | Type of the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.eventhubs.consumer.resource.region | | The region of an Azure resource. |spring.cloud.azure.eventhubs.consumer.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.eventhubs.consumer.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.eventhubs.consumer.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.consumer.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.eventhubs.consumer.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.consumer.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.consumer.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.consumer.retry.mode | | Retry backoff mode. |spring.cloud.azure.eventhubs.consumer.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.eventhubs.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.eventhubs.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.credential.managed-identity-enabled | `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 <NamespaceName>.<DomainName> |spring.cloud.azure.eventhubs.processor.batch.max-size | | The maximum number of events that will be in the batch. |spring.cloud.azure.eventhubs.processor.batch.max-wait-time | | The max time duration to wait to receive an event before processing events. |spring.cloud.azure.eventhubs.processor.checkpoint-store.account-key | | Storage account access key. |spring.cloud.azure.eventhubs.processor.checkpoint-store.account-name | | Name for the storage account. |spring.cloud.azure.eventhubs.processor.checkpoint-store.blob-name | | Name of the blob. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.connection-idle-timeout | | Amount of time before an idle connection. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers | | List of headers applied to each request sent with client. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers[0].name | | The name of the header. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers[0].values | | List of values of the header. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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 <NamespaceName>.<DomainName> |spring.cloud.azure.eventhubs.processor.prefetch-count | | The number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receiving operation is currently active. |spring.cloud.azure.eventhubs.processor.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.eventhubs.processor.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.eventhubs.processor.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.eventhubs.processor.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.eventhubs.processor.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.portal | | The management portal URL. |spring.cloud.azure.eventhubs.processor.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.eventhubs.processor.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.eventhubs.processor.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.eventhubs.processor.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.eventhubs.processor.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.eventhubs.processor.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.eventhubs.processor.proxy.hostname | | The host of the proxy. |spring.cloud.azure.eventhubs.processor.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.eventhubs.processor.proxy.port | | The port of the proxy. |spring.cloud.azure.eventhubs.processor.proxy.type | | Type of the proxy. |spring.cloud.azure.eventhubs.processor.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.eventhubs.processor.resource.region | | The region of an Azure resource. |spring.cloud.azure.eventhubs.processor.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.eventhubs.processor.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.eventhubs.processor.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.processor.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.eventhubs.processor.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.processor.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.processor.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.processor.retry.mode | | Retry backoff mode. |spring.cloud.azure.eventhubs.processor.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.eventhubs.processor.track-last-enqueued-event-properties | | Whether request information on the last enqueued event on its associated partition, and track that information as events are received. |spring.cloud.azure.eventhubs.producer.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.eventhubs.producer.client.transport-type | | Transport type for AMQP-based client. |spring.cloud.azure.eventhubs.producer.connection-string | | Connection string to connect to an event hub. |spring.cloud.azure.eventhubs.producer.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.eventhubs.producer.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.producer.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.producer.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.producer.credential.managed-identity-enabled | `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 <NamespaceName>.<DomainName> |spring.cloud.azure.eventhubs.producer.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.eventhubs.producer.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.eventhubs.producer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.eventhubs.producer.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.eventhubs.producer.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.portal | | The management portal URL. |spring.cloud.azure.eventhubs.producer.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.eventhubs.producer.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.eventhubs.producer.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.eventhubs.producer.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.eventhubs.producer.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.eventhubs.producer.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.eventhubs.producer.proxy.hostname | | The host of the proxy. |spring.cloud.azure.eventhubs.producer.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.eventhubs.producer.proxy.port | | The port of the proxy. |spring.cloud.azure.eventhubs.producer.proxy.type | | Type of the proxy. |spring.cloud.azure.eventhubs.producer.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.eventhubs.producer.resource.region | | The region of an Azure resource. |spring.cloud.azure.eventhubs.producer.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.eventhubs.producer.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.eventhubs.producer.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.producer.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.eventhubs.producer.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.producer.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.producer.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.producer.retry.mode | | Retry backoff mode. |spring.cloud.azure.eventhubs.producer.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.eventhubs.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.eventhubs.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.eventhubs.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.eventhubs.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.eventhubs.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.eventhubs.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.eventhubs.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.eventhubs.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.eventhubs.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.eventhubs.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.eventhubs.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.eventhubs.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.eventhubs.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.eventhubs.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.eventhubs.profile.environment.portal | | The management portal URL. |spring.cloud.azure.eventhubs.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.eventhubs.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.eventhubs.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.eventhubs.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.eventhubs.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.eventhubs.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.eventhubs.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.eventhubs.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.eventhubs.proxy.hostname | | The host of the proxy. |spring.cloud.azure.eventhubs.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.eventhubs.proxy.port | | The port of the proxy. |spring.cloud.azure.eventhubs.proxy.type | | Type of the proxy. |spring.cloud.azure.eventhubs.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.eventhubs.resource.name | | Namespace of the event hub. |spring.cloud.azure.eventhubs.resource.region | | The region of an Azure resource. |spring.cloud.azure.eventhubs.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.eventhubs.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.eventhubs.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.eventhubs.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.retry.mode | | Retry backoff mode. |spring.cloud.azure.eventhubs.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.eventhubs.shared-connection | | Whether to share the same connection for producers or consumers. |spring.cloud.azure.keyvault.certificate.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.keyvault.certificate.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. |spring.cloud.azure.keyvault.certificate.client.connection-idle-timeout | | Amount of time before an idle connection. |spring.cloud.azure.keyvault.certificate.client.headers | | List of headers applied to each request sent with client. |spring.cloud.azure.keyvault.certificate.client.headers[0].name | | The name of the header. |spring.cloud.azure.keyvault.certificate.client.headers[0].values | | List of values of the header. |spring.cloud.azure.keyvault.certificate.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.keyvault.certificate.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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. |spring.cloud.azure.keyvault.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.keyvault.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. |spring.cloud.azure.keyvault.client.connection-idle-timeout | | Amount of time before an idle connection. |spring.cloud.azure.keyvault.client.headers | | List of headers applied to each request sent with client. |spring.cloud.azure.keyvault.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.keyvault.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist query parameters. |spring.cloud.azure.keyvault.client.logging.level | | The level of detail to log on HTTP messages. |spring.cloud.azure.keyvault.client.logging.pretty-print-body | | Whether to pretty print the message bodies. |spring.cloud.azure.keyvault.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. |spring.cloud.azure.keyvault.client.read-timeout | | Amount of time used when reading the server response. |spring.cloud.azure.keyvault.client.response-timeout | | Amount of time used when waiting for a server to reply. |spring.cloud.azure.keyvault.client.write-timeout | | Amount of time each request being sent over the wire. |spring.cloud.azure.keyvault.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.keyvault.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.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.credential.password | | Password to use when performing username/password authentication with Azure. |spring.cloud.azure.keyvault.credential.username | | Username to use when performing username/password authentication with Azure. |spring.cloud.azure.keyvault.enabled | `true` | Whether an Azure Service is enabled. |spring.cloud.azure.keyvault.endpoint | | Azure Key Vault endpoint. |spring.cloud.azure.keyvault.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.keyvault.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.keyvault.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.keyvault.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.keyvault.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.keyvault.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.keyvault.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.keyvault.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.keyvault.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.keyvault.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.keyvault.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.keyvault.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.keyvault.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.keyvault.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.keyvault.profile.environment.portal | | The management portal URL. |spring.cloud.azure.keyvault.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.keyvault.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.keyvault.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.keyvault.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.keyvault.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.keyvault.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.keyvault.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.keyvault.proxy.hostname | | The host of the proxy. |spring.cloud.azure.keyvault.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |spring.cloud.azure.keyvault.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.keyvault.proxy.port | | The port of the proxy. |spring.cloud.azure.keyvault.proxy.type | | Type of the proxy. |spring.cloud.azure.keyvault.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.keyvault.resource.region | | The region of an Azure resource. |spring.cloud.azure.keyvault.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.keyvault.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.keyvault.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.keyvault.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.retry.mode | | Retry backoff mode. |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.keyvault.secret.client.headers[0].name | | The name of the header. |spring.cloud.azure.keyvault.secret.client.headers[0].values | | List of values of the header. |spring.cloud.azure.keyvault.secret.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.keyvault.secret.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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.property-sources[0].case-sensitive | | Defines the constant for the property that enables/disables case-sensitive keys. |spring.cloud.azure.keyvault.secret.property-sources[0].client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.keyvault.secret.property-sources[0].client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. |spring.cloud.azure.keyvault.secret.property-sources[0].client.connection-idle-timeout | | Amount of time before an idle connection. |spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].name | | The name of the header. |spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].values | | List of values of the header. |spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-query-param-names | | Comma-delimited list of allowlist query parameters. |spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.level | | The level of detail to log on HTTP messages. |spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.pretty-print-body | | Whether to pretty print the message bodies. |spring.cloud.azure.keyvault.secret.property-sources[0].client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. |spring.cloud.azure.keyvault.secret.property-sources[0].client.read-timeout | | Amount of time used when reading the server response. |spring.cloud.azure.keyvault.secret.property-sources[0].client.response-timeout | | Amount of time used when waiting for a server to reply. |spring.cloud.azure.keyvault.secret.property-sources[0].client.write-timeout | | Amount of time each request being sent over the wire. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.managed-identity-enabled | `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.property-sources[0].credential.password | | Password to use when performing username/password authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.username | | Username to use when performing username/password authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].enabled | `true` | Whether an Azure Service is enabled. |spring.cloud.azure.keyvault.secret.property-sources[0].endpoint | | Azure Key Vault endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].name | | Name of this property source. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.portal | | The management portal URL. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.hostname | | The host of the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.port | | The port of the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.type | | Type of the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].resource.region | | The region of an Azure resource. |spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.mode | | Retry backoff mode. |spring.cloud.azure.keyvault.secret.property-sources[0].secret-keys | | The secret keys supported for this property source. |spring.cloud.azure.keyvault.secret.property-sources[0].service-version | | Secret service version used when making API requests. |spring.cloud.azure.keyvault.secret.proxy.hostname | | The host of the proxy. |spring.cloud.azure.keyvault.secret.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |spring.cloud.azure.keyvault.secret.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.keyvault.secret.proxy.port | | The port of the proxy. |spring.cloud.azure.keyvault.secret.proxy.type | | Type of the proxy. |spring.cloud.azure.keyvault.secret.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.keyvault.secret.resource.region | | The region of an Azure resource. |spring.cloud.azure.keyvault.secret.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.keyvault.secret.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.keyvault.secret.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.secret.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.keyvault.secret.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.secret.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.secret.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.secret.retry.mode | | Retry backoff mode. |spring.cloud.azure.keyvault.secret.service-version | | Secret service version used when making API requests. |spring.cloud.azure.msi-enabled | `false` | Whether managed identity is enabled. This is a legacy property. |spring.cloud.azure.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.profile.environment.portal | | The management portal URL. |spring.cloud.azure.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.proxy.amqp.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.proxy.hostname | | The host of the proxy. |spring.cloud.azure.proxy.http.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |spring.cloud.azure.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.proxy.port | | The port of the proxy. |spring.cloud.azure.proxy.type | | Type of the proxy. |spring.cloud.azure.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.redis.name | | Name of the Azure Cache for Redis. |spring.cloud.azure.redis.resource.region | | The region of an Azure resource. |spring.cloud.azure.redis.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.redis.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.region | | The region of an Azure resource. This is a legacy property. |spring.cloud.azure.resource-group | | The resource group holds an Azure resource. This is a legacy property. |spring.cloud.azure.retry.amqp.try-timeout | | How long to wait until a timeout. |spring.cloud.azure.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.retry.mode | | Retry backoff mode. |spring.cloud.azure.servicebus.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.servicebus.client.transport-type | | Transport type for AMQP-based client. |spring.cloud.azure.servicebus.connection-string | | Connection string to connect to a service bus. |spring.cloud.azure.servicebus.consumer.auto-complete | `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 <NamespaceName>.<DomainName> |spring.cloud.azure.servicebus.consumer.prefetch-count | | Prefetch count of the consumer. |spring.cloud.azure.servicebus.consumer.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.servicebus.consumer.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.servicebus.consumer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.servicebus.consumer.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.servicebus.consumer.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.portal | | The management portal URL. |spring.cloud.azure.servicebus.consumer.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.servicebus.consumer.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.servicebus.consumer.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.servicebus.consumer.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.servicebus.consumer.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.servicebus.consumer.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.servicebus.consumer.proxy.hostname | | The host of the proxy. |spring.cloud.azure.servicebus.consumer.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.servicebus.consumer.proxy.port | | The port of the proxy. |spring.cloud.azure.servicebus.consumer.proxy.type | | Type of the proxy. |spring.cloud.azure.servicebus.consumer.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.servicebus.consumer.receive-mode | | Mode for receiving messages. |spring.cloud.azure.servicebus.consumer.resource.region | | The region of an Azure resource. |spring.cloud.azure.servicebus.consumer.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.servicebus.consumer.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.servicebus.consumer.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.consumer.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.servicebus.consumer.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.consumer.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.consumer.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.consumer.retry.mode | | Retry backoff mode. |spring.cloud.azure.servicebus.consumer.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.servicebus.consumer.session-enabled | | Whether to enable session for the consumer. |spring.cloud.azure.servicebus.consumer.sub-queue | | Type of the SubQueue to connect to. |spring.cloud.azure.servicebus.consumer.subscription-name | | Name for a topic subscription. |spring.cloud.azure.servicebus.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.servicebus.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.credential.managed-identity-enabled | `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 <NamespaceName>.<DomainName> |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 <NamespaceName>.<DomainName> |spring.cloud.azure.servicebus.processor.prefetch-count | | Prefetch count of the consumer. |spring.cloud.azure.servicebus.processor.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.servicebus.processor.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.servicebus.processor.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.servicebus.processor.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.servicebus.processor.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.servicebus.processor.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.servicebus.processor.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.servicebus.processor.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.portal | | The management portal URL. |spring.cloud.azure.servicebus.processor.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.servicebus.processor.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.servicebus.processor.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.servicebus.processor.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.servicebus.processor.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.servicebus.processor.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.servicebus.processor.proxy.hostname | | The host of the proxy. |spring.cloud.azure.servicebus.processor.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.servicebus.processor.proxy.port | | The port of the proxy. |spring.cloud.azure.servicebus.processor.proxy.type | | Type of the proxy. |spring.cloud.azure.servicebus.processor.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.servicebus.processor.receive-mode | | Mode for receiving messages. |spring.cloud.azure.servicebus.processor.resource.region | | The region of an Azure resource. |spring.cloud.azure.servicebus.processor.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.servicebus.processor.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.servicebus.processor.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.processor.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.servicebus.processor.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.processor.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.processor.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.processor.retry.mode | | Retry backoff mode. |spring.cloud.azure.servicebus.processor.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.servicebus.processor.session-enabled | | Whether to enable session for the consumer. |spring.cloud.azure.servicebus.processor.sub-queue | | Type of the SubQueue to connect to. |spring.cloud.azure.servicebus.processor.subscription-name | | Name for a topic subscription. |spring.cloud.azure.servicebus.producer.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.servicebus.producer.client.transport-type | | Transport type for AMQP-based client. |spring.cloud.azure.servicebus.producer.connection-string | | Connection string to connect to a service bus. |spring.cloud.azure.servicebus.producer.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.servicebus.producer.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.producer.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.producer.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.producer.credential.managed-identity-enabled | `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 <NamespaceName>.<DomainName> |spring.cloud.azure.servicebus.producer.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.servicebus.producer.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.servicebus.producer.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.servicebus.producer.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.servicebus.producer.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.servicebus.producer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.servicebus.producer.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.servicebus.producer.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.portal | | The management portal URL. |spring.cloud.azure.servicebus.producer.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.servicebus.producer.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.servicebus.producer.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.servicebus.producer.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.servicebus.producer.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.servicebus.producer.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.servicebus.producer.proxy.hostname | | The host of the proxy. |spring.cloud.azure.servicebus.producer.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.servicebus.producer.proxy.port | | The port of the proxy. |spring.cloud.azure.servicebus.producer.proxy.type | | Type of the proxy. |spring.cloud.azure.servicebus.producer.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.servicebus.producer.resource.region | | The region of an Azure resource. |spring.cloud.azure.servicebus.producer.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.servicebus.producer.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.servicebus.producer.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.producer.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.servicebus.producer.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.producer.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.producer.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.producer.retry.mode | | Retry backoff mode. |spring.cloud.azure.servicebus.producer.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.servicebus.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.servicebus.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.servicebus.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.servicebus.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.servicebus.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.servicebus.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.servicebus.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.servicebus.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.servicebus.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.servicebus.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.servicebus.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.servicebus.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.servicebus.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.servicebus.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.servicebus.profile.environment.portal | | The management portal URL. |spring.cloud.azure.servicebus.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.servicebus.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.servicebus.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.servicebus.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.servicebus.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.servicebus.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.servicebus.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.servicebus.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.servicebus.proxy.hostname | | The host of the proxy. |spring.cloud.azure.servicebus.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.servicebus.proxy.port | | The port of the proxy. |spring.cloud.azure.servicebus.proxy.type | | Type of the proxy. |spring.cloud.azure.servicebus.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.servicebus.resource.name | | Namespace of the service bus. |spring.cloud.azure.servicebus.resource.region | | The region of an Azure resource. |spring.cloud.azure.servicebus.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.servicebus.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.servicebus.retry-options.delay | | Amount of time to wait between retry attempts. This is a legacy property. |spring.cloud.azure.servicebus.retry-options.max-delay | | Maximum permissible amount of time between retry attempts. This is a legacy property. |spring.cloud.azure.servicebus.retry-options.max-retries | | The maximum number of attempts. This is a legacy property. |spring.cloud.azure.servicebus.retry-options.retry-mode | | The type of approach to apply when calculating the delay between retry attempts. This is a legacy property. |spring.cloud.azure.servicebus.retry-options.try-timeout | | Amount of time to wait until a timeout. This is a legacy property. |spring.cloud.azure.servicebus.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.servicebus.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.retry.mode | | Retry backoff mode. |spring.cloud.azure.servicebus.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.servicebus.transport-type | | Transport type for AMQP-based client. This is a legacy property. |spring.cloud.azure.storage.access-key | | Storage account access key. This is a legacy property. |spring.cloud.azure.storage.account | | Name for the storage account. This is a legacy property. |spring.cloud.azure.storage.account-key | | Storage account access key. |spring.cloud.azure.storage.account-name | | Name for the storage account. |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.storage.blob.client.headers[0].name | | The name of the header. |spring.cloud.azure.storage.blob.client.headers[0].values | | List of values of the header. |spring.cloud.azure.storage.blob.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.storage.blob.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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. |spring.cloud.azure.storage.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.storage.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. |spring.cloud.azure.storage.client.connection-idle-timeout | | Amount of time before an idle connection. |spring.cloud.azure.storage.client.headers | | List of headers applied to each request sent with client. |spring.cloud.azure.storage.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.storage.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist query parameters. |spring.cloud.azure.storage.client.logging.level | | The level of detail to log on HTTP messages. |spring.cloud.azure.storage.client.logging.pretty-print-body | | Whether to pretty print the message bodies. |spring.cloud.azure.storage.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. |spring.cloud.azure.storage.client.read-timeout | | Amount of time used when reading the server response. |spring.cloud.azure.storage.client.response-timeout | | Amount of time used when waiting for a server to reply. |spring.cloud.azure.storage.client.write-timeout | | Amount of time each request being sent over the wire. |spring.cloud.azure.storage.connection-string | | Connection string to connect to the service. |spring.cloud.azure.storage.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.storage.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.storage.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.storage.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.storage.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.credential.password | | Password to use when performing username/password authentication with Azure. |spring.cloud.azure.storage.credential.username | | Username to use when performing username/password authentication with Azure. |spring.cloud.azure.storage.enabled | `true` | Whether an Azure Service is enabled. |spring.cloud.azure.storage.endpoint | | Endpoint for Azure Storage service. |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.storage.fileshare.client.headers[0].name | | The name of the header. |spring.cloud.azure.storage.fileshare.client.headers[0].values | | List of values of the header. |spring.cloud.azure.storage.fileshare.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.storage.fileshare.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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.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. |spring.cloud.azure.storage.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.storage.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.storage.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.storage.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.storage.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.storage.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.storage.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.storage.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.storage.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.storage.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.storage.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.storage.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.storage.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.storage.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.storage.profile.environment.portal | | The management portal URL. |spring.cloud.azure.storage.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.storage.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.storage.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.storage.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.storage.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.storage.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.storage.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.storage.proxy.hostname | | The host of the proxy. |spring.cloud.azure.storage.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |spring.cloud.azure.storage.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.storage.proxy.port | | The port of the proxy. |spring.cloud.azure.storage.proxy.type | | Type of the proxy. |spring.cloud.azure.storage.proxy.username | | Username used to authenticate with the proxy. |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.storage.queue.client.headers[0].name | | The name of the header. |spring.cloud.azure.storage.queue.client.headers[0].values | | List of values of the header. |spring.cloud.azure.storage.queue.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.storage.queue.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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. |spring.cloud.azure.storage.resource-group | | Resource group the storage account belongs to. This is a legacy property. |spring.cloud.azure.storage.resource.region | | The region of an Azure resource. |spring.cloud.azure.storage.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.storage.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.storage.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.storage.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.storage.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.storage.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.storage.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.storage.retry.mode | | Retry backoff mode. |spring.cloud.azure.storage.retry.secondary-host | | Secondary Storage account to retry requests against. |spring.cloud.azure.storage.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.storage.sas-token | | Shared access signatures (SAS) token used to authorize requests sent to the service. |spring.cloud.azure.subscription-id | | Subscription ID to use when connecting to Azure resources. This is a legacy property. |spring.cloud.azure.tenant-id | | Tenant ID for Azure resources. This is a legacy property. |spring.jms.servicebus.connection-string | | Connection string to connect to a Service Bus namespace. |spring.jms.servicebus.enabled | `true` | Whether to enable Servive Bus JMS autoconfiguration. |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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-active-directory-b2c.adoc ================================================ |=== |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 | | Azure AD 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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-active-directory.adoc ================================================ |=== |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 Azure AD 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-certificate-password | | Password of the certificate file. |spring.cloud.azure.active-directory.credential.client-certificate-path | | Path of a PFX or P12 certificate file to use when performing service principal authentication with Azure. |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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-app-configuration.adoc ================================================ |=== |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.appconfiguration.client.headers[0].name | | The name of the header. |spring.cloud.azure.appconfiguration.client.headers[0].values | | List of values of the header. |spring.cloud.azure.appconfiguration.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.appconfiguration.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-cosmos-db.adoc ================================================ |=== |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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-event-hubs.adoc ================================================ |=== |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 <NamespaceName>.<DomainName> |spring.cloud.azure.eventhubs.consumer.prefetch-count | | The number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receiving operation is currently active. |spring.cloud.azure.eventhubs.consumer.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.eventhubs.consumer.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.eventhubs.consumer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.eventhubs.consumer.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.eventhubs.consumer.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.portal | | The management portal URL. |spring.cloud.azure.eventhubs.consumer.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.eventhubs.consumer.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.eventhubs.consumer.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.eventhubs.consumer.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.eventhubs.consumer.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.eventhubs.consumer.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.eventhubs.consumer.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.hostname | | The host of the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.port | | The port of the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.type | | Type of the proxy. |spring.cloud.azure.eventhubs.consumer.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.eventhubs.consumer.resource.region | | The region of an Azure resource. |spring.cloud.azure.eventhubs.consumer.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.eventhubs.consumer.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.eventhubs.consumer.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.consumer.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.eventhubs.consumer.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.consumer.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.consumer.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.consumer.retry.mode | | Retry backoff mode. |spring.cloud.azure.eventhubs.consumer.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.eventhubs.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.eventhubs.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.credential.managed-identity-enabled | `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 <NamespaceName>.<DomainName> |spring.cloud.azure.eventhubs.processor.batch.max-size | | The maximum number of events that will be in the batch. |spring.cloud.azure.eventhubs.processor.batch.max-wait-time | | The max time duration to wait to receive an event before processing events. |spring.cloud.azure.eventhubs.processor.checkpoint-store.account-key | | Storage account access key. |spring.cloud.azure.eventhubs.processor.checkpoint-store.account-name | | Name for the storage account. |spring.cloud.azure.eventhubs.processor.checkpoint-store.blob-name | | Name of the blob. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.connection-idle-timeout | | Amount of time before an idle connection. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers | | List of headers applied to each request sent with client. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers[0].name | | The name of the header. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.headers[0].values | | List of values of the header. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.eventhubs.processor.checkpoint-store.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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 <NamespaceName>.<DomainName> |spring.cloud.azure.eventhubs.processor.prefetch-count | | The number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receiving operation is currently active. |spring.cloud.azure.eventhubs.processor.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.eventhubs.processor.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.eventhubs.processor.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.eventhubs.processor.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.eventhubs.processor.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.portal | | The management portal URL. |spring.cloud.azure.eventhubs.processor.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.eventhubs.processor.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.eventhubs.processor.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.eventhubs.processor.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.eventhubs.processor.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.eventhubs.processor.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.eventhubs.processor.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.eventhubs.processor.proxy.hostname | | The host of the proxy. |spring.cloud.azure.eventhubs.processor.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.eventhubs.processor.proxy.port | | The port of the proxy. |spring.cloud.azure.eventhubs.processor.proxy.type | | Type of the proxy. |spring.cloud.azure.eventhubs.processor.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.eventhubs.processor.resource.region | | The region of an Azure resource. |spring.cloud.azure.eventhubs.processor.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.eventhubs.processor.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.eventhubs.processor.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.processor.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.eventhubs.processor.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.processor.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.processor.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.processor.retry.mode | | Retry backoff mode. |spring.cloud.azure.eventhubs.processor.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.eventhubs.processor.track-last-enqueued-event-properties | | Whether request information on the last enqueued event on its associated partition, and track that information as events are received. |spring.cloud.azure.eventhubs.producer.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.eventhubs.producer.client.transport-type | | Transport type for AMQP-based client. |spring.cloud.azure.eventhubs.producer.connection-string | | Connection string to connect to an event hub. |spring.cloud.azure.eventhubs.producer.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.eventhubs.producer.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.producer.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.producer.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.eventhubs.producer.credential.managed-identity-enabled | `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 <NamespaceName>.<DomainName> |spring.cloud.azure.eventhubs.producer.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.eventhubs.producer.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.eventhubs.producer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.eventhubs.producer.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.eventhubs.producer.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.portal | | The management portal URL. |spring.cloud.azure.eventhubs.producer.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.eventhubs.producer.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.eventhubs.producer.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.eventhubs.producer.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.eventhubs.producer.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.eventhubs.producer.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.eventhubs.producer.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.eventhubs.producer.proxy.hostname | | The host of the proxy. |spring.cloud.azure.eventhubs.producer.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.eventhubs.producer.proxy.port | | The port of the proxy. |spring.cloud.azure.eventhubs.producer.proxy.type | | Type of the proxy. |spring.cloud.azure.eventhubs.producer.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.eventhubs.producer.resource.region | | The region of an Azure resource. |spring.cloud.azure.eventhubs.producer.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.eventhubs.producer.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.eventhubs.producer.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.producer.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.eventhubs.producer.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.producer.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.producer.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.producer.retry.mode | | Retry backoff mode. |spring.cloud.azure.eventhubs.producer.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.eventhubs.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.eventhubs.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.eventhubs.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.eventhubs.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.eventhubs.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.eventhubs.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.eventhubs.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.eventhubs.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.eventhubs.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.eventhubs.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.eventhubs.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.eventhubs.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.eventhubs.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.eventhubs.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.eventhubs.profile.environment.portal | | The management portal URL. |spring.cloud.azure.eventhubs.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.eventhubs.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.eventhubs.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.eventhubs.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.eventhubs.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.eventhubs.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.eventhubs.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.eventhubs.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.eventhubs.proxy.hostname | | The host of the proxy. |spring.cloud.azure.eventhubs.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.eventhubs.proxy.port | | The port of the proxy. |spring.cloud.azure.eventhubs.proxy.type | | Type of the proxy. |spring.cloud.azure.eventhubs.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.eventhubs.resource.name | | Namespace of the event hub. |spring.cloud.azure.eventhubs.resource.region | | The region of an Azure resource. |spring.cloud.azure.eventhubs.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.eventhubs.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.eventhubs.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.eventhubs.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.eventhubs.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.eventhubs.retry.mode | | Retry backoff mode. |spring.cloud.azure.eventhubs.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.eventhubs.shared-connection | | Whether to share the same connection for producers or consumers. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-key-vault-certificates.adoc ================================================ |=== |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.keyvault.certificate.client.headers[0].name | | The name of the header. |spring.cloud.azure.keyvault.certificate.client.headers[0].values | | List of values of the header. |spring.cloud.azure.keyvault.certificate.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.keyvault.certificate.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-key-vault-secrets.adoc ================================================ |=== |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.keyvault.secret.client.headers[0].name | | The name of the header. |spring.cloud.azure.keyvault.secret.client.headers[0].values | | List of values of the header. |spring.cloud.azure.keyvault.secret.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.keyvault.secret.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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.property-sources[0].case-sensitive | | Defines the constant for the property that enables/disables case-sensitive keys. |spring.cloud.azure.keyvault.secret.property-sources[0].client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.keyvault.secret.property-sources[0].client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. |spring.cloud.azure.keyvault.secret.property-sources[0].client.connection-idle-timeout | | Amount of time before an idle connection. |spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].name | | The name of the header. |spring.cloud.azure.keyvault.secret.property-sources[0].client.headers[0].values | | List of values of the header. |spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.allowed-query-param-names | | Comma-delimited list of allowlist query parameters. |spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.level | | The level of detail to log on HTTP messages. |spring.cloud.azure.keyvault.secret.property-sources[0].client.logging.pretty-print-body | | Whether to pretty print the message bodies. |spring.cloud.azure.keyvault.secret.property-sources[0].client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. |spring.cloud.azure.keyvault.secret.property-sources[0].client.read-timeout | | Amount of time used when reading the server response. |spring.cloud.azure.keyvault.secret.property-sources[0].client.response-timeout | | Amount of time used when waiting for a server to reply. |spring.cloud.azure.keyvault.secret.property-sources[0].client.write-timeout | | Amount of time each request being sent over the wire. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.managed-identity-enabled | `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.property-sources[0].credential.password | | Password to use when performing username/password authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].credential.username | | Username to use when performing username/password authentication with Azure. |spring.cloud.azure.keyvault.secret.property-sources[0].enabled | `true` | Whether an Azure Service is enabled. |spring.cloud.azure.keyvault.secret.property-sources[0].endpoint | | Azure Key Vault endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].name | | Name of this property source. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.portal | | The management portal URL. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.keyvault.secret.property-sources[0].profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.hostname | | The host of the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.port | | The port of the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.type | | Type of the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.keyvault.secret.property-sources[0].resource.region | | The region of an Azure resource. |spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.keyvault.secret.property-sources[0].resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.secret.property-sources[0].retry.mode | | Retry backoff mode. |spring.cloud.azure.keyvault.secret.property-sources[0].secret-keys | | The secret keys supported for this property source. |spring.cloud.azure.keyvault.secret.property-sources[0].service-version | | Secret service version used when making API requests. |spring.cloud.azure.keyvault.secret.proxy.hostname | | The host of the proxy. |spring.cloud.azure.keyvault.secret.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |spring.cloud.azure.keyvault.secret.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.keyvault.secret.proxy.port | | The port of the proxy. |spring.cloud.azure.keyvault.secret.proxy.type | | Type of the proxy. |spring.cloud.azure.keyvault.secret.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.keyvault.secret.resource.region | | The region of an Azure resource. |spring.cloud.azure.keyvault.secret.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.keyvault.secret.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.keyvault.secret.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.secret.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.keyvault.secret.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.secret.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.secret.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.secret.retry.mode | | Retry backoff mode. |spring.cloud.azure.keyvault.secret.service-version | | Secret service version used when making API requests. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-key-vault.adoc ================================================ |=== |Name | Default | Description |spring.cloud.azure.keyvault.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.keyvault.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. |spring.cloud.azure.keyvault.client.connection-idle-timeout | | Amount of time before an idle connection. |spring.cloud.azure.keyvault.client.headers | | List of headers applied to each request sent with client. |spring.cloud.azure.keyvault.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.keyvault.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist query parameters. |spring.cloud.azure.keyvault.client.logging.level | | The level of detail to log on HTTP messages. |spring.cloud.azure.keyvault.client.logging.pretty-print-body | | Whether to pretty print the message bodies. |spring.cloud.azure.keyvault.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. |spring.cloud.azure.keyvault.client.read-timeout | | Amount of time used when reading the server response. |spring.cloud.azure.keyvault.client.response-timeout | | Amount of time used when waiting for a server to reply. |spring.cloud.azure.keyvault.client.write-timeout | | Amount of time each request being sent over the wire. |spring.cloud.azure.keyvault.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.keyvault.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.keyvault.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.credential.password | | Password to use when performing username/password authentication with Azure. |spring.cloud.azure.keyvault.credential.username | | Username to use when performing username/password authentication with Azure. |spring.cloud.azure.keyvault.enabled | `true` | Whether an Azure Service is enabled. |spring.cloud.azure.keyvault.endpoint | | Azure Key Vault endpoint. |spring.cloud.azure.keyvault.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.keyvault.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.keyvault.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.keyvault.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.keyvault.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.keyvault.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.keyvault.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.keyvault.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.keyvault.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.keyvault.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.keyvault.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.keyvault.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.keyvault.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.keyvault.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.keyvault.profile.environment.portal | | The management portal URL. |spring.cloud.azure.keyvault.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.keyvault.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.keyvault.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.keyvault.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.keyvault.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.keyvault.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.keyvault.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.keyvault.proxy.hostname | | The host of the proxy. |spring.cloud.azure.keyvault.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |spring.cloud.azure.keyvault.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.keyvault.proxy.port | | The port of the proxy. |spring.cloud.azure.keyvault.proxy.type | | Type of the proxy. |spring.cloud.azure.keyvault.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.keyvault.resource.region | | The region of an Azure resource. |spring.cloud.azure.keyvault.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.keyvault.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.keyvault.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.keyvault.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.keyvault.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.keyvault.retry.mode | | Retry backoff mode. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-service-bus-jms.adoc ================================================ |=== |Name | Default | Description |spring.jms.servicebus.connection-string | | Connection string to connect to a Service Bus namespace. |spring.jms.servicebus.enabled | `true` | Whether to enable Servive Bus JMS autoconfiguration. |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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-service-bus.adoc ================================================ |=== |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 <NamespaceName>.<DomainName> |spring.cloud.azure.servicebus.consumer.prefetch-count | | Prefetch count of the consumer. |spring.cloud.azure.servicebus.consumer.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.servicebus.consumer.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.servicebus.consumer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.servicebus.consumer.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.servicebus.consumer.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.portal | | The management portal URL. |spring.cloud.azure.servicebus.consumer.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.servicebus.consumer.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.servicebus.consumer.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.servicebus.consumer.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.servicebus.consumer.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.servicebus.consumer.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.servicebus.consumer.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.servicebus.consumer.proxy.hostname | | The host of the proxy. |spring.cloud.azure.servicebus.consumer.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.servicebus.consumer.proxy.port | | The port of the proxy. |spring.cloud.azure.servicebus.consumer.proxy.type | | Type of the proxy. |spring.cloud.azure.servicebus.consumer.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.servicebus.consumer.receive-mode | | Mode for receiving messages. |spring.cloud.azure.servicebus.consumer.resource.region | | The region of an Azure resource. |spring.cloud.azure.servicebus.consumer.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.servicebus.consumer.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.servicebus.consumer.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.consumer.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.servicebus.consumer.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.consumer.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.consumer.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.consumer.retry.mode | | Retry backoff mode. |spring.cloud.azure.servicebus.consumer.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.servicebus.consumer.session-enabled | | Whether to enable session for the consumer. |spring.cloud.azure.servicebus.consumer.sub-queue | | Type of the SubQueue to connect to. |spring.cloud.azure.servicebus.consumer.subscription-name | | Name for a topic subscription. |spring.cloud.azure.servicebus.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.servicebus.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.credential.managed-identity-enabled | `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 <NamespaceName>.<DomainName> |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 <NamespaceName>.<DomainName> |spring.cloud.azure.servicebus.processor.prefetch-count | | Prefetch count of the consumer. |spring.cloud.azure.servicebus.processor.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.servicebus.processor.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.servicebus.processor.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.servicebus.processor.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.servicebus.processor.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.servicebus.processor.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.servicebus.processor.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.servicebus.processor.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.portal | | The management portal URL. |spring.cloud.azure.servicebus.processor.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.servicebus.processor.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.servicebus.processor.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.servicebus.processor.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.servicebus.processor.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.servicebus.processor.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.servicebus.processor.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.servicebus.processor.proxy.hostname | | The host of the proxy. |spring.cloud.azure.servicebus.processor.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.servicebus.processor.proxy.port | | The port of the proxy. |spring.cloud.azure.servicebus.processor.proxy.type | | Type of the proxy. |spring.cloud.azure.servicebus.processor.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.servicebus.processor.receive-mode | | Mode for receiving messages. |spring.cloud.azure.servicebus.processor.resource.region | | The region of an Azure resource. |spring.cloud.azure.servicebus.processor.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.servicebus.processor.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.servicebus.processor.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.processor.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.servicebus.processor.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.processor.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.processor.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.processor.retry.mode | | Retry backoff mode. |spring.cloud.azure.servicebus.processor.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.servicebus.processor.session-enabled | | Whether to enable session for the consumer. |spring.cloud.azure.servicebus.processor.sub-queue | | Type of the SubQueue to connect to. |spring.cloud.azure.servicebus.processor.subscription-name | | Name for a topic subscription. |spring.cloud.azure.servicebus.producer.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.servicebus.producer.client.transport-type | | Transport type for AMQP-based client. |spring.cloud.azure.servicebus.producer.connection-string | | Connection string to connect to a service bus. |spring.cloud.azure.servicebus.producer.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.servicebus.producer.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.producer.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.producer.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.servicebus.producer.credential.managed-identity-enabled | `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 <NamespaceName>.<DomainName> |spring.cloud.azure.servicebus.producer.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.servicebus.producer.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.servicebus.producer.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.servicebus.producer.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.servicebus.producer.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.servicebus.producer.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.servicebus.producer.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.servicebus.producer.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.portal | | The management portal URL. |spring.cloud.azure.servicebus.producer.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.servicebus.producer.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.servicebus.producer.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.servicebus.producer.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.servicebus.producer.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.servicebus.producer.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.servicebus.producer.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.servicebus.producer.proxy.hostname | | The host of the proxy. |spring.cloud.azure.servicebus.producer.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.servicebus.producer.proxy.port | | The port of the proxy. |spring.cloud.azure.servicebus.producer.proxy.type | | Type of the proxy. |spring.cloud.azure.servicebus.producer.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.servicebus.producer.resource.region | | The region of an Azure resource. |spring.cloud.azure.servicebus.producer.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.servicebus.producer.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.servicebus.producer.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.producer.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.servicebus.producer.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.producer.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.producer.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.producer.retry.mode | | Retry backoff mode. |spring.cloud.azure.servicebus.producer.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.servicebus.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.servicebus.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.servicebus.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.servicebus.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.servicebus.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.servicebus.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.servicebus.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.servicebus.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.servicebus.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.servicebus.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.servicebus.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.servicebus.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.servicebus.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.servicebus.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.servicebus.profile.environment.portal | | The management portal URL. |spring.cloud.azure.servicebus.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.servicebus.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.servicebus.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.servicebus.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.servicebus.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.servicebus.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.servicebus.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.servicebus.proxy.authentication-type | | Authentication type used against the proxy. |spring.cloud.azure.servicebus.proxy.hostname | | The host of the proxy. |spring.cloud.azure.servicebus.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.servicebus.proxy.port | | The port of the proxy. |spring.cloud.azure.servicebus.proxy.type | | Type of the proxy. |spring.cloud.azure.servicebus.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.servicebus.resource.name | | Namespace of the service bus. |spring.cloud.azure.servicebus.resource.region | | The region of an Azure resource. |spring.cloud.azure.servicebus.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.servicebus.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.servicebus.retry-options.delay | | Amount of time to wait between retry attempts. This is a legacy property. |spring.cloud.azure.servicebus.retry-options.max-delay | | Maximum permissible amount of time between retry attempts. This is a legacy property. |spring.cloud.azure.servicebus.retry-options.max-retries | | The maximum number of attempts. This is a legacy property. |spring.cloud.azure.servicebus.retry-options.retry-mode | | The type of approach to apply when calculating the delay between retry attempts. This is a legacy property. |spring.cloud.azure.servicebus.retry-options.try-timeout | | Amount of time to wait until a timeout. This is a legacy property. |spring.cloud.azure.servicebus.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.servicebus.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.servicebus.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.servicebus.retry.mode | | Retry backoff mode. |spring.cloud.azure.servicebus.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.servicebus.transport-type | | Transport type for AMQP-based client. This is a legacy property. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-storage-blob.adoc ================================================ |=== |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.storage.blob.client.headers[0].name | | The name of the header. |spring.cloud.azure.storage.blob.client.headers[0].values | | List of values of the header. |spring.cloud.azure.storage.blob.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.storage.blob.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-storage-file-share.adoc ================================================ |=== |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.storage.fileshare.client.headers[0].name | | The name of the header. |spring.cloud.azure.storage.fileshare.client.headers[0].values | | List of values of the header. |spring.cloud.azure.storage.fileshare.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.storage.fileshare.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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.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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-storage-queue.adoc ================================================ |=== |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.storage.queue.client.headers[0].name | | The name of the header. |spring.cloud.azure.storage.queue.client.headers[0].values | | List of values of the header. |spring.cloud.azure.storage.queue.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.storage.queue.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-azure-storage.adoc ================================================ |=== |Name | Default | Description |spring.cloud.azure.storage.access-key | | Storage account access key. This is a legacy property. |spring.cloud.azure.storage.account | | Name for the storage account. This is a legacy property. |spring.cloud.azure.storage.account-key | | Storage account access key. |spring.cloud.azure.storage.account-name | | Name for the storage account. |spring.cloud.azure.storage.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. |spring.cloud.azure.storage.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. |spring.cloud.azure.storage.client.connection-idle-timeout | | Amount of time before an idle connection. |spring.cloud.azure.storage.client.headers | | List of headers applied to each request sent with client. |spring.cloud.azure.storage.client.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.storage.client.logging.allowed-query-param-names | | Comma-delimited list of allowlist query parameters. |spring.cloud.azure.storage.client.logging.level | | The level of detail to log on HTTP messages. |spring.cloud.azure.storage.client.logging.pretty-print-body | | Whether to pretty print the message bodies. |spring.cloud.azure.storage.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. |spring.cloud.azure.storage.client.read-timeout | | Amount of time used when reading the server response. |spring.cloud.azure.storage.client.response-timeout | | Amount of time used when waiting for a server to reply. |spring.cloud.azure.storage.client.write-timeout | | Amount of time each request being sent over the wire. |spring.cloud.azure.storage.connection-string | | Connection string to connect to the service. |spring.cloud.azure.storage.credential.client-certificate-password | | Password of the certificate file. |spring.cloud.azure.storage.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. |spring.cloud.azure.storage.credential.client-id | | Client ID to use when performing service principal authentication with Azure. |spring.cloud.azure.storage.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. |spring.cloud.azure.storage.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.credential.password | | Password to use when performing username/password authentication with Azure. |spring.cloud.azure.storage.credential.username | | Username to use when performing username/password authentication with Azure. |spring.cloud.azure.storage.enabled | `true` | Whether an Azure Service is enabled. |spring.cloud.azure.storage.endpoint | | Endpoint for Azure Storage service. |spring.cloud.azure.storage.profile.cloud-type | | Name of the Azure cloud to connect to. |spring.cloud.azure.storage.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. |spring.cloud.azure.storage.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. |spring.cloud.azure.storage.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. |spring.cloud.azure.storage.profile.environment.active-directory-resource-id | | The Azure Active Directory resource ID. |spring.cloud.azure.storage.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. |spring.cloud.azure.storage.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. |spring.cloud.azure.storage.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. |spring.cloud.azure.storage.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. |spring.cloud.azure.storage.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. |spring.cloud.azure.storage.profile.environment.gallery-endpoint | | The gallery endpoint. |spring.cloud.azure.storage.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. |spring.cloud.azure.storage.profile.environment.management-endpoint | | The management service endpoint. |spring.cloud.azure.storage.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. |spring.cloud.azure.storage.profile.environment.portal | | The management portal URL. |spring.cloud.azure.storage.profile.environment.publishing-profile | | The publishing settings file URL. |spring.cloud.azure.storage.profile.environment.resource-manager-endpoint | | The resource management endpoint. |spring.cloud.azure.storage.profile.environment.sql-management-endpoint | | The SQL management endpoint. |spring.cloud.azure.storage.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. |spring.cloud.azure.storage.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. |spring.cloud.azure.storage.profile.subscription-id | | Subscription ID to use when connecting to Azure resources. |spring.cloud.azure.storage.profile.tenant-id | | Tenant ID for Azure resources. |spring.cloud.azure.storage.proxy.hostname | | The host of the proxy. |spring.cloud.azure.storage.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. |spring.cloud.azure.storage.proxy.password | | Password used to authenticate with the proxy. |spring.cloud.azure.storage.proxy.port | | The port of the proxy. |spring.cloud.azure.storage.proxy.type | | Type of the proxy. |spring.cloud.azure.storage.proxy.username | | Username used to authenticate with the proxy. |spring.cloud.azure.storage.resource-group | | Resource group the storage account belongs to. This is a legacy property. |spring.cloud.azure.storage.resource.region | | The region of an Azure resource. |spring.cloud.azure.storage.resource.resource-group | | The resource group holds an Azure resource. |spring.cloud.azure.storage.resource.resource-id | | ID of an Azure resource. |spring.cloud.azure.storage.retry.exponential.base-delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.storage.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. |spring.cloud.azure.storage.retry.exponential.max-retries | | The maximum number of attempts. |spring.cloud.azure.storage.retry.fixed.delay | | Amount of time to wait between retry attempts. |spring.cloud.azure.storage.retry.fixed.max-retries | | The maximum number of attempts. |spring.cloud.azure.storage.retry.mode | | Retry backoff mode. |spring.cloud.azure.storage.retry.secondary-host | | Secondary Storage account to retry requests against. |spring.cloud.azure.storage.retry.try-timeout | | Amount of time to wait until a timeout. |spring.cloud.azure.storage.sas-token | | Shared access signatures (SAS) token used to authorize requests sent to the service. |=== ================================================ FILE: docs/src/main/asciidoc/_configuration-properties-global.adoc ================================================ |=== |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 | | List of headers applied to each request sent with client. |spring.cloud.azure.client.http.headers[0].name | | The name of the header. |spring.cloud.azure.client.http.headers[0].values | | List of values of the header. |spring.cloud.azure.client.http.logging.allowed-header-names | | Comma-delimited list of allowlist headers that should be logged. |spring.cloud.azure.client.http.logging.allowed-query-param-names | | Comma-delimited list of allowlist 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. |=== ================================================ FILE: docs/src/main/asciidoc/_known-issues.adoc ================================================ == Known Issues ================================================ FILE: docs/src/main/asciidoc/_migration-guide-for-4.0.adoc ================================================ [#migration-guide-for-4-0] == Migration Guide for 4.0 [#migration-guide-introduction] === Introduction This guide assists in the migration to *Spring Cloud Azure 4.0* from legacy Azure Spring libraries. This guide will call libraries whose group Id and artifact Id following pattern `com.azure.spring:spring-cloud-azure-\*` the **modern** libraries, and those with pattern `com.azure.spring:azure-spring-boot-*`, `com.azure.spring:azure-spring-cloud-\*` , or `com.azure.spring:azure-spring-integration-*` the *legacy* ones. This guide will focus the side-by-side comparisons for similar configurations between the modern and legacy libraries. Familiarity with `com.azure.spring:azure-spring-boot-\*`, `com.azure.spring:azure-spring-cloud-*` or `com.azure.spring:azure-spring-integration-*` package is assumed. For those new to the Spring Cloud Azure 4.0 libraries, please refer to the link:index.html[Spring Cloud Azure 4.0 Reference Doc] rather than this guide. [#migration-guide-benefits] === Migration Benefits A natural question to ask when considering whether to adopt a new version or library is its benefits. As Azure has matured and been embraced by a more diverse group of developers, we've been focused on learning the patterns and practices to best support developer productivity and to understand the gaps that the Spring Cloud Azure libraries have. There were several areas of consistent feedback expressed across the Spring Cloud Azure libraries. The most important is that the libraries for different Azure services haven't enabled the complete set of configurations. Additionally, the inconsistency of project naming, artifact Ids, versions, configurations made the learning curve steep. To improve the development experience across Spring Cloud Azure libraries, a set of design guidelines was introduced to ensure that Spring Cloud Azure libraries have a natural and idiomatic feel with respect to the Spring ecosystem. Further details are available in the 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: * A unified BOM to include all Spring Cloud Azure 4.0 libraries. * A consistent naming convention for artifacts. * A unified way to configure credential, proxy, retry, cloud environment, and transport layer settings. * Supporting all the authenticating methods an Azure Service or Azure Service SDK supports. === Overview This migration guide will consist following sections: * Naming changes for Spring Cloud Azure 4.0 * Artifact changes: renamed / added / deleted * Dependency changes * Authentication changes * Configuration properties * API breaking changes * Library changes [#migration-guide-naming] === Naming Changes There has never been a consistent or official name to call all the Spring Cloud Azure libraries, some of them were called `Azure Spring Boot` and some of them `Spring on Azure`, and all these names will make developers confused. Since 4.0, we began to use the project name `Spring Cloud Azure` to represent all the Azure Spring libraries. [#migration-guide-bom] === BOM We used to ship two BOMs for Spring Cloud Azure libraries, the `azure-spring-boot-bom` and `azure-spring-cloud-dependencies`, but we combined these two BOMs into one BOM since 4.0, the `spring-cloud-azure-dependencies`. Please add an entry in the dependencyManagement of your project to benefit from the dependency management. [source,xml,subs="attributes,verbatim"] ---- com.azure.spring spring-cloud-azure-dependencies {project-version} pom import ---- The version for spring-cloud-azure-dependencies is {project-version}. === Artifact Changes: Renamed / Added / Deleted Group Ids are the same for modern and legacy Spring Cloud Azure libraries, they're all `com.azure.spring`. Artifact Ids for the modern Spring Cloud Azure libraries have changed. And according to which Spring project it belongs, Spring Boot, Spring Integration or Spring Cloud Stream, the artifact ids pattern could be `spring-cloud-azure-starter-[service]` , `spring-integration-azure-[service]` and `spring-cloud-azure-stream-binder-[service]`. The legacy starters each has an artifact Id following the pattern `azure-spring-*`. This provides a quick and accessible means to help understand, at a glance, whether you are using modern or legacy starters. In the process of developing Spring Cloud Azure 4.0, we renamed some artifacts to make them follow the new naming conventions, deleted some artifacts for its functionality could be put in a more appropriate artifact, and added some new artifacts to better serve some scenarios. .Mapping of legacy artifact Id and modern artifact Id [cols="<,<,<", options="header"] |=== |Legacy Artifact ID |Modern Artifact ID |Description |azure-spring-boot-starter |spring-cloud-azure-starter |Deleted this artifact with merging all functionalities into the new `spring-cloud-azure-starter` artifact. |azure-spring-boot-starter-active-directory |spring-cloud-azure-starter-active-directory | Renamed the artifact. |azure-spring-boot-starter-active-directory-b2c |spring-cloud-azure-starter-active-directory-b2c | Renamed the artifact. |azure-spring-boot-starter-cosmos |spring-cloud-azure-starter-data-cosmos | Renamed the artifact to add `data`, indicating using Spring Data Cosmos DB. |azure-spring-boot-starter-keyvault-certificates |N/A |Not included in this release, but will be supported in later version. |azure-spring-boot-starter-keyvault-secrets |spring-cloud-azure-starter-keyvault-secrets | Renamed the artifact. |azure-spring-boot-starter-servicebus-jms |spring-cloud-azure-starter-servicebus-jms | Renamed the artifact. |azure-spring-boot-starter-storage |spring-cloud-azure-starter-storage-blob + spring-cloud-azure-starter-storage-file-share |Split into two separate artifacts. The legacy artifact contains the functionality of both Storage Blob and File Share, which got split into spring-cloud-azure-starter-storage-blob and spring-cloud-azure-starter-storage-file-share in 4.0. |azure-spring-boot |N/A |Deleted this artifact with merging all functionalities into the new `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 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 <> 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 <> 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. 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. |azure-spring-cloud-stream-binder-eventhubs |spring-cloud-azure-stream-binder-eventhubs |Renamed the artifact. This artifact has been refactored using new design, mainly `spring-cloud-azure-stream-binder-eventhubs` and `spring-cloud-azure-stream-binder-eventhubs-core`. |azure-spring-cloud-stream-binder-service-core |spring-cloud-azure-stream-binder-servicebus-core | Renamed the artifact. |azure-spring-cloud-stream-binder-servicebus-queue |spring-cloud-azure-stream-binder-servicebus |Deleted this artifact with merging all functionalities into the `spring-cloud-azure-stream-binder-servicebus` artifact. |azure-spring-cloud-stream-binder-servicebus-topic |spring-cloud-azure-stream-binder-servicebus |Deleted this artifact with merging all functionalities into the `spring-cloud-azure-stream-binder-servicebus` artifact. |azure-spring-integration-core |spring-integration-azure-core | Renamed the artifact. |azure-spring-integration-eventhubs |spring-integration-azure-eventhubs | Renamed the artifact. |azure-spring-integration-servicebus |spring-integration-azure-servicebus | Renamed the artifact. |azure-spring-integration-storage-queue |spring-integration-azure-storage-queue | Renamed the artifact. |N/A |spring-cloud-azure-actuator |The newly added Spring Cloud Azure Actuator artifact. |N/A |spring-cloud-azure-actuator-autoconfigure |The newly added Spring Cloud Azure Actuator AutoConfigure artifact, including autoconfiguration for actuator. |N/A |spring-cloud-azure-autoconfigure |The newly added Spring Cloud Azure AutoConfigure artifact, including all autoconfiguration for SDK clients, Spring Security support, Spring Data support and Spring Integration support. |N/A |spring-cloud-azure-core | The newly added Spring Cloud Azure Core artifact, including all core functionality. |N/A |spring-cloud-azure-resourcemanager |The newly added Resource Manager artifact. It's the Core library using Azure Resource Manager to read metadata and create resources. |N/A |spring-cloud-azure-service | The newly added Spring Cloud Azure Service artifact, including abstractions for Azure services. |N/A |spring-cloud-azure-starter-appconfiguration | The newly added starter for using Azure App Configuration SDK client. |N/A |spring-cloud-azure-starter-cosmos | The newly added starter for using Azure Cosmos SDK client. |N/A |spring-cloud-azure-starter-eventhubs |The newly added starter for using Azure Event Hubs SDK client. |N/A |spring-cloud-azure-starter-servicebus |The newly added starter for using Azure Service Bus SDK client. |N/A |spring-cloud-azure-starter-storage-blob |The newly added starter for using Azure Storage Blob SDK client. |N/A |spring-cloud-azure-starter-storage-file-share |The newly added starter for using Azure Storage File Share SDK client. |N/A |spring-cloud-azure-starter-storage-queue |The newly added starter for using Azure Storage Queue SDK client. |N/A |spring-cloud-azure-starter-stream-eventhubs |The newly added starter for using Azure Event Hubs Spring Cloud Stream Binder. |N/A |spring-cloud-azure-starter-stream-servicebus |The newly added starter for using Azure Service Bus Spring Cloud Stream Binder |N/A |spring-cloud-azure-stream-binder-eventhubs-core | The newly added Spring Cloud Stream core artifact for Azure Event Hubs. |=== === Dependency Changes Some unnecessary dependencies were included in the legacy artifacts, which we've removed in the modern Spring Cloud Azure 4.0 libraries. Please make sure add the removed dependencies manually to your project to prevent unintentionally crash. Libraries that have dependency changes include: - <> - <> - <> [#migration-guide-authentication] === Authentication Spring Cloud Azure 4.0 supports all the authentication methods each Azure Service SDK supports. It allows configuring a global token credential and providing the token credential at each service level. But credential isn't required to configure in Spring Cloud Azure 4.0, it can leverage the credential stored in a local developing environment, or managed identity in Azure Services, just make sure the principal has been granted sufficient permission to access the target Azure resources. NOTE: When assign roles to the security principals to interact with Azure messaging services, the `Data` related roles are required to conduct messaging operations. For Spring Cloud Azure Stream Event Hubs / Service Bus Binder libraries, `Contributor` role is required when the function of auto creating resources is needed. See link:https://docs.microsoft.com/azure/role-based-access-control/built-in-roles[Azure built-in roles] for more details. A chained credential, the https://docs.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable#defaultazurecredential[DefaultAzureCredential] bean is autoconfigured by default and will be used by all components if no more authentication information is specified. === Configuration Properties [#migration-guide-properties-migration] ==== Properties migration We've created an `additional-spring-configuration-metadata.json` file to smooth the property migration when using with `spring-boot-properties-migrator`. Before doing so, let’s add the property migrator to your application [source,xml] ---- org.springframework.boot spring-boot-properties-migrator runtime ---- Or, if you’re using Gradle: [source,groovy] ---- runtime("org.springframework.boot:spring-boot-properties-migrator") ---- If you run the app, it will identify the properties that are no longer managed by Spring Cloud Azure. If there is a replacement it will temporarily remap the property for you with a warning. If there isn’t a replacement, an error report will give you more information. Either way, the configuration has to be updated and the dependency removed once you have updated the configuration. Before you move on, it's a good idea to use the search feature of your IDE to double-check that you aren't using one of the properties you’ve migrated in an integration test. IMPORTANT: We've changed many configuration properties in this change, with using the `spring-boot-properties-migrator` will help smooth your migration. [#migration-guide-global-configurations] ==== Global Configurations The modern `spring-cloud-azure-starter` allows developers to define properties that apply to all Azure SDKs in the namespace `spring.cloud.azure`. It wasn't supported in the legacy `azure-spring-boot-starter`. The global configurations can be divided into five categories: .Global configurations [cols="<30,<~", options="header"] |=== |Prefix |Description |*spring.cloud.azure*.client |To configure the transport clients underneath each Azure SDK. |*spring.cloud.azure*.credential |To configure how to authenticate with Azure Active Directory. |*spring.cloud.azure*.profile |To configure the Azure cloud environment. |*spring.cloud.azure*.proxy |To configure the proxy options apply to all Azure SDK clients. |*spring.cloud.azure*.retry |To configure the retry options apply to all Azure SDK clients. The retry options have supported part of the SDKs, there's no `spring.cloud.azure.cosmos.retry`. |=== Check link:appendix.html#_global_properties[Global Properties] for a full list of global configurations. ==== Each SDK Configurations For the configuration options in SDK level, please refer to below links for details. - <> - <> - <> - <> - <> - <> - <> - <> - <> - <> - <> - <> === API Breaking Changes For API breaking changes in each libraries, please refer to below links for details. - <> - <> - <> - <> - <> - <> - <> - <> - <> - <> - <> - <> === Library Changes Breaking changes in each library are introduced as follows. ==== From azure-spring-boot-starter to spring-cloud-azure-starter This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter[spring-cloud-azure-starter] from version 3 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-boot-starter[azure-spring-boot-starter]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#dependency-spring-cloud-azure-starter] ===== Dependency Changes Some unnecessary dependencies were included in the legacy artifacts, which we have removed in the modern Spring Cloud Azure 4.0 libraries. Please make sure add the removed dependencies manually to your project to prevent unintentionally crash. .Removed dependencies of spring-cloud-starter [cols="<30,<~", options="header"] |=== |Removed dependencies |Description |org.springframework.boot:spring-boot-starter-validation | Please include the validation starter if you want to use Hibernate Validator. |=== ==== From azure-spring-boot-starter-active-directory to spring-cloud-azure-starter-active-directory This guide is intended to assist the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-active-directory[spring-cloud-azure-starter-active-directory] from version 3 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-boot-starter-active-directory[azure-spring-boot-starter-active-directory]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#dependency-spring-cloud-azure-starter-active-directory] ===== Dependency Changes Some unnecessary dependencies in the legacy artifact have been removed since the modern Spring Cloud Azure 4.0 library. Please add these removed dependencies to your project to prevent unintentional crash. .Removed Dependencies [cols="<30,<~", options="header"] |=== |Removed Dependency |Description |com.fasterxml.jackson.core:jackson-databind |Please add this dependency to your project if needed. |io.projectreactor.netty:reactor-netty |Please add this dependency to your project if needed. |org.springframework.boot:spring-boot-starter-validation |Please add this dependency to your project if needed. |org.springframework.boot:spring-boot-starter-webflux |Please add this dependency to your project if needed. |=== [#configuration-spring-cloud-azure-starter-active-directory] ===== SDK Configuration Changes This section includes the changes about the properties added, removed and changed. .The following two points are the main to pay your attention to: . All configuration property names' prefix is changed from `azure.activedirectory` to `spring.cloud.azure.active-directory`. . New property `spring.cloud.azure.active-directory.enabled` is added to enable/disable AAD related features. The default value is `false`. .Property mapping from azure-spring-boot-starter-active-directory to spring-cloud-azure-starter-active-directory [cols="<30,<~", options="header"] |=== | Legacy properties | Modern properties | *azure.activedirectory*.app-id-uri | *spring.cloud.azure.active-directory*.app-id-uri | *azure.activedirectory*.application-type | *spring.cloud.azure.active-directory*.application-type | *azure.activedirectory*.authorization-clients | *spring.cloud.azure.active-directory*.authorization-clients | *azure.activedirectory*.authorization-clients..authorization-grant-type | *spring.cloud.azure.active-directory*.authorization-clients..authorization-grant-type | *azure.activedirectory*.authorization-clients..on-demand | *spring.cloud.azure.active-directory*.authorization-clients..on-demand | *azure.activedirectory*.authorization-clients..scopes | *spring.cloud.azure.active-directory*.authorization-clients..scopes | *azure.activedirectory*.authenticate-additional-parameters | *spring.cloud.azure.active-directory*.authenticate-additional-parameters | *azure.activedirectory*.base-uri | *spring.cloud.azure.active-directory*.profile.environment.active-directory-endpoint | *azure.activedirectory*.client-id | *spring.cloud.azure.active-directory*.credential.client-id | *azure.activedirectory*.client-secret | *spring.cloud.azure.active-directory*.credential.client-secret | *azure.activedirectory*.graph-membership-uri | *spring.cloud.azure.active-directory*.graph-membership-uri | *azure.activedirectory*.jwt-connect-timeout | *spring.cloud.azure.active-directory*.jwt-connect-timeout | *azure.activedirectory*.jwt-read-timeout | *spring.cloud.azure.active-directory*.jwt-read-timeout | *azure.activedirectory*.jwt-size-limit | *spring.cloud.azure.active-directory*.jwt-size-limit | *azure.activedirectory*.jwk-set-cache-lifespan | *spring.cloud.azure.active-directory*.jwk-set-cache-lifespan | *azure.activedirectory*.jwk-set-cache-refresh-time | *spring.cloud.azure.active-directory*.jwk-set-cache-refresh-time | *azure.activedirectory*.post-logout-redirect-uri | *spring.cloud.azure.active-directory*.post-logout-redirect-uri | *azure.activedirectory*.session-stateless | *spring.cloud.azure.active-directory*.session-stateless | *azure.activedirectory*.redirect-uri-template | *spring.cloud.azure.active-directory*.redirect-uri-template | *azure.activedirectory*.resource-server.claim-to-authority-prefix-map | *spring.cloud.azure.active-directory*.resource-server.claim-to-authority-prefix-map | *azure.activedirectory*.resource-server.principal-claim-name | *spring.cloud.azure.active-directory*.resource-server.principal-claim-name | *azure.activedirectory*.tenant-id | *spring.cloud.azure.active-directory*.profile.tenant-id | *azure.activedirectory*.user-group.allowed-group-ids | *spring.cloud.azure.active-directory*.user-group.allowed-group-ids | *azure.activedirectory*.user-group.allowed-group-names | *spring.cloud.azure.active-directory*.user-group.allowed-group-names | *azure.activedirectory*.user-name-attribute | *spring.cloud.azure.active-directory*.user-name-attribute |=== .The value type of the following properties is changed from `long` to `Duration`: * `jwt-connect-timeout` * `jwt-read-timeout` * `jwk-set-cache-lifespan` * `jwk-set-cache-refresh-time`. .The following properties are removed: * azure.activedirectory.allow-telemetry * azure.activedirectory.user-group.enable-full-list * azure.activedirectory.graph-base-uri * azure.activedirectory.graph-membership-uri .The following properties are added: * spring.cloud.azure.active-directory.enabled * spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint * spring.cloud.azure.active-directory.user-group.use-transitive-members NOTE: The function of `azure.activedirectory.graph-membership-uri` has been replaced by 2 properties: `spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint` and `spring.cloud.azure.active-directory.user-group.use-transitive-members`. The first property is used to specify the host name, and the second a flag for using the url path: `v1.0/me/memberOf` or `v1.0/me/transitiveMemberOf`. Here are some examples of migration: .Case 1 ==== .For legacy: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/memberOf .For modern: spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint=`https://graph.microsoft.com/` + spring.cloud.azure.active-directory.user-group.use-transitive-members=`false` ==== .Case 2 ==== .For legacy: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/transitiveMemberOf .For modern: spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint=`https://graph.microsoft.com/` + spring.cloud.azure.active-directory.user-group.use-transitive-members=`true` ==== [#api-spring-cloud-azure-starter-active-directory] ===== API Changes .Class mapping from azure-spring-boot-starter-active-directory to spring-cloud-azure-starter-active-directory [cols="<~,<~", options="header"] |=== |Legacy class |Modern class |com.azure.spring.aad.webapi.AADJwtBearerTokenAuthenticationConverter |com.azure.spring.cloud.autoconfigure.aad.AadJwtBearerTokenAuthenticationConverter |com.azure.spring.aad.webapi.AADResourceServerProperties |com.azure.spring.cloud.autoconfigure.aad.properties.AadResourceServerProperties |com.azure.spring.aad.webapi.AADResourceServerWebSecurityConfigurerAdapter |com.azure.spring.cloud.autoconfigure.aad.AadResourceServerWebSecurityConfigurerAdapter |com.azure.spring.aad.webapp.AADWebSecurityConfigurerAdapter |com.azure.spring.cloud.autoconfigure.aad.AadWebSecurityConfigurerAdapter |com.azure.spring.aad.webapp.AuthorizationClientProperties |com.azure.spring.cloud.autoconfigure.aad.properties.AuthorizationClientProperties |com.azure.spring.aad.AADApplicationType |com.azure.spring.cloud.autoconfigure.aad.properties.AadApplicationType |com.azure.spring.aad.AADAuthorizationGrantType |com.azure.spring.cloud.autoconfigure.aad.properties.AadAuthorizationGrantType |com.azure.spring.aad.AADAuthorizationServerEndpoints |com.azure.spring.cloud.autoconfigure.aad.properties.AadAuthorizationServerEndpoints |com.azure.spring.aad.AADClientRegistrationRepository |com.azure.spring.cloud.autoconfigure.aad.AadClientRegistrationRepository |com.azure.spring.aad.AADTrustedIssuerRepository |com.azure.spring.cloud.autoconfigure.aad.AadTrustedIssuerRepository |com.azure.spring.autoconfigure.aad.AADAppRoleStatelessAuthenticationFilter |com.azure.spring.cloud.autoconfigure.aad.filter.AadAppRoleStatelessAuthenticationFilter |com.azure.spring.autoconfigure.aad.AADAuthenticationFilter |com.azure.spring.cloud.autoconfigure.aad.filter.AadAuthenticationFilter |com.azure.spring.autoconfigure.aad.AADAuthenticationProperties |com.azure.spring.cloud.autoconfigure.aad.properties.AadAuthenticationProperties |com.azure.spring.autoconfigure.aad.UserPrincipal |com.azure.spring.cloud.autoconfigure.aad.filter.UserPrincipal |com.azure.spring.autoconfigure.aad.UserPrincipalManager |com.azure.spring.cloud.autoconfigure.aad.filter.UserPrincipalManager |=== This section lists the removed classes from azure-spring-boot-starter-active-directory + .Removed legacy class * com.azure.spring.aad.webapp.AADHandleConditionalAccessFilter * com.azure.spring.aad.webapi.validator.AADJwtAudienceValidator * com.azure.spring.aad.webapi.validator.AADJwtClaimValidator ==== From azure-spring-boot-starter-active-directory-b2c to spring-cloud-azure-starter-active-directory-b2c This guide is intended to assist the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-active-directory-b2c[spring-cloud-azure-starter-active-directory-b2c] from version 3 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-boot-starter-active-directory-b2c[azure-spring-boot-starter-active-directory-b2c]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#dependency-spring-cloud-azure-starter-active-directory-b2c] ===== Dependency Changes Some unnecessary dependencies in the legacy artifact have been removed since the modern Spring Cloud Azure 4.0 library. Please add these removed dependencies to your project to prevent unintentional crash. .Removed Dependencies [cols="<30,<~", options="header"] |=== |Removed Dependency |Description |org.springframework.boot:spring-boot-starter-validation |Please include the validation starter if you want to use Hibernate Validator. |=== [#configuration-spring-cloud-azure-starter-active-directory-b2c] ===== SDK Configuration Changes This section includes the changes about the properties added, removed and changed. .The following two points are the main to pay your attention to: . All configuration property names' prefix is changed from `azure.activedirectory.b2c` to `spring.cloud.azure.active-directory.b2c`. . New property `spring.cloud.azure.active-directory.b2c.enabled` is added to enable/disable AAD B2C related features. The default value is false. .Property mapping from azure-spring-boot-starter-active-directory-b2c to spring-cloud-azure-starter-active-directory-b2c [cols="<30,<~", options="header"] |=== | Legacy properties | Modern properties | *azure.activedirectory.b2c*.authenticate-additional-parameters | *spring.cloud.azure.active-directory.b2c*.authenticate-additional-parameters | *azure.activedirectory.b2c*.authorization-clients | *spring.cloud.azure.active-directory.b2c*.authorization-clients | *azure.activedirectory.b2c*.authorization-clients..authorization-grant-type | *spring.cloud.azure.active-directory.b2c*.authorization-clients..authorization-grant-type | *azure.activedirectory.b2c*.authorization-clients..scopes | *spring.cloud.azure.active-directory.b2c*.authorization-clients..scopes | *azure.activedirectory.b2c*.app-id-uri | *spring.cloud.azure.active-directory.b2c*.app-id-uri | *azure.activedirectory.b2c*.base-uri | *spring.cloud.azure.active-directory.b2c*.base-uri | *azure.activedirectory.b2c*.client-id | *spring.cloud.azure.active-directory.b2c*.credential.client-id | *azure.activedirectory.b2c*.client-secret | *spring.cloud.azure.active-directory.b2c*.credential.client-secret | *azure.activedirectory.b2c*.jwt-connect-timeout | *spring.cloud.azure.active-directory.b2c*.jwt-connect-timeout | *azure.activedirectory.b2c*.jwt-read-timeout | *spring.cloud.azure.active-directory.b2c*.jwt-read-timeout | *azure.activedirectory.b2c*.jwt-size-limit | *spring.cloud.azure.active-directory.b2c*.jwt-size-limit | *azure.activedirectory.b2c*.login-flow | *spring.cloud.azure.active-directory.b2c*.login-flow | *azure.activedirectory.b2c*.logout-success-url | *spring.cloud.azure.active-directory.b2c*.logout-success-url | *azure.activedirectory.b2c*.reply-url | *spring.cloud.azure.active-directory.b2c*.reply-url | *azure.activedirectory.b2c*.tenant-id | *spring.cloud.azure.active-directory.b2c*.profile.tenant-id | *azure.activedirectory.b2c*.user-flows | *spring.cloud.azure.active-directory.b2c*.user-flows | *azure.activedirectory.b2c*.user-name-attribute-name | *spring.cloud.azure.active-directory.b2c*.user-name-attribute-name |=== .Removed properties from azure-spring-boot-starter-active-directory-b2c: * azure.activedirectory.b2c.allow-telemetry * azure.activedirectory.b2c.tenant .The value type of the following properties is changed from `long` to `Duration`: * `jwt-connect-timeout` * `jwt-read-timeout` [#api-spring-cloud-azure-starter-active-directory-b2c] ===== API Changes .Class mapping from azure-spring-boot-starter-active-directory-b2c to spring-cloud-azure-starter-active-directory-b2c [cols="<~,<~", options="header"] |=== |Legacy class |Modern class |com.azure.spring.autoconfigure.b2c.AADB2CAuthorizationRequestResolver |com.azure.spring.cloud.autoconfigure.aadb2c.AadB2cAuthorizationRequestResolver |com.azure.spring.autoconfigure.b2c.AADB2CJwtBearerTokenAuthenticationConverter |com.azure.spring.cloud.autoconfigure.aad.AadJwtBearerTokenAuthenticationConverter |com.azure.spring.autoconfigure.b2c.AADB2CLogoutSuccessHandler |com.azure.spring.cloud.autoconfigure.aadb2c.AadB2cLogoutSuccessHandler |com.azure.spring.autoconfigure.b2c.AADB2COidcLoginConfigurer |com.azure.spring.cloud.autoconfigure.aadb2c.AadB2cOidcLoginConfigurer |com.azure.spring.autoconfigure.b2c.AADB2CProperties |com.azure.spring.cloud.autoconfigure.aadb2c.properties.AadB2cProperties |com.azure.spring.autoconfigure.b2c.AADB2CTrustedIssuerRepository |com.azure.spring.cloud.autoconfigure.aadb2c.AadB2cTrustedIssuerRepository |com.azure.spring.autoconfigure.b2c.AuthorizationClientProperties |com.azure.spring.cloud.autoconfigure.aadb2c.properties.AuthorizationClientProperties |=== ==== From azure-spring-boot-starter-cosmos to spring-cloud-azure-starter-data-cosmos This guide is intended to assist the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-data-cosmos[spring-cloud-azure-starter-data-cosmos] from version 3 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-boot-starter-cosmos[azure-spring-boot-starter-cosmos]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes.Please refer to the <> section for the global and common configuration changes. [#configuration-spring-cloud-azure-starter-data-cosmos] ===== SDK Configuration Changes All configuration property names' prefix is changed from `azure.cosmos` to `spring.cloud.azure.cosmos`. .Property mapping from azure-spring-boot-starter-cosmos to spring-cloud-azure-starter-data-cosmos [cols="<30,<~", options="header"] |=== |Legacy properties |Morden properties |*azure.cosmos*.connection-mode |*spring.cloud.azure.cosmos*.connection-mode |*azure.cosmos*.consistency-level |*spring.cloud.azure.cosmos*.consistency-level |*azure.cosmos*.database |*spring.cloud.azure.cosmos*.database |*azure.cosmos*.key |*spring.cloud.azure.cosmos*.key |*azure.cosmos*.populate-query-metrics |*spring.cloud.azure.cosmos*.populate-query-metrics |*azure.cosmos*.uri |*spring.cloud.azure.cosmos*.endpoint |=== ==== From azure-spring-boot-starter-keyvault-secrets to spring-cloud-azure-starter-keyvault-secrets This guide is intended to assist the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-keyvault-secrets[spring-cloud-azure-starter-keyvault-secrets] from version 3 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-boot-starter-keyvault-secrets[azure-spring-boot-starter-keyvault-secrets]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#configuration-spring-cloud-azure-starter-keyvault-secrets] ===== SDK Configuration Changes This section includes the changes about the properties added, removed and changed. .Property mapping from azure-spring-boot-starter-keyvault-secrets to spring-cloud-azure-starter-keyvault-secrets [cols="<30,<~", options="header"] |=== | Legacy properties | Modern properties | *azure.keyvault*.case-sensitive-keys | *spring.cloud.azure.keyvault.secret*.property-sources[n].case-sensitive | *azure.keyvault*.certificate-password | *spring.cloud.azure.keyvault.secret*.property-sources[n].credential.client-certificate-password | *azure.keyvault*.certificate-path | *spring.cloud.azure.keyvault.secret*.property-sources[n].credential.client-certificate-path | *azure.keyvault*.client-id | *spring.cloud.azure.keyvault.secret*.property-sources[n].credential.client-id | *azure.keyvault*.client-key | *spring.cloud.azure.keyvault.secret*.property-sources[n].credential.client-secret | *azure.keyvault*.enabled | *spring.cloud.azure.keyvault.secret*.enabled and *spring.cloud.azure.keyvault.secret*.property-source-enabled | *azure.keyvault*.refresh-interval | *spring.cloud.azure.keyvault.secret*.property-sources[n].refresh-interval | *azure.keyvault*.secret-keys | *spring.cloud.azure.keyvault.secret*.property-sources[n].secret-keys | *azure.keyvault*.tenant-id | *spring.cloud.azure.keyvault.secret*.property-sources[n].profile.tenant-id | *azure.keyvault*.uri | *spring.cloud.azure.keyvault.secret*.property-sources[n].endpoint |=== .Removed properties from spring-cloud-azure-starter-keyvault-secrets * azure.keyvault.allow-telemetry * azure.keyvault.order .The following points you should pay your attention to: . All configuration property names changed the prefix from `azure.keyvault` to `spring.cloud.azure.keyvault.secret`. . `spring.cloud.azure.keyvault.secret.enabled` is used to enable the feature of configuring Key Vault secret client beans(like SecretClient and SecretAsyncClient). . `spring.cloud.azure.keyvault.secret.property-source-enabled` is used to enable all `KeyVaultPropertySource`. . For Azure common properties(like `client`, `proxy`, `retry`, `credential`, `profile`) and Key Vault properties(like `endpoint`, `service-version`). If `spring.cloud.azure.keyvault.secret.property-sources[n].PROPERTY_NAME` isn't configured, `spring.cloud.azure.keyvault.secret.PROPERTY_NAME` will be used. . `spring.cloud.azure.keyvault.secret.property-sources[n].resource` is specific to a unique Azure resource, so if it's not configured, it won't get value from other places. ==== From azure-spring-boot-starter-servicebus-jms to spring-cloud-azure-starter-servicebus-jms This guide is intended to assist the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-servicebus-jms[spring-cloud-azure-starter-servicebus-jms] from 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 <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#configuration-spring-cloud-azure-starter-servicebus-jms] ===== SDK Configuration Changes The value type for `spring.jms.servicebus.idle-timeout` is changed from `long`(milliseconds) to `Duration` for ease of readability. ==== From azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-blob This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-storage-blob[spring-cloud-azure-starter-storage-blob] from version 3 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-boot-starter-storage[azure-spring-boot-starter-storage]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#configuration-spring-cloud-azure-starter-storage-blob] ===== SDK Configuration Changes All configuration property names changed the prefix from `azure.storage` to `spring.cloud.azure.storage.blob`. .Property mapping from azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-blob [cols="<30,<~", options="header"] |=== |Legacy properties |Modern properties |*azure.storage*.account-name |*spring.cloud.azure.storage.blob*.account-name |*azure.storage*.account-key |*spring.cloud.azure.storage.blob*.account-key |*azure.storage*.blob-endpoint |*spring.cloud.azure.storage.blob*.endpoint |=== [#api-spring-cloud-azure-starter-storage-blob] ===== API Changes .Class mapping from azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-blob [cols="<~,<~", options="header"] |=== |Legacy class |Modern class |com.azure.spring.autoconfigure.storage.resource.AzureStorageProtocolResolver |com.azure.spring.cloud.core.resource.AzureStorageBlobProtocolResolver |com.azure.spring.autoconfigure.storage.resource.AzureStorageResourcePatternResolver|com.azure.spring.cloud.core.resource.AzureStorageBlobProtocolResolver |com.azure.spring.autoconfigure.storage.resource.BlobStorageResource|com.azure.spring.cloud.core.resource.StorageBlobResource |=== ==== From azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-file-share This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-storage-file-share[spring-cloud-azure-starter-storage-file-share] from version 3 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-boot-starter-storage[azure-spring-boot-starter-storage]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#configuration-spring-cloud-azure-starter-storage-file-share] ===== SDK Configuration Changes All configuration property names changed the prefix from `azure.storage` to `spring.cloud.azure.storage.fileshare`. .Property mapping from azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-file-share [cols="<30,<~", options="header"] |=== |Legacy properties |Modern properties |*azure.storage*.account-name |*spring.cloud.azure.storage.fileshare*.account-name |*azure.storage*.account-key |*spring.cloud.azure.storage.fileshare*.account-key |*azure.storage*.file-endpoint |*spring.cloud.azure.storage.fileshare*.endpoint |=== [#api-spring-cloud-azure-starter-storage-file-share] ===== API Changes .Class mapping from azure-spring-boot-starter-storage to spring-cloud-azure-starter-storage-file-share [cols="<~,<~", options="header"] |=== |Legacy class |Modern class |com.azure.spring.autoconfigure.storage.resource.AzureStorageProtocolResolver |com.azure.spring.cloud.core.resource.AzureStorageFileProtocolResolver |com.azure.spring.autoconfigure.storage.resource.AzureStorageResourcePatternResolver|com.azure.spring.cloud.core.resource.AzureStorageFileProtocolResolver |com.azure.spring.autoconfigure.storage.resource.FileStorageResource|com.azure.spring.cloud.core.resource.StorageFileResource |=== ==== From azure-spring-cloud-starter-eventhubs to spring-cloud-azure-starter-integration-eventhubs This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-integration-eventhubs[spring-cloud-azure-starter-integration-eventhubs] from version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-cloud-starter-eventhubs[azure-spring-cloud-starter-eventhubs]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#configuration-spring-cloud-azure-starter-integration-eventhubs] ===== SDK Configuration Changes IMPORTANT: Configuration prefix has been changed from `spring.cloud.azure.eventhub` to `spring.cloud.azure.eventhubs.` Changes for the child entries for this prefix, please refer the following tables: .Property mapping from azure-spring-cloud-starter-eventhubs to spring-cloud-azure-starter-integration-eventhubs [cols="<30,<~", options="header"] |=== |Legacy properties | Modern properties |*spring.cloud.azure*.resource-group|*spring.cloud.azure.eventhubs*.resource.resource-group |*spring.cloud.azure.eventhub*.namespace|*spring.cloud.azure.eventhubs*.namespace |*spring.cloud.azure.eventhub*.connection-string|*spring.cloud.azure.eventhubs*.connection-string |*spring.cloud.azure.eventhub*.checkpoint-storage-account|*spring.cloud.azure.eventhubs.processor*.checkpoint-store.account-name |*spring.cloud.azure.eventhub*.checkpoint-access-key|*spring.cloud.azure.eventhubs.processor*.checkpoint-store.account-key |*spring.cloud.azure.eventhub*.checkpoint-container|*spring.cloud.azure.eventhubs.processor*.checkpoint-store.container-name |=== For example, change from: [source,yaml] ---- spring: cloud: azure: eventhub: connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING} checkpoint-storage-account: ${AZURE_CHECKPOINT_STORAGE_ACCOUNT_NAME} checkpoint-access-key: ${AZURE_CHECKPOINT_ACCOUNT_KEY} checkpoint-container: ${AZURE_CHECKPOINT_CONTAINER_NAME} ---- to: [source,yaml] ---- spring: cloud: azure: eventhubs: connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING} processor: checkpoint-store: container-name: ${AZURE_STORAGE_CONTAINER_NAME} account-name: ${AZURE_STORAGE_ACCOUNT_NAME} account-key: ${AZURE_STORAGE_ACCOUNT_KEY} ---- [#api-spring-cloud-azure-starter-integration-eventhubs] ===== API Changes * Please refer to the migration guide of <> library for the changes of listener annotations. * Drop `EventHubOperation` with the subscribing function moved to class `EventHubsMessageListenerContainer` and the sending function moved to `EventHubsTemplate`. * 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 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 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`. - Change message header from `azure_eventhub_sequence_number` to `azure_eventhubs_batch_converted_sequence_number`. - Change message header from `azure_partition_key` to `azure_batch_converted_partition_key`. * When publishing messages to Event Hubs, ignore all message headers converted from batched messages. Headers include: - azure_batch_converted_partition_key - azure_eventhubs_batch_converted_enqueued_time - azure_eventhubs_batch_converted_offset - azure_eventhubs_batch_converted_sequence_number - azure_eventhubs_batch_converted_system_properties - azure_eventhubs_batch_converted_application_properties * The `BATCH` checkpoint mode only works in the batch-consuming mode now, which can be enabled by passing `ListenerMode.BATCH` to EventHubsInboundChannelAdapter constructor. .Class mapping from azure-spring-cloud-starter-eventhubs to spring-cloud-azure-starter-integration-eventhubs [cols="<~,<~", options="header"] |=== |Legacy class |Modern class |com.azure.spring.integration.core.AzureHeaders |com.azure.spring.messaging.AzureHeaders |com.azure.spring.integration.core.EventHubHeaders |com.azure.spring.messaging.eventhubs.support.EventHubsHeaders |com.azure.spring.integration.core.api.CheckpointConfig |com.azure.spring.messaging.eventhubs.core.checkpoint.CheckpointConfig |com.azure.spring.integration.core.api.CheckpointMode |com.azure.spring.messaging.eventhubs.core.checkpoint.CheckpointMode |com.azure.spring.integration.core.api.reactor.Checkpointer |com.azure.spring.messaging.checkpoint.Checkpointer |com.azure.spring.integration.core.api.reactor.DefaultMessageHandler |com.azure.spring.integration.core.handler.DefaultMessageHandler |com.azure.spring.integration.eventhub.inbound.EventHubInboundChannelAdapter |com.azure.spring.integration.eventhubs.inbound.EventHubsInboundChannelAdapter |=== ====== Sample Code Snippet 1.EventHubsInboundChannelAdapter sample code: Legacy code: [source,java] ---- public class Demo { @Bean public EventHubInboundChannelAdapter messageChannelAdapter( @Qualifier("INPUT_CHANNEL") MessageChannel inputChannel, EventHubOperation eventhubOperation) { eventhubOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode(CheckpointMode.MANUAL).build()); EventHubInboundChannelAdapter adapter = new EventHubInboundChannelAdapter("EVENTHUB_NAME", eventhubOperation, "CONSUMER_GROUP"); adapter.setOutputChannel(inputChannel); return adapter; } } ---- Modern code: [source,java] ---- public class Demo { @Bean public EventHubsMessageListenerContainer messageListenerContainer(EventHubsProcessorFactory processorFactory) { EventHubsContainerProperties containerProperties = new EventHubsContainerProperties(); containerProperties.setEventHubName("EVENTHUB_NAME"); containerProperties.setConsumerGroup("CONSUMER_GROUP"); CheckpointConfig config = new CheckpointConfig(CheckpointMode.MANUAL); containerProperties.setCheckpointConfig(config); return new EventHubsMessageListenerContainer(processorFactory, containerProperties); } @Bean public EventHubsInboundChannelAdapter messageChannelAdapter(@Qualifier("INPUT_CHANNEL") MessageChannel inputChannel, EventHubsMessageListenerContainer listenerContainer) { EventHubsInboundChannelAdapter adapter = new EventHubsInboundChannelAdapter(listenerContainer); adapter.setOutputChannel(inputChannel); return adapter; } } ---- 2.DefaultMessageHandler sample code: Legacy code: [source,java] ---- public class Demo { @Bean @ServiceActivator(inputChannel = "OUTPUT_CHANNEL") public MessageHandler messageSender(EventHubOperation eventhubOperation) { DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation); handler.setSendCallback(new ListenableFutureCallback() { @Override public void onSuccess(Void result) { LOGGER.info("Message was sent successfully."); } @Override public void onFailure(Throwable ex) { LOGGER.error("There was an error sending the message.", ex); } }); return handler; } } ---- Modern code: [source,java] ---- public class Demo { @Bean @ServiceActivator(inputChannel = "OUTPUT_CHANNEL") public MessageHandler messageSender(EventHubsTemplate eventhubOperation) { DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation); handler.setSendCallback(new ListenableFutureCallback() { @Override public void onSuccess(Void result) { LOGGER.info("Message was sent successfully."); } @Override public void onFailure(Throwable ex) { LOGGER.error("There was an error sending the message.", ex); } }); return handler; } } ---- ==== From azure-spring-integration-eventhubs to spring-integration-azure-eventhubs This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-integration-azure-eventhubs[spring-integration-azure-eventhubs] from version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-integration-eventhubs[azure-spring-integration-eventhubs]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. [#api-spring-integration-azure-eventhubs] ===== API Changes * Drop `EventHubOperation` with the subscribing function moved to class `EventHubsMessageListenerContainer` and the sending function moved to `EventHubsTemplate`. * 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 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 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`. - Change message header from `azure_eventhub_sequence_number` to `azure_eventhubs_batch_converted_sequence_number`. - Change message header from `azure_partition_key` to `azure_batch_converted_partition_key`. * When publishing messages to Event Hubs, ignore all message headers converted from batched messages. Headers include: - azure_batch_converted_partition_key - azure_eventhubs_batch_converted_enqueued_time - azure_eventhubs_batch_converted_offset - azure_eventhubs_batch_converted_sequence_number - azure_eventhubs_batch_converted_system_properties - azure_eventhubs_batch_converted_application_properties * The `BATCH` checkpoint mode only works in the batch-consuming mode now, which can be enabled by passing `ListenerMode.BATCH` to EventHubsInboundChannelAdapter constructor. .Class mapping from azure-spring-integration-eventhubs to spring-integration-azure-eventhubs [cols="<~,<~", options="header"] |=== |Legacy class |Modern class |com.azure.spring.integration.core.AzureHeaders |com.azure.spring.messaging.AzureHeaders |com.azure.spring.integration.core.EventHubHeaders |com.azure.spring.messaging.eventhubs.support.EventHubsHeaders |com.azure.spring.integration.core.api.CheckpointConfig |com.azure.spring.messaging.eventhubs.core.checkpoint.CheckpointConfig |com.azure.spring.integration.core.api.CheckpointMode |com.azure.spring.messaging.eventhubs.core.checkpoint.CheckpointMode |com.azure.spring.integration.core.api.reactor.Checkpointer |com.azure.spring.messaging.checkpoint.Checkpointer |com.azure.spring.integration.core.api.reactor.DefaultMessageHandler |com.azure.spring.integration.core.handler.DefaultMessageHandler |com.azure.spring.integration.eventhub.inbound.EventHubInboundChannelAdapter |com.azure.spring.integration.eventhubs.inbound.EventHubsInboundChannelAdapter |=== ==== From azure-spring-cloud-starter-servicebus to spring-cloud-azure-starter-integration-servicebus This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-integration-servicebus[spring-cloud-azure-starter-integration-servicebus] from version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-cloud-starter-servicebus[azure-spring-cloud-starter-servicebus]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#configuration-spring-cloud-azure-starter-integration-servicebus] ===== SDK Configuration Changes For all configuration options supported in spring-cloud-azure-starter-integration-servicebus, the prefix remains to be as `spring.cloud.azure.servicebus`. .Property mapping from azure-spring-cloud-starter-servicebus to spring-cloud-azure-starter-integration-servicebus [cols="<30,<~", options="header"] |=== |Legacy properties |Modern properties |*spring.cloud.azure*.resource-group|*spring.cloud.azure.servicebus*.resource.resource-group |*spring.cloud.azure.servicebus*.transport-type |*spring.cloud.azure.servicebus*.client.transport-type |*spring.cloud.azure.servicebus*.retry-options.retry-mode |*spring.cloud.azure.servicebus*.retry.mode |*spring.cloud.azure.servicebus*.retry-options.max-retries |*spring.cloud.azure.servicebus*.retry.exponential.max-retries or *spring.cloud.azure.servicebus*.retry.fixed.max-retries, should be configured depending on *spring.cloud.azure.servicebus*.retry.mode=*fixed* or *exponential* |*spring.cloud.azure.servicebus*.retry-options.delay |*spring.cloud.azure.servicebus*.retry.exponential.base-delay or *spring.cloud.azure.servicebus*.retry.fixed.delay, should be configured depending on *spring.cloud.azure.servicebus*.retry.mode=*fixed* or *exponential* |*spring.cloud.azure.servicebus*.retry-options.max-delay |*spring.cloud.azure.servicebus*.retry.exponential.max-delay |*spring.cloud.azure.servicebus*.retry-options.try-timeout |*spring.cloud.azure.servicebus*.retry.try-timeout |=== [#api-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 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<String, ProducerProperties>` 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"] |=== |Legacy class |Modern class |com.azure.spring.integration.core.AzureHeaders |com.azure.spring.messaging.AzureHeaders |com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders |com.azure.spring.messaging.servicebus.support.ServiceBusMessageHeaders |com.azure.spring.integration.servicebus.converter.ServiceBusMessageConverter |com.azure.spring.messaging.servicebus.support.converter.ServiceBusMessageConverter |com.azure.spring.integration.core.DefaultMessageHandler |com.azure.spring.integration.core.handler.DefaultMessageHandler |com.azure.spring.integration.servicebus.inbound.ServiceBusQueueInboundChannelAdapter |com.azure.spring.integration.servicebus.inbound.ServiceBusInboundChannelAdapter |com.azure.spring.integration.servicebus.inbound.ServiceBusTopicInboundChannelAdapter |com.azure.spring.integration.servicebus.inbound.ServiceBusInboundChannelAdapter |=== ====== Sample Code Snippet 1.ServiceBusInboundChannelAdapter sample code: Legacy code of using `ServiceBusQueueInboundChannelAdapter` or `ServiceBusTopicInboundChannelAdapter`: [source,java] ---- public class Demo { @Bean public ServiceBusQueueInboundChannelAdapter queueMessageChannelAdapter( @Qualifier("INPUT_CHANNEL_NAME") MessageChannel inputChannel, ServiceBusQueueOperation queueOperation) { queueOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode(CheckpointMode.MANUAL).build()); ServiceBusQueueInboundChannelAdapter adapter = new ServiceBusQueueInboundChannelAdapter("QUEUE_NAME", queueOperation); adapter.setOutputChannel(inputChannel); return adapter; } @Bean public ServiceBusTopicInboundChannelAdapter topicMessageChannelAdapter( @Qualifier("INPUT_CHANNEL_NAME") MessageChannel inputChannel, ServiceBusTopicOperation topicOperation) { topicOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode(CheckpointMode.MANUAL).build()); ServiceBusTopicInboundChannelAdapter adapter = new ServiceBusTopicInboundChannelAdapter("TOPIC_NAME", topicOperation, "SUBSCRIPTION_NAME"); adapter.setOutputChannel(inputChannel); return adapter; } } ---- Modern code: [source,java] ---- public class Demo { @Bean("queue-listener-container") public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) { ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties(); containerProperties.setEntityName("QUEUE_NAME"); containerProperties.setAutoComplete(false); return new ServiceBusMessageListenerContainer(processorFactory, containerProperties); } @Bean public ServiceBusInboundChannelAdapter queueMessageChannelAdapter( @Qualifier("INPUT_CHANNEL") MessageChannel inputChannel, @Qualifier("queue-listener-container") ServiceBusMessageListenerContainer listenerContainer) { ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer); adapter.setOutputChannel(inputChannel); return adapter; } @Bean("topic-listener-container") public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) { ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties(); containerProperties.setEntityName("TOPIC_NAME"); containerProperties.setSubscriptionName("SUBSCRIPTION_NAME"); containerProperties.setAutoComplete(false); return new ServiceBusMessageListenerContainer(processorFactory, containerProperties); } @Bean public ServiceBusInboundChannelAdapter topicMessageChannelAdapter( @Qualifier("INPUT_CHANNEL") MessageChannel inputChannel, @Qualifier("topic-listener-container") ServiceBusMessageListenerContainer listenerContainer) { ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer); adapter.setOutputChannel(inputChannel); return adapter; } } ---- 2.DefaultMessageHandler sample code: Legacy code, taking queue as example: [source,java] ---- public class Demo { @Bean @ServiceActivator(inputChannel = "OUTPUT_CHANNEL_NAME") public MessageHandler queueMessageSender(ServiceBusQueueOperation queueOperation) { DefaultMessageHandler handler = new DefaultMessageHandler("QUEUE_NAME", queueOperation); handler.setSendCallback(new ListenableFutureCallback() { @Override public void onSuccess(Void result) { LOGGER.info("Message was sent successfully."); } @Override public void onFailure(Throwable ex) { LOGGER.info("There was an error sending the message."); } }); return handler; } } ---- Modern code: [source,java] ---- public class Demo { @Bean @ServiceActivator(inputChannel = "OUTPUT_CHANNEL_NAME") public MessageHandler queueMessageSender(ServiceBusTemplate serviceBusTemplate) { serviceBusTemplate.setDefaultEntityType(ServiceBusEntityType.QUEUE); DefaultMessageHandler handler = new DefaultMessageHandler("QUEUE_NAME", serviceBusTemplate); handler.setSendCallback(new ListenableFutureCallback() { @Override public void onSuccess(Void result) { LOGGER.info("Message was sent successfully for {}.", "QUEUE_NAME"); } @Override public void onFailure(Throwable ex) { LOGGER.info("There was an error sending the message."); } }); return handler; } } ---- ==== From azure-spring-integration-servicebus to spring-integration-azure-servicebus This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-integration-azure-servicebus[spring-integration-azure-servicebus] from version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-integration-servicebus[azure-spring-integration-servicebus]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. [#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 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<String, ProducerProperties>` 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"] |=== |Legacy class |Modern class |com.azure.spring.integration.core.AzureHeaders |com.azure.spring.messaging.AzureHeaders |com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders |com.azure.spring.messaging.servicebus.support.ServiceBusMessageHeaders |com.azure.spring.integration.servicebus.converter.ServiceBusMessageConverter |com.azure.spring.messaging.servicebus.support.converter.ServiceBusMessageConverter |com.azure.spring.integration.core.DefaultMessageHandler |com.azure.spring.integration.core.handler.DefaultMessageHandler |com.azure.spring.integration.servicebus.inbound.ServiceBusQueueInboundChannelAdapter |com.azure.spring.integration.servicebus.inbound.ServiceBusInboundChannelAdapter |com.azure.spring.integration.servicebus.inbound.ServiceBusTopicInboundChannelAdapter |com.azure.spring.integration.servicebus.inbound.ServiceBusInboundChannelAdapter |=== ==== From azure-spring-cloud-starter-storage-queue to spring-cloud-azure-starter-integration-storage-queue This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-starter-integration-storage-queue[spring-cloud-azure-starter-integration-storage-queue] from version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-cloud-starter-storage-queue[azure-spring-cloud-starter-storage-queue]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#configuration-spring-cloud-azure-starter-integration-storage-queue] ===== SDK Configuration Changes All configuration property names changed the prefix from `spring.cloud.azure.storage` to `spring.cloud.azure.storage.queue`. .Property mapping from azure-spring-cloud-starter-storage-queue to spring-cloud-azure-starter-integration-storage-queue [cols="<30,<~", options="header"] |=== |Legacy properties |Modern properties |*spring.cloud.azure.storage*.account |*spring.cloud.azure.storage.queue*.account-name |*spring.cloud.azure.storage*.access-key |*spring.cloud.azure.storage.queue*.account-key |*spring.cloud.azure.storage*.resource-group |*spring.cloud.azure.storage.queue*.resource.resource-group |=== [#api-spring-cloud-azure-starter-integration-storage-queue] ===== API Changes * Drop `StorageQueueOperation` and provide `StorageQueueTemplate` instead. * 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"] |=== |Legacy class |Modern class |com.azure.spring.integration.core.AzureHeaders |com.azure.spring.messaging.AzureHeaders |com.azure.spring.integration.storage.queue.converter.StorageQueueMessageConverter |com.azure.spring.messaging.storage.queue.support.converter.StorageQueueMessageConverter |com.azure.spring.integration.core.api.reactor.Checkpointer |com.azure.spring.messaging.checkpoint.Checkpointer |com.azure.spring.integration.storage.queue.StorageQueueTemplate |com.azure.spring.messaging.storage.queue.core.StorageQueueTemplate |com.azure.spring.integration.core.api.reactor.DefaultMessageHandler |com.azure.spring.integration.core.handler.DefaultMessageHandler |com.azure.spring.integration.storage.queue.inbound.StorageQueueMessageSource |com.azure.spring.integration.storage.queue.inbound.StorageQueueMessageSource |=== ==== From azure-spring-integration-storage-queue to spring-integration-azure-storage-queue This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-integration-azure-storage-queue[spring-integration-azure-storage-queue] from version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-integration-storage-queue[azure-spring-integration-storage-queue]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. [#api-spring-integration-azure-storage-queue] ===== API Changes * Drop `StorageQueueOperation` and provide `StorageQueueTemplate` instead. * 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"] |=== |Legacy class |Modern class |com.azure.spring.integration.core.AzureHeaders |com.azure.spring.messaging.AzureHeaders |com.azure.spring.integration.storage.queue.converter.StorageQueueMessageConverter |com.azure.spring.messaging.storage.queue.support.converter.StorageQueueMessageConverter |com.azure.spring.integration.core.api.reactor.Checkpointer |com.azure.spring.messaging.checkpoint.Checkpointer |com.azure.spring.integration.storage.queue.StorageQueueTemplate |com.azure.spring.messaging.storage.queue.core.StorageQueueTemplate |com.azure.spring.integration.core.api.reactor.DefaultMessageHandler |com.azure.spring.integration.core.handler.DefaultMessageHandler |com.azure.spring.integration.storage.queue.inbound.StorageQueueMessageSource |com.azure.spring.integration.storage.queue.inbound.StorageQueueMessageSource |=== ==== From azure-spring-cloud-stream-binder-eventhubs to spring-cloud-azure-stream-binder-eventhubs This guide is intended to assist in the migration to 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/azure-spring-cloud-stream-binder-eventhubs[azure-spring-cloud-stream-binder-eventhubs]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#configuration-spring-cloud-azure-stream-binder-eventhubs] ===== SDK Configuration Changes IMPORTANT: Configuration prefix has been changed from `spring.cloud.azure.eventhub` to `spring.cloud.azure.eventhubs.` IMPORTANT: The binder type is renamed from: `eventhub` to `eventhubs`. Changes for the child entries for following prefix, please refer the following table: .Property mapping from azure-spring-cloud-stream-binder-eventhubs to spring-cloud-azure-stream-binder-eventhubs [cols="<30,<~", options="header"] |=== |Legacy properties |Modern properties |*spring.cloud.azure*.resource-group|*spring.cloud.azure.eventhubs*.resource.resource-group |*spring.cloud.azure.eventhub*.namespace|*spring.cloud.azure.eventhubs*.namespace |*spring.cloud.azure.eventhub*.connection-string|*spring.cloud.azure.eventhubs*.connection-string |*spring.cloud.azure.eventhub*.checkpoint-storage-account|*spring.cloud.azure.eventhubs.processor*.checkpoint-store.account-name |*spring.cloud.azure.eventhub*.checkpoint-access-key|*spring.cloud.azure.eventhubs.processor*.checkpoint-store.account-key |*spring.cloud.azure.eventhub*.checkpoint-container|*spring.cloud.azure.eventhubs.processor*.checkpoint-store.container-name |*spring.cloud.stream.eventhub.bindings..consumer*.max-batch-size |*spring.cloud.stream.eventhubs.bindings..consumer*.batch.max-size |*spring.cloud.stream.eventhub.bindings..consumer*.max-wait-time |*spring.cloud.stream.eventhubs.bindings..consumer*.batch.max-wait-time |*spring.cloud.stream.eventhub.bindings..consumer*.checkpoint-mode |*spring.cloud.stream.eventhubs.bindings..consumer*.checkpoint.mode |*spring.cloud.stream.eventhub.bindings..consumer*.checkpoint-count |*spring.cloud.stream.eventhubs.bindings..consumer*.checkpoint.count |*spring.cloud.stream.eventhub.bindings..consumer*.checkpoint-interval |*spring.cloud.stream.eventhubs.bindings..consumer*.checkpoint.interval |*spring.cloud.stream.eventhub.bindings..consumer*.start-position |*spring.cloud.stream.eventhubs.bindings..consumer*.initial-partition-event-position |=== 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 the follows: Legacy configuration: [source,yaml] ---- spring: cloud: azure: eventhub: connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING} checkpoint-storage-account: ${AZURE_CHECKPOINT_STORAGE_ACCOUNT_NAME} checkpoint-access-key: ${AZURE_CHECKPOINT_ACCOUNT_KEY} checkpoint-container: ${AZURE_CHECKPOINT_CONTAINER_NAME} stream: eventhub: bindings: : consumer: max-batch-size: ${AZURE_MAX_BATCH_SIZE} max-wait-time: ${AZURE_MAX_WAIT_TIME} checkpoint-mode: ${AZURE_CHECKPOINT_MODE} checkpoint-count: ${AZURE_CHECKPOINT_COUNT} checkpoint-interval: ${AZURE_CHECKPOINT_INTERVAL} start-position: EARLIEST ---- Modern configuration: [source,yaml] ---- spring: cloud: azure: eventhubs: connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING} processor: checkpoint-store: container-name: ${AZURE_STORAGE_CONTAINER_NAME} account-name: ${AZURE_STORAGE_ACCOUNT_NAME} account-key: ${AZURE_STORAGE_ACCOUNT_KEY} stream: eventhubs: bindings: : consumer: batch: max-size: ${AZURE_MAX_BATCH_SIZE} max-wait-time: ${AZURE_MAX_WAIT_TIME} checkpoint: mode: ${AZURE_CHECKPOINT_MODE} count: ${AZURE_CHECKPOINT_COUNT} interval: ${AZURE_CHECKPOINT_INTERVAL} initial-partition-event-position: 0: offset: earliest 1: sequence-number: 100 2: enqueued-date-time: 2022-01-12T13:32:47.650005Z 4: inclusive: false ---- If you use security principals instead of connection strings, in versions before 4.0 the application will firstly connect to Azure Resource Manager (ARM) with the provided security principal, and then retrieve the connection string of the specified namespace with ARM. In the end the application uses the retrieved connection string to connect to Azure Event Hubs. In this way the provided security principal should be granted with the link:https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#contributor[Contributor] role to retrieve of the associated Azure Event Hubs namespace. For Azure Spring Cloud 4.0, we provide two ways of leveraging security principals for authentication. One is still using the principals to connect to ARM and retrieve the connection strings where the `Contributor` role is required for the principals. The other leverages security principals to authenticate to Azure Active Directory (Azure AD) and then connect to Azure Event Hubs directly, in this case the `Contributor` role is not necessary anymore while other `Data` related roles are required for messaging operations, please refer to 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. For authentication based on ARM, taking service principal as example, configuration migration is listed the follows, where the assigned role should not change: Legacy configuration: [source,yaml] ---- spring: cloud: azure: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} tenant-id: ${AZURE_TENANT_ID} resource-group: ${EVENTHUB_RESOURCE_GROUP} eventhub: namespace: ${EVENTHUB_NAMESPACE} ---- Modern configuration, properties for Azure subscription ID and resource group are required: [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} subscription-id: ${AZURE_SUBSCRIPTION_ID} eventhubs: namespace: ${EVENTHUB_NAMESPACE} resource: resource-group: ${RESOURCE_GROUP} ---- You can also migrate to authenticate and authorize with Azure AD directly without making a detour to ARM. Make sure to grant the security principal necessary `Data` roles for messaging operations. The configuration examples of the service principal and the managed identity are listed the follows: * With a service principal [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} eventhubs: namespace: ${EVENTHUB_NAMESPACE} ---- * With a managed identity [source,yaml] ---- spring: cloud: azure: credential: managed-identity-enabled: true client-id: ${AZURE_MANAGED_IDENTITY_CLIENT_ID} # Only needed when using a user-assigned managed identity eventhubs: namespace: ${EVENTHUB_NAMESPACE} ---- [#api-spring-cloud-azure-stream-binder-eventhubs] ===== API Changes .Class mapping from azure-spring-cloud-stream-binder-eventhubs to spring-cloud-azure-stream-binder-eventhubs [cols="<~,<~", options="header"] |=== |Legacy class |Modern class |com.azure.spring.integration.core.api.reactor.Checkpointer |com.azure.spring.messaging.checkpoint.Checkpointer |com.azure.spring.integration.core.AzureHeaders |com.azure.spring.messaging.AzureHeaders |com.azure.spring.integration.core.EventHubHeaders |com.azure.spring.messaging.eventhubs.support.EventHubsHeaders |=== ==== From azure-spring-cloud-stream-binder-servicebus-* to spring-cloud-azure-stream-binder-servicebus This guide is intended to assist in the migration to link:https://search.maven.org/artifact/com.azure.spring/spring-cloud-azure-stream-binder-servicebus[spring-cloud-azure-stream-binder-servicebus] from version 2 of link:https://search.maven.org/artifact/com.azure.spring/azure-spring-cloud-stream-binder-servicebus-queue[azure-spring-cloud-stream-binder-servicebus-queue] or link:https://search.maven.org/artifact/com.azure.spring/azure-spring-cloud-stream-binder-servicebus-topic[azure-spring-cloud-stream-binder-servicebus-topic]. * Please refer to <> and <> to get a whole picture of the changes in 4.0. * Please refer to <> to learn more about the strategy changes in the project naming. * Please refer to <> to learn how to using one BOM for all Spring Cloud Azure libraries. * Please refer to <> to learn how to handle authentication in Spring Cloud Azure 4.0. * Please refer to <> to learn how to leverage `spring-boot-properties-migrator` during migration. * Please refer to <> to learn more about the global and common configuration changes. [#configuration-spring-cloud-azure-stream-binder-servicebus] ===== SDK Configuration changes IMPORTANT: Legacy binder libraries are `azure-spring-cloud-stream-binder-servicebus-queue` and `azure-spring-cloud-stream-binder-servicebus-topic`, and now they're merged into one `spring-cloud-azure-stream-binder-servicebus` to support both Service Bus Queue and Topic. IMPORTANT: The binder type is combined from `servicebus-queue` and `servicebus-topic` as `servicebus`. .New configuration properties of spring-cloud-azure-stream-binder-servicebus [cols="<30,<~", options="header"] |=== |Modern properties |description |*spring.cloud.stream.servicebus*.bindings..producer.entity-type |If you use the sending function, the entity-type property is required, which can be set to topic or queue. |=== .Property mapping from azure-spring-cloud-stream-binder-servicebus-* to spring-cloud-azure-stream-binder-servicebus [cols="<30,<~", options="header"] |=== |Legacy properties |Modern properties |*spring.cloud.azure*.resource-group|*spring.cloud.azure.servicebus*.resource.resource-group |*spring.cloud.azure.servicebus*.transport-type |*spring.cloud.azure.servicebus*.client.transport-type |*spring.cloud.azure.servicebus*.retry-options.retry-mode |*spring.cloud.azure.servicebus*.retry.mode |*spring.cloud.azure.servicebus*.retry-options.max-retries |*spring.cloud.azure.servicebus*.retry.exponential.max-retries or *spring.cloud.azure.servicebus*.retry.fixed.max-retries, should be configured depending on *spring.cloud.azure.servicebus*.retry.mode=*fixed* or *exponential* |*spring.cloud.azure.servicebus*.retry-options.delay |*spring.cloud.azure.servicebus*.retry.exponential.base-delay or *spring.cloud.azure.servicebus*.retry.fixed.delay, should be configured depending on *spring.cloud.azure.servicebus*.retry.mode=*fixed* or *exponential* |*spring.cloud.azure.servicebus*.retry-options.max-delay |*spring.cloud.azure.servicebus*.retry.exponential.max-delay |*spring.cloud.azure.servicebus*.retry-options.try-timeout |*spring.cloud.azure.servicebus*.retry.try-timeout |*spring.cloud.stream.servicebus.queue*.bindings.* |*spring.cloud.stream.servicebus*.bindings.* |*spring.cloud.stream.servicebus.queue*.bindings..consumer.*concurrency* |*spring.cloud.stream.servicebus*.bindings..consumer.max-concurrent-sessions/max-concurrent-calls |*spring.cloud.stream.servicebus.queue*.bindings..consumer.*checkpoint-mode* |*spring.cloud.stream.servicebus*.bindings..consumer.*auto-complete* |*spring.cloud.stream.servicebus.topic*.bindings.* |*spring.cloud.stream.servicebus*.bindings.* |*spring.cloud.stream.servicebus.topic*.bindings..consumer.*concurrency* |*spring.cloud.stream.servicebus*.bindings..consumer.max-concurrent-sessions/max-concurrent-calls |*spring.cloud.stream.servicebus.topic*.bindings..consumer.*checkpoint-mode* |*spring.cloud.stream.servicebus*.bindings..consumer.*auto-complete* |=== 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 Legacy configuration, taking queue as example: [source,yaml] ---- spring: cloud: azure: servicebus: connection-string: ${AZURE_SERVICEBUS_BINDER_CONNECTION_STRING} stream: function: definition: consume;supply bindings: consume-in-0: destination: ${AZURE_SERVICEBUS_QUEUE_NAME} supply-out-0: destination: ${AZURE_SERVICEBUS_QUEUE_NAME} servicebus: queue: bindings: consume-in-0: consumer: checkpoint-mode: MANUAL ---- Modern configuration: [source,yaml] ---- spring: cloud: azure: servicebus: connection-string: ${AZURE_SERVICEBUS_BINDER_CONNECTION_STRING} stream: function: definition: consume;supply bindings: consume-in-0: destination: ${AZURE_SERVICEBUS_QUEUE_NAME} supply-out-0: destination: ${AZURE_SERVICEBUS_QUEUE_NAME} servicebus: bindings: consume-in-0: consumer: auto-complete: false supply-out-0: producer: entity-type: queue #set as topic if needed ---- If you use security principals instead of connection strings, in versions before 4.0 the application will firstly connect to Azure Resource Manager (ARM) with the provided security principal, and then retrieve the connection string of the specified namespace with ARM. In the end the application uses the retrieved connection string to connect to Azure Service Bus. In this way the provided security principal should be granted with the link:https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#contributor[Contributor] role to retrieve of the associated Azure Service Bus namespace. For Azure Spring Cloud 4.0, we provide two ways of leveraging security principals for authentication. One is still using the principals to connect to ARM and retrieve the connection strings where the `Contributor` role is required for the principals. The other leverages security principals to authenticate to Azure Active Directory (Azure AD) and then connect to the Azure Service Bus directly, in this case the `Contributor` role is not necessary anymore while other `Data` related roles are required for messaging operations, please refer to 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. For authentication based on ARM, taking service principal as example, configuration migration is listed the follows, where the assigned role should not change: Legacy configuration: [source,yaml] ---- spring: cloud: azure: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} tenant-id: ${AZURE_TENANT_ID} resource-group: ${SERVICEBUS_RESOURCE_GROUP} servicebus: namespace: ${SERVICEBUS_NAMESPACE} ---- Modern configuration, properties for Azure subscription ID and resource group are required: [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} subscription-id: ${AZURE_SUBSCRIPTION_ID} servicebus: namespace: ${SERVICEBUS_NAMESPACE} resource: resource-group: ${SERVICEBUS_RESOURCE_GROUP} ---- You can also migrate to authenticate and authorize with Azure AD directly without making a detour to ARM. Make sure to grant the security principal necessary `Data` roles for messaging operations. The configuration examples of the service principal and the managed identity are listed the follows: * With a service principal [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} servicebus: namespace: ${SERVICEBUS_NAMESPACE} ---- * With a managed identity [source,yaml] ---- spring: cloud: azure: credential: managed-identity-enabled: true client-id: ${AZURE_MANAGED_IDENTITY_CLIENT_ID} # Only needed when using a user-assigned managed identity servicebus: namespace: ${SERVICEBUS_NAMESPACE} ---- [#api-spring-cloud-azure-stream-binder-servicebus] ===== API Changes * 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"] |=== |Legacy class |Modern class |com.azure.spring.integration.core.AzureHeaders |com.azure.spring.messaging.AzureHeaders |com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders |com.azure.spring.messaging.servicebus.support.ServiceBusMessageHeaders |com.azure.spring.integration.core.api.Checkpointer |com.azure.spring.messaging.checkpoint.Checkpointer |=== [#migration-azure-spring-cloud-messaging] ==== azure-spring-cloud-messaging Library of `com.azure.spring:azure-spring-cloud-messaging` is not ready for 4.0. The function of listener annotations is under redesign, so annotations of `@AzureMessageListener`, `@AzureMessageListeners` and `@EnableAzureMessaging` are not supported now. ================================================ FILE: docs/src/main/asciidoc/appendix.adoc ================================================ [appendix] == Configuration Properties [#global_proeprties] === Global Properties include::_configuration-properties-global.adoc[] === Azure Active Directory Properties include::_configuration-properties-azure-active-directory.adoc[] === Azure Active Directory B2C Properties include::_configuration-properties-azure-active-directory-b2c.adoc[] [#azure_app_configuration_proeprties] === Azure App Configuration Properties include::_configuration-properties-azure-app-configuration.adoc[] [#azure_cosmos_proeprties] === Azure Cosmos Properties include::_configuration-properties-azure-cosmos-db.adoc[] [#azure_event_hubs_proeprties] === Azure Event Hubs Properties include::_configuration-properties-azure-event-hubs.adoc[] === Azure Key Vault Properties include::_configuration-properties-azure-key-vault.adoc[] [#azure_key_vault_secrets_proeprties] === Azure Key Vault Secrets Properties include::_configuration-properties-azure-key-vault-secrets.adoc[] [#azure_key_vault_certificates_proeprties] === Azure Key Vault Certificates Properties include::_configuration-properties-azure-key-vault-certificates.adoc[] [#azure_service_bus_proeprties] === Azure Service Bus Properties include::_configuration-properties-azure-service-bus.adoc[] === Azure Service Bus JMS Properties include::_configuration-properties-azure-service-bus-jms.adoc[] === Azure Storage Properties include::_configuration-properties-azure-storage.adoc[] [#azure_storage_blob_proeprties] === Azure Storage Blob Properties include::_configuration-properties-azure-storage-blob.adoc[] [#azure_storage_file_share_proeprties] === Azure Storage File Share Properties include::_configuration-properties-azure-storage-file-share.adoc[] [#azure_storage_queue_proeprties] === Azure Storage Queue Properties include::_configuration-properties-azure-storage-queue.adoc[] === All Configuration Properties include::_configuration-properties-all.adoc[] [appendix] include::_migration-guide-for-4.0.adoc[] [appendix] include::create-and-configure-managed-identity.adoc[] [appendix] include::deploy-applications-to-azure-hosting-environments.adoc[] [appendix] include::_known-issues.adoc[] ================================================ FILE: docs/src/main/asciidoc/authentication.adoc ================================================ :azure-built-in-roles: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles :app-configuration-data-owner: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#app-configuration-data-owner :app-configuration-data-reader: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#app-configuration-data-reader :azure-event-hubs-data-owner: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#azure-event-hubs-data-owner :azure-event-hubs-data-receiver: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#azure-event-hubs-data-receiver :azure-event-hubs-data-sender: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#azure-event-hubs-data-send :azure-service-bus-data-owner: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#azure-service-bus-data-owner :azure-service-bus-data-receiver: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#azure-service-bus-data-receiver :azure-service-bus-data-sender: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#azure-service-bus-data-sender :azure-storage-blob-data-owner: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#storage-blob-data-owner :azure-storage-blob-data-reader: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#storage-blob-data-reader :azure-storage-queue-data-reader: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#storage-queue-data-reader :azure-redis-cache-contributor: https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#redis-cache-contributor :key-vault-access-policy: https://docs.microsoft.com/azure/key-vault/general/assign-access-policy :cosmos-db-rbac: https://docs.microsoft.com/azure/cosmos-db/how-to-setup-rbac :managed-identity: https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview [#authentication] == Authentication === DefaultAzureCredential The `DefaultAzureCredential` is appropriate for most scenarios where the application is intended to be run in the Azure Cloud. This is because the DefaultAzureCredential combines credentials commonly used to authenticate when deployed, with credentials used to authenticate in a development environment. NOTE: DefaultAzureCredential is intended to simplify getting started with the SDK by handling common scenarios with reasonable default behaviors. Developers who want more control or whose scenario isn't served by the default settings should use other credential types. The `DefaultAzureCredential` will attempt to authenticate via the following mechanisms in order. image::https://user-images.githubusercontent.com/13167207/143148654-f3a37180-85e2-4360-a47d-c1af2da8fada.png[DefaultAzureCredential] - Environment - The `DefaultAzureCredential` will read account information specified via environment variables and use it to authenticate. - Managed Identity - If the application is deployed to an Azure host with Managed Identity enabled, the `DefaultAzureCredential` will authenticate with that account. - IntelliJ - If the developer has authenticated via Azure Toolkit for IntelliJ, the `DefaultAzureCredential` will authenticate with that account. - Visual Studio Code - If the developer has authenticated via the Visual Studio Code Azure Account plugin, the `DefaultAzureCredential` will authenticate with that account. - Azure CLI - If the developer has authenticated an account via the Azure CLI az login command, the `DefaultAzureCredential` will authenticate with that account. 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. NOTE: Since Spring Cloud Azure AutoConfigure 4.1.0, a `ThreadPoolTaskExecutor` bean named `springCloudAzureCredentialTaskExecutor` will be automatically registered by default and will manage all threads created by Azure Identity. The name of each thread managed by this thread pool is prefixed with `az-identity-`. This `ThreadPoolTaskExecutor` bean is independent of the `Executor` bean provided by Spring Boot. === Managed Identities 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 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: - *System-assigned* Some Azure services allow you to enable a managed identity directly on a service instance. When you enable a system-assigned managed identity an identity is created in Azure AD that's tied to the lifecycle of that service instance. So when the resource is deleted, Azure automatically deletes the identity for you. By design, only that Azure resource can use this identity to request tokens from Azure AD. - *User-assigned* You may also create a managed identity as a standalone Azure resource. You can create a user-assigned managed identity and assign it to one or more instances of an Azure service. In the case of user-assigned managed identities, the identity is managed separately from the resources that use it. NOTE: When using a user-assigned managed identity, you can specify the client ID by `spring.cloud.azure.credential.client-id` or `spring.cloud.azure..credential.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 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 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 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..credential`. .Authentication properties [cols="1,3", options="header"] |=== |Property |Description |client-id |Client id to use when performing service principal authentication with Azure. |client-secret |Client secret to use when performing service principal authentication with Azure. |client-certificate-path |Path of a PEM certificate file to use when performing service principal authentication with Azure. |client-certificate-password |Password of the certificate file. |username |Username to use when performing username/password authentication with Azure. |password |Password to use when performing username/password authentication with Azure. |managed-identity-enabled |Whether to enable managed identity. |=== TIP: To see the list of all Spring Cloud Azure related configuration properties please check link:appendix.html[the Appendix page]. The application will look in several places to find an available credential, and will use `DefaultAzureCredential` if no credential properties are configured. If you want to use specific credential, see the following examples for guidance. The following example shows you how to authenticate using a system-assigned managed identity: [source,yaml] ---- spring.cloud.azure: credential: managed-identity-enabled: true ---- The following example shows you how to authenticate using a user-assigned managed identity: [source,yaml] ---- spring.cloud.azure: credential: managed-identity-enabled: true client-id: ${AZURE_CLIENT_ID} ---- The following example shows you how to authenticate using a service principal with a client secret: [source,yaml] ---- spring.cloud.azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} ---- The following example shows you how to authenticate using a service principal with a client PFX certificate: [source,yaml] ---- spring.cloud.azure: credential: client-id: ${AZURE_CLIENT_ID} client-certificate-path: ${AZURE_CLIENT_CERTIFICATE_PATH} client-certificate-password: ${AZURE_CLIENT_CERTIFICATE_PASSWORD} profile: tenant-id: ${AZURE_TENANT_ID} ---- The following example shows you how to authenticate using a service principal with client PEM certificate: [source,yaml] ---- spring.cloud.azure: credential: client-id: ${AZURE_CLIENT_ID} client-certificate-path: ${AZURE_CLIENT_CERTIFICATE_PATH} profile: tenant-id: ${AZURE_TENANT_ID} ---- The following example shows you how to authenticate using a user credential: [source,yaml] ---- spring.cloud.azure: credential: client-id: ${AZURE_CLIENT_ID} username: ${AZURE_USER_USERNAME} password: ${AZURE_USER_PASSWORD} ---- The following example shows you how to authenticate with Key Vault using a different service principal. This example configures the application with two credentials: one system-assigned managed identity and one service principal. The Key Vault Secret client will use the service principal, but any other components will use managed identity instead. [source,yaml] ---- spring.cloud.azure: credential: managed-identity-enabled: true keyvault.secret: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} ---- [#authorize-access-with-azure-active-directory] ===== 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. TIP: To see the list of all Azure built-in roles please check {azure-built-in-roles}[Azure built-in roles]. Following are the Azure built-in roles for authorizing access to Azure services supported in Spring Cloud Azure: .Azure built-in roles [cols="<50,<50",options="header"] |=== |Role |Description |link:{app-configuration-data-owner}[App Configuration Data Owner] |Allows full access to App Configuration data. |link:{app-configuration-data-reader}[App Configuration Data Reader] |Allows read access to App Configuration data. |link:{azure-event-hubs-data-owner}[Azure Event Hubs Data Owner] |Allows for full access to Azure Event Hubs resources. |link:{azure-event-hubs-data-receiver}[Azure Event Hubs Data Receiver] |Allows receive access to Azure Event Hubs resources. |link:{azure-event-hubs-data-sender}[Azure Event Hubs Data Sender] |Allows send access to Azure Event Hubs resources. |link:{azure-service-bus-data-owner}[Azure Service Bus Data Owner] |Allows for full access to Azure Service Bus resources. |link:{azure-service-bus-data-receiver}[Azure Service Bus Data Receiver] |Allows for receive access to Azure Service Bus resources. |link:{azure-service-bus-data-sender}[Azure Service Bus Data Sender] |Allows for send access to Azure Service Bus resources. |link:{azure-storage-blob-data-owner}[Storage Blob Data Owner] |Provides full access to Azure Storage blob containers and data, including assigning POSIX access control. |link:{azure-storage-blob-data-reader}[Storage Blob Data Reader] |Read and list Azure Storage containers and blobs. |link:{azure-storage-queue-data-reader}[Storage Queue Data Reader] |Read and list Azure Storage queues and queue messages. |link:{azure-redis-cache-contributor}[Redis Cache Contributor] |Manage Redis caches. |=== NOTE: When using Spring Cloud Azure Resource Manager to get the connection strings of Event Hubs, Service Bus, and Storage Queue, or properties of Cache for Redis, assign the Azure built-in role `Contributor`. Azure Cache for Redis is special, and you can also assign the `Redis Cache Contributor` role to get the Redis properties. NOTE: A Key Vault access policy determines whether a given security principal, namely a user, application or user group, can perform different operations on Key Vault secrets, keys, and certificates. You can assign access policies using the Azure portal, the Azure CLI, or Azure PowerShell. Check {key-vault-access-policy}[here] for more details. IMPORTANT: Azure Cosmos DB exposes 2 built-in role definitions: `Cosmos DB Built-in Data Reader` and `Cosmos DB Built-in Data Contributor`. However, Azure portal support for role management isn't available yet. Check {cosmos-db-rbac}[here] for more details about the permission model, role definitions, and role assignment. ==== SAS tokens It's also configurable for services support authenticating with Shared Access Signature (SAS). `spring.cloud.azure..sas-token` is the property to configure. For example, using `spring.cloud.azure.storage.blob.sas-token` to authenticate to Storage Blob service. ==== Connection Strings Connection strings are supported by some Azure services to provide connection information as well as credentials. To connect to those Azure services using a connection string, just configure `spring.cloud.azure..connection-string` will do. For example, `spring.cloud.azure.eventhubs.connection-string` to connect to Event Hubs service. ================================================ FILE: docs/src/main/asciidoc/auto-configure-azure-sdk-clients.adoc ================================================ == Autoconfigure Azure SDK Clients Spring Boot simplifies the Spring Cloud Azure development experience. Spring Cloud Azure starters are a set of convenient dependency descriptors to include in your application. They handle the object instantiation and configuration logic, so you don’t have to. Every starter depends on the `spring-cloud-azure-starter` to provide critical bits of configuration, like the Azure cloud environment and authentication information. You can configure these as properties in, for example, a yaml file: [source,yaml] ---- spring: cloud: azure: profile: tenant-id: ${AZURE_TENANT_ID} cloud-type: Azure # <1> credential: client-id: ${AZURE_CLIENT_ID} ---- <1> `cloud-type` is optional for it has default value set to `Azure`. These properties are optional and, if not specified, Spring Boot will try to automatically find them for you. For details on how Spring Boot finds these properties, refer to the documentation. === Dependency Setup There are two ways to use Spring Cloud Azure starters. One is using Azure SDKs with this `spring-cloud-azure-starter` dependency. For example with Cosmos DB: [source,xml] ---- com.azure azure-cosmos com.azure.spring spring-cloud-azure-starter ---- Or including the Spring Cloud Azure starter directly without adding Azure SDK dependencies. For example with Cosmos DB: [source,xml] ---- com.azure.spring spring-cloud-azure-starter-cosmos ---- TIP: Please refer to link:index.html#starter-dependencies[Starter Dependencies] for the list of starters Spring Cloud Azure supports. === Configuration NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, 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. Configuration properties for each Azure service are under prefix `spring.cloud.azure.`. TIP: To see the list of all Spring Cloud Azure related configuration properties please check link:appendix.html[the Appendix page]. === Basic Usage Adding below properties to your `application.yaml` will autoconfigure the Cosmos clients for you, both `CosmosClient` and `CosmosAsyncClient` are available in the context and could be autowired. [source,yaml] ---- spring: cloud: azure: cosmos: database: ${AZURE_COSMOS_DATABASE_NAME} endpoint: ${AZURE_COSMOS_ENDPOINT} consistency-level: eventual connection-mode: direct ---- [source,java] ---- class Demo { @Autowired private CosmosClient cosmosClient; @Override public void run() { User item = User.randomUser(); CosmosContainer container = cosmosClient.getDatabase(databaseName).getContainer(containerName); container.createItem(item); } } ---- === 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. ================================================ FILE: docs/src/main/asciidoc/configuration-properties.adoc ================================================ == Configuration Properties To see the list of all Spring Cloud Azure related configuration properties please check link:appendix.html[the Appendix page]. ================================================ FILE: docs/src/main/asciidoc/configuration.adoc ================================================ [#configuration] == Configuration === Configuration for each Azure Service SDK 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"] |=== |Property |Description |spring.cloud.azure.*__.client* |To configure the transport clients underneath one Azure service SDK. |spring.cloud.azure.*__.credential* |To configure how to authenticate with Azure Active Directory for one Azure service SDK. |spring.cloud.azure.*__.profile* |To configure the Azure cloud environment for one Azure service SDK. |spring.cloud.azure.*__.proxy* |To configure the proxy options for one Azure service SDK. |spring.cloud.azure.*__.retry* |To configure the retry options apply to one Azure service SDK. The retry options has supported part of the SDKs, there's no `spring.cloud.azure.cosmos.retry`. |=== There are some properties that could be shared among different Azure services, for example using the same service principal to access Azure Cosmos DB and Azure Event Hubs. Spring Cloud Azure 4.0 allows application developers to specify properties that apply to all Azure SDKs with the prefix `spring.cloud.azure`. .Global properties [cols="1,3", options="header"] |=== |Property |Description |spring.cloud.azure.*client* |To configure the transport clients apply to all Azure SDKs by default. |spring.cloud.azure.*credential* |To configure how to authenticate with Azure Active Directory for all Azure SDKs by default. |spring.cloud.azure.*profile* |To configure the Azure cloud environment for all Azure SDKs by default. |spring.cloud.azure.*proxy* |To configure the proxy options apply to all Azure SDK clients by default. |spring.cloud.azure.*retry* |To configure the retry options apply to all Azure SDK clients by default. |=== NOTE: Properties configured under each Azure service will override the global configurations. === Global configuration for Azure Service SDKs 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="<3,<3,<3", options="header"] |=== |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 Certificates |spring.cloud.azure.*keyvault.certificate* |link:appendix.html#azure_key_vault_certificates_proeprties[Key Vault Certificates Properties] |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] |=== === Configuration examples ==== Global retry configuration for Azure Service SDKs [source,yaml] ---- spring.cloud.azure: retry: mode: exponential exponential: max-retries: 4 base-delay: PT0.0801S max-delay: PT9S ---- ==== Retry configuration for Key Vault property source The following configuration example shows you how to configure the retry behavior for the Azure Key Vault Secret client: [source,yaml] ---- spring.cloud.azure: keyvault: secret: credential: client-id: client-secret: profile: tenant-id: property-source-enabled: true property-sources: - endpoint: retry: mode: exponential exponential: max-retries: 4 base-delay: PT0.0801S max-delay: PT9S ---- ================================================ FILE: docs/src/main/asciidoc/create-and-configure-managed-identity.adoc ================================================ [#create-and-configure-a-managed-identity-on-azure-hosting-services] == Create and configure a managed identity on Azure hosting services There are two types of managed identities: **system-assigned** and **user-assigned**. For more information about Azure managed identities, see link:https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/[Azure AD-managed identities for Azure resources]. For more information about Azure Active Directory, see link:https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis[What is Azure Active Directory]. === Create and configure a system-assigned managed identity The following list provides references on how to create and configure system-assigned managed identity on various Azure hosting services. - Azure VM. For more information, see link:https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/qs-configure-portal-windows-vm[Configure managed identities for Azure resources on a VM using the Azure portal]. - Azure App Service and Azure Functions. For more information, see link:https://docs.microsoft.com/azure/app-service/overview-managed-identity[How to use managed identities for App Service and Azure Functions]. - Azure Containers Instances. For more information, see link:https://docs.microsoft.com/azure/container-instances/container-instances-managed-identity[How to use managed identities with Azure Container Instances]. - Azure Kubernetes Service(AKS). For more information, see link:https://docs.microsoft.com/azure/aks/use-managed-identity[Use a managed identity in Azure Kubernetes Service]. - Azure Spring Apps. For more information, see link:https://docs.microsoft.com/azure/spring-cloud/how-to-enable-system-assigned-managed-identity?tabs=azure-portal&pivots=sc-standard-tier[Enable system-assigned managed identity for an application in Azure Spring Apps]. === Create and configure a user-assigned managed identity For instructions on how to create a user-assigned managed identity, see link:https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities?pivots=identity-mi-methods-azp[Manage user-assigned managed identities]. The following list provides references on how to configure a user-assigned managed identity on various Azure hosting services. - Azure VM. For more information, see link:https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/qs-configure-portal-windows-vm[Configure managed identities for Azure resources on a VM using the Azure portal]. - Azure App Service and Azure Functions. For more information, see link:https://docs.microsoft.com/azure/app-service/overview-managed-identity[How to use managed identities for App Service and Azure Functions]. - Azure Containers instances. For more information, see link:https://docs.microsoft.com/azure/container-instances/container-instances-managed-identity[How to use managed identities with Azure Container Instances]. - Azure Kubernetes Service(AKS). For more information, see link:https://docs.microsoft.com/azure/aks/use-managed-identity#bring-your-own-control-plane-mi[Use a managed identity in Azure Kubernetes Service]. - Azure Spring Apps. For more information, see link:https://docs.microsoft.com/azure/spring-cloud/how-to-manage-user-assigned-managed-identities?tabs=azure-portal&pivots=sc-standard-tier[Manage user-assigned managed identities for an application in Azure Spring Apps]. ================================================ FILE: docs/src/main/asciidoc/deploy-applications-to-azure-hosting-environments.adoc ================================================ [#deploy-application-to-azure-hosting-services] == Deploy application to Azure hosting services The following list provides references on how to deploy applications to various Azure hosting services. - Azure Virtual Machines (VMs). For more information, see the link:https://docs.microsoft.com/azure/virtual-machines/linux/tutorial-manage-vm#connect-to-vm[Connect to VM] section of link:https://docs.microsoft.com/azure/virtual-machines/linux/tutorial-manage-vm[Tutorial: Create and Manage Linux VMs with the Azure CLI]. After you connect to the VM, you have to install and configure your applications yourself. - Azure App Service. For more information, see link:https://docs.microsoft.com/azure/app-service/deploy-best-practices[Azure App Service deployment]. - Azure Functions. For more information, see link:https://docs.microsoft.com/azure/azure-functions/functions-deployment-technologies[Deployment technologies in Azure Functions]. - Azure Containers Instances. For more information, see link:https://docs.microsoft.com/azure/container-instances/container-instances-quickstart[Quickstart: Deploy a container instance in Azure using the Azure CLI]. - Azure Kubernetes Service (AKS). For more information, see link:https://docs.microsoft.com/azure/developer/java/spring-framework/deploy-spring-boot-java-app-on-kubernetes[Deploy Spring Boot Application to the Azure Kubernetes Service]. - Azure Spring Apps. For more information, see link:https://docs.microsoft.com/azure/spring-cloud/quickstart-deploy-apps?tabs=Azure-CLI&pivots=programming-language-java[Quickstart: Build and deploy apps to Azure Spring Apps]. ================================================ FILE: docs/src/main/asciidoc/docinfo.html ================================================ ================================================ FILE: docs/src/main/asciidoc/getting-help.adoc ================================================ == Getting Help If you have any questions about this document, please ask by creating GitHub issues. And Pull Request is welcome. .GitHub repositories [%autowidth.stretch] [cols="<30,<70", options="header"] |=== |GitHub repositories | Description |https://github.com/Azure/azure-sdk-for-java/tree/spring-cloud-azure-dependencies_{project-version}/sdk/spring[Azure/azure-sdk-for-java] |This repository used to hold the source code. |https://github.com/microsoft/spring-cloud-azure[microsoft/spring-cloud-azure] |This repository used to hold the document which is displaying in current page. |=== ================================================ FILE: docs/src/main/asciidoc/getting-started.adoc ================================================ == Getting Started === Setting up Dependencies ==== Bill of Material (BOM) [source,xml,indent=0,subs="attributes,verbatim"] ---- com.azure.spring spring-cloud-azure-dependencies {project-version} pom import ---- [#starter-dependencies] ==== Starter Dependencies Spring Cloud Azure Starters are a set of convenient dependency descriptors to include in your application. Each starter includes all the dependencies and transitive dependencies needed to begin using its corresponding Spring Cloud Azure module. They boost your Spring Boot application development with Azure services. For example, if you want to get started using Azure Cosmos DB for data persistence, include the `spring-cloud-azure-starter-cosmos` dependency in your project. Spring Cloud Azure provides the following starters under the `com.azure.spring` group: .Spring Cloud Azure starters [cols="<50,<50",options="header"] |=== |Name |Description |spring-cloud-azure-starter |Core starter, including autoconfiguration support |spring-cloud-azure-starter-active-directory |Starter for using Azure Active Directory with Spring Security |spring-cloud-azure-starter-active-directory-b2c |Starter for using Azure Active Directory B2C with Spring Security |spring-cloud-azure-starter-appconfiguration |Starter for using Azure App Configuration |spring-cloud-azure-starter-cosmos |Starter for using Azure Cosmos DB |spring-cloud-azure-starter-eventhubs |Starter for using Azure Event Hubs |spring-cloud-azure-starter-keyvault |Starter for using Azure Key Vault |spring-cloud-azure-starter-keyvault-certificates |Starter for using Azure Key Vault Certificates |spring-cloud-azure-starter-keyvault-secrets |Starter for using Azure Key Vault Secrets |spring-cloud-azure-starter-servicebus |Starter for using Azure Service Bus |spring-cloud-azure-starter-servicebus-jms |Starter for using Azure Service Bus and JMS |spring-cloud-azure-starter-storage |Starter for using Azure Storage |spring-cloud-azure-starter-storage-blob |Starter for using Azure Storage Blob |spring-cloud-azure-starter-storage-file-share |Starter for using Azure Storage File Share |spring-cloud-azure-starter-storage-queue |Starter for using Azure Storage Queue |spring-cloud-azure-starter-actuator |Starter for using Spring Boot’s Actuator which provides production ready features |=== Below are starters for **Spring Data** support: .Spring Data related starters [cols="<50,<50", options="header"] |=== |Name |Description |spring-cloud-azure-starter-data-cosmos |Starter for using Azure Cosmos DB and Spring Data Cosmos DB |=== Below are starters for **Spring Integration** support: .Spring Integration related starters [cols="<50,<50", options="header"] |=== |Name |Description |spring-cloud-azure-starter-integration-eventhubs |Starter for using Azure Event Hubs and Spring Integration |spring-cloud-azure-starter-integration-servicebus |Starter for using Azure Service Bus and Spring Integration |spring-cloud-azure-starter-integration-storage-queue |Starter for using Azure Storage Queue and Spring Integration |=== Below are starters for **Spring Cloud Stream** support: .Spring Cloud Stream related starters [cols="<50,<50", options="header"] |=== |Name |Description |spring-cloud-azure-starter-stream-eventhubs |Starters for using Azure Event Hubs and Spring Cloud Stream Binder |spring-cloud-azure-starter-stream-servicebus |Starter for using Azure Service Bus and Spring Cloud Stream Binder |=== === Learning Spring Cloud Azure We prepared a full list of samples to show the usages, can be found at https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}[Spring Cloud Azure Samples]. ================================================ FILE: docs/src/main/asciidoc/ghpages.sh ================================================ #!/bin/bash -x set -e # Set default props like MAVEN_PATH, ROOT_FOLDER etc. function set_default_props() { # The script should be executed from the root folder ROOT_FOLDER=`pwd` echo "Current folder is ${ROOT_FOLDER}" if [[ ! -e "${ROOT_FOLDER}/.git" ]]; then echo "You're not in the root folder of the project!" exit 1 fi # Prop that will let commit the changes COMMIT_CHANGES="no" MAVEN_PATH=${MAVEN_PATH:-} echo "Path to Maven is [${MAVEN_PATH}]" REPO_NAME=${PWD##*/} echo "Repo name is [${REPO_NAME}]" SPRING_CLOUD_STATIC_REPO=${SPRING_CLOUD_STATIC_REPO:-git@github.com:spring-cloud/spring-cloud-static.git} echo "Spring Cloud Static repo is [${SPRING_CLOUD_STATIC_REPO}" } # Check if gh-pages exists and docs have been built function check_if_anything_to_sync() { git remote set-url --push origin `git config remote.origin.url | sed -e 's/^git:/https:/'` if ! (git remote set-branches --add origin gh-pages && git fetch -q); then echo "No gh-pages, so not syncing" exit 0 fi if ! [ -d docs/target/generated-docs ] && ! [ "${BUILD}" == "yes" ]; then echo "No gh-pages sources in docs/target/generated-docs, so not syncing" exit 0 fi } function retrieve_current_branch() { # Code getting the name of the current branch. For main we want to publish as we did until now # https://stackoverflow.com/questions/1593051/how-to-programmatically-determine-the-current-checked-out-git-branch # If there is a branch already passed will reuse it - otherwise will try to find it CURRENT_BRANCH=${BRANCH} if [[ -z "${CURRENT_BRANCH}" ]] ; then CURRENT_BRANCH=$(git symbolic-ref -q HEAD) CURRENT_BRANCH=${CURRENT_BRANCH##refs/heads/} CURRENT_BRANCH=${CURRENT_BRANCH:-HEAD} fi echo "Current branch is [${CURRENT_BRANCH}]" git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script" } # Switches to the provided value of the release version. We always prefix it with `v` function switch_to_tag() { git checkout v${VERSION} } # Build the docs if switch is on function build_docs_if_applicable() { if [[ "${BUILD}" == "yes" ]] ; then ./mvnw clean install -P docs -pl docs -DskipTests fi } # Get the name of the `docs.main` property # Get whitelisted branches - assumes that a `docs` module is available under `docs` profile function retrieve_doc_properties() { RELEASE_TO_GH_PAGES_ENABLED_PROPERTY=${RELEASE_TO_GH_PAGES_ENABLED_PROPERTY:-"release.to.gh.pages.enabled"} RELEASE_TO_GH_PAGES_ENABLED_VALUE=$("${MAVEN_PATH}"mvn -q \ -Dexec.executable="echo" \ -Dexec.args="\${${RELEASE_TO_GH_PAGES_ENABLED_PROPERTY}}" \ org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \ -P docs \ -pl docs) echo "Extracted '${RELEASE_TO_GH_PAGES_ENABLED_PROPERTY}' from Maven build [${RELEASE_TO_GH_PAGES_ENABLED_VALUE}]" RELEASE_TO_GH_PAGES_TARGET_FLODER_PROPERTY=${RELEASE_TO_GH_PAGES_TARGET_FLODER_PROPERTY:-"release.to.gh.pages.target.floder"} RELEASE_TO_GH_PAGES_TARGET_FLODER_VALUE=$("${MAVEN_PATH}"mvn -q \ -Dexec.executable="echo" \ -Dexec.args="\${${RELEASE_TO_GH_PAGES_TARGET_FLODER_PROPERTY}}" \ org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \ -P docs \ -pl docs) echo "Extracted '${RELEASE_TO_GH_PAGES_TARGET_FLODER_PROPERTY}' from Maven build [${RELEASE_TO_GH_PAGES_TARGET_FLODER_VALUE}]" } # Stash any outstanding changes function stash_changes() { git diff-index --quiet HEAD && dirty=$? || (echo "Failed to check if the current repo is dirty. Assuming that it is." && dirty="1") if [ "$dirty" != "0" ]; then git stash; fi } # Switch to gh-pages branch to sync it with current branch function add_docs_from_target() { local DESTINATION_REPO_FOLDER if [[ -z "${DESTINATION}" && -z "${CLONE}" ]] ; then DESTINATION_REPO_FOLDER=${ROOT_FOLDER} elif [[ "${CLONE}" == "yes" ]]; then mkdir -p ${ROOT_FOLDER}/target local clonedStatic=${ROOT_FOLDER}/target/spring-cloud-static if [[ ! -e "${clonedStatic}/.git" ]]; then echo "Cloning Spring Cloud Static to target" git clone ${SPRING_CLOUD_STATIC_REPO} ${clonedStatic} && git checkout gh-pages else echo "Spring Cloud Static already cloned - will pull changes" cd ${clonedStatic} && git checkout gh-pages && git pull origin gh-pages fi DESTINATION_REPO_FOLDER=${clonedStatic}/${REPO_NAME} mkdir -p ${DESTINATION_REPO_FOLDER} else if [[ ! -e "${DESTINATION}/.git" ]]; then echo "[${DESTINATION}] is not a git repository" exit 1 fi DESTINATION_REPO_FOLDER=${DESTINATION}/${REPO_NAME} mkdir -p ${DESTINATION_REPO_FOLDER} echo "Destination was provided [${DESTINATION}]" fi cd ${DESTINATION_REPO_FOLDER} git checkout gh-pages git pull origin gh-pages # Add git branches ################################################################### if [[ -z "${VERSION}" ]] ; then copy_docs_for_current_version else copy_docs_for_provided_version fi commit_changes_if_applicable } # Copies the docs by using the retrieved properties from Maven build function copy_docs_for_current_version() { if [[ "${RELEASE_TO_GH_PAGES_ENABLED_VALUE}" == "true" ]] ; then echo -e "Need to release - Will copy the all files from docs/target/generated-docs/ to ${ROOT_FOLDER}${RELEASE_TO_GH_PAGES_TARGET_FLODER_VALUE}" for f in docs/target/generated-docs/*; do file=${f#docs/target/generated-docs/*} if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then # Not ignored... cp -rf $f ${ROOT_FOLDER}${RELEASE_TO_GH_PAGES_TARGET_FLODER_VALUE} git add -A ${ROOT_FOLDER}${RELEASE_TO_GH_PAGES_TARGET_FLODER_VALUE}$file fi done COMMIT_CHANGES="yes" fi } # Copies the docs by using the explicitly provided version function copy_docs_for_provided_version() { local FOLDER=${DESTINATION_REPO_FOLDER}/${VERSION} mkdir -p ${FOLDER} echo -e "Current tag is [v${VERSION}] Will copy the current docs to the [${FOLDER}] folder" for f in ${ROOT_FOLDER}/docs/target/generated-docs/*; do file=${f#${ROOT_FOLDER}/docs/target/generated-docs/*} copy_docs_for_branch ${file} ${FOLDER} done COMMIT_CHANGES="yes" CURRENT_BRANCH="v${VERSION}" } # Copies the docs from target to the provided destination # Params: # $1 - file from target # $2 - destination to which copy the files function copy_docs_for_branch() { local file=$1 local destination=$2 if ! git ls-files -i -o --exclude-standard --directory | grep -q ^${file}$; then # Not ignored... # We want users to access 1.0.0.RELEASE/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html if [[ ("${file}" == "${MAIN_ADOC_VALUE}.html") || ("${file}" == "${REPO_NAME}.html") ]] ; then # We don't want to copy the spring-cloud-sleuth.html # we want it to be converted to index.html cp -rf $f ${destination}/index.html git add -A ${destination}/index.html else cp -rf $f ${destination} git add -A ${destination}/$file fi fi } function commit_changes_if_applicable() { if [[ "${COMMIT_CHANGES}" == "yes" ]] ; then COMMIT_SUCCESSFUL="no" git commit -a -m "Sync docs from ${CURRENT_BRANCH} to gh-pages" && COMMIT_SUCCESSFUL="yes" || echo "Failed to commit changes" # Uncomment the following push if you want to auto push to # the gh-pages branch whenever you commit to main locally. # This is a little extreme. Use with care! ################################################################### if [[ "${COMMIT_SUCCESSFUL}" == "yes" ]] ; then git push origin gh-pages fi fi } # Switch back to the previous branch and exit block function checkout_previous_branch() { # If -version was provided we need to come back to root project cd ${ROOT_FOLDER} git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script" if [ "$dirty" != "0" ]; then git stash pop; fi exit 0 } # Assert if properties have been properly passed function assert_properties() { echo "VERSION [${VERSION}], DESTINATION [${DESTINATION}], CLONE [${CLONE}]" if [[ "${VERSION}" != "" && (-z "${DESTINATION}" && -z "${CLONE}") ]] ; then echo "Version was set but destination / clone was not!"; exit 1;fi if [[ ("${DESTINATION}" != "" && "${CLONE}" != "") && -z "${VERSION}" ]] ; then echo "Destination / clone was set but version was not!"; exit 1;fi if [[ "${DESTINATION}" != "" && "${CLONE}" == "yes" ]] ; then echo "Destination and clone was set. Pick one!"; exit 1;fi } # Prints the usage function print_usage() { cat </` - if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will switch to gh-pages of that repo and copy the generated docs to `docs//` USAGE: You can use the following options: -v|--version - the script will apply the whole procedure for a particular library version -d|--destination - the root of destination folder where the docs should be copied. You have to use the full path. E.g. point to spring-cloud-static folder. Can't be used with (-c) -b|--build - will run the standard build process after checking out the branch -c|--clone - will automatically clone the spring-cloud-static repo instead of providing the destination. Obviously can't be used with (-d) EOF } # ========================================== # ____ ____ _____ _____ _____ _______ # / ____|/ ____| __ \|_ _| __ \__ __| # | (___ | | | |__) | | | | |__) | | | # \___ \| | | _ / | | | ___/ | | # ____) | |____| | \ \ _| |_| | | | # |_____/ \_____|_| \_\_____|_| |_| # # ========================================== while [[ $# > 0 ]] do key="$1" case ${key} in -v|--version) VERSION="$2" shift # past argument ;; -d|--destination) DESTINATION="$2" shift # past argument ;; -b|--build) BUILD="yes" ;; -c|--clone) CLONE="yes" ;; -h|--help) print_usage exit 0 ;; *) echo "Invalid option: [$1]" print_usage exit 1 ;; esac shift # past argument or value done assert_properties set_default_props check_if_anything_to_sync if [[ -z "${VERSION}" ]] ; then retrieve_current_branch else switch_to_tag fi build_docs_if_applicable retrieve_doc_properties stash_changes add_docs_from_target checkout_previous_branch ================================================ FILE: docs/src/main/asciidoc/index.adoc ================================================ = Spring Cloud Azure - Reference Documentation include::_attributes.adoc[] include::version-information.adoc[] include::legal.adoc[] include::intro.adoc[] include::getting-help.adoc[] include::whats-new-4.0.adoc[] include::migration-guide-for-4.0.adoc[] include::getting-started.adoc[] include::configuration.adoc[] include::authentication.adoc[] include::production-ready.adoc[] include::auto-configure-azure-sdk-clients.adoc[] include::resource-handling.adoc[] include::secret-management.adoc[] include::spring-data-support.adoc[] include::spring-security-support.adoc[] include::spring-integration-support.adoc[] include::spring-cloud-stream-support.adoc[] include::spring-jms-support.adoc[] include::spring-native-support.adoc[] include::kafka-support.adoc[] include::redis-support.adoc[] include::resource-manager.adoc[] include::configuration-properties.adoc[] == Appendix === link:appendix.html##configuration-properties[Configuration properties] === link:appendix.html#migration-guide-for-4-0[Migration guide for 4.0] === link:appendix.html#known-issues[Known issues] === link:appendix.html#create-and-configure-a-managed-identity-on-azure-hosting-services[Create and configure a managed identity on Azure hosting services] === link:appendix.html#deploy-application-to-azure-hosting-services[Deploy application to Azure hosting services] ================================================ FILE: docs/src/main/asciidoc/intro.adoc ================================================ Spring is an open-source application framework developed by VMware that provides a simplified, modular approach for creating Java applications. Spring Cloud Azure is an open-source project that provides seamless Spring integration with Azure services. ================================================ FILE: docs/src/main/asciidoc/kafka-support.adoc ================================================ [#kafka-support] == Kafka Support From version 4.3.0, Spring Cloud Azure for Kafka supports various types of credentials to authenticate and connect to Azure Event Hubs. === Supported Kafka version The current version of the starter should be compatible with Apache Kafka Clients 2.0.0 using Java 8 or above. === Supported authentication types The following authentication types are supported: * Plain connection string authentication ** Direct connection string authentication ** ARM-based connection string authentication * OAuth credential authentication ** Managed identity authentication ** Username/password authentication ** Service principal authentication ** DefautlAzureCredential authentication === How it works ==== OAuth credential authentication This section describes the overall workflow of Spring Cloud Azure OAuth authentication. Spring Cloud Azure will first build one of the following types of credentials depending on the application authentication configuration: - `ClientSecretCredential` - `ClientCertificateCredential` - `UsernamePasswordCredential` - `ManagedIdentityCredential` If none of these types of credentials are found, the credential chain via `DefaultAzureTokenCredential` will be used to obtain credentials from application properties, environment variables, managed identity, or IDEs. For detailed information, see the link:index.html#authentication[Authentication] section. ==== Plain connection string authentication For the connection string authentication mode, you can use connection string authentication directly or use the Azure Resource Manager to retrieve the connection string. For more information about the usage, see the link:#basic-usage-connection-string[Basic usage for connection string authentication] section. NOTE: Since version of 4.3.0, connection string authentication is deprecated in favor of OAuth authentications. === Configuration ==== Configurable properties when using Kafka support with OAuth authentication Spring Cloud Azure for Kafka supports the following two levels of configuration options: 1. Spring Cloud Azure for Event Hubs Kafka properties. 2. The global authentication configuration options of `credential` and `profile` with prefixes of `spring.cloud.azure`. 3. Kafka-specific level configurations. The Kafka-level configurations are also available for Spring Boot and Spring Cloud Stream binders for `common`, `consumer`, `producer`, or `admin` scopes, which have different prefixes. The global properties are exposed via `com.azure.spring.cloud.autoconfigure.context.AzureGlobalProperties`. The Kafka-specific properties are exposed via `org.springframework.boot.autoconfigure.kafka.KafkaProperties` (Spring Boot) and `org.springframework.cloud.stream.binder.kafka.properties.KafkaBinderConfigurationProperties` (Spring Cloud Stream binder). The following list shows all supported configuration options. * The Spring Cloud Azure global authentication configuration options ** Prefix: `spring.cloud.azure` ** Supported options: `spring.cloud.azure.credential.*`, `spring.cloud.azure.profile.*` For the full list of global configuration options, see the link:appendix.html#global_proeprties[Global properties] section. * Spring Boot Kafka common configuration ** Prefix: `spring.kafka.properties.azure` ** Example: `spring.kafka.properties.azure`.credential.* * Spring Kafka consumer configuration options ** Prefix: `spring.kafka.consumer.properties.azure` ** Example: `spring.kafka.consumer.properties.azure`.credential.* * Spring Kafka producer configuration options ** Prefix: `spring.kafka.producer.properties.azure` ** Example: `spring.kafka.producer.properties.azure`.credential.* * Spring Kafka admin configuration options ** Prefix: `spring.kafka.admin.properties.azure` ** Example: `spring.kafka.admin.properties.azure`.credential.* * Spring Cloud Stream Kafka Binder common configuration ** Prefix: `spring.cloud.stream.kafka.binder.configuration.azure` ** Example: `spring.cloud.stream.kafka.binder.configuration.azure`.credential.* * Spring Cloud Stream Kafka Binder consumer configuration ** Prefix: `spring.cloud.stream.kafka.binder.consumer-properties.azure` ** Example: `spring.cloud.stream.kafka.binder.consumer-properties.azure`.credential.* * Spring Cloud Stream Kafka Binder producer configuration ** Prefix: `spring.cloud.stream.kafka.binder.producer-properties.azure` ** Example: `spring.cloud.stream.kafka.binder.producer-properties.azure`.credential.* * Spring Cloud Stream Kafka Binder admin configuration ** Prefix: Not supported, should use Spring Boot Kafka common or admin configuration. .Spring Boot Kafka common configuration options [cols="2*", options="header"] |=== |Property |Description | spring.kafka.properties.azure.credential.client-certificate-password | Password of the certificate file. | spring.kafka.properties.azure.credential.client-certificate-path | Path of a PEM certificate file to use when performing service principal authentication with Azure. | spring.kafka.properties.azure.credential.client-id | Client ID to use when performing service principal authentication with Azure. This is a legacy property. | spring.kafka.properties.azure.credential.client-secret | Client secret to use when performing service principal authentication with Azure. This is a legacy property. | spring.kafka.properties.azure.credential.managed-identity-enabled | Whether to enable managed identity to authenticate with Azure. If *true* and the `client-id` is set, will use the client ID as user assigned managed identity client ID. The default value is *false*. | spring.kafka.properties.azure.credential.password | Password to use when performing username/password authentication with Azure. | spring.kafka.properties.azure.credential.username | Username to use when performing username/password authentication with Azure. | spring.kafka.properties.azure.profile.environment.active-directory-endpoint | The Azure Active Directory endpoint to connect to. | spring.kafka.properties.azure.profile.tenant-id | Tenant ID for Azure resources. |=== [NOTE] ==== The configuration options in different levels apply the following rules. The more specific configuration options have higher priority than the common ones. For example: - Spring Kafka common configuration options supersede the global options. - Spring Kafka consumer configuration options supersede the common options. - Spring Kafka producer configuration options supersede the common options. - Spring Kafka admin configuration options supersede the common options. - The Spring Cloud Stream Kafka Binder options are just like the above. ==== ==== Configurable properties when using Kafka support with plain connection string authentication .Spring Boot Event Hubs for Kafka common configuration options [cols="2*", options="header"] |=== |Property |Description | **spring.cloud.azure.eventhubs**.kafka.enabled | Whether to enable the Azure Event Hubs Kafka support. The default value is *true*. | **spring.cloud.azure.eventhubs**.connection-string | Azure Event Hubs connection string. Provide this value when you want to provide the connection string directly. | **spring.cloud.azure.eventhubs**.namespace | Azure Event Hubs namespace. Provide this value when you want to retrieve the connection information through Azure Resource Manager. | **spring.cloud.azure.eventhubs**.resource.resource-group | The resource group of Azure Event Hubs namespace. Provide this value when you want to retrieve the connection information through Azure Resource Manager. | **spring.cloud.azure**.profile.subscription-id | The subscription ID. Provide this value when you want to retrieve the connection information through Azure Resource Manager. |=== === Dependency Setup Add the following dependency to your project. This will automatically include the `spring-boot-starter` dependency in your project transitively. [source,xml] ---- com.azure.spring spring-cloud-azure-starter ---- NOTE: Remember to add the BOM `spring-cloud-azure-dependencies` along with the above dependency. For details, see the link:index.html#starter-dependencies[Getting started] section. === Basic usage The following sections show the classic Spring Boot application usage scenarios. ==== Use OAuth authentication When you use the OAuth authentication provided by Spring Cloud Azure for Kafka, you can configure the specific credentials using the above configurations. Alternatively, you can choose to configure nothing about credentials, in which case Spring Cloud Azure will load the credentials from the environment. This section describes the usages that load the credentials from the Azure CLI environment or the Azure Spring Apps hosting environment. NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, see the link:index.html#authorize-access-with-azure-active-directory[Authorize access with Azure Active Directory] section to make sure the security principal has been granted the sufficient permission to access the Azure resource. The following section describes the scenarios using different Spring ecosystem libraries with OAuth authentication. ===== Spring Kafka application support This section describes the usage scenario for Spring Boot application using Spring Kafka or Spring Integration Kafka library. ====== Dependency setup [source,xml] ---- com.azure.spring spring-cloud-azure-starter org.springframework.kafka spring-kafka {version} org.springframework.integration spring-integration-kafka {version} ---- [#spring-kafka-configuraiton-setup] ====== Configuration update To use the OAuth authentication, just specify the Event Hubs endpoint, as shown in the following example: [source,properties] ---- spring.kafka.bootstrap-servers=.servicebus.windows.net:9093 ---- ===== Spring Cloud Stream binder Kafka application support This section describes the usage scenario for Spring Boot applications using the Spring Cloud Stream binder Kafka library. ====== Dependency setup [source,xml] ---- com.azure.spring spring-cloud-azure-starter org.springframework.cloud spring-cloud-starter-stream-kafka {version} ---- ====== Configuration To use the OAuth authentication, just specify the Event Hubs endpoint and `com.azure.spring.cloud.autoconfigure.kafka.AzureKafkaSpringCloudStreamConfiguration`, as shown in the following example: [source,properties] ---- spring.cloud.stream.kafka.binder.brokers=.servicebus.windows.net:9093 spring.cloud.stream.binders.kafka.environment.spring.main.sources=com.azure.spring.cloud.autoconfigure.kafka.AzureKafkaSpringCloudStreamConfiguration ---- NOTE: If you're using version `4.3.0`, don't forget to set the `spring.cloud.stream.binders..environment.spring.main.sources=com.azure.spring.cloud.autoconfigure.kafka.AzureKafkaSpringCloudStreamConfiguration` property to enable the whole OAuth authentication workflow, where `kafka-binder-name` is `kafka` by default in a single Kafka binder application. The configuration `AzureKafkaSpringCloudStreamConfiguration` specifies the OAuth security parameters for `KafkaBinderConfigurationProperties`, which is used in `KafkaOAuth2AuthenticateCallbackHandler` to enable Azure Identity. For version after `4.4.0`, this property will be added automatically for each Kafka binder environment, so there's no need for you to add it manually. ====== Samples See the link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}[azure-spring-boot-samples] repository on GitHub. [#basic-usage-connection-string] ==== Use connection string authentication You can use connection string authentication directly or use the Azure Resource Manager to retrieve the connection string. NOTE: Since version of 4.3.0, connection string authentication is deprecated in favor of OAuth authentications. ===== Dependency setup Add the following dependencies if you want to migrate your Apache Kafka application to use Azure Event Hubs for Kafka. [source,xml] ---- com.azure.spring spring-cloud-azure-starter ---- If you want to retrieve the connection string using Azure Resource Manager, add the following dependency: [source,xml] ---- com.azure.spring spring-cloud-azure-resourcemanager ---- ===== Configuration ====== Use Event Hubs connection string directly The simplest way to connect to Event Hubs for Kafka is with the connection string. Just add the following property. [source,properties] ---- spring.cloud.azure.eventhubs.connection-string=${AZURE_EVENTHUBS_CONNECTION_STRING} ---- ====== Use Azure Resource Manager to retrieve connection string If you don't want to configure the connection string in your application, you can use Azure Resource Manager to retrieve the connection string. To authenticate with Azure Resource Manager, you can also use credentials stored in Azure CLI or another local development tool such as Visual Studio Code or Intellij IDEA. Alternately, you can use Managed Identity if your application is deployed to Azure Cloud. Just be sure the principal has sufficient permission to read resource metadata. NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, see the link:index.html#authorize-access-with-azure-active-directory[Authorize access with Azure Active Directory] section to be sure the security principal has been granted the sufficient permission to access the Azure resource. To use Azure Resource Manager to retrieve the connection string, just add the following property. [source,yaml] ---- spring: cloud: azure: profile: subscription-id: ${AZURE_SUBSCRIPTION_ID} eventhubs: namespace: ${AZURE_EVENTHUBS_NAMESPACE} resource: resource-group: ${AZURE_EVENTHUBS_RESOURCE_GROUP} ---- === Samples See the link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}[azure-spring-boot-samples] repository on GitHub. ================================================ FILE: docs/src/main/asciidoc/legal.adoc ================================================ (C) 2016-2022 the original authors. NOTE: _Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically._ ================================================ FILE: docs/src/main/asciidoc/migration-guide-for-4.0.adoc ================================================ == Migration Guide for 4.0 To learn how to migrate to 4.0, please check link:appendix.html#migration-guide-for-4-0[the Appendix page]. ================================================ FILE: docs/src/main/asciidoc/production-ready.adoc ================================================ == Production Ready 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 Add the Spring Cloud Azure Actuator Starter dependency. This dependency will also include the `spring-boot-starter-actuator`. [source,xml] ---- com.azure.spring spring-cloud-azure-starter-actuator ---- .Configurable properties to enable or disable health indicators for each Azure service [cols="<30,<70", options="header"] |=== |Azure Service |Property |App Configuration |management.health.*azure-appconfiguration*.enabled |Cosmos DB |management.health.*azure-cosmos*.enabled |Event Hubs |management.health.*azure-eventhubs*.enabled |Key Vault Certificate |management.health.*azure-keyvault-certificate*.enabled |Key Vault Secret |management.health.*azure-keyvault-secret*.enabled |Storage Blob |management.health.*azure-storage-blob*.enabled |Storage File Share|management.health.*azure-storage-fileshare*.enabled |Storage Queue |management.health.*azure-storage-queue*.enabled |=== IMPORTANT: Calling the health endpoint of Azure services may cause extra charge. For example, calling `http://HOST_NAME:{port}/actuator/health/cosmos` to get the Cosmos DB health info, it will calculate https://docs.microsoft.com/azure/cosmos-db/request-units[RUs]. NOTE: For calling the health endpoint of `Cosmos`, the option `spring.cloud.azure.cosmos.database` should be configured; Otherwise, the health status of `unknown` will be returned. NOTE: For calling the health endpoint of `Storage Queue`, role of `Storage Account Contributor` is required if `Azure AD` is used for authorizing. === Enable Sleuth Add the Spring Cloud Azure Trace Sleuth dependency when you want to trace Azure SDK activities with using Spring Cloud Sleuth. [source,xml] ---- com.azure.spring spring-cloud-azure-trace-sleuth ---- NOTE: Only HTTP-based Azure SDK clients are supported now, for example, Eventhub and ServiceBus with AMQP transport are currently not supported, we recommend to use https://docs.microsoft.com/azure/azure-monitor/app/app-insights-overview[Azure Application Insights] for such requirement. ================================================ FILE: docs/src/main/asciidoc/redis-support.adoc ================================================ [#redis-support] == Redis Support Connect to Azure Cache for Redis using Spring Redis libraries. With adding `spring-cloud-azure-starter` and `spring-cloud-azure-resourcemanager` to your application, it's possible to read the Azure Cache for Redis connection information through Azure Resource Manager and auto-configure the Redis properties. === Dependency Setup Add the following dependencies if you want to use the Spring Cloud Azure Redis support to your Spring Boot application using Redis. [source,xml] ---- com.azure.spring spring-cloud-azure-starter com.azure.spring spring-cloud-azure-resourcemanager ---- === Configuration NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, 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. .Configurable properties when using Redis support [cols="4*", options="header"] |=== |Property |Description |Default Value | Required |*spring.cloud.azure.redis*.enabled |A value that indicates whether the Azure Cache for Redis is enabled.|true | No |*spring.cloud.azure.redis*.name |Azure Cache for Redis instance name.| |Yes |*spring.cloud.azure.redis*.resource.resource-group |The resource group of Azure Cache for Redis.||Yes |*spring.cloud.azure*.profile.subscription-id| The subscription id. ||Yes |=== NOTE: Authentication information is also required for authenticating for Azure Resource Manager. The credential related configurations of Resource Manager should be configured under prefix `spring.cloud.azure`. For more information, see the link:index.html#authentication[Authentication] section. === Basic Usage Add the following properties and you are good to go. [source,properties] ---- spring.cloud.azure.redis.name=${AZURE_CACHE_REDIS_NAME} spring.cloud.azure.redis.resource.resource-group=${AZURE_CACHE_REDIS_RESOURCE_GROUP} ---- === Samples See link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}[azure-spring-boot-samples] for more details. ================================================ FILE: docs/src/main/asciidoc/resource-handling.adoc ================================================ == Resource Handling Spring project provides link:https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources[Spring Resources] abstraction to access a number of low-level resources. It provides interfaces like `Resource`, `ResourceLoader` and `ResourcePatternResolver`. Spring Cloud Azure implements these interfaces for Azure Storage services which allows you to interact with Azure Storage Blob and File Share using Spring programming model. It provides `spring-cloud-azure-starter-storage-blob` and `spring-cloud-azure-starter-storage-file-share` to autoconfigure Azure Storage Blob and Azure Storage File Share. .Azure Storage related libraries. [cols="2,1,5", options="header"] |=== |Starter |Service |Description |spring-cloud-azure-starter-storage-blob |Azure Storage Blob |Allows unstructured data to be stored and accessed at a massive scale in block blobs. |spring-cloud-azure-starter-storage-file-share |Azure Storage File Share |Offers fully managed cloud file shares that you can access from anywhere via the industry standard Server Message Block (SMB) protocol. |=== === Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-starter-storage-blob # <1> com.azure.spring spring-cloud-azure-starter-storage-file-share # <2> ---- <1> Only required when you're using Azure Storage Blob. <2> Only required when you're using Azure Storage File Share. TIP: We also provide `spring-cloud-azure-starter-storage` to support all the features of Storage. If you choose to use it, `spring.cloud.azure.storage.enable` is the property to configure, the default value is `true`. Then you can use `spring.cloud.azure.storage..enable` to disable unneeded services. === Configuration NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, 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. .Configurable properties of spring-cloud-azure-starter-storage-blob [cols="3,1,5", options="header"] |=== |Property |Default | Description |*spring.cloud.azure.storage.blob*.enabled |true |Whether to enable Azure Storage Blob. |*spring.cloud.azure.storage.blob*.endpoint | |Endpoint for Azure Storage Blob service. |*spring.cloud.azure.storage.blob*.account-key | |Private key to connect Azure Storage Blob. |*spring.cloud.azure.storage.blob*.account-name | |Azure Storage Blob account name. |=== .Configurable properties of spring-cloud-azure-starter-storage-file-share [cols="3,1,5", options="header"] |=== |Property | Default | Description |*spring.cloud.azure.storage.fileshare*.enabled |true |Whether to enable Azure Storage File Share. |*spring.cloud.azure.storage.fileshare*.endpoint | |Endpoint for Azure Storage File Share service. |*spring.cloud.azure.storage.fileshare*.account-key | |Private key to connect Azure Storage File Share. |*spring.cloud.azure.storage.fileshare*.account-name | |Azure Storage File Share account name. |=== === Basic Usage Provide the properties below in your configuration file. [source,yaml] ---- spring: cloud: azure: storage: blob: account-name: ${STORAGE_ACCOUNT_NAME} account-key: ${STORAGE_ACCOUNT_KEY} endpoint: ${STORAGE_BLOB_ENDPOINT} fileshare: account-name: ${STORAGE_ACCOUNT_NAME} account-key: ${STORAGE_ACCOUNT_KEY} endpoint: ${STORAGE_FILESHARE_ENDPOINT} ---- ==== Get a Resource ===== Get a Resource with @Value You can use the annotation of `@Value("azure-blob://[your-container-name]/[your-blob-name]")` to autowire a blob resource. [source,java] ---- @Value("azure-blob://[your-container-name]/[your-blob-name]") private Resource storageBlobResource; ---- You can use the annotation of @Value("azure-file://[your-fileshare-name]/[your-file-name]") to autowire a file resource. [source,java] ---- @Value("azure-file://[your-fileshare-name]/[your-file-name]") private Resource storageFileResource; ---- ===== Get a resource with ResourceLoader [source,java] ---- @Autowired private ResourceLoader resourceLoader; ... // get a BlobResource Resource storageBlobResource = resourceLoader.getResource("azure-blob://[your-container-name]/[your-blob-name]"); // get a FileResource Resource storageFileResource = resourceLoader.getResource("azure-file://[your-fileshare-name]/[your-file-name]"); ---- ===== Get Resources by Searching Pattern You can use implementation class of `ResourcePatternResolver` to search resources. Use `AzureStorageBlobProtocolResolver` to search `blob` resources, and `AzureStorageFileProtocolResolver` to search `file` resources. - Pattern search, the **searchPattern** should start with `azure-blob://` or `azure-file://`. Such as `azure-blob://+++**+++/+++**+++`, it means list all blobs in all containers; `azure-blob://demo-container/**`, it means list all blobs in the demo-container container, including any sub-folders. - Location search, the **searchLocation** should start with `azure-blob://` or `azure-file://`, the remaining file path should exist, otherwise an exception will be thrown. [source,java] ---- @Autowired private AzureStorageBlobProtocolResolver azureStorageBlobProtocolResolver; @Autowired private AzureStorageFileProtocolResolver azureStorageFileProtocolResolver; // get all text blobs Resource[] blobTextResources = azureStorageBlobProtocolResolver.getResources("azure-blob://[container-pattern]/*.txt"); // get all text files Resource[] fileTextResources = azureStorageFileProtocolResolver.getResources("azure-file://[fileshare-pattern]/*.txt"); ---- ==== Handling with Resource ===== Download Data from Specific Resource You can download a resource from Azure Stroage Blob or File Share with the `getInputStream()` method of `Resource`. [source,java] ---- @Value("azure-blob://[your-container-name]/[your-blob-name]") private Resource storageBlobResource; @Value("azure-file://[your-fileshare-name]/[your-file-name]") private Resource storageFileResource; .... // download data as stream from blob resource InputStream inputblobStream = storageBlobResource.getInputStream(); // download data as stream from file resource InputStream inputfileStream = storageFileResource.getInputStream(); ---- ===== Upload Data to Specific Resource You can upload to a resource to Azure Storage Blob or File Share by casting the Spring `Resource` to `WritableResource`. [source,java] ---- @Value("azure-blob://[your-container-name]/[your-blob-name]") private Resource storageBlobResource; @Value("azure-file://[your-fileshare-name]/[your-file-name]") private Resource storageFileResource; String data = "sampledata"; // upload string data to blob try (OutputStream blobos = ((WritableResource) this.storageBlobResource).getOutputStream()) { blobos.write(data.getBytes()); } // upload string data to file try (OutputStream fileos = ((WritableResource) this.storageFileResource).getOutputStream()) { fileos.write(data.getBytes()); } ---- ==== Multipart Upload Files larger than 4 MiB will be uploaded to Azure Storage in parallel. === Samples Please refer to link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/storage/spring-cloud-azure-starter-storage-blob/storage-blob-sample[storage-blob-sample] and link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/storage/spring-cloud-azure-starter-storage-file-share/storage-file-sample[storage-file-sample] for more details. ================================================ FILE: docs/src/main/asciidoc/resource-manager.adoc ================================================ [#spring-cloud-azure-resourcemanager] == Azure Resource Manager Azure Resource Manager (ARM) is the deployment and management service for Azure. It provides a management layer that enables you to create, update, and delete resources in your Azure account. Spring Cloud Azure Resource Manager can help provision resources or retrieve resource metadata. === Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-resourcemanager ---- === Configuration NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, 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. .Configurable properties of spring-cloud-azure-resourcemanager [cols="2*", options="header"] |=== |Property |Description |*spring.cloud.azure.resource-manager*.enabled |Whether the Resource Manager is enabled. Default is true. |*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*.client-certificate-path |Path of a PEM certificate file to use when performing service principal authentication with Azure. |*spring.cloud.azure.credential*.client-certificate-password |Password of the certificate file. |*spring.cloud.azure.credential*.username |Username to use when performing username/password authentication with Azure. |*spring.cloud.azure.credential*.password |Password to use when performing username/password authentication. |*spring.cloud.azure.credential*.managed-identity-enabled |Whether to enable managed identity. |*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 for authentication. |*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.*.namespace |The namespace of the Azure service to provision resources with. |*spring.cloud.azure.*.resource.resource-group |The resource group holding an Azure service resource. |=== [#resource-manager-basic-usage] === Basic Usage Spring Cloud Azure Resource Manager can work together with specific Spring Cloud Azure starters to retrieve connection information, such as connection strings, to connect to Azure services. It can also work together with `spring-cloud-azure-starter` and third-party libraries to retrieve metadata like username/password, and to complete authentication, For more information, see the <> and <> sections. For example, to retrieve the connection string of an Azure Service, developers can use a service principal as the credential to authenticate and retrieve the connection string. The configuration is listed the follows. The provided service principal should be assigned a role of `Contributor` of the associated namespace at least. See link:index.html#authorize-access-with-azure-active-directory[Authorize access with Azure AD] to make sure the principal has been granted the sufficient permission to access the Azure resource. [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} subscription-id: ${AZURE_SUBSCRIPTION_ID} : namespace: ${SERVICEBUS_NAMESPACE} resource: resource-group: ${RESOURCE_GROUP} ---- === Samples See link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}[azure-spring-boot-samples] for more details. ================================================ FILE: docs/src/main/asciidoc/secret-management.adoc ================================================ == Secret Management Spring Cloud Azure construct link:https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-property-source-abstraction[PropertySource] which holds secrets stored in Azure Key Vault Secrets. === Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-starter-keyvault-secrets ---- TIP: We also provide `spring-cloud-azure-starter-keyvault` to support all the features of Key Vault. If you choose to use it, `spring.cloud.azure.keyvault.enable` is the property to configure, the default value is `true`. Then you can use `spring.cloud.azure.keyvault..enable` to disable unneeded services. === Basic Usage If you want to authenticate by `client-id` and `client-secret`, the following properties are required: ==== Configuration Properties [source,yml] ---- spring: cloud: azure: keyvault: secret: property-sources: - name: key-vault-property-souece-1 endpoint: ${ENDPOINT_1} - name: key-vault-property-souece-2 endpoint: ${ENDPOINT_2} ---- ==== Java Code [source,java] ---- @SpringBootApplication public class SampleApplication implements CommandLineRunner { @Value("${sampleProperty1}") private String sampleProperty1; @Value("${sampleProperty2}") private String sampleProperty2; @Value("${samplePropertyInMultipleKeyVault}") private String samplePropertyInMultipleKeyVault; public static void main(String[] args) { SpringApplication.run(SampleApplication.class, args); } public void run(String[] args) { System.out.println("sampleProperty1: " + sampleProperty1); System.out.println("sampleProperty2: " + sampleProperty2); System.out.println("samplePropertyInMultipleKeyVault: " + samplePropertyInMultipleKeyVault); } } ---- === Advanced Usage ==== Special Characters in Property Name 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. `.` 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_`. ==== Case Sensitive By default, the secret names are case-insensitive. To enable case-sensitive mode, just set the following property: `spring.cloud.azure.keyvault.secret.property-sources[].case-sensitive=true`. ==== Not Retrieve All Secrets In Key Vault If you stored 1000 secrets in the Key Vault, and you just want to use 3 of them. You can list the 3 secret names by `spring.cloud.azure.keyvault.secret.property-sources[].secret-keys`. ==== 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. ==== PropertySource Priority If key exists in multiple PropertySources, which will take effect is decided by the priority. - 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 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 .Configurable properties of Key Vault Secret PropertySource [cols="<45,<5,<50", options="header"] |=== | Property | Default value | Description | *spring.cloud.azure.keyvault.secret*.property-source-enabled | true | Whether to enable the Key Vault property source. | *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 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. | *spring.cloud.azure.keyvault.secret*.property-sources[].credential | | Credential related properties. | *spring.cloud.azure.keyvault.secret*.property-sources[].profile | | Profile related properties. | *spring.cloud.azure.keyvault.secret*.property-sources[].proxy | | Proxy related properties. | *spring.cloud.azure.keyvault.secret*.property-sources[].retry | | Retry related properties. |=== - See 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` aren't configured in `spring.cloud.azure.keyvault.secret.property-sources[].xxx`, `spring.cloud.azure.xxx` will be used. See link:index.html#configuration[Configuration] to get more information about these common properties. - See 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]. ================================================ FILE: docs/src/main/asciidoc/spring-cloud-stream-support.adoc ================================================ :content-type-negotiation: https://docs.spring.io/spring-cloud-stream/docs/current/reference/html/spring-cloud-stream.html#content-type-management == Spring Cloud Stream Support Spring Cloud Stream is a framework for building highly scalable event-driven microservices connected with shared messaging systems. The framework provides a flexible programming model built on already established and familiar Spring idioms and best practices, including support for persistent pub/sub semantics, consumer groups, and stateful partitions. Current binder implementations include: * spring-cloud-azure-stream-binder-eventhubs * spring-cloud-azure-stream-binder-servicebus === Spring Cloud Stream Binder for Azure Event Hubs ==== Key Concepts The Spring Cloud Stream Binder for Azure Event Hubs provides the binding implementation for the Spring Cloud Stream framework. This implementation uses Spring Integration Event Hubs Channel Adapters at its foundation. From design's perspective, Event Hubs is similar as Kafka. Also, Event Hubs could be accessed via Kafka API. If your project has tight dependency on Kafka API, you can try link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/eventhubs/spring-cloud-azure-starter/spring-cloud-azure-sample-eventhubs-kafka[Events Hub with Kafka API Sample] ===== Consumer Group Event Hubs provides similar support of consumer group as Apache Kafka, but with slight different logic. While Kafka stores all committed offsets in the broker, you have to store offsets of Event Hubs messages being processed manually. Event Hubs SDK provides the function to store such offsets inside Azure Storage. ===== Partitioning Support Event Hubs provides a similar concept of physical partition as Kafka. But unlike Kafka's auto re-balancing between consumers and partitions, Event Hubs provides a kind of preemptive mode. The storage account acts as a lease to determine which partition is owned by which consumer. When a new consumer starts, it will try to steal some partitions from most heavy-loaded consumers to achieve the workload balancing. To specify the load balancing strategy, properties of `spring.cloud.stream.eventhubs.bindings..consumer.load-balancing.*` are provided. See <> for more details. ===== Batch Consumer Support Spring Cloud Azure Stream Event Hubs binder supports link:https://docs.spring.io/spring-cloud-stream/docs/current/reference/html/spring-cloud-stream.html#_batch_consumers[Spring Cloud Stream Batch Consumer feature]. To work with the batch-consumer mode, the property of `spring.cloud.stream.bindings..consumer.batch-mode` should be set as `true`. When enabled, an **Message** of which the payload is a list of batched events will be received and passed to the `Consumer` function. Each message header is also converted as a list, of which the content is the associated header value parsed from each event. For the communal headers of partition id, checkpointer and last enqueued properties, they are presented as a single value for the entire batch of events shares the same one. See <> for more details. NOTE: The checkpoint header only exists when **MANUAL** checkpoint mode is used. Checkpointing of batch consumer supports two modes: `BATCH` and `MANUAL`. `BATCH` mode is an auto checkpointing mode to checkpoint the entire batch of events together once they are received by the binder. `MANUAL` mode is to checkpoint the events by users. When used, the **Checkpointer** will be passed into the message header, and users could use it to do checkpointing. The batch size can be specified by properties of `max-size` and `max-wait-time` with prefix as `spring.cloud.stream.eventhubs.bindings..consumer.batch.`, where `max-size` is a necessary property while `max-wait-time` is optional. See <> for more details. ==== Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-stream-binder-eventhubs ---- Alternatively, you can also use the Spring Cloud Azure Stream Event Hubs Starter, as shown in the following example for Maven: [source,xml] ---- com.azure.spring spring-cloud-azure-starter-stream-eventhubs ---- ==== Configuration The binder provides the following 3 parts of configuration options: [#eventhubs-connection-configuration] ===== Connection Configuration Properties This section contains the configuration options used for connecting to Azure Event Hubs. NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, See 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. .Connection configurable properties of spring-cloud-azure-stream-binder-eventhubs [cols="<,<,<", options="header"] |=== |Property | Type |Description |*spring.cloud.azure.eventhubs*.enabled | boolean | Whether an Azure Event Hubs is enabled. |*spring.cloud.azure.eventhubs*.connection-string | String | Event Hubs Namespace connection string value. |*spring.cloud.azure.eventhubs*.namespace | String | Event Hubs Namespace value, which is the prefix of the FQDN. A FQDN should be composed of . |*spring.cloud.azure.eventhubs*.domain-name | String | Domain name of an Azure Event Hubs Namespace value. |*spring.cloud.azure.eventhubs*.custom-endpoint-address | String | Custom Endpoint address. |=== TIP: Common Azure Service SDK configuration options are configurable for the Spring Cloud Azure Stream Event Hubs binder as well. The supported configuration options are introduced in link:configuration.html[the Configuration page], and could be configured with either the unified prefix `spring.cloud.azure.` or the prefix of `spring.cloud.azure.eventhubs.`. The binder also supports link:index.html#spring-cloud-azure-resourcemanager[Spring Could Azure Resource Manager] by default. To learn about how to retrieve the connection string with security principals that are not granted with `Data` related roles, see the link:index.html#resource-manager-basic-usage[resource manager example] for details. ===== Checkpoint Configuration Properties This section contains the configuration options for the Storage Blobs service, which is used for persisting partition ownership and checkpoint information. NOTE: From version 4.0.0, when the property of **spring.cloud.azure.eventhubs.processor.checkpoint-store.create-container-if-not-exists** is not enabled manually, no Storage container will be created automatically with the name from **spring.cloud.stream.bindings..destination**. .Checkpointing configurable properties of spring-cloud-azure-stream-binder-eventhubs [cols="<,<,<", options="header"] |=== |Property | Type |Description |*spring.cloud.azure.eventhubs.processor.checkpoint-store*.create-container-if-not-exists |Boolean |Whether to allow creating containers if not exists. |*spring.cloud.azure.eventhubs.processor.checkpoint-store*.account-name | String | Name for the storage account. |*spring.cloud.azure.eventhubs.processor.checkpoint-store*.account-key | String | Storage account access key. |*spring.cloud.azure.eventhubs.processor.checkpoint-store*.container-name | String | Storage container name. |=== TIP: Common Azure Service SDK configuration options are configurable for Storage Blob checkpoint store as well. The supported configuration options are introduced in link:configuration.html[the Configuration page], and could be configured with either the unified prefix `spring.cloud.azure.` or the prefix of `spring.cloud.azure.eventhubs.processor.checkpoint-store`. ===== Azure Event Hubs Binding Configuration Properties The following options are divided into four sections: Consumer Properties, Advanced Consumer Configurations, Producer Properties and Advanced Producer Configurations. [#eventhubs-consumer-properties] ====== Consumer Properties These properties are exposed via `EventHubsConsumerProperties`. .Consumer configurable properties of spring-cloud-azure-stream-binder-eventhubs [cols="<,<,<", options="header"] |=== |Property | Type |Description |*spring.cloud.stream.eventhubs.bindings..consumer*.checkpoint.mode |CheckpointMode | Checkpoint mode used when consumer decide how to checkpoint message |*spring.cloud.stream.eventhubs.bindings..consumer*.checkpoint.count | Integer |Decides the amount of message for each partition to do one checkpoint. Will take effect only when `PARTITION_COUNT` checkpoint mode is used. |*spring.cloud.stream.eventhubs.bindings..consumer*.checkpoint.interval | Duration |Decides the time interval to do one checkpoint. Will take effect only when `TIME` checkpoint mode is used. |*spring.cloud.stream.eventhubs.bindings..consumer*.batch.max-size | Integer | The maximum number of events in a batch. Required for the batch-consumer mode. |*spring.cloud.stream.eventhubs.bindings..consumer*.batch.max-wait-time | Duration | The maximum time duration for batch consuming. Will take effect only when the batch-consumer mode is enabled and is optional. |*spring.cloud.stream.eventhubs.bindings..consumer*.load-balancing.update-interval | Duration | The interval time duration for updating. |*spring.cloud.stream.eventhubs.bindings..consumer*.load-balancing.strategy |LoadBalancingStrategy |The load balancing strategy. |*spring.cloud.stream.eventhubs.bindings..consumer*.load-balancing.partition-ownership-expiration-interval |Duration |The time duration after which the ownership of partition expires. |*spring.cloud.stream.eventhubs.bindings..consumer*.track-last-enqueued-event-properties |Boolean |Whether the event processor should request information on the last enqueued event on its associated partition, and track that information as events are received. |*spring.cloud.stream.eventhubs.bindings..consumer*.prefetch-count |Integer |The count used by the consumer to control the number of events the Event Hub consumer will actively receive and queue locally. |*spring.cloud.stream.eventhubs.bindings..consumer*.initial-partition-event-position |Map with the key as the partition id, and values of `StartPositionProperties` |The map containing the event position to use for each partition if a checkpoint for the partition does not exist in checkpoint store. This map is keyed off of the partition id. |=== NOTE: The `initial-partition-event-position` configuration accepts a `map` to specify the initial position for each event hub. Thus, its key is the partition id, and the value is of `StartPositionProperties` which includes properties of offset, sequence number, enqueued date time and whether inclusive. For example, you can set it as [source,yaml] ---- spring: cloud: stream: eventhubs: bindings: : consumer: initial-partition-event-position: 0: offset: earliest 1: sequence-number: 100 2: enqueued-date-time: 2022-01-12T13:32:47.650005Z 4: inclusive: false ---- ====== Advanced Consumer Configuration The above <>, <> and <> configuration are supported to be customized for each binder consumer, which can be configured with the prefix `spring.cloud.stream.eventhubs.bindings..consumer.`. ====== Producer Properties These properties are exposed via `EventHubsProducerProperties`. .Producer configurable properties of spring-cloud-azure-stream-binder-eventhubs [cols="<,<,<", options="header"] |=== |Property | Type |Description |*spring.cloud.stream.eventhubs.bindings..producer*.sync | boolean |The switch flag for sync of producer. If true, the producer will wait for a response after a send operation. |*spring.cloud.stream.eventhubs.bindings..producer*.send-timeout | long |The amount of time to wait for a response after a send operation. Will take effect only when a sync producer is enabled. |=== ====== Advanced Producer Configuration The above <> and <> configuration are supported to be customized for each binder producer, which can be configured with the prefix `spring.cloud.stream.eventhubs.bindings..producer.`. ==== Basic Usage ===== Sending and Receiving Messages from/to Event Hubs Step 1. Fill the configuration options with credential information. - For credentials as connection string, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: eventhubs: connection-string: ${EVENTHUB_NAMESPACE_CONNECTION_STRING} processor: checkpoint-store: container-name: ${CHECKPOINT_CONTAINER} account-name: ${CHECKPOINT_STORAGE_ACCOUNT} account-key: ${CHECKPOINT_ACCESS_KEY} stream: function: definition: consume;supply bindings: consume-in-0: destination: ${EVENTHUB_NAME} group: ${CONSUMER_GROUP} supply-out-0: destination: ${THE_SAME_EVENTHUB_NAME_AS_ABOVE} eventhubs: bindings: consume-in-0: consumer: checkpoint: mode: MANUAL ---- - For credentials as service principal, configure the following properties in application.yml: [source, yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} eventhubs: namespace: ${EVENTHUB_NAMESPACE} processor: checkpoint-store: container-name: ${CONTAINER_NAME} account-name: ${ACCOUNT_NAME} stream: function: definition: consume;supply bindings: consume-in-0: destination: ${EVENTHUB_NAME} group: ${CONSUMER_GROUP} supply-out-0: destination: ${THE_SAME_EVENTHUB_NAME_AS_ABOVE} eventhubs: bindings: consume-in-0: consumer: checkpoint: mode: MANUAL ---- - For credentials as managed identites, configure the following properties in application.yml: [source, yaml] ---- spring: cloud: azure: credential: managed-identity-enabled: true client-id: ${AZURE_MANAGED_IDENTITY_CLIENT_ID} # Only needed when using a user-assigned managed identity eventhubs: namespace: ${EVENTHUB_NAMESPACE} processor: checkpoint-store: container-name: ${CONTAINER_NAME} account-name: ${ACCOUNT_NAME} stream: function: definition: consume;supply bindings: consume-in-0: destination: ${EVENTHUB_NAME} group: ${CONSUMER_GROUP} supply-out-0: destination: ${THE_SAME_EVENTHUB_NAME_AS_ABOVE} eventhubs: bindings: consume-in-0: consumer: checkpoint: mode: MANUAL ---- Step2. Define supplier and consumer. [source,java] ---- @Bean public Consumer> consume() { return message -> { Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER); LOGGER.info("New message received: '{}', partition key: {}, sequence number: {}, offset: {}, enqueued time: {}", message.getPayload(), message.getHeaders().get(EventHubsHeaders.PARTITION_KEY), message.getHeaders().get(EventHubsHeaders.SEQUENCE_NUMBER), message.getHeaders().get(EventHubsHeaders.OFFSET), message.getHeaders().get(EventHubsHeaders.ENQUEUED_TIME) ); checkpointer.success() .doOnSuccess(success -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload())) .doOnError(error -> LOGGER.error("Exception found", error)) .block(); }; } @Bean public Supplier> supply() { return () -> { LOGGER.info("Sending message, sequence " + i); return MessageBuilder.withPayload("Hello world, " + i++).build(); }; } ---- ===== Partitioning Support A `PartitionSupplier` with user-provided partition information will be created to configure the partition information about the message to be sent, the following is the process of obtaining different priorities of the partition ID and key: image:https://user-images.githubusercontent.com/63028776/145347877-fa8afa90-ec28-4c0a-8277-63b9fdaa5d0f.png[] ===== Batch Consumer Support Step 1. Fill the batch configuration options [source,yaml] ---- spring: cloud: stream: function: definition: consume bindings: consume-in-0: destination: ${AZURE_EVENTHUB_NAME} group: ${AZURE_EVENTHUB_CONSUMER_GROUP} consumer: batch-mode: true eventhubs: bindings: consume-in-0: consumer: batch: max-batch-size: 10 # Required for batch-consumer mode max-wait-time: 1m # Optional, the default value is null checkpoint: mode: BATCH # or MANUAL as needed ---- Step2. Define supplier and consumer. For checkpointing mode as `BATCH`, you can use the following code to send messages and consume in batches. [source,java] ---- @Bean public Consumer>> consume() { return message -> { for (int i = 0; i < message.getPayload().size(); i++) { LOGGER.info("New message received: '{}', partition key: {}, sequence number: {}, offset: {}, enqueued time: {}", message.getPayload().get(i), ((List) message.getHeaders().get(EventHubsHeaders.BATCH_CONVERTED_PARTITION_KEY)).get(i), ((List) message.getHeaders().get(EventHubsHeaders.BATCH_CONVERTED_SEQUENCE_NUMBER)).get(i), ((List) message.getHeaders().get(EventHubsHeaders.BATCH_CONVERTED_OFFSET)).get(i), ((List) message.getHeaders().get(EventHubsHeaders.BATCH_CONVERTED_ENQUEUED_TIME)).get(i)); } }; } @Bean public Supplier> supply() { return () -> { LOGGER.info("Sending message, sequence " + i); return MessageBuilder.withPayload("\"test"+ i++ +"\"").build(); }; } ---- For checkpointing mode as `MANUAL`, you can use the following code to send messages and consume/checkpoint in batches. [source,java] ---- @Bean public Consumer>> consume() { return message -> { for (int i = 0; i < message.getPayload().size(); i++) { LOGGER.info("New message received: '{}', partition key: {}, sequence number: {}, offset: {}, enqueued time: {}", message.getPayload().get(i), ((List) message.getHeaders().get(EventHubHeaders.BATCH_CONVERTED_PARTITION_KEY)).get(i), ((List) message.getHeaders().get(EventHubHeaders.BATCH_CONVERTED_SEQUENCE_NUMBER)).get(i), ((List) message.getHeaders().get(EventHubHeaders.BATCH_CONVERTED_OFFSET)).get(i), ((List) message.getHeaders().get(EventHubHeaders.BATCH_CONVERTED_ENQUEUED_TIME)).get(i)); } Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER); checkpointer.success() .doOnSuccess(success -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload())) .doOnError(error -> LOGGER.error("Exception found", error)) .block(); }; } @Bean public Supplier> supply() { return () -> { LOGGER.info("Sending message, sequence " + i); return MessageBuilder.withPayload("\"test"+ i++ +"\"").build(); }; } ---- NOTE: In the batch-consuming mode, the default content type of Spring Cloud Stream binder is `application/json`, so make sure the message payload is aligned with the content type. For example, when using the default content type of `application/json` to receive messages with `String` payload, the payload should be JSON String, surrounded with double quotes for the original String text. While for `text/plain` content type, it can be a `String` object directly. For more details, see the official doc of {content-type-negotiation}[Spring Cloud Stream Content Type Negotiation]. ===== Error Channels - Consumer error channel This channel is open by default, you can handle the error message in this way: [source,java] ---- // Replace destination with spring.cloud.stream.bindings.input.destination // Replace group with spring.cloud.stream.bindings.input.group @ServiceActivator(inputChannel = "{destination}.{group}.errors") public void consumerError(Message message) { LOGGER.error("Handling customer ERROR: " + message); } ---- - Producer error channel This channel is not open by default. You need to add a configuration in your application.properties to enable it, like this: [source,properties] ---- spring.cloud.stream.default.producer.errorChannelEnabled=true ---- You can handle the error message in this way: [source,java] ---- // Replace destination with spring.cloud.stream.bindings.output.destination @ServiceActivator(inputChannel = "{destination}.errors") public void producerError(Message message) { LOGGER.error("Handling Producer ERROR: " + message); } ---- - Global default error channel A global error channel called "errorChannel" is created by default Spring Integration, which allows users to subscribe many endpoints to it. [source,java] ---- @ServiceActivator(inputChannel = "errorChannel") public void producerError(Message message) { LOGGER.error("Handling ERROR: " + message); } ---- [#scs-eh-headers] ===== Event Hubs Message Headers See the <> for the basic message headers supported. ===== 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 the following properties in application.yml [source,yaml] ---- spring: cloud: stream: function: definition: consume1;supply1;consume2;supply2 bindings: consume1-in-0: destination: ${EVENTHUB_NAME_01} group: ${CONSUMER_GROUP_01} supply1-out-0: destination: ${THE_SAME_EVENTHUB_NAME_01_AS_ABOVE} consume2-in-0: binder: eventhub-2 destination: ${EVENTHUB_NAME_02} group: ${CONSUMER_GROUP_02} supply2-out-0: binder: eventhub-2 destination: ${THE_SAME_EVENTHUB_NAME_02_AS_ABOVE} binders: eventhub-1: type: eventhubs default-candidate: true environment: spring: cloud: azure: eventhubs: connection-string: ${EVENTHUB_NAMESPACE_01_CONNECTION_STRING} processor: checkpoint-store: container-name: ${CHECKPOINT_CONTAINER_01} account-name: ${CHECKPOINT_STORAGE_ACCOUNT} account-key: ${CHECKPOINT_ACCESS_KEY} eventhub-2: type: eventhubs default-candidate: false environment: spring: cloud: azure: eventhubs: connection-string: ${EVENTHUB_NAMESPACE_02_CONNECTION_STRING} processor: checkpoint-store: container-name: ${CHECKPOINT_CONTAINER_02} account-name: ${CHECKPOINT_STORAGE_ACCOUNT} account-key: ${CHECKPOINT_ACCESS_KEY} eventhubs: bindings: consume1-in-0: consumer: checkpoint: mode: MANUAL consume2-in-0: consumer: checkpoint: mode: MANUAL poller: initial-delay: 0 fixed-delay: 1000 ---- Step 2. we need define two suppliers and two consumers [source,java] ---- @Bean public Supplier> supply1() { return () -> { LOGGER.info("Sending message1, sequence1 " + i); return MessageBuilder.withPayload("Hello world1, " + i++).build(); }; } @Bean public Supplier> supply2() { return () -> { LOGGER.info("Sending message2, sequence2 " + j); return MessageBuilder.withPayload("Hello world2, " + j++).build(); }; } @Bean public Consumer> consume1() { return message -> { Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER); LOGGER.info("New message1 received: '{}'", message); checkpointer.success() .doOnSuccess(success -> LOGGER.info("Message1 '{}' successfully checkpointed", message)) .doOnError(error -> LOGGER.error("Exception found", error)) .block(); }; } @Bean public Consumer> consume2() { return message -> { Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER); LOGGER.info("New message2 received: '{}'", message); checkpointer.success() .doOnSuccess(success -> LOGGER.info("Message2 '{}' successfully checkpointed", message)) .doOnError(error -> LOGGER.error("Exception found", error)) .block(); }; } ---- ===== Resource Provision Event Hubs binder supports provisioning of event hub and consumer group, users could use the following properties to enable provisioning. [source,yaml] ---- spring: cloud: azure: credential: tenant-id: ${AZURE_TENANT_ID} profile: subscription-id: ${AZURE_SUBSCRIPTION_ID} eventhubs: resource: resource-group: ${AZURE_EVENTHUBS_RESOURECE_GROUP} ---- ==== Samples See link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/eventhubs/spring-cloud-azure-stream-binder-eventhubs[azure-spring-boot-samples] for more details. === Spring Cloud Stream Binder for Azure Service Bus ==== Key Concepts The Spring Cloud Stream Binder for Azure Service Bus provides the binding implementation for the Spring Cloud Stream Framework. This implementation uses Spring Integration Service Bus Channel Adapters at its foundation. ===== Scheduled Message This binder supports submitting messages to a topic for delayed processing. Users can send scheduled messages with header `x-delay` expressing in milliseconds a delay time for the message. The message will be delivered to the respective topics after `x-delay` milliseconds. ===== Consumer Group Service Bus Topic provides similar support of consumer group as Apache Kafka, but with slight different logic. This binder relies on `Subscription` of a topic to act as a consumer group. ==== Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-stream-binder-servicebus ---- Alternatively, you can also use the Spring Cloud Azure Stream Service Bus Starter, as shown in the following example for Maven: [source,xml] ---- com.azure.spring spring-cloud-azure-starter-stream-servicebus ---- ==== Configuration The binder provides the following 2 parts of configuration options: [#servicebus-connection-configuration] ===== Connection Configuration Properties This section contains the configuration options used for connecting to Azure Service Bus. NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, see 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. .Connection configurable properties of spring-cloud-azure-stream-binder-servicebus [cols="<,<,<", options="header"] |=== |Property | Type |Description |*spring.cloud.azure.servicebus*.enabled | boolean | Whether an Azure Service Bus is enabled. |*spring.cloud.azure.servicebus*.connection-string | String | Service Bus Namespace connection string value. |*spring.cloud.azure.servicebus*.namespace | String | Service Bus Namespace value, which is the prefix of the FQDN. A FQDN should be composed of . |*spring.cloud.azure.servicebus*.domain-name | String | Domain name of an Azure Service Bus Namespace value. |=== TIP: Common Azure Service SDK configuration options are configurable for the Spring Cloud Azure Stream Service Bus binder as well. The supported configuration options are introduced in link:configuration.html[the Configuration page], and could be configured with either the unified prefix `spring.cloud.azure.` or the prefix of `spring.cloud.azure.servicebus.`. The binder also supports link:index.html#spring-cloud-azure-resourcemanager[Spring Could Azure Resource Manager] by default. To learn about how to retrieve the connection string with security principals that are not granted with `Data` related roles, see the link:index.html#resource-manager-basic-usage[resource manager example] for details. ===== Azure Service Bus Binding Configuration Properties The following options are divided into four sections: Consumer Properties, Advanced Consumer Configurations, Producer Properties and Advanced Producer Configurations. ====== Consumer Properties These properties are exposed via `ServiceBusConsumerProperties`. .Consumer configurable properties of spring-cloud-azure-stream-binder-servicebus [cols="<,<,<,<", options="header"] |=== |Property | Type |Default |Description |*spring.cloud.stream.servicebus.bindings..consumer*.requeue-rejected |boolean |false |If the failed messages are routed to the DLQ. |*spring.cloud.stream.servicebus.bindings..consumer*.max-concurrent-calls | Integer | 1 | Max concurrent messages that the Service Bus processor client should process. |*spring.cloud.stream.servicebus.bindings..consumer*.max-concurrent-sessions |Integer |null | Maximum number of concurrent sessions to process at any given time. |*spring.cloud.stream.servicebus.bindings..consumer*.session-enabled | Boolean | null | Whether session is enabled. |*spring.cloud.stream.servicebus.bindings..consumer*.prefetch-count | Integer | 0 | The prefetch count of the Service Bus processor client. |*spring.cloud.stream.servicebus.bindings..consumer*.sub-queue | SubQueue | none | The type of the sub queue to connect to. |*spring.cloud.stream.servicebus.bindings..consumer*.max-auto-lock-renew-duration | Duration | 5m | The amount of time to continue auto-renewing the lock. |*spring.cloud.stream.servicebus.bindings..consumer*.receive-mode | ServiceBusReceiveMode | peek_lock | The receive mode of the Service Bus processor client. |*spring.cloud.stream.servicebus.bindings..consumer*.auto-complete | Boolean | true | Whether to settle messages automatically. If set as false, a message header of `Checkpointer` will be added to enable developers to settle messages manually. |=== ====== Advanced Consumer Configuration The above <> and <> configuration are supported to be customized for each binder consumer, which can be configured with the prefix `spring.cloud.stream.servicebus.bindings..consumer.`. ====== Producer Properties These properties are exposed via `ServiceBusProducerProperties`. .Producer configurable properties of spring-cloud-azure-stream-binder-servicebus [cols="<,<,<,<", options="header"] |=== |Property | Type | Default |Description |*spring.cloud.stream.servicebus.bindings..producer*.sync |boolean |false | Switch flag for sync of producer. |*spring.cloud.stream.servicebus.bindings..producer*.send-timeout |long |10000 | Timeout value for sending of producer. |*spring.cloud.stream.servicebus.bindings..producer*.entity-type |ServiceBusEntityType |null | Service Bus entity type of the producer, required for the binding producer. |=== IMPORTANT: When using the binding producer, property of `spring.cloud.stream.servicebus.bindings..producer.entity-type` is required to be configured. ====== Advanced Producer Configuration The above <> and <> configuration are supported to be customized for each binder producer, which can be configured with the prefix `spring.cloud.stream.servicebus.bindings..producer.`. ==== Basic Usage ===== Sending and Receiving Messages from/to Service Bus Step 1. Fill the configuration options with credential information. - For credentials as connection string, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: servicebus: connection-string: ${SERVICEBUS_NAMESPACE_CONNECTION_STRING} stream: function: definition: consume;supply bindings: consume-in-0: destination: ${SERVICEBUS_ENTITY_NAME} # If you use Service Bus Topic, please add the following configuration # group: ${SUBSCRIPTION_NAME} supply-out-0: destination: ${SERVICEBUS_ENTITY_NAME_SAME_AS_ABOVE} servicebus: bindings: consume-in-0: consumer: auto-complete: false supply-out-0: producer: entity-type: queue # set as "topic" if you use Service Bus Topic ---- - For credentials as service principal, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} servicebus: namespace: ${SERVICEBUS_NAMESPACE} stream: function: definition: consume;supply bindings: consume-in-0: destination: ${SERVICEBUS_ENTITY_NAME} # If you use Service Bus Topic, please add the following configuration # group: ${SUBSCRIPTION_NAME} supply-out-0: destination: ${SERVICEBUS_ENTITY_NAME_SAME_AS_ABOVE} servicebus: bindings: consume-in-0: consumer: auto-complete: false supply-out-0: producer: entity-type: queue # set as "topic" if you use Service Bus Topic ---- - For credentials as managed identities, configure the following properties in application.yml: [source, yaml] ---- spring: cloud: azure: credential: managed-identity-enabled: true client-id: ${MANAGED_IDENTITY_CLIENT_ID} # Only needed when using a user-assigned managed identity servicebus: namespace: ${SERVICEBUS_NAMESPACE} stream: function: definition: consume;supply bindings: consume-in-0: destination: ${SERVICEBUS_ENTITY_NAME} # If you use Service Bus Topic, please add the following configuration # group: ${SUBSCRIPTION_NAME} supply-out-0: destination: ${SERVICEBUS_ENTITY_NAME_SAME_AS_ABOVE} servicebus: bindings: consume-in-0: consumer: auto-complete: false supply-out-0: producer: entity-type: queue # set as "topic" if you use Service Bus Topic ---- Step 2. Define supplier and consumer. [source,java] ---- @Bean public Consumer> consume() { return message -> { Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER); LOGGER.info("New message received: '{}'", message.getPayload()); checkpointer.success() .doOnSuccess(success -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload())) .doOnError(error -> LOGGER.error("Exception found", error)) .block(); }; } @Bean public Supplier> supply() { return () -> { LOGGER.info("Sending message, sequence " + i); return MessageBuilder.withPayload("Hello world, " + i++).build(); }; } ---- ===== Partition Key Support 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..producer.partition-key-expression`. For example, setting this property as `"'partitionKey-' + headers[<message-header-key>]"` and add a header called . 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] ---- @Bean public Supplier> generate() { return () -> { String value = “random payload”; return MessageBuilder.withPayload(value) .setHeader("", value.length() % 4) .build(); }; } ---- ===== Session Support The binder supports link:https://docs.microsoft.com/azure/service-bus-messaging/message-sessions[message sessions] of Service Bus. Session id of a message could be set via the message header. [source,java] ---- @Bean public Supplier> generate() { return () -> { String value = “random payload”; return MessageBuilder.withPayload(value) .setHeader(ServiceBusMessageHeaders.SESSION_ID, "Customize session id") .build(); }; } ---- NOTE: According to link:https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning[Service Bus partitioning], session id has higher priority than partition key. So when both of `ServiceBusMessageHeaders#SESSION_ID` and `ServiceBusMessageHeaders#PARTITION_KEY` (or `AzureHeaders#PARTITION_KEY`) headers are set, the value of the session id will eventually be used to overwrite the value of the partition key. ===== Error Channels - Consumer error channel This channel is open by default, and a default consumer error channel handler is used to send failed messages to the dead-letter queue when `spring.cloud.stream.servicebus.bindings..consumer.requeue-rejected` is enabled, otherwise the failed messages will be abandoned. To customize the consumer error channel handler, you can register you own error handler to the related consumer error channel in this way: [source,java] ---- // Replace destination with spring.cloud.stream.bindings.input.destination // Replace group with spring.cloud.stream.bindings.input.group @ServiceActivator(inputChannel = "{destination}.{group}.errors") public void consumerError(Message message) { LOGGER.error("Handling customer ERROR: " + message); } ---- - Producer error channel This channel is not open by default. You need to add a configuration in your application.properties to enable it, like this: [source,properties] ---- spring.cloud.stream.default.producer.errorChannelEnabled=true ---- You can handle the error message in this way: [source,java] ---- // Replace destination with spring.cloud.stream.bindings.output.destination @ServiceActivator(inputChannel = "{destination}.errors") public void producerError(Message message) { LOGGER.error("Handling Producer ERROR: " + message); } ---- - Global default error channel A global error channel called "errorChannel" is created by default Spring Integration, which allows users to subscribe many endpoints to it. [source,java] ---- @ServiceActivator(inputChannel = "errorChannel") public void producerError(Message message) { LOGGER.error("Handling ERROR: " + message); } ---- [#scs-sb-headers] ===== Service Bus Message Headers See the <> for the basic message headers supported. NOTE: When setting the partiton key, the priority of message header is higher than Spring Cloud Stream property. So `spring.cloud.stream.bindings..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. ===== 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 the following properties in application.yml [source,yaml] ---- spring: cloud: stream: function: definition: consume1;supply1;consume2;supply2 bindings: consume1-in-0: destination: ${SERVICEBUS_TOPIC_NAME} group: ${SUBSCRIPTION_NAME} supply1-out-0: destination: ${SERVICEBUS_TOPIC_NAME_SAME_AS_ABOVE} consume2-in-0: binder: servicebus-2 destination: ${SERVICEBUS_QUEUE_NAME} supply2-out-0: binder: servicebus-2 destination: ${SERVICEBUS_QUEUE_NAME_SAME_AS_ABOVE} binders: servicebus-1: type: servicebus default-candidate: true environment: spring: cloud: azure: servicebus: connection-string: ${SERVICEBUS_NAMESPACE_01_CONNECTION_STRING} servicebus-2: type: servicebus default-candidate: false environment: spring: cloud: azure: servicebus: connection-string: ${SERVICEBUS_NAMESPACE_02_CONNECTION_STRING} servicebus: bindings: consume1-in-0: consumer: auto-complete: false supply1-out-0: producer: entity-type: topic consume2-in-0: consumer: auto-complete: false supply2-out-0: producer: entity-type: queue poller: initial-delay: 0 fixed-delay: 1000 ---- Step 2. we need define two suppliers and two consumers [source,java] ---- @Bean public Supplier> supply1() { return () -> { LOGGER.info("Sending message1, sequence1 " + i); return MessageBuilder.withPayload("Hello world1, " + i++).build(); }; } @Bean public Supplier> supply2() { return () -> { LOGGER.info("Sending message2, sequence2 " + j); return MessageBuilder.withPayload("Hello world2, " + j++).build(); }; } @Bean public Consumer> consume1() { return message -> { Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER); LOGGER.info("New message1 received: '{}'", message); checkpointer.success() .doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload())) .doOnError(e -> LOGGER.error("Error found", e)) .block(); }; } @Bean public Consumer> consume2() { return message -> { Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER); LOGGER.info("New message2 received: '{}'", message); checkpointer.success() .doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload())) .doOnError(e -> LOGGER.error("Error found", e)) .block(); }; } ---- ===== Resource Provision Service bus binder supports provisioning of queue, topic and subscription, users could use the following properties to enable provisioning. [source,yaml] ---- spring: cloud: azure: credential: tenant-id: ${AZURE_TENANT_ID} profile: subscription-id: ${AZURE_SUBSCRIPTION_ID} servicebus: resource: resource-group: ${AZURE_SERVICEBUS_RESOURECE_GROUP} stream: servicebus: bindings: : consumer: entity-type: ${SERVICEBUS_CONSUMER_ENTITY_TYPE} ---- ==== Samples See link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/servicebus/spring-cloud-azure-stream-binder-servicebus[azure-spring-boot-samples] for more details. ================================================ FILE: docs/src/main/asciidoc/spring-data-support.adoc ================================================ == Spring Data Support === Spring Data CosmosDB Support 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. === Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-starter-data-cosmos ---- === Configuration NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, 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. .Configurable properties of spring-cloud-azure-starter-data-cosmos [cols="2,1,3", options="header"] |=== |Property | Default | Description |*spring.cloud.azure.cosmos*.enabled |true |Whether Azure Cosmos Service is enabled. |*spring.cloud.azure.cosmos*.database | |The Cosmos DB database id. |*spring.cloud.azure.cosmos*.endpoint | |Uri to connect Cosmos DB. |*spring.cloud.azure.cosmos*.key | |Private key to connect Cosmos DB. |*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. |*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*.populate-query-metrics |false |Populate Diagnostics Strings and Query metrics. |*spring.cloud.azure.cosmos*.consistency-level | | link:https://docs.microsoft.com/azure/cosmos-db/consistency-levels[Consistency levels] in Azure Cosmos DB. |=== === Key Concepts * Spring Data CrudRepository and ReactiveCrudRepository basic CRUD functionality ** save ** findAll ** findOne by Id ** deleteAll ** delete by Id ** delete entity * Spring Data link:https://github.com/spring-projects/spring-data-commons/blob/db62390de90c93a78743c97cc2cc9ccd964994a5/src/main/java/org/springframework/data/annotation/Id.java[@Id] annotation. There're 2 ways to map a field in domain class to `id` of Azure Cosmos DB document. ** annotate a field in domain class with @Id, this field will be mapped to document `id` in Cosmos DB. ** set name of this field to `id`, this field will be mapped to document `id` in Cosmos DB. [Note] if both way applied, * Custom collection Name. By default, collection name will be class name of user domain class. To customize it, add annotation `@Document(collection="myCustomCollectionName")` to your domain class, that's all. * Supports link:https://docs.microsoft.com/azure/cosmos-db/partitioning-overview[Azure Cosmos DB partition]. To specify a field of your domain class to be partition key field, just annotate it with `@PartitionKey`. When you do CRUD operation, please specify your partition value. For more sample on partition CRUD, please refer to link:https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/spring/azure-spring-data-cosmos/src/test/java/com/azure/spring/data/cosmos/repository/integration/AddressRepositoryIT.java[test here] * Supports link:https://docs.spring.io/spring-data/commons/docs/current/reference/html/#repositories.query-methods.details[Spring Data custom query] find operation. * Supports link:https://spring.io/projects/spring-data-rest[spring-boot-starter-data-rest]. * Supports List and nested type in domain class. === Basic Usage ==== Use Private Key to Access CosmosDB The simplest way to connect CosmosDB with `spring-cloud-azure-starter-data-cosmos` is primary key, add below properties, and you are good to go. [source,yaml] ---- spring: cloud: azure: cosmos: key: ${AZURE_COSMOS_KEY} endpoint: ${AZURE_COSMOS_ENDPOINT} database: ${AZURE_COSMOS_DATABASE} ---- ==== Define an Entity Define a simple entity as Document in Cosmos DB. ---- @Container(containerName = "mycollection") public class User { @Id private String id; private String firstName; @PartitionKey private String lastName; private String address; public User() { } public User(String id, String firstName, String lastName, String address) { this.id = id; this.firstName = firstName; this.lastName = lastName; this.address = address; } public String getId() { return id; } public void setId(String id) { this.id = id; } public String getFirstName() { return firstName; } public void setFirstName(String firstName) { this.firstName = firstName; } public String getLastName() { return lastName; } public void setLastName(String lastName) { this.lastName = lastName; } public String getAddress() { return address; } public void setAddress(String address) { this.address = address; } @Override public String toString() { return String.format("%s %s, %s", firstName, lastName, address); } } ---- `id` field will be used as document `id` in Azure Cosmos DB. Or you can annotate any field with `@Id` to map it to document `id`. Annotation `@Container(containerName = "mycollection")` is used to specify the collection name of your document in Azure Cosmos DB. ==== Create Repositories Extends ReactiveCosmosRepository interface, which provides Spring Data repository support. ---- @Repository public interface UserRepository extends ReactiveCosmosRepository { Flux findByFirstName(String firstName); } ---- So far ReactiveCosmosRepository provides basic save, delete and find operations. More operations will be supported later. ==== Create an Application Class Here create an application class with all the components ---- @SpringBootApplication public class CosmosSampleApplication implements CommandLineRunner { private static final Logger LOGGER = LoggerFactory.getLogger(CosmosSampleApplication.class); @Autowired private UserRepository repository; @Autowired private CosmosProperties properties; public static void main(String[] args) { SpringApplication.run(CosmosSampleApplication.class, args); } public void run(String... var1) { final User testUser = new User("testId", "testFirstName", "testLastName", "test address line one"); // Save the User class to Azure Cosmos DB database. final Mono saveUserMono = repository.save(testUser); final Flux firstNameUserFlux = repository.findByFirstName("testFirstName"); // Nothing happens until we subscribe to these Monos. // findById will not return the user as user is not present. final Mono findByIdMono = repository.findById(testUser.getId()); final User findByIdUser = findByIdMono.block(); Assert.isNull(findByIdUser, "User must be null"); final User savedUser = saveUserMono.block(); Assert.state(savedUser != null, "Saved user must not be null"); Assert.state(savedUser.getFirstName().equals(testUser.getFirstName()), "Saved user first name doesn't match"); firstNameUserFlux.collectList().block(); final Optional optionalUserResult = repository.findById(testUser.getId()).blockOptional(); Assert.isTrue(optionalUserResult.isPresent(), "Cannot find user."); final User result = optionalUserResult.get(); Assert.state(result.getFirstName().equals(testUser.getFirstName()), "query result firstName doesn't match!"); Assert.state(result.getLastName().equals(testUser.getLastName()), "query result lastName doesn't match!"); LOGGER.info("findOne in User collection get result: {}", result.toString()); } @PostConstruct public void setup() { // For this example, remove all of the existing records. this.repository.deleteAll().block(); } } ---- Autowired UserRepository interface, then can do save, delete and find operations. === Samples 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. 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. ================================================ FILE: docs/src/main/asciidoc/spring-integration-support.adoc ================================================ == Spring Integration Support Spring Integration Extension for Azure provides Spring Integration adapters for the various services provided by the https://github.com/Azure/azure-sdk-for-java/[Azure SDK for Java]. We provide Spring Integration support for these Azure services: Event Hubs, Service Bus, Storage Queue. The following is a list of supported adapters: * spring-cloud-azure-starter-integration-eventhubs * spring-cloud-azure-starter-integration-servicebus * spring-cloud-azure-starter-integration-storage-queue === Spring Integration with Azure Event Hubs ==== Key Concepts Azure Event Hubs is a big data streaming platform and event ingestion service. It can receive and process millions of events per second. Data sent to an event hub can be transformed and stored by using any real-time analytics provider or batching/storage adapters. Spring Integration enables lightweight messaging within Spring-based applications and supports integration with external systems via declarative adapters. Those adapters provide a higher-level of abstraction over Spring’s support for remoting, messaging, and scheduling. The *Spring Integration for Event Hubs* extension project provides inbound and outbound channel adapters and gateways for Azure Event Hubs. NOTE: RxJava support APIs are dropped from version 4.0.0. See Javadoc for details. ===== Consumer Group Event Hubs provides similar support of consumer group as Apache Kafka, but with slight different logic. While Kafka stores all committed offsets in the broker, you have to store offsets of Event Hubs messages being processed manually. Event Hubs SDK provides the function to store such offsets inside Azure Storage. ===== Partitioning Support Event Hubs provides a similar concept of physical partition as Kafka. But unlike Kafka's auto re-balancing between consumers and partitions, Event Hubs provides a kind of preemptive mode. The storage account acts as a lease to determine which partition is owned by which consumer. When a new consumer starts, it will try to steal some partitions from most heavy-loaded consumers to achieve the workload balancing. To specify the load balancing strategy, developers can use `EventHubsContainerProperties` for the configuration. See <> for an example of how to configure `EventHubsContainerProperties`. ===== Batch Consumer Support The `EventHubsInboundChannelAdapter` supports the batch-consuming mode. To enable it, users can specify the listener mode as `ListenerMode.BATCH` when constructing an `EventHubsInboundChannelAdapter` instance. When enabled, an **Message** of which the payload is a list of batched events will be received and passed to the downstream channel. Each message header is also converted as a list, of which the content is the associated header value parsed from each event. For the communal headers of partition id, checkpointer and last enqueued properties, they are presented as a single value for the entire batch of events shares the same one. See <> for more details. NOTE: The checkpoint header only exists when **MANUAL** checkpoint mode is used. Checkpointing of batch consumer supports two modes: `BATCH` and `MANUAL`. `BATCH` mode is an auto checkpointing mode to checkpoint the entire batch of events together once they are received. `MANUAL` mode is to checkpoint the events by users. When used, the **Checkpointer** will be passed into the message header, and users could use it to do checkpointing. The batch consuming policy can be specified by properties of `max-size` and `max-wait-time`, where `max-size` is a necessary property while `max-wait-time` is optional. To specify the batch consuming strategy, developers can use `EventHubsContainerProperties` for the configuration. See <> for an example of how to configure `EventHubsContainerProperties`. ==== Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-starter-integration-eventhubs ---- ==== Configuration This starter provides the following 3 parts of configuration options: ===== Connection Configuration Properties This section contains the configuration options used for connecting to Azure Event Hubs. NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, see 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. .Connection configurable properties of spring-cloud-azure-starter-integration-eventhubs [cols="<,<,<", options="header"] |=== |Property | Type |Description |*spring.cloud.azure.eventhubs*.enabled | boolean | Whether an Azure Event Hubs is enabled. |*spring.cloud.azure.eventhubs*.connection-string | String | Event Hubs Namespace connection string value. |*spring.cloud.azure.eventhubs*.namespace | String | Event Hubs Namespace value, which is the prefix of the FQDN. A FQDN should be composed of . |*spring.cloud.azure.eventhubs*.domain-name | String | Domain name of an Azure Event Hubs Namespace value. |*spring.cloud.azure.eventhubs*.custom-endpoint-address | String | Custom Endpoint address. |*spring.cloud.azure.eventhubs*.shared-connection | Boolean | Whether the underlying EventProcessorClient and EventHubProducerAsyncClient use the same connection. By default, a new connection is constructed and used created for each Event Hub client created. |=== ===== Checkpoint Configuration Properties This section contains the configuration options for the Storage Blobs service, which is used for persisting partition ownership and checkpoint information. NOTE: From version 4.0.0, when the property of **spring.cloud.azure.eventhubs.processor.checkpoint-store.create-container-if-not-exists** is not enabled manually, no Storage container will be created automatically. .Checkpointing configurable properties of spring-cloud-azure-starter-integration-eventhubs [cols="<,<,<", options="header"] |=== |Property | Type |Description |*spring.cloud.azure.eventhubs.processor.checkpoint-store*.create-container-if-not-exists |Boolean |Whether to allow creating containers if not exists. |*spring.cloud.azure.eventhubs.processor.checkpoint-store*.account-name | String | Name for the storage account. |*spring.cloud.azure.eventhubs.processor.checkpoint-store*.account-key | String | Storage account access key. |*spring.cloud.azure.eventhubs.processor.checkpoint-store*.container-name | String | Storage container name. |=== Common Azure Service SDK configuration options are configurable for Storage Blob checkpoint store as well. The supported configuration options are introduced in link:configuration.html[the Configuration page], and could be configured with either the unified prefix `spring.cloud.azure.` or the prefix of `spring.cloud.azure.eventhubs.processor.checkpoint-store`. ===== Event Hub Processor Configuration Properties The `EventHubsInboundChannelAdapter` uses the `EventProcessorClient` to consume messages from an event hub, to configure the overall properties of an `EventProcessorClient`, developers can use `EventHubsContainerProperties` for the configuration. See <> about how to work with `EventHubsInboundChannelAdapter`. ==== Basic Usage ===== Send messages to Azure Event Hubs Step 1. Fill the credential configuration options. * For credentials as connection string, configure the following properties in `application.yml`: [source,yaml] ---- spring: cloud: azure: eventhubs: connection-string: ${AZURE_SERVICE_BUS_CONNECTION_STRING} processor: checkpoint-store: container-name: ${CHECKPOINT-CONTAINER} account-name: ${CHECKPOINT-STORAGE-ACCOUNT} account-key: ${CHECKPOINT-ACCESS-KEY} ---- * For credentials as managed identities, configure the following properties in `application.yml`: [source,yaml] ---- spring: cloud: azure: credential: managed-identity-enabled: true client-id: ${AZURE_CLIENT_ID} eventhubs: namespace: ${AZURE_SERVICE_BUS_NAMESPACE} processor: checkpoint-store: container-name: ${CONTAINER_NAME} account-name: ${ACCOUNT_NAME} ---- * For credentials as service principal, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} eventhubs: namespace: ${AZURE_SERVICE_BUS_NAMESPACE} processor: checkpoint-store: container-name: ${CONTAINER_NAME} account-name: ${ACCOUNT_NAME} ---- Step 2. Create `DefaultMessageHandler` with the bean of `EventHubsTemplate` to send messages to Event Hubs. [source,java] ---- class Demo { private static final String OUTPUT_CHANNEL = "output"; private static final String EVENTHUB_NAME = "eh1"; @Bean @ServiceActivator(inputChannel = OUTPUT_CHANNEL) public MessageHandler messageSender(EventHubsTemplate eventHubsTemplate) { DefaultMessageHandler handler = new DefaultMessageHandler(EVENTHUB_NAME, eventHubsTemplate); handler.setSendCallback(new ListenableFutureCallback() { @Override public void onSuccess(Void result) { LOGGER.info("Message was sent successfully."); } @Override public void onFailure(Throwable ex) { LOGGER.error("There was an error sending the message.", ex); } }); return handler; } } ---- Step 3. Create a message gateway binding with the above message handler via a message channel. [source,java] ---- class Demo { @Autowired EventHubOutboundGateway messagingGateway; @MessagingGateway(defaultRequestChannel = OUTPUT_CHANNEL) public interface EventHubOutboundGateway { void send(String text); } } ---- Step 4. Send messages using the gateway. [source,java] ---- class Demo { public void demo() { this.messagingGateway.send(message); } } ---- [#receive-from-eh] ===== Receive Messages from Azure Event Hubs Step 1. Fill the credential configuration options. Step 2. Create a bean of message channel as the input channel. [source,java] ---- @Configuration class Demo { @Bean public MessageChannel input() { return new DirectChannel(); } } ---- Step 3. Create `EventHubsInboundChannelAdapter` with the bean of `EventHubsMessageListenerContainer` to receive messages from Event Hubs. [source,java] ---- @Configuration class Demo { private static final String INPUT_CHANNEL = "input"; private static final String EVENTHUB_NAME = "eh1"; private static final String CONSUMER_GROUP = "$Default"; @Bean public EventHubsInboundChannelAdapter messageChannelAdapter( @Qualifier(INPUT_CHANNEL) MessageChannel inputChannel, EventHubsMessageListenerContainer listenerContainer) { EventHubsInboundChannelAdapter adapter = new EventHubsInboundChannelAdapter(processorContainer); adapter.setOutputChannel(inputChannel); return adapter; } @Bean public EventHubsMessageListenerContainer messageListenerContainer(EventHubsProcessorFactory processorFactory) { EventHubsContainerProperties containerProperties = new EventHubsContainerProperties(); containerProperties.setEventHubName(EVENTHUB_NAME); containerProperties.setConsumerGroup(CONSUMER_GROUP); containerProperties.setCheckpointConfig(new CheckpointConfig(CheckpointMode.MANUAL)); return new EventHubsMessageListenerContainer(processorFactory, containerProperties); } } ---- Step 4. Create a message receiver binding with EventHubsInboundChannelAdapter via the message channel created before. [source,java] ---- class Demo { @ServiceActivator(inputChannel = INPUT_CHANNEL) public void messageReceiver(byte[] payload, @Header(AzureHeaders.CHECKPOINTER) Checkpointer checkpointer) { String message = new String(payload); LOGGER.info("New message received: '{}'", message); checkpointer.success() .doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message)) .doOnError(e -> LOGGER.error("Error found", e)) .block(); } } ---- ===== Configure EventHubsMessageConverter to Customize ObjectMapper `EventHubsMessageConverter` is made as a configurable bean to allow users to customize ObjectMapper. [#si-eh-batch] ===== Batch Consumer Support To consume messages from Event Hubs in batches is similar with the above sample, besides users should set the batch-consuming related configuration options for `EventHubsInboundChannelAdapter`. When create `EventHubsInboundChannelAdapter`, the listener mode should be set as `BATCH`. When create bean of `EventHubsMessageListenerContainer`, set the checkpoint mode as either `MANUAL` or `BATCH`, and the batch options can be configured as needed. [source,java] ---- @Configuration class Demo { private static final String INPUT_CHANNEL = "input"; private static final String EVENTHUB_NAME = "eh1"; private static final String CONSUMER_GROUP = "$Default"; @Bean public EventHubsInboundChannelAdapter messageChannelAdapter( @Qualifier(INPUT_CHANNEL) MessageChannel inputChannel, EventHubsMessageListenerContainer listenerContainer) { EventHubsInboundChannelAdapter adapter = new EventHubsInboundChannelAdapter(processorContainer, ListenerMode.BATCH); adapter.setOutputChannel(inputChannel); return adapter; } @Bean public EventHubsMessageListenerContainer messageListenerContainer(EventHubsProcessorFactory processorFactory) { EventHubsContainerProperties containerProperties = new EventHubsContainerProperties(); containerProperties.setEventHubName(EVENTHUB_NAME); containerProperties.setConsumerGroup(CONSUMER_GROUP); containerProperties.getBatch().setMaxSize(100); containerProperties.setCheckpointConfig(new CheckpointConfig(CheckpointMode.MANUAL)); return new EventHubsMessageListenerContainer(processorFactory, containerProperties); } } ---- [#si-eh-headers] ===== Event Hubs Message Headers The following table illustrates how Event Hubs message properties are mapped to Spring message headers. For Azure Event Hubs, message is called as `event`. .Mapping between Event Hubs Message / Event Properties and Spring Message Headers in Record Listener Mode [cols="<,<,<,<", options="header"] |=== |Event Hubs Event Properties | Spring Message Header Constants | Type | Description |Enqueued time | EventHubsHeaders#ENQUEUED_TIME |Instant |The instant, in UTC, of when the event was enqueued in the Event Hub partition. |Offset |EventHubsHeaders#OFFSET |Long |The offset of the event when it was received from the associated Event Hub partition. |Partition key |AzureHeaders#PARTITION_KEY |String |The partition hashing key if it was set when originally publishing the event. |Partition id |AzureHeaders#RAW_PARTITION_ID |String |The partition id of the Event Hub. |Sequence number |EventHubsHeaders#SEQUENCE_NUMBER |Long |The sequence number assigned to the event when it was enqueued in the associated Event Hub partition. |Last enqueued event properties |EventHubsHeaders#LAST_ENQUEUED_EVENT_PROPERTIES |LastEnqueuedEventProperties |The properties of the last enqueued event in this partition. |NA |AzureHeaders#CHECKPOINTER |Checkpointer |The header for checkpoint the specific message. |=== Users can parse the message headers for the related information of each event. To set a message header for the event, all customized headers will be put as an application property of an event, where the header is set as the property key. When events are received from Event Hubs, all application properties will be converted to the message header. NOTE: Message headers of partition key, enqueued time, offset and sequence number is not supported to be set manually. When the batch-consumer mode is enabled, the specific headers of batched messages are listed the following, which contains a list of values from each single Event Hubs event. .Mapping between Event Hubs Message / Event Properties and Spring Message Headers in Batch Listener Mode [cols="<,<,<,<", options="header"] |=== |Event Hubs Event Properties | Spring Batch Message Header Constants | Type | Description |Enqueued time |EventHubsHeaders#ENQUEUED_TIME |List of Instant |List of the instant, in UTC, of when each event was enqueued in the Event Hub partition. |Offset |EventHubsHeaders#OFFSET |List of Long |List of the offset of each event when it was received from the associated Event Hub partition. |Partition key |AzureHeaders#PARTITION_KEY |List of String |List of the partition hashing key if it was set when originally publishing each event. |Sequence number |EventHubsHeaders#SEQUENCE_NUMBER |List of Long |List of the sequence number assigned to each event when it was enqueued in the associated Event Hub partition. |System properties |EventHubsHeaders#BATCH_CONVERTED_SYSTEM_PROPERTIES |List of Map |List of the system properties of each event. |Application properties |EventHubsHeaders#BATCH_CONVERTED_APPLICATION_PROPERTIES |List of Map |List of the application properties of each event, where all customized message headers or event properties are placed. |=== NOTE: When publish messages, all the above batch headers will be removed from the messages if exist. ==== Samples See link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/eventhubs/spring-cloud-azure-starter-integration-eventhubs/eventhubs-integration[azure-spring-boot-samples] for more details. === Spring Integration with Azure Service Bus ==== Key Concepts Spring Integration enables lightweight messaging within Spring-based applications and supports integration with external systems via declarative adapters. The Spring Integration for Azure Service Bus extension project provides inbound and outbound channel adapters for Azure Service Bus. NOTE: CompletableFuture support APIs have been deprecated from version 2.10.0, and is replaced by Reactor Core from version 4.0.0. See Javadoc for details. ==== Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-starter-integration-servicebus ---- ==== Configuration This starter provides the following 2 parts of configuration options: ===== Connection Configuration Properties This section contains the configuration options used for connecting to Azure Service Bus. NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, see 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. .Connection configurable properties of spring-cloud-azure-starter-integration-servicebus [cols="<,<,<", options="header"] |=== |Property | Type |Description |*spring.cloud.azure.servicebus*.enabled | boolean | Whether an Azure Service Bus is enabled. |*spring.cloud.azure.servicebus*.connection-string | String | Service Bus Namespace connection string value. |*spring.cloud.azure.servicebus*.namespace | String | Service Bus Namespace value, which is the prefix of the FQDN. A FQDN should be composed of . |*spring.cloud.azure.servicebus*.domain-name | String | Domain name of an Azure Service Bus Namespace value. |=== ===== Service Bus Processor Configuration Properties The `ServiceBusInboundChannelAdapter` uses the `ServiceBusProcessorClient` to consume messages, to configure the overall properties of an `ServiceBusProcessorClient`, developers can use `ServiceBusContainerProperties` for the configuration. See <> about how to work with `ServiceBusInboundChannelAdapter`. ==== Basic Usage ===== Send Messages to Azure Service Bus Step 1. Fill the credential configuration options. * For credentials as connection string, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: servicebus: connection-string: ${AZURE_SERVICE_BUS_CONNECTION_STRING} ---- * For credentials as managed identities, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: credential: managed-identity-enabled: true client-id: ${AZURE_CLIENT_ID} profile: tenant-id: ${AZURE_TENANT_ID} servicebus: namespace: ${AZURE_SERVICE_BUS_NAMESPACE} ---- * For credentials as service principal, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} servicebus: namespace: ${AZURE_SERVICE_BUS_NAMESPACE} ---- Step 2. Create `DefaultMessageHandler` with the bean of `ServiceBusTemplate` to send messages to Service Bus, set the entity type for the ServiceBusTemplate. This sample takes Service Bus Queue as example. [source,java] ---- class Demo { private static final String OUTPUT_CHANNEL = "queue.output"; @Bean @ServiceActivator(inputChannel = OUTPUT_CHANNEL) public MessageHandler queueMessageSender(ServiceBusTemplate serviceBusTemplate) { serviceBusTemplate.setDefaultEntityType(ServiceBusEntityType.QUEUE); DefaultMessageHandler handler = new DefaultMessageHandler(QUEUE_NAME, serviceBusTemplate); handler.setSendCallback(new ListenableFutureCallback() { @Override public void onSuccess(Void result) { LOGGER.info("Message was sent successfully."); } @Override public void onFailure(Throwable ex) { LOGGER.info("There was an error sending the message."); } }); return handler; } } ---- Step 3. Create a message gateway binding with the above message handler via a message channel. [source,java] ---- class Demo { @Autowired QueueOutboundGateway messagingGateway; @MessagingGateway(defaultRequestChannel = OUTPUT_CHANNEL) public interface QueueOutboundGateway { void send(String text); } } ---- Step 4. Send messages using the gateway. [source,java] ---- class Demo { public void demo() { this.messagingGateway.send(message); } } ---- [#receive-from-sb] ===== Receive Messages from Azure Service Bus Step 1. Fill the credential configuration options. Step 2. Create a bean of message channel as the input channel. [source,java] ---- @Configuration class Demo { private static final String INPUT_CHANNEL = "input"; @Bean public MessageChannel input() { return new DirectChannel(); } } ---- Step 3. Create `ServiceBusInboundChannelAdapter` with the bean of `ServiceBusMessageListenerContainer` to receive messages to Service Bus. This sample takes Service Bus Queue as example. [source,java] ---- @Configuration class Demo { private static final String QUEUE_NAME = "queue1"; @Bean public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) { ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties(); containerProperties.setEntityName(QUEUE_NAME); containerProperties.setAutoComplete(false); return new ServiceBusMessageListenerContainer(processorFactory, containerProperties); } @Bean public ServiceBusInboundChannelAdapter queueMessageChannelAdapter( @Qualifier(INPUT_CHANNEL) MessageChannel inputChannel, ServiceBusMessageListenerContainer listenerContainer) { ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer); adapter.setOutputChannel(inputChannel); return adapter; } } ---- Step 4. Create a message receiver binding with ServiceBusInboundChannelAdapter via the message channel we created before. [source,java] ---- class Demo { @ServiceActivator(inputChannel = INPUT_CHANNEL) public void messageReceiver(byte[] payload, @Header(AzureHeaders.CHECKPOINTER) Checkpointer checkpointer) { String message = new String(payload); LOGGER.info("New message received: '{}'", message); checkpointer.success() .doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message)) .doOnError(e -> LOGGER.error("Error found", e)) .block(); } } ---- ===== Configure ServiceBusMessageConverter to Customize ObjectMapper `ServiceBusMessageConverter` is made as a configurable bean to allow users to customize ObjectMapper. [#si-sb-headers] ===== Service Bus Message Headers 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"] |=== |Service Bus Message Headers and Properties | Spring Message Header Constants | Type | Configurable | Description | Content type | MessageHeaders#CONTENT_TYPE | String | Yes | The RFC2045 Content-Type descriptor of the message. | Correlation id | ServiceBusMessageHeaders#CORRELATION_ID | String | Yes | The correlation id of the message | Message id | ServiceBusMessageHeaders#MESSAGE_ID | String | Yes | The message id of the message, this header has higher priority than `MessageHeaders#ID`. | Message id | MessageHeaders#ID | UUID | Yes | The message id of the message, this header has lower priority than `ServiceBusMessageHeaders#MESSAGE_ID`. | Partition key | ServiceBusMessageHeaders#PARTITION_KEY | String | Yes | The partition key for sending the message to a partitioned entity. | Reply to | MessageHeaders#REPLY_CHANNEL | String | Yes | The address of an entity to send replies to. | Reply to session id | ServiceBusMessageHeaders#REPLY_TO_SESSION_ID | String | Yes | The ReplyToGroupId property value of the message. | 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 | Yes | The datetime at which the message should be enqueued in Service Bus, this header has lower priority than `ServiceBusMessageHeaders#SCHEDULED_ENQUEUE_TIME`. | Session id | ServiceBusMessageHeaders#SESSION_ID | String | Yes | The session identifier for a session-aware entity. | Time to live | ServiceBusMessageHeaders#TIME_TO_LIVE | Duration | Yes | The duration of time before this message expires. | To | ServiceBusMessageHeaders#TO | String | 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 This starter 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. _Recommended:_ Use `ServiceBusMessageHeaders.PARTITION_KEY` as the key of the header. [source,java] ---- public class SampleController { @PostMapping("/messages") public ResponseEntity sendMessage(@RequestParam String message) { LOGGER.info("Going to add message {} to Sinks.Many.", message); many.emitNext(MessageBuilder.withPayload(message) .setHeader(ServiceBusMessageHeaders.PARTITION_KEY, "Customize partition key") .build(), Sinks.EmitFailureHandler.FAIL_FAST); return ResponseEntity.ok("Sent!"); } } ---- _Not recommended but currently supported:_ `AzureHeaders.PARTITION_KEY` as the key of the header. [source,java] ---- public class SampleController { @PostMapping("/messages") public ResponseEntity sendMessage(@RequestParam String message) { LOGGER.info("Going to add message {} to Sinks.Many.", message); many.emitNext(MessageBuilder.withPayload(message) .setHeader(AzureHeaders.PARTITION_KEY, "Customize partition key") .build(), Sinks.EmitFailureHandler.FAIL_FAST); return ResponseEntity.ok("Sent!"); } } ---- NOTE: When both `ServiceBusMessageHeaders.PARTITION_KEY` and `AzureHeaders.PARTITION_KEY` are set in the message headers, `ServiceBusMessageHeaders.PARTITION_KEY` is preferred. ===== Session Support This example demonstrates how to manually set the session id of a message in the application. [source,java] ---- public class SampleController { @PostMapping("/messages") public ResponseEntity sendMessage(@RequestParam String message) { LOGGER.info("Going to add message {} to Sinks.Many.", message); many.emitNext(MessageBuilder.withPayload(message) .setHeader(ServiceBusMessageHeaders.SESSION_ID, "Customize session id") .build(), Sinks.EmitFailureHandler.FAIL_FAST); return ResponseEntity.ok("Sent!"); } } ---- NOTE: When the `ServiceBusMessageHeaders.SESSION_ID` is set in the message headers, and a different `ServiceBusMessageHeaders.PARTITION_KEY` (or `AzureHeaders.PARTITION_KEY`) header is also set, the value of the session id will eventually be used to overwrite the value of the partition key. ==== Samples See link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/servicebus/spring-cloud-azure-starter-integration-servicebus[azure-spring-boot-samples] for more details. === Spring Integration with Azure Storage Queue ==== Key Concepts Azure Queue Storage is a service for storing large numbers of messages. You access messages from anywhere in the world via authenticated calls using HTTP or HTTPS. A queue message can be up to 64 KB in size. A queue may contain millions of messages, up to the total capacity limit of a storage account. Queues are commonly used to create a backlog of work to process asynchronously. ==== Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-starter-integration-storage-queue ---- ==== Configuration This starter provides the following configuration options: ===== Connection Configuration Properties This section contains the configuration options used for connecting to Azure Storage Queue. NOTE: If you choose to use a security principal to authenticate and authorize with Azure Active Directory for accessing an Azure resource, see 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. .Connection configurable properties of spring-cloud-azure-starter-integration-storage-queue [cols="<,<,<", options="header"] |=== |Property | Type |Description |*spring.cloud.azure.storage.queue*.enabled | boolean | Whether an Azure Storage Queue is enabled. |*spring.cloud.azure.storage.queue*.connection-string | String | Storage Queue Namespace connection string value. |*spring.cloud.azure.storage.queue*.accountName | String | Storage Queue account name. |*spring.cloud.azure.storage.queue*.accountKey | String | Storage Queue account key. |*spring.cloud.azure.storage.queue*.endpoint | String | Storage Queue service endpoint. |*spring.cloud.azure.storage.queue*.sasToken | String | Sas token credential |*spring.cloud.azure.storage.queue*.serviceVersion | QueueServiceVersion | QueueServiceVersion that is used when making API requests. |*spring.cloud.azure.storage.queue*.messageEncoding | String | Queue message encoding. |=== ==== Basic Usage ===== Send messages to Azure Storage Queue Step 1. Fill the credential configuration options. ** For credentials as connection string, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: storage: queue: connection-string: ${AZURE_SERVICE_BUS_CONNECTION_STRING} ---- ** For credentials as managed identities, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: credential: managed-identity-enabled: true client-id: ${AZURE_CLIENT_ID} profile: tenant-id: ${AZURE_TENANT_ID} storage: queue: namespace: ${AZURE_SERVICE_BUS_NAMESPACE} ---- ** For credentials as service principal, configure the following properties in application.yml: [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} profile: tenant-id: ${AZURE_TENANT_ID} storage: queue: namespace: ${AZURE_SERVICE_BUS_NAMESPACE} ---- Step 2. Create `DefaultMessageHandler` with the bean of `StorageQueueTemplate` to send messages to Storage Queue. [source,java] ---- class Demo { private static final String STORAGE_QUEUE_NAME = "example"; private static final String OUTPUT_CHANNEL = "output"; @Bean @ServiceActivator(inputChannel = OUTPUT_CHANNEL) public MessageHandler messageSender(StorageQueueTemplate storageQueueTemplate) { DefaultMessageHandler handler = new DefaultMessageHandler(STORAGE_QUEUE_NAME, storageQueueTemplate); handler.setSendCallback(new ListenableFutureCallback() { @Override public void onSuccess(Void result) { LOGGER.info("Message was sent successfully."); } @Override public void onFailure(Throwable ex) { LOGGER.info("There was an error sending the message."); } }); return handler; } } ---- Step 3. Create a Message gateway binding with the above message handler via a message channel. [source,java] ---- class Demo { @Autowired StorageQueueOutboundGateway storageQueueOutboundGateway; @MessagingGateway(defaultRequestChannel = OUTPUT_CHANNEL) public interface StorageQueueOutboundGateway { void send(String text); } } ---- Step 4. Send messages using the gateway. [source,java] ---- class Demo { public void demo() { this.storageQueueOutboundGateway.send(message); } } ---- ===== Receive Messages from Azure Storage Queue Step 1. Fill the credential configuration options. Step 2. Create a bean of message channel as the input channel. [source,java] ---- class Demo { private static final String INPUT_CHANNEL = "input"; @Bean public MessageChannel input() { return new DirectChannel(); } } ---- Step 3. Create `StorageQueueMessageSource` with the bean of `StorageQueueTemplate` to receive messages to Storage Queue. [source,java] ---- class Demo { private static final String STORAGE_QUEUE_NAME = "example"; @Bean @InboundChannelAdapter(channel = INPUT_CHANNEL, poller = @Poller(fixedDelay = "1000")) public StorageQueueMessageSource storageQueueMessageSource(StorageQueueTemplate storageQueueTemplate) { return new StorageQueueMessageSource(STORAGE_QUEUE_NAME, storageQueueTemplate); } } ---- Step 4. Create a message receiver binding with StorageQueueMessageSource created in the last step via the message channel we created before. [source,java] ---- class Demo { @ServiceActivator(inputChannel = INPUT_CHANNEL) public void messageReceiver(byte[] payload, @Header(AzureHeaders.CHECKPOINTER) Checkpointer checkpointer) { String message = new String(payload); LOGGER.info("New message received: '{}'", message); checkpointer.success() .doOnError(Throwable::printStackTrace) .doOnSuccess(t -> LOGGER.info("Message '{}' successfully checkpointed", message)) .block(); } } ---- ==== Samples See link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}/storage/spring-cloud-azure-starter-integration-storage-queue[azure-spring-boot-samples] for more details. ================================================ FILE: docs/src/main/asciidoc/spring-jms-support.adoc ================================================ [#spring-jms-support] == Spring JMS Support To use Azure Service Bus by the JMS API integrated into the Spring JMS framework. Azure Service Bus connection string have to be provided which is to be parsed into the login username, password and remote URI for the AMQP broker. === Dependency Setup Adding the following dependencies if you want to migrate your Spring JMS application to use Azure Service Bus. [source,xml] ---- com.azure.spring spring-cloud-azure-starter-servicebus-jms ---- === Configuration .Configurable properties when using Spring JMS support [cols="<50,<50",options="header"] |=== |Property |Description |*spring.jms.servicebus*.connection-string |Azure Service Bus connection string. Should be provided when want to provide the connection string directly. |*spring.jms.servicebus*.topic-client-id |JMS client ID. Only works for the bean of topicJmsListenerContainerFactory. |*spring.jms.servicebus*.idle-timeout | The duration for idle. |*spring.jms.servicebus*.pricing-tier | The Azure Service Bus Price Tier. |*spring.jms.servicebus*.listener.reply-pub-sub-domain | Whether the reply destination type is topic. |*spring.jms.servicebus*.listener.phase | Specify the phase in which this container should be started and stopped. |*spring.jms.servicebus*.listener.reply-qos-settings | Configure the QosSettings to use when sending a reply. |*spring.jms.servicebus*.listener.subscription-durable | Whether to make the subscription durable. Only works for the bean of topicJmsListenerContainerFactory. |*spring.jms.servicebus*.listener.subscription-shared | Whether to make the subscription shared. Only works for the bean of topicJmsListenerContainerFactory. |*spring.jms.servicebus*.password | Login password of the AMQP broker | *spring.jms.servicebus*.pool.block-if-full | [[jms-servicebus-pool-configuration]] Whether to block when a connection is requested and the pool is full. |*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 regularConnectionFactory. |*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. |*spring.jms.servicebus*.pool.use-anonymous-producers |Whether to use only one anonymous "MessageProducer" instance. |*spring.jms.servicebus*.prefetch-policy.all | Fallback value for prefetch option in this Service Bus namespace. |*spring.jms.servicebus*.prefetch-policy.durable-topic-prefetch | The number of prefetch for durable topic. |*spring.jms.servicebus*.prefetch-policy.queue-browser-prefetch | The number of prefetch for queue browser. |*spring.jms.servicebus*.prefetch-policy.queue-prefetch | The number of prefetch for queue. |*spring.jms.servicebus*.prefetch-policy.topic-prefetch | The number of prefetch for topic. |*spring.jms.servicebus*.remote-url | URL of the AMQP broker. |*spring.jms.servicebus*.username | Login user of the AMQP broker. |=== NOTE: Spring JMS general configuration is omitted for short. See 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 ==== Use Service Bus Connection String The simplest way to connect to Service Bus for Spring JMS application is with the connection string. Add the following properties and you are good to go. [source,yaml] ---- spring: jms: servicebus: connection-string: ${AZURE_SERVICEBUS_CONNECTION_STRING} pricing-tier: ${PRICING_TIER} ---- NOTE: The default enabled `ConnectionFactory` is the `CachingConnectionFactory` which adds Session caching as well MessageProducer caching. If you want to activate the connection pooling featured one of JmsPoolConnectionFactory, the property of `spring.jms.servicebus.pool.enabled` should be specified `true`. You can find other pooling configuration options (properties with prefix `spring.jms.servicebus.pool.`) from the above <> section. === Samples See link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_{project-version}[azure-spring-boot-samples] for more details. ================================================ FILE: docs/src/main/asciidoc/spring-native-support.adoc ================================================ [#spring-native-support] include::_attributes.adoc[] == Spring Native Support === Spring Native Spring Native provides support for compiling Spring Boot applications to native executables using the {graalvm}[GraalVM] {graalvm-native-docs}[native-image] compiler. The native images will bring many advantages, such as instant startup, instant peak performance, and reduced memory consumption. Some Spring Cloud Azure features can also benefit from the Spring Native support, the goal is that Spring Cloud Azure applications can be built as native images without any code modification. For more information, see the link:https://docs.spring.io/spring-native/docs/{spring-native-version}/reference/htmlsingle/#overview[Spring Native documentation]. === Support Spring Cloud Azure has been validated against GraalVM and Spring Native, and provides the beta version support. You can try it on your projects if they are using those supported dependencies, and {azure-sdk-java-issues}[raise bugs] or {spring-cloud-azure-native-configuration}[contribute pull requests] if something goes wrong on Spring Cloud Azure. For more information, see the link:https://docs.spring.io/spring-native/docs/{spring-native-version}/reference/htmlsingle/#support[Spring Native Support] for more details. ==== Spring Native Spring Cloud Azure **{project-version}** has been tested against Spring Native `{spring-native-version}` and GraalVM `{graalvm-version}`. ==== Spring Cloud Azure Native NOTE: Spring Native `{spring-native-version}` has been tested against Spring Cloud Azure Native Configuration `{spring-cloud-azure-native-configuration-version}`. Spring Cloud Azure provides a dependency `spring-cloud-azure-native-configuration` that is an extension of Spring Native configuration for Spring Cloud Azure libraries. The Spring Native AOT plugin will combine the `spring-native-configuration` and `spring-cloud-azure-native-configuration` to build applications into native executables. You don't need any extra modifications to the code that uses Spring Cloud Azure libraries apart from adding the dependency, which only applies to the code in the Spring Cloud Azure libraries. The following features are supported: * `Azure App Configuration clients auto-configuration` * `Azure Event Hubs clients auto-configuration` * `Azure Key Vault Certificates clients auto-configuration` * `Azure Key Vault Secrets clients auto-configuration` * `Azure Storage Blob clients auto-configuration` * `Azure Storage File Share clients auto-configuration` * `Azure Storage Queue clients auto-configuration` * `Spring Integration for Azure Event Hubs` * `Spring Integration for Azure Storage Queue` ==== Limitations The Spring Cloud Azure support for Spring Native is still in the early stages and continues to be updated. The following features are not yet supported: * `Azure Cosmos clients auto-configuration` * `Azure Service Bus clients auto-configuration` * `Spring Data for Azure Cache for Redis` * `Spring Data for Azure Cosmos` * `Spring Cloud Stream for Azure Event Hubs` * `Spring Cloud Stream for Azure Service Bus` * `Spring Kafka for Azure Event Hubs` * `Spring Integration for Azure Service Bus` NOTE: Not all the native image options are supported by Spring Native. For more information, see the link:https://docs.spring.io/spring-native/docs/{spring-native-version}/reference/htmlsingle/#native-image-options[Native image options] section of the Spring Native documentation. WARNING: Spring Cloud Azure **{project-version}** is not validated for building native executables based on Gradle Kotlin. === Project Setup The Spring Cloud Azure applications can enable Spring Native support by following the instructions in the link:https://docs.spring.io/spring-native/docs/{spring-native-version}/reference/htmlsingle/#getting-started[Getting started], section of the Spring Native documentation. The only additional processing required is to add the following dependency to the POM file. TIP: The dependency `com.azure.spring:spring-cloud-azure-native-configuration` is not managed in `com.azure.spring:spring-cloud-azure-dependencies`. [source,xml,indent=2,subs="attributes,verbatim",role="primary"] .Maven ---- com.azure.spring spring-cloud-azure-native-configuration {spring-cloud-azure-native-configuration-version} ---- [source,groovy,subs="attributes,verbatim",role="secondary"] .Gradle Groovy ---- dependencies { implementation "com.azure.spring:spring-cloud-azure-native-configuration:{spring-cloud-azure-native-configuration-version}" } ---- === Build the native application The following sections describe the two main ways to build a Spring Boot native application with Spring Cloud Azure libraries. ==== Build with Buildpacks The native application can be built as follows: [source,bash,role="primary"] .Maven ---- mvn spring-boot:build-image ---- [source,bash,role="secondary"] .Gradle Groovy ---- gradle bootBuildImage ---- For more information, see the link:https://docs.spring.io/spring-native/docs/{spring-native-version}/reference/htmlsingle/#getting-started-buildpacks[Getting started with Buildpacks] section in the Spring Native documentation. ==== Build with Native Build Tools You can build the native application by using the following command: [source,bash,role="primary"] .Maven ---- mvn -Pnative -DskipTests package ---- [source,bash,role="secondary"] .Gradle Groovy ---- gradle nativeCompile ---- For more information, see the link:https://docs.spring.io/spring-native/docs/{spring-native-version}/reference/htmlsingle/#getting-started-native-build-tools[Getting started with Native Build Tools] section of the Spring Native documentation. === Run the native application The following sections describe the two main ways to run a native executable. TIP: Assuming the project artifact ID is `spring-cloud-azure-sample` and the project version is `0.0.1-SNAPSHOT`, you can specify the custom image name in one of the following ways: If you're using link:https://docs.spring.io/spring-boot/docs/{spring-boot-version}/reference/html/container-images.html#container-images.buildpacks[Cloud Native Buildpacks], use the `image`->`name`->`custom-image-name` configuration element in the Spring Boot plugin. If you're using link:{graalvm-native-buildtools}[GraalVM Native Build Tools], use the `imageName`->`custom-image-name` configuration element in the Spring Boot plugin. ==== Run with Buildpacks To run the application, you can use `docker` the usual way as shown in the following example: [source,bash,subs="attributes,verbatim"] ---- docker run --rm -p 8080:8080 spring-cloud-azure-sample:0.0.1-SNAPSHOT ---- ==== Run with Native Build Tools To run your application, use the following command: [source,bash,role="primary"] .Build with Maven ---- target\spring-cloud-azure-sample ---- [source,bash,role="secondary"] .Build with Gradle ---- build\native\nativeCompile\spring-cloud-azure-sample ---- === Samples For more information, see link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_4.4.1/spring-native/storage-blob-native[storage-blob-native] on GitHub. Here are other verified samples that support Spring Native. For more information, see link:https://github.com/Azure-Samples/azure-spring-boot-samples#run-samples-based-on-spring-native[Spring Cloud Azure Samples] on GitHub. .Supported Spring Cloud Azure Samples [cols="2", options="header"] |=== |Library Artifact ID |Supported Example Projects |spring-cloud-azure-starter-appconfiguration |link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/appconfiguration/spring-cloud-azure-starter-appconfiguration/appconfiguration-client[appconfiguration-client] |spring-cloud-azure-starter-eventhubs |link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/eventhubs/spring-cloud-azure-starter-eventhubs/eventhubs-client[eventhubs-client] |spring-cloud-azure-starter-integration-eventhubs |link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/eventhubs/spring-cloud-azure-starter-integration-eventhubs/eventhubs-integration[eventhubs-integration] |spring-cloud-azure-starter-integration-storage-queue |link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/storage/spring-cloud-azure-starter-integration-storage-queue/storage-queue-integration[storage-queue-integration], link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/storage/spring-cloud-azure-starter-integration-storage-queue/storage-queue-operation[storage-queue-operation] |spring-cloud-azure-starter-keyvault-secrets |link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/keyvault/spring-cloud-azure-starter-keyvault-secrets/property-source[property-source], link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/keyvault/spring-cloud-azure-starter-keyvault-secrets/secret-client[secret-client] |spring-cloud-azure-starter-storage-blob |link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/storage/spring-cloud-azure-starter-storage-blob/storage-blob-sample[storage-blob-sample] |spring-cloud-azure-starter-storage-file-share |link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/storage/spring-cloud-azure-starter-storage-file-share/storage-file-sample[storage-file-sample] |spring-cloud-azure-starter-storage-queue |link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/storage/spring-cloud-azure-starter-storage-queue/storage-queue-client[storage-queue-client] |=== ================================================ FILE: docs/src/main/asciidoc/spring-security-support.adoc ================================================ == Spring Security Support === Spring Security With Azure Active Directory When you are building a web application, identity and access management will always be foundational pieces. Azure offers a great platform to democratize your application development journey, as it not only offers a cloud-base identity service, but also deep integration with the rest of the Azure ecosystem. 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` provides the most optimal way to connect your web application to an Azure Active Directory (Azure AD for short) tenant and protect your resource server with Azure AD. It uses the Oauth 2.0 protocol to protect web applications and resource servers. ==== 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] ---- com.azure.spring spring-cloud-azure-starter-active-directory org.springframework.boot spring-boot-starter-oauth2-client ---- ===== Add Required Properties [source,yaml] ---- spring: cloud: azure: active-directory: profile: tenant-id: ${AZURE_TENANT_ID} credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} ---- Now start you application and access your application by browser, then you will be redirected into Microsoft login page. ===== 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: cloud: azure: active-directory: user-group: allowed-group-names: group1_name_1, group2_name_2 # 1. If allowed-group-ids == all, then all group id will take effect. # 2. If "all" is used, we should not configure other group ids. # 3. "all" is only supported for allowed-group-ids, not supported for allowed-group-names. allowed-group-ids: group_id_1, group_id_2 ---- * Step 2: Protect specific method. [source,java] ---- @Controller public class RoleController { @GetMapping("group1") @ResponseBody @PreAuthorize("hasRole('ROLE_group1')") public String group1() { return "group1 message"; } @GetMapping("group2") @ResponseBody @PreAuthorize("hasRole('ROLE_group2')") public String group2() { return "group2 message"; } @GetMapping("group1Id") @ResponseBody @PreAuthorize("hasRole('ROLE_')") public String group1Id() { return "group1Id message"; } @GetMapping("group2Id") @ResponseBody @PreAuthorize("hasRole('ROLE_')") public String group2Id() { return "group2Id message"; } } ---- ====== Use National Azure Instead of Global Azure 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] ---- spring: cloud: azure: active-directory: base-uri: https://login.partner.microsoftonline.cn graph-base-uri: https://microsoftgraph.chinacloudapi.cn ---- 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]. ====== Configure 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 redirect-uri in Azure portal. image:https://user-images.githubusercontent.com/13167207/149296913-a4259df9-e0c3-4e38-8d4e-77ee845de4ad.png[web-application-config-redirect-uri] * Step 3: Update WebSecurityConfigurerAdapter 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.oauth2Login() .loginProcessingUrl("${REDIRECT-URI-TEMPLATE}") .and() .authorizeRequests() .anyRequest().authenticated(); } } ---- [#connecting-to-azure-ad-via-proxy] ====== Connecting to Azure AD via proxy To connect Azure AD via proxy, just provide a `RestTemplateCustomizer` bean like this: [source,java] ---- @Configuration class DemoConfiguration { @Bean public RestTemplateCustomizer proxyRestTemplateCustomizer() { return (RestTemplate restTemplate) -> { Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(PROXY_SERVER_HOST, PROXY_SERVER_PORT)); SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory(); requestFactory.setProxy(proxy); restTemplate.setRequestFactory(requestFactory); }; } } ---- ===== 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]. ==== 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] ===== 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] ---- com.azure.spring spring-cloud-azure-starter-active-directory org.springframework.boot spring-boot-starter-oauth2-client ---- ===== Add Required Properties [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: scopes: https://graph.microsoft.com/Analytics.Read, email ---- Here, `graph` is the name of `OAuth2AuthorizedClient`, `scopes` means the scopes need to consent when login. ===== Use OAuth2AuthorizedClient in Your Application [source,java] ---- public class Demo { @GetMapping("/graph") @ResponseBody public String graph( @RegisteredOAuth2AuthorizedClient("graph") OAuth2AuthorizedClient graphClient) { // toJsonString() is just a demo. // oAuth2AuthorizedClient contains access_token. We can use this access_token to access resource server. return toJsonString(graphClient); } } ---- Now start you application and access your application by browser, then you will be redirected into Microsoft login page. ===== Advanced Usages ====== Client Credential Flow 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] ===== 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_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] ---- com.azure.spring spring-cloud-azure-starter-active-directory org.springframework.boot spring-boot-starter-oauth2-resource-server ---- ===== Add Required Properties [source,yaml] ---- spring: cloud: azure: active-directory: credential: client-id: ${AZURE_CLIENT_ID} ---- Now start your application and access your application's web api. 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. 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. ===== Advanced Usages ====== Add Extra Security Configurations [source,java] ---- @EnableWebSecurity @EnableGlobalMethodSecurity(prePostEnabled = true) public class AadOAuth2ResourceServerSecurityConfig extends AadResourceServerWebSecurityConfigurerAdapter { /** * Add configuration logic as needed. */ @Override protected void configure(HttpSecurity http) throws Exception { super.configure(http); http.authorizeRequests((requests) -> requests.anyRequest().authenticated()); } } ---- ====== Validate Permission by Scopes * 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`. * 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`. ====== Use JWT Client Authentication 1. Read link:https://docs.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-microsoft-identity-platform[MS docs about Register your certificate with Microsoft identity platform]. 2. Upload a *.pem* certificate to application registered in Azure Portal. 3. Configure certificate path and password of a **.PFX* or **.P12* certificate. 4. Add property `spring.cloud.azure.active-directory.authorization-clients.azure.client-authentication-method=private_key_jwt` configuration to client that wants to be authenticated through JWT Client Authentication. Below is an example configuration file for a Web Application scenario, certificate information is configured in global properties: [source,yaml] ---- spring: cloud: azure: credential: client-id: ${AZURE_CLIENT_ID} client-certificate-path: ${AZURE_CERTIFICATE_PATH} client-certificate-password: ${AZURE_CERTIFICATE_PASSWORD} profile: tenant-id: ${AZURE_TENANT_ID} active-directory: enabled: true user-group: allowed-group-names: group1,group2 allowed-group-ids: , post-logout-redirect-uri: http://localhost:8080 authorization-clients: azure: client-authentication-method: private_key_jwt arm: client-authentication-method: private_key_jwt on-demand: true scopes: https://management.core.windows.net/user_impersonation graph: client-authentication-method: private_key_jwt scopes: - https://graph.microsoft.com/User.Read - https://graph.microsoft.com/Directory.Read.All webapiA: client-authentication-method: private_key_jwt scopes: - ${WEB_API_A_APP_ID_URL}/Obo.WebApiA.ExampleScope webapiB: client-authentication-method: private_key_jwt scopes: - ${WEB_API_B_APP_ID_URL}/.default authorization-grant-type: client_credentials ---- The certificate information can also be configured in `active-directory` service properties: [source,yaml] ---- spring: cloud: azure: active-directory: enabled: true credential: client-id: ${AZURE_CLIENT_ID} client-certificate-path: ${AZURE_CERTIFICATE_PATH} client-certificate-password: ${AZURE_CERTIFICATE_PASSWORD} profile: tenant-id: ${AZURE_TENANT_ID} user-group: allowed-group-names: group1,group2 allowed-group-ids: , post-logout-redirect-uri: http://localhost:8080 authorization-clients: azure: client-authentication-method: private_key_jwt arm: client-authentication-method: private_key_jwt on-demand: true scopes: https://management.core.windows.net/user_impersonation graph: client-authentication-method: private_key_jwt scopes: - https://graph.microsoft.com/User.Read - https://graph.microsoft.com/Directory.Read.All webapiA: client-authentication-method: private_key_jwt scopes: - ${WEB_API_A_APP_ID_URL}/Obo.WebApiA.ExampleScope webapiB: client-authentication-method: private_key_jwt scopes: - ${WEB_API_B_APP_ID_URL}/.default authorization-grant-type: client_credentials ---- ====== Connecting to Azure AD via proxy To connect Azure AD via proxy, you need provide a `RestTemplateCustomizer` bean. For more information, see the link:index.html#connecting-to-azure-ad-via-proxy[Web application connecting to Azure AD via proxy] section. ===== 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] ===== 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] ---- com.azure.spring spring-cloud-azure-starter-active-directory org.springframework.boot spring-boot-starter-oauth2-resource-server org.springframework.boot spring-boot-starter-oauth2-client ---- ===== Add Required Properties [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: scopes: - https://graph.microsoft.com/User.Read ---- ===== Use OAuth2AuthorizedClient in Your Application [source,java] ---- public class SampleController { @GetMapping("call-graph") public String callGraph(@RegisteredOAuth2AuthorizedClient("graph") OAuth2AuthorizedClient graph) { return callMicrosoftGraphMeEndpoint(graph); } } ---- ===== 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-obo[aad-resource-server-obo]. ==== 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] ---- com.azure.spring spring-cloud-azure-starter-active-directory org.springframework.boot spring-boot-starter-oauth2-resource-server org.springframework.boot spring-boot-starter-oauth2-client ---- ===== 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. [source,yaml] ---- spring: cloud: azure: active-directory: profile: tenant-id: ${AZURE_TENANT_ID} credential: client-id: ${AZURE_CLIENT_ID} client-secret: ${AZURE_CLIENT_SECRET} app-id-uri: ${WEB_API_ID_URI} application-type: web_application_and_resource_server # This is required. authorization-clients: graph: authorizationGrantType: authorization_code # This is required. scopes: - https://graph.microsoft.com/User.Read - https://graph.microsoft.com/Directory.Read.All ---- ===== Define SecurityConfigurationAdapter Configure multiple HttpSecurity instances, `AadWebApplicationAndResourceServerConfig` contain two security configurations for resource server and web application. [source,java] ---- @EnableWebSecurity @EnableGlobalMethodSecurity(prePostEnabled = true) public class AadWebApplicationAndResourceServerConfig { @Order(1) @Configuration public static class ApiWebSecurityConfigurationAdapter extends AadResourceServerWebSecurityConfigurerAdapter { protected void configure(HttpSecurity http) throws Exception { super.configure(http); // All the paths that match `/api/**`(configurable) work as `Resource Server`, other paths work as `Web application`. http.antMatcher("/api/**") .authorizeRequests().anyRequest().authenticated(); } } @Configuration public static class HtmlWebSecurityConfigurerAdapter extends AadWebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { super.configure(http); // @formatter:off http.authorizeRequests() .antMatchers("/login").permitAll() .anyRequest().authenticated(); // @formatter:on } } } ---- ==== Configuration .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*.credential.client-certificate-path | | Client secret to use when performing service principal authentication with Azure. |*spring.cloud.azure.active-directory*.credential.client-certificate-password | | Password of the certificate file. |*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: ===== Application Type 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: .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` |=== === 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. ==== Dependency Setup [source,xml] ---- com.azure.spring spring-cloud-azure-starter-active-directory-b2c ---- ==== Configuration .Configurable properties of spring-cloud-azure-starter-active-directory-b2c [cols="<,<,<", options="header"] |=== |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 | | AAD B2C credential information. |*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 | | AAD B2C profile information. |*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. |=== For full configurations, check link:appendix.html#migration-guide-for-4-0[the Appendix page]. ==== Basic Usage A `web application` is any web based application that allows user to login with Azure AD, whereas a `resource server` will either accept or deny access after validating access_token obtained from Azure AD. We will cover 4 scenarios in this guide: . Accessing a web application. . Web application accessing resource servers. . Accessing a resource server. . Resource server accessing other resource servers. image:https://user-images.githubusercontent.com/13167207/142620440-f970b572-2646-4f50-9f77-db62d6e965f1.png[B2C Web application & Web Api Overall] ===== Usage 1: 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 your Azure AD B2C user. * Step 1: Select *Azure AD B2C* from the portal menu, click *Applications*, and then click *Add*. * Step 2: Specify your application *Name*, we call it `webapp`, add `http://localhost:8080/login/oauth2/code/` for the *Reply URL*, record the *Application ID* as your `WEB_APP_AZURE_CLIENT_ID` and then click *Save*. * Step 3: Select *Keys* from your application, click *Generate key* to generate `WEB_APP_AZURE_CLIENT_SECRET` and then *Save*. * Step 4: Select *User flows* on your left, and then Click *New user flow*. * Step 5: Choose *Sign up or in*, *Profile editing* and *Password reset* to create user flows respectively. Specify your user flow *Name* and *User attributes and claims*, click *Create*. * Step 6: Select *API permissions* > *Add a permission* > *Microsoft APIs*, select *_Microsoft Graph_*, select *Delegated permissions*, check *offline_access* and *openid* permissions, select *Add permission* to complete the process. * Step 7: Grant admin consent for *_Graph_* permissions. image:https://user-images.githubusercontent.com/13167207/142620491-8c8a82ea-c920-43a8-aa0a-dd028f1b8553.png[Add Graph permissions] * Step 8: Add the following dependencies in your _pom.xml_. [source,xml] ---- com.azure.spring azure-spring-boot-starter-active-directory-b2c org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-thymeleaf org.springframework.boot spring-boot-starter-security org.thymeleaf.extras thymeleaf-extras-springsecurity5 ---- * Step 9: Add properties in _application.yml_ using the values you created earlier, for example: [source,yaml] ---- spring: cloud: azure: active-directory: b2c: authenticate-additional-parameters: domain_hint: xxxxxxxxx # optional login_hint: xxxxxxxxx # optional prompt: [login,none,consent] # optional base-uri: ${BASE_URI} credential: client-id: ${WEBAPP_AZURE_CLIENT_ID} client-secret: ${WEBAPP_AZURE_CLIENT_SECRET} login-flow: ${LOGIN_USER_FLOW_KEY} # default to sign-up-or-sign-in, will look up the user-flows map with provided key. logout-success-url: ${LOGOUT_SUCCESS_URL} user-flows: ${YOUR_USER_FLOW_KEY}: ${USER_FLOW_NAME} user-name-attribute-name: ${USER_NAME_ATTRIBUTE_NAME} ---- * Step 10: Write your Java code. Controller code can refer to the following: [source,java] ---- @Controller public class WebController { private void initializeModel(Model model, OAuth2AuthenticationToken token) { if (token != null) { final OAuth2User user = token.getPrincipal(); model.addAllAttributes(user.getAttributes()); model.addAttribute("grant_type", user.getAuthorities()); model.addAttribute("name", user.getName()); } } @GetMapping(value = { "/", "/home" }) public String index(Model model, OAuth2AuthenticationToken token) { initializeModel(model, token); return "home"; } } ---- Security configuration code can refer to the following: [source,java] ---- @EnableWebSecurity public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter { private final AadB2cOidcLoginConfigurer configurer; public WebSecurityConfiguration(AadB2cOidcLoginConfigurer configurer) { this.configurer == configurer; } @Override protected void configure(HttpSecurity http) throws Exception { // @formatter:off http.authorizeRequests() .anyRequest().authenticated() .and() .apply(configurer); // @formatter:off } } ---- Copy the _home.html_ from https://github.com/Azure-Samples/azure-spring-boot-samples/blob/spring-cloud-azure_{project-version}/aad/spring-cloud-azure-starter-active-directory-b2c/aad-b2c-web-application/src/main/resources/templates/home.html[aad-b2c-web-application sample], and replace the `PROFILE_EDIT_USER_FLOW` and `PASSWORD_RESET_USER_FLOW` with your user flow name respectively that completed earlier. * Step 11: Build and test your app Let `Webapp` run on port _8080_. 1. After your application is built and started by Maven, open `http://localhost:8080/` in a web browser; you should be redirected to login page. 2. Click link with the login user flow, you should be redirected Azure AD B2C to start the authentication process. 3. After you have logged in successfully, you should see the sample `home page` from the browser. ===== Usage 2: Web Application Accessing Resource Servers This scenario is based on *Accessing a web application* scenario to allow application to access other resources, that is [The OAuth 2.0 client credentials grant] flow. * Step 1: Select *Azure AD B2C* from the portal menu, click *Applications*, and then click *Add*. * Step 2: Specify your application *Name*, we call it `webApiA`, record the *Application ID* as your `WEB_API_A_AZURE_CLIENT_ID` and then click *Save*. * Step 3: Select *Keys* from your application, click *Generate key* to generate `WEB_API_A_AZURE_CLIENT_SECRET` and then *Save*. * Step 4: Select *Expose an API* on your left, and then Click the *Set* link, record the *Application ID URI* as your `WEB_API_A_APP_ID_URL`, then *Save*. * Step 5: Select *Manifest* on your left, and then paste the following json segment into `appRoles` array, record the *Application ID URI* as your `WEB_API_A_APP_ID_URL`, record the value of the app role as your `WEB_API_A_ROLE_VALUE`, then *save*. [source,json] ---- { "allowedMemberTypes": [ "Application" ], "description": "WebApiA.SampleScope", "displayName": "WebApiA.SampleScope", "id": "04989db0-3efe-4db6-b716-ae378517d2b7", "isEnabled": true, "value": "WebApiA.SampleScope" } ---- image:https://user-images.githubusercontent.com/13167207/142620567-59a91df7-7a97-4027-b525-1f422f25fb22.png[Configure WebApiA appRoles] * Step 6: Select *API permissions* > *Add a permission* > *My APIs*, select *_WebApiA_* application name, select *Application Permissions*, select *WebApiA.SampleScope* permission, select *Add permission* to complete the process. * Step 7: Grant admin consent for *_WebApiA_* permissions. image:https://user-images.githubusercontent.com/13167207/142620601-660400fa-7cff-4989-9d7f-2b32a9aa1244.png[Add WebApiA permission] * Step 8: Add the following dependency on the basis of *Accessing a web application* scenario. [source,xml] ---- org.springframework.boot spring-boot-starter-webflux ---- * Step 9: Add the following configuration on the basis of *Accessing a web application* scenario. [source,yaml] ---- spring: cloud: azure: active-directory: b2c: base-uri: ${BASE_URI} # Such as: https://xxxxb2c.b2clogin.com profile: tenant-id: ${AZURE_TENANT_ID} authorization-clients: ${RESOURCE_SERVER_A_NAME}: authorization-grant-type: client_credentials scopes: ${WEB_API_A_APP_ID_URL}/.default ---- * Step 10: Write your `Webapp` Java code. Controller code can refer to the following: [source,java] ---- class Demo { /** * Access to protected data from Webapp to WebApiA through client credential flow. The access token is obtained by webclient, or *

@RegisteredOAuth2AuthorizedClient("webApiA")

. In the end, these two approaches will be executed to * DefaultOAuth2AuthorizedClientManager#authorize method, get the access token. * * @return Respond to protected data from WebApi A. */ @GetMapping("/webapp/webApiA") public String callWebApiA() { String body = webClient .get() .uri(LOCAL_WEB_API_A_SAMPLE_ENDPOINT) .attributes(clientRegistrationId("webApiA")) .retrieve() .bodyToMono(String.class) .block(); LOGGER.info("Call callWebApiA(), request '/webApiA/sample' returned: {}", body); return "Request '/webApiA/sample'(WebApi A) returned a " + (body != null ? "success." : "failure."); } } ---- Security configuration code is the same with *Accessing a web application* scenario, another bean `webClient` is added as follows: [source,java] ---- public class SampleConfiguration { @Bean public WebClient webClient(OAuth2AuthorizedClientManager oAuth2AuthorizedClientManager) { ServletOAuth2AuthorizedClientExchangeFilterFunction function = new ServletOAuth2AuthorizedClientExchangeFilterFunction(oAuth2AuthorizedClientManager); return WebClient.builder() .apply(function.oauth2Configuration()) .build(); } } ---- * Step 11: See *Accessing a resource server* section to write your `WebApiA` Java code. * Step 12: Build and test your app Let `Webapp` and `WebApiA` run on port _8080_ and _8081_ respectively. Start `Webapp` and `WebApiA` application, return to the home page after logging successfully, you can access `http://localhost:8080/webapp/webApiA` to get *WebApiA* resource response. ===== Usage 3: Accessing a Resource Server This scenario not support login. Just protect the server by validating the access token, and if valid, serves the request. * Step 1: Refer to <<#usage-2-web-application-accessing-resource-servers,Usage 2: Web Application Accessing Resource Servers>> to build your `WebApiA` permission. * Step 2: Add `WebApiA` permission and grant admin consent for your web application. * Step 3: Add the following dependencies in your _pom.xml_. [source,xml] ---- com.azure.spring azure-spring-boot-starter-active-directory-b2c org.springframework.boot spring-boot-starter-web ---- * Step 4: Add the following configuration. [source,yaml] ---- spring: cloud: azure: active-directory: b2c: base-uri: ${BASE_URI} # Such as: https://xxxxb2c.b2clogin.com profile: tenant-id: ${AZURE_TENANT_ID} app-id-uri: ${APP_ID_URI} # If you are using v1.0 token, please configure app-id-uri for `aud` verification credential: client-id: ${AZURE_CLIENT_ID} # If you are using v2.0 token, please configure client-id for `aud` verification ---- * Step 5: Write your Java code. Controller code can refer to the following: [source,java] ---- class Demo { /** * webApiA resource api for web app * @return test content */ @PreAuthorize("hasAuthority('APPROLE_WebApiA.SampleScope')") @GetMapping("/webApiA/sample") public String webApiASample() { LOGGER.info("Call webApiASample()"); return "Request '/webApiA/sample'(WebApi A) returned successfully."; } } ---- Security configuration code can refer to the following: [source,java] ---- @EnableWebSecurity @EnableGlobalMethodSecurity(prePostEnabled = true) public class ResourceServerConfiguration extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { http.authorizeRequests((requests) -> requests.anyRequest().authenticated()) .oauth2ResourceServer() .jwt() .jwtAuthenticationConverter(new AadJwtBearerTokenAuthenticationConverter()); } } ---- * Step 6: Build and test your app 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 This scenario is an upgrade of *Accessing a resource server*, supports access to other application resources, based on OAuth2 client credentials flow. * Step 1: Referring to the previous steps, we create a `WebApiB` application and expose an application permission `WebApiB.SampleScope`. [source,json] ---- { "allowedMemberTypes": [ "Application" ], "description": "WebApiB.SampleScope", "displayName": "WebApiB.SampleScope", "id": "04989db0-3efe-4db6-b716-ae378517d2b7", "isEnabled": true, "lang": null, "origin": "Application", "value": "WebApiB.SampleScope" } ---- image:https://user-images.githubusercontent.com/13167207/142620648-cfbf5220-9736-4050-a3ef-1370c522e672.png[Configure WebApiB appRoles] * Step 2: Grant admin consent for *_WebApiB_* permissions. image:https://user-images.githubusercontent.com/13167207/142620691-b1a7fcda-fc92-41af-9515-812139f26ee0.png[Add WebApiB permission] * Step 3: On the basis of *Accessing a resource server*, add a dependency in your _pom.xml_. [source,xml] ---- org.springframework.boot spring-boot-starter-webflux ---- * Step 4: Add the following configuration on the basis of *Accessing a resource server* scenario configuration. [source,yaml] ---- spring: cloud: azure: active-directory: b2c: credential: client-secret: ${WEB_API_A_AZURE_CLIENT_SECRET} authorization-clients: ${RESOURCE_SERVER_B_NAME}: authorization-grant-type: client_credentials scopes: ${WEB_API_B_APP_ID_URL}/.default ---- * Step 5: Write your Java code. WebApiA controller code can refer to the following: [source,java] ---- public class SampleController { /** * Access to protected data from WebApiA to WebApiB through client credential flow. The access token is obtained by webclient, or *

@RegisteredOAuth2AuthorizedClient("webApiA")

. In the end, these two approaches will be executed to * DefaultOAuth2AuthorizedClientManager#authorize method, get the access token. * * @return Respond to protected data from WebApi B. */ @GetMapping("/webApiA/webApiB/sample") @PreAuthorize("hasAuthority('APPROLE_WebApiA.SampleScope')") public String callWebApiB() { String body = webClient .get() .uri(LOCAL_WEB_API_B_SAMPLE_ENDPOINT) .attributes(clientRegistrationId("webApiB")) .retrieve() .bodyToMono(String.class) .block(); LOGGER.info("Call callWebApiB(), request '/webApiB/sample' returned: {}", body); return "Request 'webApiA/webApiB/sample'(WebApi A) returned a " + (body != null ? "success." : "failure."); } } ---- WebApiB controller code can refer to the following: [source,java] ---- public class SampleController { /** * webApiB resource api for other web application * @return test content */ @PreAuthorize("hasAuthority('APPROLE_WebApiB.SampleScope')") @GetMapping("/webApiB/sample") public String webApiBSample() { LOGGER.info("Call webApiBSample()"); return "Request '/webApiB/sample'(WebApi B) returned successfully."; } } ---- Security configuration code is the same with *Accessing a resource server* scenario, another bean `webClient` is added as follows [source,java] ---- public class SampleConfiguration { @Bean public WebClient webClient(OAuth2AuthorizedClientManager oAuth2AuthorizedClientManager) { ServletOAuth2AuthorizedClientExchangeFilterFunction function = new ServletOAuth2AuthorizedClientExchangeFilterFunction(oAuth2AuthorizedClientManager); return WebClient.builder() .apply(function.oauth2Configuration()) .build(); } } ---- * Step 6: Build and test your app Let `WebApiA` and `WebApiB` run on port _8081_ and _8082_ respectively. Start `WebApiA` and `WebApiB` application, get the access token for `webApiA` resource and access `http://localhost:8081/webApiA/webApiB/sample` as the Bearer authorization header. ==== Samples See 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. ================================================ FILE: docs/src/main/asciidoc/version-information.adoc ================================================ This document is only for Spring Cloud Azure: **{project-version}**. See https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping[Spring Versions Mapping] to get more information about supported versions. IMPORTANT: For the latest reference document, see https://aka.ms/spring/msdocs/developer-guide[Spring Cloud Azure developer guide] for the developer guide. ================================================ FILE: docs/src/main/asciidoc/whats-new-4.0.adoc ================================================ == What Is New in 4.0 Since 3.10.x 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 migrate to 4.0, please check link:appendix.html#migration-guide-for-4-0[the Appendix page]. The following list summarizes some of the changes that Spring Cloud Azure 4.0 provides: * A unified development experience, with unified project name, artifact ID, and properties. * Simplified dependency management using a single `spring-cloud-azure-dependencies` BOM. * Expanded Azure support on link:https://start.spring.io[Spring Initializr] to cover Kafka, Event Hubs, Azure Cache for Redis, and Azure App Configuration. * Rearchitected Spring module dependencies to remove excess layers and entanglement. * Managed Identity support for Azure App Configuration, Event Hubs, Service Bus, Cosmos DB, Key Vault, Storage Blob, and Storage Queue. * Continued support for authentication methods in the underlying Azure SDK from our Spring libraries, such as SAS token and token credential authentication with Service Bus and Event Hubs. * link:https://docs.microsoft.com/en-us/java/api/overview/azure/identity-readme?view=azure-java-stable&preserve-view=true#defaultazurecredential[Credential chain] is now enabled by default, enabling applications to obtain credentials from application properties, environment variables, managed identity, IDEs, and so on. * Granular access control at the resource level (such as Service Bus queue) to enable better security governance and adherence to IT policies. * More options exposed in a Spring-idiomatic way through significantly improved auto-configuration coverage of Azure SDK clients for both synchronous and asynchronous scenarios. * Added health indicators for Azure App Configuration, Event Hubs, Cosmos DB, Key Vault, Storage Blob, Storage Queue, and Storage File. * Spring Cloud Sleuth support for all HTTP-based Azure SDKs. ================================================ FILE: mvnw ================================================ #!/bin/sh # ---------------------------------------------------------------------------- # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # ---------------------------------------------------------------------------- # ---------------------------------------------------------------------------- # Maven Start Up Batch script # # Required ENV vars: # ------------------ # JAVA_HOME - location of a JDK home dir # # Optional ENV vars # ----------------- # M2_HOME - location of maven2's installed home dir # MAVEN_OPTS - parameters passed to the Java VM when running Maven # e.g. to debug Maven itself, use # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 # MAVEN_SKIP_RC - flag to disable loading of mavenrc files # ---------------------------------------------------------------------------- if [ -z "$MAVEN_SKIP_RC" ] ; then if [ -f /etc/mavenrc ] ; then . /etc/mavenrc fi if [ -f "$HOME/.mavenrc" ] ; then . "$HOME/.mavenrc" fi fi # OS specific support. $var _must_ be set to either true or false. cygwin=false; darwin=false; mingw=false case "`uname`" in CYGWIN*) cygwin=true ;; MINGW*) mingw=true;; Darwin*) darwin=true # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home # See https://developer.apple.com/library/mac/qa/qa1170/_index.html if [ -z "$JAVA_HOME" ]; then if [ -x "/usr/libexec/java_home" ]; then export JAVA_HOME="`/usr/libexec/java_home`" else export JAVA_HOME="/Library/Java/Home" fi fi ;; esac if [ -z "$JAVA_HOME" ] ; then if [ -r /etc/gentoo-release ] ; then JAVA_HOME=`java-config --jre-home` fi fi if [ -z "$M2_HOME" ] ; then ## resolve links - $0 may be a link to maven's home PRG="$0" # need this for relative symlinks while [ -h "$PRG" ] ; do ls=`ls -ld "$PRG"` link=`expr "$ls" : '.*-> \(.*\)$'` if expr "$link" : '/.*' > /dev/null; then PRG="$link" else PRG="`dirname "$PRG"`/$link" fi done saveddir=`pwd` M2_HOME=`dirname "$PRG"`/.. # make it fully qualified M2_HOME=`cd "$M2_HOME" && pwd` cd "$saveddir" # echo Using m2 at $M2_HOME fi # For Cygwin, ensure paths are in UNIX format before anything is touched if $cygwin ; then [ -n "$M2_HOME" ] && M2_HOME=`cygpath --unix "$M2_HOME"` [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` [ -n "$CLASSPATH" ] && CLASSPATH=`cygpath --path --unix "$CLASSPATH"` fi # For Mingw, ensure paths are in UNIX format before anything is touched if $mingw ; then [ -n "$M2_HOME" ] && M2_HOME="`(cd "$M2_HOME"; pwd)`" [ -n "$JAVA_HOME" ] && JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" fi if [ -z "$JAVA_HOME" ]; then javaExecutable="`which javac`" if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then # readlink(1) is not available as standard on Solaris 10. readLink=`which readlink` if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then if $darwin ; then javaHome="`dirname \"$javaExecutable\"`" javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" else javaExecutable="`readlink -f \"$javaExecutable\"`" fi javaHome="`dirname \"$javaExecutable\"`" javaHome=`expr "$javaHome" : '\(.*\)/bin'` JAVA_HOME="$javaHome" export JAVA_HOME fi fi fi if [ -z "$JAVACMD" ] ; then if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables JAVACMD="$JAVA_HOME/jre/sh/java" else JAVACMD="$JAVA_HOME/bin/java" fi else JAVACMD="`which java`" fi fi if [ ! -x "$JAVACMD" ] ; then echo "Error: JAVA_HOME is not defined correctly." >&2 echo " We cannot execute $JAVACMD" >&2 exit 1 fi if [ -z "$JAVA_HOME" ] ; then echo "Warning: JAVA_HOME environment variable is not set." fi CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher # traverses directory structure from process work directory to filesystem root # first directory with .mvn subdirectory is considered project base directory find_maven_basedir() { if [ -z "$1" ] then echo "Path not specified to find_maven_basedir" return 1 fi basedir="$1" wdir="$1" while [ "$wdir" != '/' ] ; do if [ -d "$wdir"/.mvn ] ; then basedir=$wdir break fi # workaround for JBEAP-8937 (on Solaris 10/Sparc) if [ -d "${wdir}" ]; then wdir=`cd "$wdir/.."; pwd` fi # end of workaround done echo "${basedir}" } # concatenates all lines of a file concat_lines() { if [ -f "$1" ]; then echo "$(tr -s '\n' ' ' < "$1")" fi } BASE_DIR=`find_maven_basedir "$(pwd)"` if [ -z "$BASE_DIR" ]; then exit 1; fi ########################################################################################## # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central # This allows using the maven wrapper in projects that prohibit checking in binary data. ########################################################################################## if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then if [ "$MVNW_VERBOSE" = true ]; then echo "Found .mvn/wrapper/maven-wrapper.jar" fi else if [ "$MVNW_VERBOSE" = true ]; then echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." fi if [ -n "$MVNW_REPOURL" ]; then jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" else jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" fi while IFS="=" read key value; do case "$key" in (wrapperUrl) jarUrl="$value"; break ;; esac done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" if [ "$MVNW_VERBOSE" = true ]; then echo "Downloading from: $jarUrl" fi wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" if $cygwin; then wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` fi if command -v wget > /dev/null; then if [ "$MVNW_VERBOSE" = true ]; then echo "Found wget ... using wget" fi if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then wget "$jarUrl" -O "$wrapperJarPath" else wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" fi elif command -v curl > /dev/null; then if [ "$MVNW_VERBOSE" = true ]; then echo "Found curl ... using curl" fi if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then curl -o "$wrapperJarPath" "$jarUrl" -f else curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f fi else if [ "$MVNW_VERBOSE" = true ]; then echo "Falling back to using Java to download" fi javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" # For Cygwin, switch paths to Windows format before running javac if $cygwin; then javaClass=`cygpath --path --windows "$javaClass"` fi if [ -e "$javaClass" ]; then if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then if [ "$MVNW_VERBOSE" = true ]; then echo " - Compiling MavenWrapperDownloader.java ..." fi # Compiling the Java class ("$JAVA_HOME/bin/javac" "$javaClass") fi if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then # Running the downloader if [ "$MVNW_VERBOSE" = true ]; then echo " - Running MavenWrapperDownloader.java ..." fi ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") fi fi fi fi ########################################################################################## # End of extension ########################################################################################## export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} if [ "$MVNW_VERBOSE" = true ]; then echo $MAVEN_PROJECTBASEDIR fi MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" # For Cygwin, switch paths to Windows format before running java if $cygwin; then [ -n "$M2_HOME" ] && M2_HOME=`cygpath --path --windows "$M2_HOME"` [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` [ -n "$CLASSPATH" ] && CLASSPATH=`cygpath --path --windows "$CLASSPATH"` [ -n "$MAVEN_PROJECTBASEDIR" ] && MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` fi # Provide a "standardized" way to retrieve the CLI args that will # work with both Windows and non-Windows executions. MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" export MAVEN_CMD_LINE_ARGS WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain exec "$JAVACMD" \ $MAVEN_OPTS \ -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" ================================================ FILE: mvnw.cmd ================================================ @REM ---------------------------------------------------------------------------- @REM Licensed to the Apache Software Foundation (ASF) under one @REM or more contributor license agreements. See the NOTICE file @REM distributed with this work for additional information @REM regarding copyright ownership. The ASF licenses this file @REM to you under the Apache License, Version 2.0 (the @REM "License"); you may not use this file except in compliance @REM with the License. You may obtain a copy of the License at @REM @REM https://www.apache.org/licenses/LICENSE-2.0 @REM @REM Unless required by applicable law or agreed to in writing, @REM software distributed under the License is distributed on an @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @REM KIND, either express or implied. See the License for the @REM specific language governing permissions and limitations @REM under the License. @REM ---------------------------------------------------------------------------- @REM ---------------------------------------------------------------------------- @REM Maven Start Up Batch script @REM @REM Required ENV vars: @REM JAVA_HOME - location of a JDK home dir @REM @REM Optional ENV vars @REM M2_HOME - location of maven2's installed home dir @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven @REM e.g. to debug Maven itself, use @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files @REM ---------------------------------------------------------------------------- @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' @echo off @REM set title of command window title %0 @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% @REM set %HOME% to equivalent of $HOME if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") @REM Execute a user defined script before this one if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre @REM check for pre script, once with legacy .bat ending and once with .cmd ending if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" :skipRcPre @setlocal set ERROR_CODE=0 @REM To isolate internal variables from possible post scripts, we use another setlocal @setlocal @REM ==== START VALIDATION ==== if not "%JAVA_HOME%" == "" goto OkJHome echo. echo Error: JAVA_HOME not found in your environment. >&2 echo Please set the JAVA_HOME variable in your environment to match the >&2 echo location of your Java installation. >&2 echo. goto error :OkJHome if exist "%JAVA_HOME%\bin\java.exe" goto init echo. echo Error: JAVA_HOME is set to an invalid directory. >&2 echo JAVA_HOME = "%JAVA_HOME%" >&2 echo Please set the JAVA_HOME variable in your environment to match the >&2 echo location of your Java installation. >&2 echo. goto error @REM ==== END VALIDATION ==== :init @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". @REM Fallback to current working directory if not found. set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir set EXEC_DIR=%CD% set WDIR=%EXEC_DIR% :findBaseDir IF EXIST "%WDIR%"\.mvn goto baseDirFound cd .. IF "%WDIR%"=="%CD%" goto baseDirNotFound set WDIR=%CD% goto findBaseDir :baseDirFound set MAVEN_PROJECTBASEDIR=%WDIR% cd "%EXEC_DIR%" goto endDetectBaseDir :baseDirNotFound set MAVEN_PROJECTBASEDIR=%EXEC_DIR% cd "%EXEC_DIR%" :endDetectBaseDir IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig @setlocal EnableExtensions EnableDelayedExpansion for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% :endReadAdditionalConfig SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B ) @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central @REM This allows using the maven wrapper in projects that prohibit checking in binary data. if exist %WRAPPER_JAR% ( if "%MVNW_VERBOSE%" == "true" ( echo Found %WRAPPER_JAR% ) ) else ( if not "%MVNW_REPOURL%" == "" ( SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" ) if "%MVNW_VERBOSE%" == "true" ( echo Couldn't find %WRAPPER_JAR%, downloading it ... echo Downloading from: %DOWNLOAD_URL% ) powershell -Command "&{"^ "$webclient = new-object System.Net.WebClient;"^ "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ "}"^ "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ "}" if "%MVNW_VERBOSE%" == "true" ( echo Finished downloading %WRAPPER_JAR% ) ) @REM End of extension @REM Provide a "standardized" way to retrieve the CLI args that will @REM work with both Windows and non-Windows executions. set MAVEN_CMD_LINE_ARGS=%* %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* if ERRORLEVEL 1 goto error goto end :error set ERROR_CODE=1 :end @endlocal & set ERROR_CODE=%ERROR_CODE% if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost @REM check for post script, once with legacy .bat ending and once with .cmd ending if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" :skipRcPost @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' if "%MAVEN_BATCH_PAUSE%" == "on" pause if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% exit /B %ERROR_CODE% ================================================ FILE: pom.xml ================================================ 4.0.0 org.springframework.cloud spring-cloud-build 4.0.5 com.azure.spring spring-cloud-azure-aggregator 4.4.1 pom Spring Cloud Azure Spring Cloud Azure 2.8.2 4.0.5 4.4.1 0.0.29 1.8 1.8 docs spring-cloud-azure-markdown-appdendix-generator com.azure.spring spring-cloud-azure-dependencies ${version.spring.cloud.azure} pom import org.springframework.cloud spring-cloud-commons-dependencies ${spring-cloud-commons.version} pom import org.slf4j slf4j-api org.springframework.boot spring-boot-starter-test test org.junit.vintage junit-vintage-engine junit junit maven-compiler-plugin -Xlint:all -Xlint:-options -Xlint:-serial org.codehaus.mojo exec-maven-plugin generate-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-all.adoc (?!spring.cloud.azure.storage.fileshare.(credential).*)(spring.jms.servicebus.*|spring.cloud.azure.*) generate-global-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-global.adoc spring.cloud.azure.(client|credential|profile|proxy|retry).* generate-aad-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-active-directory.adoc (?!spring.cloud.azure.active-directory.b2c.*)(spring.cloud.azure.active-directory.*) generate-aadb2c-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-active-directory-b2c.adoc spring.cloud.azure.active-directory.b2c.* generate-appconf-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-app-configuration.adoc spring.cloud.azure.appconfiguration.* generate-cosmos-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-cosmos-db.adoc spring.cloud.azure.cosmos.* generate-eventhubs-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-event-hubs.adoc spring.cloud.azure.eventhubs.* generate-kv-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-key-vault.adoc (?!spring.cloud.azure.keyvault.(secret|certificate).*)(spring.cloud.azure.keyvault.*) generate-kv-secret-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-key-vault-secrets.adoc spring.cloud.azure.keyvault.secret.* generate-kv-certificate-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-key-vault-certificates.adoc spring.cloud.azure.keyvault.certificate.* generate-servicebus-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-service-bus.adoc spring.cloud.azure.servicebus.* generate-servicebus-jms-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-service-bus-jms.adoc spring.jms.servicebus.* generate-storage-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-storage.adoc (?!spring.cloud.azure.storage.(blob|fileshare|queue).*)(spring.cloud.azure.storage.*) generate-storage-blob-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-storage-blob.adoc spring.cloud.azure.storage.blob.* generate-storage-fileshare-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-storage-file-share.adoc (?!spring.cloud.azure.storage.fileshare.(credential).*)(spring.cloud.azure.storage.fileshare.*) generate-storage-queue-configprops prepare-package java ${project.basedir}/src/main/asciidoc/_configuration-properties-azure-storage-queue.adoc spring.cloud.azure.storage.queue.* org.apache.maven.plugins maven-checkstyle-plugin io.spring.javaformat spring-javaformat-maven-plugin validate true validate org.apache.maven.plugins maven-javadoc-plugin 3.5.0 https://docs.oracle.com/javase/8/docs/api/ https://docs.oracle.com/javaee/8/api/ https://fasterxml.github.io/jackson-core/javadoc/2.8/ https://docs.spring.io/spring/docs/5.3.x/javadoc-api/ true
${project.name}
${project.build.directory}/site/${project.version}/apidocs org.apache.maven.plugins maven-checkstyle-plugin spring spring-snapshots Spring Snapshots https://repo.spring.io/libs-snapshot-local true false spring-milestones Spring Milestones https://repo.spring.io/libs-milestone-local false spring-releases Spring Releases https://repo.spring.io/release false spring-snapshots Spring Snapshots https://repo.spring.io/libs-snapshot-local true false spring-milestones Spring Milestones https://repo.spring.io/libs-milestone-local false spring-releases Spring Releases https://repo.spring.io/libs-release-local false ================================================ FILE: spring-cloud-azure-markdown-appdendix-generator/pom.xml ================================================ 4.0.0 com.azure.spring spring-cloud-azure-aggregator 4.4.1 ../pom.xml spring-cloud-azure-markdown-appdendix-generator spring-cloud-azure-markdown-appdendix-generator jar com.azure.spring spring-cloud-azure-starter com.azure.spring spring-cloud-azure-starter-stream-eventhubs com.azure.spring spring-cloud-azure-starter-stream-servicebus markdown-docs org.codehaus.mojo exec-maven-plugin com.azure.spring.cloud.internal.Main ================================================ FILE: spring-cloud-azure-markdown-appdendix-generator/src/main/java/com/azure/spring/cloud/internal/Main.java ================================================ /* * Copyright 2012-2020 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.azure.spring.cloud.internal; import java.io.BufferedWriter; import java.io.File; import java.io.IOException; import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; import java.text.SimpleDateFormat; import java.util.Arrays; import java.util.Date; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.TreeMap; import java.util.regex.Pattern; import java.util.stream.Collectors; import java.util.stream.Stream; import com.fasterxml.jackson.databind.ObjectMapper; import org.springframework.core.io.Resource; import org.springframework.core.io.support.PathMatchingResourcePatternResolver; import org.springframework.util.StreamUtils; /** * Generate markdown files with configuration properties based on the path of the file to * be output and the pattern included in the properties. */ public final class Main { private Main() { } /** * This method is used to generate configuration properties Markdown files. * @param args args[0]: output file name. The file name must start with * "_configuration-properties-". And in actual outputted file name, ".adoc" will be * replaced by ".md", "_" will be replaced by "". For example: * "_configuration-properties-global.adoc" after the replacement is * "configuration-properties-global.md". This is required because this module and the * docs' module use the configuration of the parent pom and changes to configuration * properties need to be synced to MS Docs. args[1]: property inclusion pattern. * Filter unwanted properties based on patterns. */ public static void main(String... args) { String outputFile = args[0].replace("adoc", "md").replace("_", ""); String inclusionPattern = args.length > 1 ? args[1] : ".*"; File parent = new File(outputFile).getParentFile(); if (!parent.exists()) { System.out.println( "No parent directory [" + parent + "] found. Will not generate the configuration properties file"); return; } new Generator().generate(outputFile, inclusionPattern, getCurrentDateString()); } /** * Get current date string. * @return the current date string */ static String getCurrentDateString() { SimpleDateFormat simpleDateFormat = new SimpleDateFormat(); simpleDateFormat.applyPattern("MM/dd/yyyy"); Date date = new Date(); return simpleDateFormat.format(date); } /** * Generate Markdown files based on properties and filename. */ static class Generator { /** * Generate files prefixed with configuration-properties. * @param outputFile the file name must start with "configuration-properties-" * @param inclusionPattern the inclusion pattern * @param date the current date string */ void generate(String outputFile, String inclusionPattern, String date) { try { System.out.println("Parsing all configuration metadata"); List resources = getSpringConfigurationMetadataJsonFilesInClasspath(); TreeMap descriptions = new TreeMap<>(); int propertyCount = 0; Pattern pattern = Pattern.compile(inclusionPattern); ObjectMapper objectMapper = new ObjectMapper(); for (Resource resource : resources) { byte[] bytes = StreamUtils.copyToByteArray(resource.getInputStream()); Map rootMap = objectMapper.readValue(bytes, HashMap.class); List> properties = (List>) rootMap.get("properties"); propertyCount += properties.size(); properties.forEach(propertyItem -> { String name = String.valueOf(propertyItem.get("name")); if (!pattern.matcher(name).matches()) { return; } String description = formatDescription(String.valueOf(propertyItem.get("description"))); String defaultValue = String.valueOf(propertyItem.get("defaultValue")); descriptions.put(name, defaultValue == null || defaultValue.equals("null") ? description : description + " The default value is " + "`" + defaultValue + "`" + "."); }); } System.out.println("Found [" + resources.size() + "] Azure projects configuration metadata jsons. [" + descriptions.size() + "/" + propertyCount + "] were matching the pattern [" + inclusionPattern + "]"); System.out.println("Successfully built the description table"); if (descriptions.isEmpty()) { System.out.println("Will not update the table, since no configuration properties were found!"); return; } generatePropertiesFile(outputFile, descriptions, date); } catch (IOException e) { throw new IllegalStateException(e); } } /** * Get Spring on Azure related "spring-configuration-metadata.json" files in * classpath. * @return a result set containing the specified fields * @throws IOException did not get any "spring-configuration-metadata.json" files * in classpath */ protected List getSpringConfigurationMetadataJsonFilesInClasspath() throws IOException { Resource[] resources = new PathMatchingResourcePatternResolver() .getResources("classpath*:/META-INF/spring-configuration-metadata.json"); return Arrays.stream(resources).filter(resource -> { try { return resource.getURL().toString().contains("azure"); } catch (IOException e) { e.printStackTrace(); } return false; }).collect(Collectors.toList()); } private String formatDescription(String description) { return formatURL(replaceQuotes(description)).replace("GrantedAuthority's", "`GrantedAuthority`'s") .replace("access_token's", "`access_token`'s"); } private String formatURL(String description) { String regex1 = "(\\b\\w+\\b)\\s?:\\s*https?://learn.microsoft.com([^\\s]+)"; String regex2 = "(@see = 5 && description.startsWith("@see <", i - 5)) { insideSeeTag = true; } if (insideSeeTag) { result.append(currentChar); if (currentChar == '>') { insideSeeTag = false; } continue; } if (currentChar == '`') { insideBacktick = !insideBacktick; result.append(currentChar); continue; } if (!insideBacktick) { // skip 's, n't if (i + 1 < n && currentChar == '\'' && (description.charAt(i + 1) == 's' || description.charAt(i + 1) == 't') && i > 0 && (Character.isLetter(description.charAt(i - 1)) || description.charAt(i - 1) == 'n')) { result.append(currentChar); continue; } if (currentChar == '\'' && !insideDoubleQuote) { result.append('`'); insideSingleQuote = !insideSingleQuote; } else if (currentChar == '"' && !insideSingleQuote) { result.append('`'); insideDoubleQuote = !insideDoubleQuote; } else { result.append(currentChar); } } else { result.append(currentChar); } } return result.toString(); } /** * Padding the string to the required length. * @param string the string to padding * @param c the padding content * @param resultLength the length of padding * @return the required length */ private String paddingWithChar(String string, char c, int resultLength) { String result = String.format("%1$-" + resultLength + "s", string.trim()); if (' ' != c) { return result.replace(' ', c); } return result; } /** * Uppercase string. * @param letters the uppercase string required * @return the uppercase string */ private String uppercaseString(String letters) { if ("db".equals(letters) | "jms".equals(letters) | "b2c".equals(letters)) { return letters.toUpperCase(); } else { return letters.substring(0, 1).toUpperCase().concat(letters.substring(1)); } } /** * Generate title name for markdown files. * @param outputFile the output file name * @return the title name */ private String generateTitleName(String outputFile) { outputFile = outputFile .substring(outputFile.lastIndexOf(File.separator) + "_configuration-properties-".length(), outputFile.lastIndexOf(".")) .replace('-', ' ').trim(); if ("all".equals(outputFile)) { return "List of configuration"; } String[] value = outputFile.split(" "); StringBuilder result = new StringBuilder(" "); for (String s : value) { result.append(uppercaseString(s)).append(" "); } return result.toString().trim(); } /** * Compare the lengths of elements in the given result set and return the max * length. * @param stringStream the result sets to compare * @return the max length */ private int getMaxLength(Stream stringStream) { return stringStream.map(String::trim).mapToInt(String::length).max().orElse(0); } /** * To reduce variance, use the same description width as the current document. */ private int getDescriptionColumnWidth(String outputFile, Stream stringStream) { Map DES_WIDTH = new HashMap<>(); DES_WIDTH.put("configuration-properties-azure-active-directory.md", 641); DES_WIDTH.put("configuration-properties-azure-active-directory-b2c.md", 470); DES_WIDTH.put("configuration-properties-azure-service-bus.md", 194); DES_WIDTH.put("configuration-properties-azure-service-bus-jms.md", 446); return DES_WIDTH.getOrDefault(outputFile.substring(outputFile.lastIndexOf("/") + 1), getMaxLength(stringStream)); } private String getServiceName(String outputFile) { HashMap DES_WIDTH = new HashMap<>(); DES_WIDTH.put("configuration-properties-all.md", "Spring Cloud Azure"); DES_WIDTH.put("configuration-properties-azure-active-directory.md", "Microsoft Entra"); DES_WIDTH.put("configuration-properties-azure-active-directory-b2c.md", "Azure Active Directory B2C"); DES_WIDTH.put("configuration-properties-azure-app-configuration.md", "Azure App Configuration"); DES_WIDTH.put("configuration-properties-azure-cosmos-db.md", "Azure Cosmos DB"); DES_WIDTH.put("configuration-properties-azure-event-hubs.md", "Azure Event Hubs"); DES_WIDTH.put("configuration-properties-azure-key-vault.md", "Azure Key Vault"); DES_WIDTH.put("configuration-properties-azure-key-vault-certificates.md", "Azure Key Vault Certificates"); DES_WIDTH.put("configuration-properties-azure-key-vault-secrets.md", "Azure Key Vault Secrets"); DES_WIDTH.put("configuration-properties-azure-service-bus.md", "Azure Service Bus"); DES_WIDTH.put("configuration-properties-azure-service-bus-jms.md", "Azure Service Bus JMS"); DES_WIDTH.put("configuration-properties-azure-storage.md", "Azure Storage"); DES_WIDTH.put("configuration-properties-azure-storage-blob.md", "Azure Storage Blob"); DES_WIDTH.put("configuration-properties-azure-storage-file-share.md", "Azure Storage File Share"); DES_WIDTH.put("configuration-properties-azure-storage-queue.md", "Azure Storage Queue"); DES_WIDTH.put("configuration-properties-global.md", "Spring Cloud Azure Global"); return DES_WIDTH.getOrDefault(outputFile.substring(outputFile.lastIndexOf("/") + 1), null); } /** * Generate properties markdown files. * @param outputFile the output file * @param descriptions the result set of properties and their descriptions * @param date the current date string */ private void generatePropertiesFile(String outputFile, TreeMap descriptions, String date) { int nameColumnWidth = getMaxLength(descriptions.keySet().stream()); int descriptionColumnWidth = getDescriptionColumnWidth(outputFile, descriptions.values().stream()); Path path = Paths.get(outputFile); String serviceName = getServiceName(outputFile); try (BufferedWriter writer = Files.newBufferedWriter(path, StandardCharsets.UTF_8)) { writer.write("---"); writer.newLine(); writer.write(String.format("title: %s configuration properties", serviceName)); writer.newLine(); writer.write(String.format("description: This reference doc contains all %s configuration properties.", serviceName)); writer.newLine(); writer.write("author: KarlErickson"); writer.newLine(); writer.write("ms.author: hangwan"); writer.newLine(); writer.write("ms.date: " + date); writer.newLine(); writer.write("ms.topic: reference"); writer.newLine(); writer.write("ms.custom: devx-track-java, spring-cloud-azure, devx-track-extended-java"); writer.newLine(); writer.write("---"); writer.newLine(); writer.newLine(); writer.write(String.format("# %s configuration properties", serviceName)); writer.newLine(); writer.newLine(); writer.write("> [!div class=\"mx-tdBreakAll\"]"); writer.newLine(); String propertyHeader = paddingWithChar("Property", ' ', nameColumnWidth + 1); String descriptionHeader = paddingWithChar("Description", ' ', descriptionColumnWidth + 1); writer.write("> | " + propertyHeader + "| " + descriptionHeader + "|"); writer.newLine(); String markdownTableCol1 = paddingWithChar("", '-', nameColumnWidth + 2); String markdownTableCol2 = paddingWithChar("", '-', descriptionColumnWidth + 2); writer.write("> |" + markdownTableCol1 + "|" + markdownTableCol2 + "|"); writer.newLine(); for (Map.Entry description : descriptions.entrySet()) { String nameCol = paddingWithChar(description.getKey(), ' ', nameColumnWidth); String descriptionCol = paddingWithChar(description.getValue(), ' ', descriptionColumnWidth); writer.write("> | " + nameCol + " | " + descriptionCol + " |"); writer.newLine(); } } catch (IOException e) { e.printStackTrace(); } System.out.println("Successfully stored the output Markdown file!"); } } } ================================================ FILE: spring-cloud-azure-markdown-appdendix-generator/src/test/java/com/azure/spring/cloud/internal/GeneratorTests.java ================================================ /* * Copyright 2013-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.azure.spring.cloud.internal; import java.io.BufferedInputStream; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.net.URL; import java.util.ArrayList; import java.util.Arrays; import java.util.List; import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.core.io.Resource; import org.springframework.core.io.support.PathMatchingResourcePatternResolver; import static org.assertj.core.api.BDDAssertions.then; class GeneratorTests { private static final String DATE = "MM/dd/yyyy"; private static final String INCLUSION_PATTERN = "spring.cloud.azure.*"; @BeforeEach public void before() { File file = getOutputFilePath(); if (file.delete()) { System.out.println("File deleted!"); } } @Test void notCreateFileWhenNoPropertiesFound() { Main.Generator generator = new Main.Generator() { @Override protected List getSpringConfigurationMetadataJsonFilesInClasspath() { return new ArrayList<>(); } }; File file = getOutputFilePath(); String outputFile = file.getPath(); generator.generate(outputFile, INCLUSION_PATTERN, DATE); then(file).doesNotExist(); } @Test void createFileWhenPropertiesFound() throws IOException { Main.Generator generator = new Main.Generator() { @Override protected List getSpringConfigurationMetadataJsonFilesInClasspath() throws IOException { Resource[] resources = new PathMatchingResourcePatternResolver() .getResources("/with-azure-in-name.json"); return Arrays.asList(resources); } }; File file = getOutputFilePath(); String outputFile = file.getPath(); generator.generate(outputFile, INCLUSION_PATTERN, DATE); then(file).exists(); compareFile(outputFile); } private void compareFile(String file2) throws IOException { try (BufferedInputStream inFile1 = new BufferedInputStream( new FileInputStream("src/test/resources/configuration-properties-output.md")); BufferedInputStream inFile2 = new BufferedInputStream(new FileInputStream(file2))) { Assertions.assertThat(inFile1).hasSameContentAs(inFile2); } } private File getOutputFilePath() { URL root = this.getClass().getResource("."); if (root == null) { throw new IllegalArgumentException("The output file path is not found!"); } else { return new File(root.getPath(), "configuration-properties-output.md"); } } } ================================================ FILE: spring-cloud-azure-markdown-appdendix-generator/src/test/java/com/azure/spring/cloud/internal/MainTests.java ================================================ /* * Copyright 2013-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.azure.spring.cloud.internal; import java.io.File; import org.junit.jupiter.api.Test; import static org.assertj.core.api.BDDAssertions.then; class MainTests { @Test void notCreateFileWhenNoParentDirectoryFound() { File nonExistantFile = new File("/this/file/does/not/exist"); Main.main(nonExistantFile.getAbsolutePath()); then(nonExistantFile).doesNotExist(); } } ================================================ FILE: spring-cloud-azure-markdown-appdendix-generator/src/test/resources/configuration-properties-output.md ================================================ --- author: KarlErickson ms.author: v-yonghuiye ms.date: MM/dd/yyyy --- ## Output properties > [!div class="mx-tdBreakAll"] > | Property | Description | > |------------------------------------|--------------------------------------------------| > | spring.cloud.azure.first-property | First Description. The default value is `false`. | > | spring.cloud.azure.fourth-property | Fourth Description. | > | spring.cloud.azure.second-property | Second Description. The default value is `true`. | ================================================ FILE: spring-cloud-azure-markdown-appdendix-generator/src/test/resources/with-azure-in-name.json ================================================ { "properties": [ { "defaultValue": "false", "name": "spring.cloud.azure.first-property", "description": "First Description.", "type": "java.lang.Boolean" }, { "defaultValue": "true", "name": "spring.cloud.azure.second-property", "description": "Second Description.", "type": "java.lang.Boolean" }, { "defaultValue": "true", "name": "spring.cloud.third-property", "description": "Third Description.", "type": "java.lang.Boolean" }, { "name": "spring.cloud.azure.fourth-property", "description": "Fourth Description.", "type": "java.lang.Boolean" } ] }