* Revert "Fix pipeline failure (#907)"

This reverts commit 45db4411b4.

* Revert "Add more modules: profile, getting-started, samples, tutorial (#906)"

This reverts commit 0e022a77b2.
This commit is contained in:
Rujun Chen 2022-04-01 22:27:14 +08:00 коммит произвёл GitHub
Родитель 45db4411b4
Коммит 6034fba970
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
306 изменённых файлов: 1004 добавлений и 6184 удалений

48
.github/workflows/updateDocs.yaml поставляемый
Просмотреть файл

@ -4,15 +4,24 @@ on:
push:
branches:
- main
- hotfix/*
- docs
- 4.*
# 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:
- name: Install azure-sdk-for-java
run: |
- run: |
git init azure-sdk-for-java
cd azure-sdk-for-java
git remote add origin https://github.com/Azure/azure-sdk-for-java.git
@ -30,15 +39,11 @@ jobs:
-Dparallel-test-playback \
-Pdev \
-f sdk/spring/pom.xml
- name: Get current date
id: date
run: echo "::set-output name=date::$(date +'%Y-%m-%d' --utc)"
- uses: actions/checkout@v2
- name: Config git
run: |
- run: |
git config user.name github-actions
git config user.email github-actions@github.com
@ -57,5 +62,28 @@ jobs:
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: ./scripts/update_gh-pages_branch.sh --build
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
./docs/src/main/asciidoc/ghpages.sh --build
fi

Просмотреть файл

Просмотреть файл

6
docs/generate-docs.sh Executable file
Просмотреть файл

@ -0,0 +1,6 @@
#!/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

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

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

Просмотреть файл

Просмотреть файл

@ -0,0 +1,26 @@
= Getting Started Guides
== Spring Boot
include::getting-started-guides/spring-boot/spring-boot-starters-for-azure.adoc[]
include::getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-storage.adoc[]
include::getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault.adoc[]
include::getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault-certificates.adoc[]
include::getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-service-bus.adoc[]
== Spring Data
TODO: finish this content.
== Spring Security
TODO: finish this content.
== Spring Cloud
TODO: finish this content.
== Azure App Configuration
TODO: finish this content.

Просмотреть файл

@ -21,8 +21,6 @@ function set_default_props() {
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}"
MODULES=("getting-started" "portal" "reference" "samples" "tutorials")
echo "MODULES: ${MODULES[*]}"
}
# Check if gh-pages exists and docs have been built
@ -33,6 +31,11 @@ function check_if_anything_to_sync() {
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() {
@ -57,14 +60,35 @@ function switch_to_tag() {
# Build the docs if switch is on
function build_docs_if_applicable() {
if [[ "${BUILD}" == "yes" ]] ; then
./mvnw clean install -DskipTests
./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() {
MAIN_ADOC_VALUE=$("${MAVEN_PATH}"mvn -q \
-Dexec.executable="echo" \
-Dexec.args='${docs.main}' \
--non-recursive \
org.codehaus.mojo:exec-maven-plugin:1.3.1:exec)
echo "Extracted 'main.adoc' from Maven build [${MAIN_ADOC_VALUE}]"
WHITELIST_PROPERTY=${WHITELIST_PROPERTY:-"docs.whitelisted.branches"}
WHITELISTED_BRANCHES_VALUE=$("${MAVEN_PATH}"mvn -q \
-Dexec.executable="echo" \
-Dexec.args="\${${WHITELIST_PROPERTY}}" \
org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \
-P docs \
-pl docs)
echo "Extracted '${WHITELIST_PROPERTY}' from Maven build [${WHITELISTED_BRANCHES_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 isn't." && dirty="")
if [ "$dirty" != "" ]; then git stash; fi
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
@ -112,34 +136,41 @@ function add_docs_from_target() {
function copy_docs_for_current_version() {
if [[ "${CURRENT_BRANCH}" == "main" ]] ; then
echo -e "Current branch is main - will copy the current docs only to the root folder"
for d in "${MODULES[@]}"; do
for f in "${d}"/target/generated-docs/*; do
file=${f#"${d}"/target/generated-docs/*}
if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then
# Not ignored...
cp -rf $f ${ROOT_FOLDER}/
git add -A ${ROOT_FOLDER}/$file
fi
done
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}/
git add -A ${ROOT_FOLDER}/$file
fi
done
COMMIT_CHANGES="yes"
else
echo -e "Current branch is [${CURRENT_BRANCH}]"
if [[ ",main," = ",${CURRENT_BRANCH}," ]] ; then
# https://stackoverflow.com/questions/29300806/a-bash-script-to-check-if-a-string-is-present-in-a-comma-separated-list-of-strin
if [[ ",${WHITELISTED_BRANCHES_VALUE}," = *",${CURRENT_BRANCH},"* ]] ; then
mkdir -p ${ROOT_FOLDER}/${CURRENT_BRANCH}
echo -e "Will copying the current docs to the [${CURRENT_BRANCH}] folder"
for d in "${MODULES[@]}"; do
for f in "${d}"/target/generated-docs/*; do
file=${f#"${d}"/target/generated-docs/*}
if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then
echo -e "Branch [${CURRENT_BRANCH}] is whitelisted! Will copy the current docs to the [${CURRENT_BRANCH}] folder"
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...
# 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" ]] ; then
# We don't want to copy the spring-cloud-sleuth.html
# we want it to be converted to index.html
cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html
git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html
else
cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH}
git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/$file
fi
done
fi
done
COMMIT_CHANGES="yes"
else
echo -e "Skipping for current branch: ${CURRENT_BRANCH}"
echo -e "Branch [${CURRENT_BRANCH}] is not on the white list! Check out the Maven [${WHITELIST_PROPERTY}] property in
[docs] module available under [docs] profile. Won't commit any changes to gh-pages for this branch."
fi
fi
}
@ -149,12 +180,10 @@ 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 d in "${MODULES[@]}"; do
for f in ${ROOT_FOLDER}/"${d}"/target/generated-docs/*; do
file=${f#${ROOT_FOLDER}/"${d}"/target/generated-docs/*}
copy_docs_for_branch ${file} ${FOLDER}
done
done;
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}"
}
@ -167,8 +196,17 @@ function copy_docs_for_branch() {
local file=$1
local destination=$2
if ! git ls-files -i -o --exclude-standard --directory | grep -q ^${file}$; then
cp -rf $f ${destination}
git add -A ${destination}/$file
# 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
}
@ -192,7 +230,7 @@ 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" != "" ]; then git stash pop; fi
if [ "$dirty" != "0" ]; then git stash pop; fi
exit 0
}
@ -286,6 +324,7 @@ else
switch_to_tag
fi
build_docs_if_applicable
retrieve_doc_properties
stash_changes
add_docs_from_target
checkout_previous_branch

Просмотреть файл

@ -0,0 +1,8 @@
include::_attributes.adoc[]
= Spring Cloud Azure
include::getting-started-guides.adoc[]
include::tutorials.adoc[]
include::samples.adoc[]
include::reference.adoc[]

Просмотреть файл

@ -0,0 +1,39 @@
= Reference
include::reference/version-information.adoc[]
include::reference/legal.adoc[]
include::reference/intro.adoc[]
include::reference/getting-help.adoc[]
include::reference/whats-new-4.0.adoc[]
include::reference/migration-guide-for-4.0.adoc[]
include::reference/getting-started.adoc[]
include::reference/configuration.adoc[]
include::reference/authentication.adoc[]
include::reference/production-ready.adoc[]
include::reference/auto-configure-azure-sdk-clients.adoc[]
include::reference/resource-handling.adoc[]
include::reference/secret-management.adoc[]
include::reference/spring-data-support.adoc[]
include::reference/spring-security-support.adoc[]
include::reference/spring-integration-support.adoc[]
include::reference/spring-cloud-stream-support.adoc[]
include::reference/spring-jms-support.adoc[]
include::reference/kafka-support.adoc[]
include::reference/redis-support.adoc[]
include::reference/resource-manager.adoc[]
include::reference/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:https://projects.spring.io/spring-boot/[Spring Boot]
== link:https://spring.io/projects[Spring Project References]
== link:https://github.com/Microsoft/azure-spring-boot/[Spring Boot Starters for Azure]

Просмотреть файл

@ -0,0 +1,75 @@
|===
|Name | Default | Description
|spring.cloud.azure.storage.blob.account-key | | Storage account access key.
|spring.cloud.azure.storage.blob.account-name | | Name for the storage account.
|spring.cloud.azure.storage.blob.blob-name | | Name of the blob.
|spring.cloud.azure.storage.blob.client.application-id | | Represents current application and is used for telemetry/monitoring purposes.
|spring.cloud.azure.storage.blob.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved.
|spring.cloud.azure.storage.blob.client.connection-idle-timeout | | Amount of time before an idle connection.
|spring.cloud.azure.storage.blob.client.headers | | Comma-delimited list of headers applied to each request sent with client.
|spring.cloud.azure.storage.blob.client.logging.allowed-header-names | | Comma-delimited list of whitelisted headers that should be logged.
|spring.cloud.azure.storage.blob.client.logging.allowed-query-param-names | | Comma-delimited list of whitelisted query parameters.
|spring.cloud.azure.storage.blob.client.logging.level | | The level of detail to log on HTTP messages.
|spring.cloud.azure.storage.blob.client.logging.pretty-print-body | | Whether to pretty print the message bodies.
|spring.cloud.azure.storage.blob.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client.
|spring.cloud.azure.storage.blob.client.read-timeout | | Amount of time used when reading the server response.
|spring.cloud.azure.storage.blob.client.response-timeout | | Amount of time used when waiting for a server to reply.
|spring.cloud.azure.storage.blob.client.write-timeout | | Amount of time each request being sent over the wire.
|spring.cloud.azure.storage.blob.connection-string | | Connection string to connect to the service.
|spring.cloud.azure.storage.blob.container-name | | Name of the container.
|spring.cloud.azure.storage.blob.credential.client-certificate-password | | Password of the certificate file.
|spring.cloud.azure.storage.blob.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure.
|spring.cloud.azure.storage.blob.credential.client-id | | Client id to use when performing service principal authentication with Azure.
|spring.cloud.azure.storage.blob.credential.client-secret | | Client secret to use when performing service principal authentication with Azure.
|spring.cloud.azure.storage.blob.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|spring.cloud.azure.storage.blob.credential.password | | Password to use when performing username/password authentication with Azure.
|spring.cloud.azure.storage.blob.credential.username | | Username to use when performing username/password authentication with Azure.
|spring.cloud.azure.storage.blob.customer-provided-key | | Customer provided key used to encrypt blob contents on the server.
|spring.cloud.azure.storage.blob.enabled | `true` | Whether an Azure Service is enabled.
|spring.cloud.azure.storage.blob.encryption-scope | | Encryption scope used to encrypt blob contents on the server.
|spring.cloud.azure.storage.blob.endpoint | | Endpoint for Azure Storage service.
|spring.cloud.azure.storage.blob.profile.cloud-type | | Name of the Azure cloud to connect to.
|spring.cloud.azure.storage.blob.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to.
|spring.cloud.azure.storage.blob.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version.
|spring.cloud.azure.storage.blob.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint.
|spring.cloud.azure.storage.blob.profile.environment.active-directory-resource-id | | The Azure Active Directory resource id.
|spring.cloud.azure.storage.blob.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint.
|spring.cloud.azure.storage.blob.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix.
|spring.cloud.azure.storage.blob.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix.
|spring.cloud.azure.storage.blob.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint.
|spring.cloud.azure.storage.blob.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint.
|spring.cloud.azure.storage.blob.profile.environment.gallery-endpoint | | The gallery endpoint.
|spring.cloud.azure.storage.blob.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix.
|spring.cloud.azure.storage.blob.profile.environment.management-endpoint | | The management service endpoint.
|spring.cloud.azure.storage.blob.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint.
|spring.cloud.azure.storage.blob.profile.environment.portal | | The management portal URL.
|spring.cloud.azure.storage.blob.profile.environment.publishing-profile | | The publishing settings file URL.
|spring.cloud.azure.storage.blob.profile.environment.resource-manager-endpoint | | The resource management endpoint.
|spring.cloud.azure.storage.blob.profile.environment.sql-management-endpoint | | The SQL management endpoint.
|spring.cloud.azure.storage.blob.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix.
|spring.cloud.azure.storage.blob.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix.
|spring.cloud.azure.storage.blob.profile.subscription-id | | Subscription id to use when connecting to Azure resources.
|spring.cloud.azure.storage.blob.profile.tenant-id | | Tenant id for Azure resources.
|spring.cloud.azure.storage.blob.proxy.hostname | | The host of the proxy.
|spring.cloud.azure.storage.blob.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through.
|spring.cloud.azure.storage.blob.proxy.password | | Password used to authenticate with the proxy.
|spring.cloud.azure.storage.blob.proxy.port | | The port of the proxy.
|spring.cloud.azure.storage.blob.proxy.type | | Type of the proxy.
|spring.cloud.azure.storage.blob.proxy.username | | Username used to authenticate with the proxy.
|spring.cloud.azure.storage.blob.resource.region | | The region of an Azure resource.
|spring.cloud.azure.storage.blob.resource.resource-group | | The resource group holds an Azure resource.
|spring.cloud.azure.storage.blob.resource.resource-id | | ID of an Azure resource.
|spring.cloud.azure.storage.blob.retry.exponential.base-delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.storage.blob.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.storage.blob.retry.exponential.max-retries | | The maximum number of attempts.
|spring.cloud.azure.storage.blob.retry.fixed.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.storage.blob.retry.fixed.max-retries | | The maximum number of attempts.
|spring.cloud.azure.storage.blob.retry.mode | | Retry backoff mode.
|spring.cloud.azure.storage.blob.retry.secondary-host | | Secondary Storage account to retry requests against.
|spring.cloud.azure.storage.blob.retry.try-timeout | | Amount of time to wait until a timeout.
|spring.cloud.azure.storage.blob.sas-token | | Shared access signatures (SAS) token used to authorize requests sent to the service.
|spring.cloud.azure.storage.blob.service-version | | Blob service version used when making API requests.
|===

Просмотреть файл

@ -0,0 +1,74 @@
|===
|Name | Default | Description
|spring.cloud.azure.storage.fileshare.account-key | | Storage account access key.
|spring.cloud.azure.storage.fileshare.account-name | | Name for the storage account.
|spring.cloud.azure.storage.fileshare.client.application-id | | Represents current application and is used for telemetry/monitoring purposes.
|spring.cloud.azure.storage.fileshare.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved.
|spring.cloud.azure.storage.fileshare.client.connection-idle-timeout | | Amount of time before an idle connection.
|spring.cloud.azure.storage.fileshare.client.headers | | Comma-delimited list of headers applied to each request sent with client.
|spring.cloud.azure.storage.fileshare.client.logging.allowed-header-names | | Comma-delimited list of whitelisted headers that should be logged.
|spring.cloud.azure.storage.fileshare.client.logging.allowed-query-param-names | | Comma-delimited list of whitelisted query parameters.
|spring.cloud.azure.storage.fileshare.client.logging.level | | The level of detail to log on HTTP messages.
|spring.cloud.azure.storage.fileshare.client.logging.pretty-print-body | | Whether to pretty print the message bodies.
|spring.cloud.azure.storage.fileshare.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client.
|spring.cloud.azure.storage.fileshare.client.read-timeout | | Amount of time used when reading the server response.
|spring.cloud.azure.storage.fileshare.client.response-timeout | | Amount of time used when waiting for a server to reply.
|spring.cloud.azure.storage.fileshare.client.write-timeout | | Amount of time each request being sent over the wire.
|spring.cloud.azure.storage.fileshare.connection-string | | Connection string to connect to the service.
|spring.cloud.azure.storage.fileshare.credential.client-certificate-password | | Password of the certificate file.
|spring.cloud.azure.storage.fileshare.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure.
|spring.cloud.azure.storage.fileshare.credential.client-id | | Client id to use when performing service principal authentication with Azure.
|spring.cloud.azure.storage.fileshare.credential.client-secret | | Client secret to use when performing service principal authentication with Azure.
|spring.cloud.azure.storage.fileshare.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|spring.cloud.azure.storage.fileshare.credential.password | | Password to use when performing username/password authentication with Azure.
|spring.cloud.azure.storage.fileshare.credential.username | | Username to use when performing username/password authentication with Azure.
|spring.cloud.azure.storage.fileshare.directory-path | | Path to the directory. For instance, 'directory1/directory2'.
|spring.cloud.azure.storage.fileshare.enabled | `true` | Whether an Azure Service is enabled.
|spring.cloud.azure.storage.fileshare.endpoint | | Endpoint for Azure Storage service.
|spring.cloud.azure.storage.fileshare.file-path | | Path to the file. For instance, 'directory1/file1'.
|spring.cloud.azure.storage.fileshare.profile.cloud-type | | Name of the Azure cloud to connect to.
|spring.cloud.azure.storage.fileshare.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to.
|spring.cloud.azure.storage.fileshare.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version.
|spring.cloud.azure.storage.fileshare.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint.
|spring.cloud.azure.storage.fileshare.profile.environment.active-directory-resource-id | | The Azure Active Directory resource id.
|spring.cloud.azure.storage.fileshare.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint.
|spring.cloud.azure.storage.fileshare.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix.
|spring.cloud.azure.storage.fileshare.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix.
|spring.cloud.azure.storage.fileshare.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint.
|spring.cloud.azure.storage.fileshare.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint.
|spring.cloud.azure.storage.fileshare.profile.environment.gallery-endpoint | | The gallery endpoint.
|spring.cloud.azure.storage.fileshare.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix.
|spring.cloud.azure.storage.fileshare.profile.environment.management-endpoint | | The management service endpoint.
|spring.cloud.azure.storage.fileshare.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint.
|spring.cloud.azure.storage.fileshare.profile.environment.portal | | The management portal URL.
|spring.cloud.azure.storage.fileshare.profile.environment.publishing-profile | | The publishing settings file URL.
|spring.cloud.azure.storage.fileshare.profile.environment.resource-manager-endpoint | | The resource management endpoint.
|spring.cloud.azure.storage.fileshare.profile.environment.sql-management-endpoint | | The SQL management endpoint.
|spring.cloud.azure.storage.fileshare.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix.
|spring.cloud.azure.storage.fileshare.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix.
|spring.cloud.azure.storage.fileshare.profile.subscription-id | | Subscription id to use when connecting to Azure resources.
|spring.cloud.azure.storage.fileshare.profile.tenant-id | | Tenant id for Azure resources.
|spring.cloud.azure.storage.fileshare.proxy.hostname | | The host of the proxy.
|spring.cloud.azure.storage.fileshare.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through.
|spring.cloud.azure.storage.fileshare.proxy.password | | Password used to authenticate with the proxy.
|spring.cloud.azure.storage.fileshare.proxy.port | | The port of the proxy.
|spring.cloud.azure.storage.fileshare.proxy.type | | Type of the proxy.
|spring.cloud.azure.storage.fileshare.proxy.username | | Username used to authenticate with the proxy.
|spring.cloud.azure.storage.fileshare.resource.region | | The region of an Azure resource.
|spring.cloud.azure.storage.fileshare.resource.resource-group | | The resource group holds an Azure resource.
|spring.cloud.azure.storage.fileshare.resource.resource-id | | ID of an Azure resource.
|spring.cloud.azure.storage.fileshare.retry.exponential.base-delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.storage.fileshare.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.storage.fileshare.retry.exponential.max-retries | | The maximum number of attempts.
|spring.cloud.azure.storage.fileshare.retry.fixed.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.storage.fileshare.retry.fixed.max-retries | | The maximum number of attempts.
|spring.cloud.azure.storage.fileshare.retry.mode | | Retry backoff mode.
|spring.cloud.azure.storage.fileshare.retry.secondary-host | | Secondary Storage account to retry requests against.
|spring.cloud.azure.storage.fileshare.retry.try-timeout | | Amount of time to wait until a timeout.
|spring.cloud.azure.storage.fileshare.sas-token | | Shared access signatures (SAS) token used to authorize requests sent to the service.
|spring.cloud.azure.storage.fileshare.service-version | | Share service version used when making API requests
|spring.cloud.azure.storage.fileshare.share-name | | Name of the share.
|===

Просмотреть файл

@ -0,0 +1,74 @@
|===
|Name | Default | Description
|spring.cloud.azure.storage.queue.account-key | | Storage account access key.
|spring.cloud.azure.storage.queue.account-name | | Name for the storage account.
|spring.cloud.azure.storage.queue.client.application-id | | Represents current application and is used for telemetry/monitoring purposes.
|spring.cloud.azure.storage.queue.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved.
|spring.cloud.azure.storage.queue.client.connection-idle-timeout | | Amount of time before an idle connection.
|spring.cloud.azure.storage.queue.client.headers | | Comma-delimited list of headers applied to each request sent with client.
|spring.cloud.azure.storage.queue.client.logging.allowed-header-names | | Comma-delimited list of whitelisted headers that should be logged.
|spring.cloud.azure.storage.queue.client.logging.allowed-query-param-names | | Comma-delimited list of whitelisted query parameters.
|spring.cloud.azure.storage.queue.client.logging.level | | The level of detail to log on HTTP messages.
|spring.cloud.azure.storage.queue.client.logging.pretty-print-body | | Whether to pretty print the message bodies.
|spring.cloud.azure.storage.queue.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client.
|spring.cloud.azure.storage.queue.client.read-timeout | | Amount of time used when reading the server response.
|spring.cloud.azure.storage.queue.client.response-timeout | | Amount of time used when waiting for a server to reply.
|spring.cloud.azure.storage.queue.client.write-timeout | | Amount of time each request being sent over the wire.
|spring.cloud.azure.storage.queue.connection-string | | Connection string to connect to the service.
|spring.cloud.azure.storage.queue.credential.client-certificate-password | | Password of the certificate file.
|spring.cloud.azure.storage.queue.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure.
|spring.cloud.azure.storage.queue.credential.client-id | | Client id to use when performing service principal authentication with Azure.
|spring.cloud.azure.storage.queue.credential.client-secret | | Client secret to use when performing service principal authentication with Azure.
|spring.cloud.azure.storage.queue.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id.
|spring.cloud.azure.storage.queue.credential.password | | Password to use when performing username/password authentication with Azure.
|spring.cloud.azure.storage.queue.credential.username | | Username to use when performing username/password authentication with Azure.
|spring.cloud.azure.storage.queue.enabled | `true` | Whether an Azure Service is enabled.
|spring.cloud.azure.storage.queue.endpoint | | Endpoint for Azure Storage service.
|spring.cloud.azure.storage.queue.message-encoding | | How queue message body is represented in HTTP requests and responses.
|spring.cloud.azure.storage.queue.profile.cloud-type | | Name of the Azure cloud to connect to.
|spring.cloud.azure.storage.queue.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to.
|spring.cloud.azure.storage.queue.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version.
|spring.cloud.azure.storage.queue.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint.
|spring.cloud.azure.storage.queue.profile.environment.active-directory-resource-id | | The Azure Active Directory resource id.
|spring.cloud.azure.storage.queue.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint.
|spring.cloud.azure.storage.queue.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix.
|spring.cloud.azure.storage.queue.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix.
|spring.cloud.azure.storage.queue.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint.
|spring.cloud.azure.storage.queue.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint.
|spring.cloud.azure.storage.queue.profile.environment.gallery-endpoint | | The gallery endpoint.
|spring.cloud.azure.storage.queue.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix.
|spring.cloud.azure.storage.queue.profile.environment.management-endpoint | | The management service endpoint.
|spring.cloud.azure.storage.queue.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint.
|spring.cloud.azure.storage.queue.profile.environment.portal | | The management portal URL.
|spring.cloud.azure.storage.queue.profile.environment.publishing-profile | | The publishing settings file URL.
|spring.cloud.azure.storage.queue.profile.environment.resource-manager-endpoint | | The resource management endpoint.
|spring.cloud.azure.storage.queue.profile.environment.sql-management-endpoint | | The SQL management endpoint.
|spring.cloud.azure.storage.queue.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix.
|spring.cloud.azure.storage.queue.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix.
|spring.cloud.azure.storage.queue.profile.subscription-id | | Subscription id to use when connecting to Azure resources.
|spring.cloud.azure.storage.queue.profile.tenant-id | | Tenant id for Azure resources.
|spring.cloud.azure.storage.queue.proxy.hostname | | The host of the proxy.
|spring.cloud.azure.storage.queue.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through.
|spring.cloud.azure.storage.queue.proxy.password | | Password used to authenticate with the proxy.
|spring.cloud.azure.storage.queue.proxy.port | | The port of the proxy.
|spring.cloud.azure.storage.queue.proxy.type | | Type of the proxy.
|spring.cloud.azure.storage.queue.proxy.username | | Username used to authenticate with the proxy.
|spring.cloud.azure.storage.queue.queue-name | | Name of the storage queue.
|spring.cloud.azure.storage.queue.resource.name | | Name of the storage account.
|spring.cloud.azure.storage.queue.resource.region | | The region of an Azure resource.
|spring.cloud.azure.storage.queue.resource.resource-group | | The resource group holds an Azure resource.
|spring.cloud.azure.storage.queue.resource.resource-id | | ID of an Azure resource.
|spring.cloud.azure.storage.queue.retry.exponential.base-delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.storage.queue.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts.
|spring.cloud.azure.storage.queue.retry.exponential.max-retries | | The maximum number of attempts.
|spring.cloud.azure.storage.queue.retry.fixed.delay | | Amount of time to wait between retry attempts.
|spring.cloud.azure.storage.queue.retry.fixed.max-retries | | The maximum number of attempts.
|spring.cloud.azure.storage.queue.retry.mode | | Retry backoff mode.
|spring.cloud.azure.storage.queue.retry.secondary-host | | Secondary Storage account to retry requests against.
|spring.cloud.azure.storage.queue.retry.try-timeout | | Amount of time to wait until a timeout.
|spring.cloud.azure.storage.queue.sas-token | | Shared access signatures (SAS) token used to authorize requests sent to the service.
|spring.cloud.azure.storage.queue.service-version | | Queue service version used when making API requests.
|===

Просмотреть файл

@ -0,0 +1,66 @@
[appendix]
== Configuration Properties
=== Global Properties
include::reference/_configprops_global.adoc[]
=== Azure Active Directory Properties
include::reference/_configprops_aad.adoc[]
=== Azure Active Directory B2C Properties
include::reference/_configprops_aadb2c.adoc[]
=== Azure App Configuration Properties
include::reference/_configprops_appconf.adoc[]
=== Azure Cosmos Properties
include::reference/_configprops_cosmos.adoc[]
=== Azure Event Hubs Properties
include::reference/_configprops_eventhubs.adoc[]
=== Azure Key Vault Secrets Properties
include::reference/_configprops_kv_secret.adoc[]
=== Azure Key Vault Certificates Properties
include::reference/_configprops_kv_certificate.adoc[]
=== Azure Service Bus Properties
include::reference/_configprops_servicebus.adoc[]
=== Azure Service Bus JMS Properties
include::reference/_configprops_servicebus_jms.adoc[]
=== Azure Storage Blob Properties
include::reference/_configprops_storage_blob.adoc[]
=== Azure Storage File Share Properties
include::reference/_configprops_storage_fileshare.adoc[]
=== Azure Storage Queue Properties
include::reference/_configprops_storage_queue.adoc[]
=== All Configuration Properties
include::reference/_configprops.adoc[]
[appendix]
include::reference/_migration-guide-for-4.0.adoc[]
[appendix]
include::reference/_known-issues.adoc[]

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше