update readme for unified configuration #23452

yiliuTo · 2021-08-10T13:43:21Z

This pr aims to update README of cosmos, keyvault, storage starters to introduce supported configuration properties in pr #22937, #23166.

Introduce active and deprecated properties for each starter specific props
Introduce the supported unified configuration for each starter
Declare that deprecated configuration will be converted automatically
Declare the higher priority of Key Vault property sources.

joshfree · 2021-08-10T20:32:10Z

sdk/spring/azure-spring-boot-starter-cosmos/README.md

+spring.cloud.azure.cosmos.uri|Document DB URI.|||
+
+#### Deprecated Properties
+|Name|Description|Default Value|Comment|


Consider renaming Name to Obsolete Type and Comment to Replacement Type

Thanks for the advice, updated.

joshfree · 2021-08-10T20:32:48Z

sdk/spring/azure-spring-boot-starter-cosmos/README.md

+Note that replaced properties will not be refreshed as common properties from Key Vault property source.
+#### Active Properties
+
+|Name|Description|Default Value|Comment|


Should Default Value be removed if every entry is blank?

joshfree · 2021-08-10T20:33:00Z

sdk/spring/azure-spring-boot-starter-cosmos/README.md

@@ -39,16 +39,45 @@
 - Supports [spring-boot-starter-data-rest](https://projects.spring.io/spring-data-rest/).
 - Supports List and nested type in domain class.

+### Configuration Options
+Azure Spring Boot Cosmos Starter deprecates all legacy properties of which the prefix is `azure.cosmos` and uses `spring.cloud.azure.cosmos` instead.


tagging @kushagraThapar for more feedback

joshfree · 2021-08-10T20:33:19Z

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md

@@ -28,6 +28,66 @@ For highly sensitive data, clients should consider additional layers of protecti
 Key Vault also supports a contentType field for secrets. Clients may specify the content type of a secret to assist in interpreting the secret data when it's retrieved. The maximum length of this field is 255 characters. There are no pre-defined values. The suggested usage is as a hint for interpreting the secret data.

 Besides, this starter provides features of supporting multiple Key Vaults, case sensitive mode of Key Vault names and using placeholder presenting Key Vault names in property file
+
+### Configuration Options
+Azure Spring Boot Key Vault Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.


tagging @vcolin7 for more feedback

We should keep the name consistent across the README.

Suggested change

Azure Spring Boot Key Vault Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.

Azure Key Vault Secrets Spring Boot Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.

joshfree · 2021-08-10T20:34:00Z

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md

+
+Note: for multiple Key Vault usage, specify your Key Vault name after the prefix of `spring.cloud.azure.keyvault`.
+#### Deprecated Properties
+|Name|Description|Default Value|Comment|


Consider renaming Name to Obsolete Type and Comment to Replacement Type

joshfree · 2021-08-10T20:34:10Z

sdk/spring/azure-spring-boot-starter-storage/README.md

+spring.cloud.azure.storage.file-endpoint | The file endpoint URL of the Azure Storage account. | | Optional when storage file resource is used |
+
+#### Deprecated Properties
+|Name|Description|Default Value|Comment|


Consider renaming Name to Obsolete Type and Comment to Replacement Type

…ement Type

vcolin7

Added some comments.

vcolin7 · 2021-08-11T19:48:29Z

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md

@@ -28,6 +28,66 @@ For highly sensitive data, clients should consider additional layers of protecti
 Key Vault also supports a contentType field for secrets. Clients may specify the content type of a secret to assist in interpreting the secret data when it's retrieved. The maximum length of this field is 255 characters. There are no pre-defined values. The suggested usage is as a hint for interpreting the secret data.

 Besides, this starter provides features of supporting multiple Key Vaults, case sensitive mode of Key Vault names and using placeholder presenting Key Vault names in property file
+
+### Configuration Options
+Azure Spring Boot Key Vault Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.


We should keep the name consistent across the README.

Suggested change

Azure Spring Boot Key Vault Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.

Azure Key Vault Secrets Spring Boot Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.

vcolin7 · 2021-08-11T19:49:29Z

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md

+
+### Configuration Options
+Azure Spring Boot Key Vault Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.
+When a deprecated property is detected while its active property is not found, the active property will be configured into application environment with value from the deprecated property.


Suggested change

When a deprecated property is detected while its active property is not found, the active property will be configured into application environment with value from the deprecated property.

When a deprecated property is detected while its active property is not found, the active property will be configured into the application environment with the value from the deprecated property.

vcolin7 · 2021-08-11T19:49:53Z

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md

+Azure Spring Boot Key Vault Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.
+When a deprecated property is detected while its active property is not found, the active property will be configured into application environment with value from the deprecated property.
+
+If you load configuration properties from Azure Key Vault, the preceding detection and replacement are also applicable for Key Vault property sources. Replaced properties from Key Vault have higher priorities than local ones.


Suggested change

If you load configuration properties from Azure Key Vault, the preceding detection and replacement are also applicable for Key Vault property sources. Replaced properties from Key Vault have higher priorities than local ones.

If you load configuration properties from Azure Key Vault, the preceding detection and replacement are also applicable for Key Vault property sources. Replaced properties from Key Vault have a higher priority than local ones.

vcolin7 · 2021-08-11T19:52:22Z

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md

+spring.cloud.azure.keyvault.secret-service-version|Valid secret-service-version value can be found [here][version_link].|The latest value||
+spring.cloud.azure.keyvault.uri|Azure Key Vault Uri.|||
+
+Note: for multiple Key Vault usage, specify your Key Vault name after the prefix of `spring.cloud.azure.keyvault`.


It would be nice to have an example of what you mean here, otherwise it's not clear if people should do something like spring.cloud.azure.keyvault.mykeyvault or spring.cloud.azure.keyvaultmykeyvault.

Agree, I modified it by adding a reference link to the multiple kv example section.

sdk/spring/azure-spring-boot-starter-cosmos/README.md

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md

sdk/spring/azure-spring-boot-starter-cosmos/README.md

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md

saragluna

LGTM.

…23597) * Unify spring configurations (#22937) * Refactor Azure Spring projects structure (#23004) * Mapping spring legacy props (#23166) ** use file for property mapping ** add environmentpostprocessor after kv ** map multiple key vault use case * update readme for unified configuration (#23452) Co-authored-by: Yi Liu <yiliu6@microsoft.com>

Review request for Microsoft.ContainerInstance to add version stable/2023-05-01 (Azure#23485) * Adds base for updating Microsoft.ContainerInstance from version preview/2022-10-01-preview to version 2023-05-01 * Updates readme * Updates API version in new specs and examples * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * Fnuarnav containerinstance microsoft.container instance 2023 05 01 (Azure#23166) * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * fix CI errors * Fnuarnav containerinstance microsoft.container instance 2023 05 01 (Azure#23169) * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * fix CI errors * use altest api version as default for Avocado * Fnuarnav containerinstance microsoft.container instance 2023 05 01 (Azure#23170) * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * fix CI errors * use altest api version as default for Avocado * update host to eastus2euap endpoint to check manifest * Fnuarnav containerinstance microsoft.container instance 2023 05 01 (Azure#23452) * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * fix CI errors * use altest api version as default for Avocado * update host to eastus2euap endpoint to check manifest * use old api versionf or operations * Fnuarnav containerinstance microsoft.container instance 2023 05 01 (Azure#23453) * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * fix CI errors * use altest api version as default for Avocado * update host to eastus2euap endpoint to check manifest * use old api versionf or operations * revert Operations example api version * Fnuarnav containerinstance microsoft.container instance 2023 05 01 (Azure#23471) * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * fix CI errors * use altest api version as default for Avocado * update host to eastus2euap endpoint to check manifest * use old api versionf or operations * revert Operations example api version * Fnuarnav containerinstance microsoft.container instance 2023 05 01 (Azure#23473) * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * fix CI errors * use altest api version as default for Avocado * update host to eastus2euap endpoint to check manifest * MGRP S360 Vuln (Azure#22832) * Add blockchain to latest profile * Add additional types * Fix Swagger issues * Solve validation --------- Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> * use old api versionf or operations * Azure Orbital - swagger fix for api-version 2022-11-01 (Azure#23441) * added example for the new field * updated the double ref that was causing build failure * Fixed PrometheusRuleGroups examples (Azure#23390) * Fixed PrometheusRuleGroups examples * One more fix * Remvoe flattern (Azure#23460) Co-authored-by: Will Huang <huangwill@microsoft.com> * Mvad update (Azure#23434) * Add default value 10 for topContributorCount * Update AnomalyDetector typespec to latest typespec and Azure.Core versions and fix all warnings * Update TypeSpec config * Add back language emitter options * Fix cspell and model validation errors --------- Co-authored-by: Chunlei Wang <chuwan@microsoft.com> * revert Operations example api version --------- Co-authored-by: ramoka178 <57157576+ramoka178@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Stuti Kumar <113545470+stuti-1807@users.noreply.github.com> Co-authored-by: giladsu <43436811+giladsu@users.noreply.github.com> Co-authored-by: will <koyasu221b@gmail.com> Co-authored-by: Will Huang <huangwill@microsoft.com> Co-authored-by: Mike Kistler <mikekistler@microsoft.com> Co-authored-by: Chunlei Wang <chuwan@microsoft.com> * use management.auzre.com endpoint * Fnuarnav containerinstance microsoft.container instance 2023 05 01 (Azure#23483) * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * fix CI errors * use altest api version as default for Avocado * update host to eastus2euap endpoint to check manifest * MGRP S360 Vuln (Azure#22832) * Add blockchain to latest profile * Add additional types * Fix Swagger issues * Solve validation --------- Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> * use old api versionf or operations * Azure Orbital - swagger fix for api-version 2022-11-01 (Azure#23441) * added example for the new field * updated the double ref that was causing build failure * Fixed PrometheusRuleGroups examples (Azure#23390) * Fixed PrometheusRuleGroups examples * One more fix * Remvoe flattern (Azure#23460) Co-authored-by: Will Huang <huangwill@microsoft.com> * Mvad update (Azure#23434) * Add default value 10 for topContributorCount * Update AnomalyDetector typespec to latest typespec and Azure.Core versions and fix all warnings * Update TypeSpec config * Add back language emitter options * Fix cspell and model validation errors --------- Co-authored-by: Chunlei Wang <chuwan@microsoft.com> * revert Operations example api version * use management.auzre.com endpoint --------- Co-authored-by: ramoka178 <57157576+ramoka178@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Stuti Kumar <113545470+stuti-1807@users.noreply.github.com> Co-authored-by: giladsu <43436811+giladsu@users.noreply.github.com> Co-authored-by: will <koyasu221b@gmail.com> Co-authored-by: Will Huang <huangwill@microsoft.com> Co-authored-by: Mike Kistler <mikekistler@microsoft.com> Co-authored-by: Chunlei Wang <chuwan@microsoft.com> * fix package version in readme * Fnuarnav containerinstance microsoft.container instance 2023 05 01 (Azure#23484) * add container security context property * update readme tag to previous stable version * add example with security context * avocado fix default tag should contain all endpoints * add back spot priority changes * use previous stable version as default tag * prettier fix * use spaces * fix error * use spaces * fix CI errors * use altest api version as default for Avocado * update host to eastus2euap endpoint to check manifest * MGRP S360 Vuln (Azure#22832) * Add blockchain to latest profile * Add additional types * Fix Swagger issues * Solve validation --------- Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> * use old api versionf or operations * Azure Orbital - swagger fix for api-version 2022-11-01 (Azure#23441) * added example for the new field * updated the double ref that was causing build failure * Fixed PrometheusRuleGroups examples (Azure#23390) * Fixed PrometheusRuleGroups examples * One more fix * Remvoe flattern (Azure#23460) Co-authored-by: Will Huang <huangwill@microsoft.com> * Mvad update (Azure#23434) * Add default value 10 for topContributorCount * Update AnomalyDetector typespec to latest typespec and Azure.Core versions and fix all warnings * Update TypeSpec config * Add back language emitter options * Fix cspell and model validation errors --------- Co-authored-by: Chunlei Wang <chuwan@microsoft.com> * revert Operations example api version * add codeowners for Compute Instance swagger (Azure#23437) Co-authored-by: Naman Agarwal <naagarw@microsoft.com> * [Hub Generated] Review request for Microsoft.DevHub to add version preview/2022-10-11-preview (Azure#22828) * Adds base for updating Microsoft.DevHub from version preview/2022-04-01-preview to version 2022-10-11-preview * Updates readme * Updates API version in new specs and examples * start 10-11 preview * add words * fix readme version * update swagger version * add second putworkflow example * fix generatepreviewartifactsresponse * align generate preview artifacts example * update param locations that got changed * add x-ms-client-flatten for artifact properties * Adding WorkflowRunStatus * Fixing enum name * add namespace to example --------- Co-authored-by: Brandon Foley <brandonfoley13@gmail.com> * Update readme.python.md (Azure#23208) * fixing async response type for machinelearningservices-2023-02-01-preview (Azure#23105) * fixing regex pattern and async response type * remove update to regex * Fix lint error for Datadog RP (Azure#23477) * Fix link error for Datadog RP * Fix version * merging billing fix to public repo (Azure#23424) Co-authored-by: Gaurav Bang <gauravbang@microsoft.com> * use management.auzre.com endpoint * fix package version in readme --------- Co-authored-by: ramoka178 <57157576+ramoka178@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Stuti Kumar <113545470+stuti-1807@users.noreply.github.com> Co-authored-by: giladsu <43436811+giladsu@users.noreply.github.com> Co-authored-by: will <koyasu221b@gmail.com> Co-authored-by: Will Huang <huangwill@microsoft.com> Co-authored-by: Mike Kistler <mikekistler@microsoft.com> Co-authored-by: Chunlei Wang <chuwan@microsoft.com> Co-authored-by: Naman Agarwal <namanag16@gmail.com> Co-authored-by: Naman Agarwal <naagarw@microsoft.com> Co-authored-by: David Gamero <david340804@gmail.com> Co-authored-by: Brandon Foley <brandonfoley13@gmail.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Karishma Daga <karishmadaga@microsoft.com> Co-authored-by: vikotha <81368129+vikotha@users.noreply.github.com> Co-authored-by: Gaurav <bang.gourav@gmail.com> Co-authored-by: Gaurav Bang <gauravbang@microsoft.com> * fix tag in readme * update example with capabilities example * fix typo --------- Co-authored-by: ramoka178 <57157576+ramoka178@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Stuti Kumar <113545470+stuti-1807@users.noreply.github.com> Co-authored-by: giladsu <43436811+giladsu@users.noreply.github.com> Co-authored-by: will <koyasu221b@gmail.com> Co-authored-by: Will Huang <huangwill@microsoft.com> Co-authored-by: Mike Kistler <mikekistler@microsoft.com> Co-authored-by: Chunlei Wang <chuwan@microsoft.com> Co-authored-by: Naman Agarwal <namanag16@gmail.com> Co-authored-by: Naman Agarwal <naagarw@microsoft.com> Co-authored-by: David Gamero <david340804@gmail.com> Co-authored-by: Brandon Foley <brandonfoley13@gmail.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Karishma Daga <karishmadaga@microsoft.com> Co-authored-by: vikotha <81368129+vikotha@users.noreply.github.com> Co-authored-by: Gaurav <bang.gourav@gmail.com> Co-authored-by: Gaurav Bang <gauravbang@microsoft.com>

update readme for unified configuration

a59aa2c

yiliuTo requested review from backwind1233, chenrujun, saragluna and stliu as code owners August 10, 2021 13:43

ghost added the azure-spring All azure-spring related issues label Aug 10, 2021

joshfree approved these changes Aug 10, 2021

View reviewed changes

joshfree added Client This issue points to a problem in the data-plane of the library. Docs labels Aug 10, 2021

yiliuTo self-assigned this Aug 11, 2021

yiliuTo added this to the [2021] September milestone Aug 11, 2021

yiliuTo linked an issue Aug 11, 2021 that may be closed by this pull request

Add configuration introduction in Spring starters'README #23368

Closed

rename table header from Name and Comment to Obsolete Type and Replac…

93866b2

…ement Type

yiliuTo added feature-request This issue requires a new behavior in the product in order be resolved. and removed feature-request This issue requires a new behavior in the product in order be resolved. labels Aug 11, 2021

vcolin7 reviewed Aug 11, 2021

View reviewed changes

update starter name description

910c690

saragluna self-assigned this Aug 12, 2021

saragluna requested changes Aug 12, 2021

View reviewed changes

update outdated cosmos property description

7b2b2da

saragluna requested changes Aug 13, 2021

View reviewed changes

sdk/spring/azure-spring-boot-starter-cosmos/README.md Outdated Show resolved Hide resolved

sdk/spring/azure-spring-boot-starter-cosmos/README.md Outdated Show resolved Hide resolved

Remove blank colomn of cosmos readme

f2bd585

saragluna requested changes Aug 13, 2021

View reviewed changes

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md Outdated Show resolved Hide resolved

sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md Outdated Show resolved Hide resolved

remove blank colomn in keyvault readme

8226bb0

saragluna approved these changes Aug 13, 2021

View reviewed changes

yiliuTo merged commit 66a6fa2 into Azure:feature/spring-unify-configurations Aug 13, 2021

saragluna pushed a commit to saragluna/azure-sdk-for-java that referenced this pull request Aug 16, 2021

update readme for unified configuration (Azure#23452)

84a7fc5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update readme for unified configuration #23452

update readme for unified configuration #23452

yiliuTo commented Aug 10, 2021

joshfree Aug 10, 2021

yiliuTo Aug 11, 2021

joshfree Aug 10, 2021

joshfree Aug 10, 2021

joshfree Aug 10, 2021

vcolin7 Aug 11, 2021

joshfree Aug 10, 2021

joshfree Aug 10, 2021

vcolin7 left a comment

vcolin7 Aug 11, 2021

vcolin7 Aug 11, 2021

vcolin7 Aug 11, 2021

vcolin7 Aug 11, 2021

yiliuTo Aug 12, 2021

saragluna left a comment

	Azure Spring Boot Key Vault Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.
	Azure Key Vault Secrets Spring Boot Starter deprecates all legacy properties of which the prefix is `azure.keyvault` and uses `spring.cloud.azure.keyvault` instead.

	When a deprecated property is detected while its active property is not found, the active property will be configured into application environment with value from the deprecated property.
	When a deprecated property is detected while its active property is not found, the active property will be configured into the application environment with the value from the deprecated property.

	If you load configuration properties from Azure Key Vault, the preceding detection and replacement are also applicable for Key Vault property sources. Replaced properties from Key Vault have higher priorities than local ones.
	If you load configuration properties from Azure Key Vault, the preceding detection and replacement are also applicable for Key Vault property sources. Replaced properties from Key Vault have a higher priority than local ones.

update readme for unified configuration #23452

update readme for unified configuration #23452

Conversation

yiliuTo commented Aug 10, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vcolin7 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saragluna left a comment

Choose a reason for hiding this comment