This commit is contained in:
Gary Liu 2022-03-28 18:01:21 +08:00
Родитель 413bfd513d
Коммит c4a0d71ab8
1 изменённых файлов: 88 добавлений и 45 удалений

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

@ -526,60 +526,89 @@ version 3 of link:https://search.maven.org/artifact/com.azure.spring/azure-sprin
[#dependency-spring-cloud-azure-starter-active-directory-b2c]
===== 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.
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 of spring-cloud-azure-starter-active-directory-b2c
.Removed Dependencies
[cols="<30,<~", options="header"]
|===
|Removed dependencies |Description
|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
. All configuration property names changed the prefix from `azure.activedirectory.b2c` to `spring.cloud.azure.active-directory.b2c`.
. New property `spring.cloud.azure.active-directory.b2c.enabled=false` is added to allow enable / disable AAD B2C related features. The default value is false.
This section includes the changes about the properties added, removed and changed.
IMPORTANT: If you're using the new `spring-cloud-azure-starter-active-directory-b2c`, you have to specify the `spring.cloud.azure.active-directory.b2c.enabled` to true, even if the starter is included in classpath.
.The following two points are the main to pay your attention to:
. All configuration property names' prefix changed from `azure.activedirectory.b2c` to `spring.cloud.azure.active-directory.b2c`.
. New property `spring.cloud.azure.active-directory.b2c.enabled=false` 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.<AZURE_CLIENT_NAME>.authorization-grant-type | *spring.cloud.azure.active-directory.b2c*.authorization-clients.<AZURE_CLIENT_NAME>.authorization-grant-type
| *azure.activedirectory.b2c*.authorization-clients.<AZURE_CLIENT_NAME>.scopes | *spring.cloud.azure.active-directory.b2c*.authorization-clients.<AZURE_CLIENT_NAME>.scopes
| *azure.activedirectory.b2c*.app-id-uri | *spring.cloud.azure.active-directory.b2c*.app-id-uri
| *azure.activedirectory.b2c*.base-uri | *spring.cloud.azure.active-directory.b2c*.base-uri
| *azure.activedirectory.b2c*.client-id | *spring.cloud.azure.active-directory.b2c*.credential.client-id
| *azure.activedirectory.b2c*.client-secret | *spring.cloud.azure.active-directory.b2c*.credential.client-secret
| *azure.activedirectory.b2c*.jwt-connect-timeout | *spring.cloud.azure.active-directory.b2c*.jwt-connect-timeout
| *azure.activedirectory.b2c*.jwt-read-timeout | *spring.cloud.azure.active-directory.b2c*.jwt-read-timeout
| *azure.activedirectory.b2c*.jwt-size-limit | *spring.cloud.azure.active-directory.b2c*.jwt-size-limit
| *azure.activedirectory.b2c*.login-flow | *spring.cloud.azure.active-directory.b2c*.login-flow
| *azure.activedirectory.b2c*.logout-success-url | *spring.cloud.azure.active-directory.b2c*.logout-success-url
| *azure.activedirectory.b2c*.reply-url | *spring.cloud.azure.active-directory.b2c*.reply-url
| *azure.activedirectory.b2c*.tenant-id | *spring.cloud.azure.active-directory.b2c*.profile.tenant-id
| *azure.activedirectory.b2c*.user-flows | *spring.cloud.azure.active-directory.b2c*.user-flows
| *azure.activedirectory.b2c*.user-name-attribute-name | *spring.cloud.azure.active-directory.b2c*.user-name-attribute-name
| Legacy properties | Modern properties
| *azure.activedirectory.b2c*.authenticate-additional-parameters
| *spring.cloud.azure.active-directory.b2c*.authenticate-additional-parameters
| *azure.activedirectory.b2c*.authorization-clients
| *spring.cloud.azure.active-directory.b2c*.authorization-clients
| *azure.activedirectory.b2c*.authorization-clients.<AZURE_CLIENT_NAME>.authorization-grant-type
| *spring.cloud.azure.active-directory.b2c*.authorization-clients.<AZURE_CLIENT_NAME>.authorization-grant-type
| *azure.activedirectory.b2c*.authorization-clients.<AZURE_CLIENT_NAME>.scopes
| *spring.cloud.azure.active-directory.b2c*.authorization-clients.<AZURE_CLIENT_NAME>.scopes
| *azure.activedirectory.b2c*.app-id-uri
| *spring.cloud.azure.active-directory.b2c*.app-id-uri
| *azure.activedirectory.b2c*.base-uri
| *spring.cloud.azure.active-directory.b2c*.base-uri
| *azure.activedirectory.b2c*.client-id
| *spring.cloud.azure.active-directory.b2c*.credential.client-id
| *azure.activedirectory.b2c*.client-secret
| *spring.cloud.azure.active-directory.b2c*.credential.client-secret
| *azure.activedirectory.b2c*.jwt-connect-timeout
| *spring.cloud.azure.active-directory.b2c*.jwt-connect-timeout
| *azure.activedirectory.b2c*.jwt-read-timeout
| *spring.cloud.azure.active-directory.b2c*.jwt-read-timeout
| *azure.activedirectory.b2c*.jwt-size-limit
| *spring.cloud.azure.active-directory.b2c*.jwt-size-limit
| *azure.activedirectory.b2c*.login-flow
| *spring.cloud.azure.active-directory.b2c*.login-flow
| *azure.activedirectory.b2c*.logout-success-url
| *spring.cloud.azure.active-directory.b2c*.logout-success-url
| *azure.activedirectory.b2c*.reply-url
| *spring.cloud.azure.active-directory.b2c*.reply-url
| *azure.activedirectory.b2c*.tenant-id
| *spring.cloud.azure.active-directory.b2c*.profile.tenant-id
| *azure.activedirectory.b2c*.user-flows
| *spring.cloud.azure.active-directory.b2c*.user-flows
| *azure.activedirectory.b2c*.user-name-attribute-name
| *spring.cloud.azure.active-directory.b2c*.user-name-attribute-name
|===
.Removed properties from azure-spring-boot-starter-active-directory-b2c
[options="header"]
|===
| Removed property
| azure.activedirectory.b2c.allow-telemetry
| azure.activedirectory.b2c.tenant
|===
.Removed properties from azure-spring-boot-starter-active-directory-b2c:
* azure.activedirectory.b2c.allow-telemetry
* azure.activedirectory.b2c.tenant
[NOTE]
====
The value type of the following properties is changed from `long` to `java.time.Duration`, they are `jwt-connect-timeout`, `jwt-read-timeout`.
====
.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
@ -588,17 +617,31 @@ The value type of the following properties is changed from `long` to `java.time.
[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.aad.properties.AuthorizationClientProperties
|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 in the migration to
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].