Guía de migración para Spring Cloud Azure 4.0

Esta guía ayuda a migrar a Spring Cloud Azure 4.0 desde bibliotecas heredadas de Azure Spring.

Introducción

Llamaremos a bibliotecas cuyo identificador de grupo e identificador de artefacto siguen el patrón las bibliotecas de modernas de y aquellas con patrones , o las bibliotecas de heredadas de .

Esta guía se centrará en comparaciones en paralelo para configuraciones similares entre las bibliotecas modernas y heredadas.

Se supone que está familiarizado con com.azure.spring:azure-spring-boot-*, com.azure.spring:azure-spring-cloud-* o paquete de com.azure.spring:azure-spring-integration-*.

Si no está familiarizado con las bibliotecas de Spring Cloud Azure 4.0, consulte la guía para desarrolladores de Azure Spring Cloud en lugar de esta guía.

Ventajas de la migración

Una pregunta natural que se debe plantear al considerar si adoptar una nueva versión o biblioteca es sus ventajas. A medida que Azure ha madurado y ha sido adoptado por un grupo más diverso de desarrolladores, nos hemos centrado en aprender los patrones y prácticas para admitir mejor la productividad del desarrollador y comprender las brechas que tienen las bibliotecas de Azure de Spring Cloud.

Hubo varias áreas de comentarios coherentes expresadas en las bibliotecas de Azure de Spring Cloud. Lo más importante es que las bibliotecas de diferentes servicios de Azure no han habilitado el conjunto completo de configuraciones. Además, la incoherencia de la nomenclatura del proyecto, los identificadores de artefacto, las versiones y las configuraciones hicieron que la curva de aprendizaje empinó.

Para mejorar la experiencia de desarrollo en las bibliotecas de Azure de Spring Cloud, se introdujo un conjunto de directrices de diseño para garantizar que las bibliotecas de Azure de Spring Cloud tengan una sensación natural e idiomática con respecto al ecosistema de Spring. Encontrará más detalles en el documento de diseño de para los interesados.

Spring Cloud Azure 4.0 proporciona la experiencia compartida entre bibliotecas que se integran con diferentes proyectos de Spring, como Spring Boot, Spring Integration, Spring Cloud Stream, etc. La experiencia compartida incluye:

• Una lista de materiales unificada para incluir todas las bibliotecas de Spring Cloud Azure 4.0.
• Una convención de nomenclatura coherente para los artefactos.
• Una manera unificada de configurar las credenciales, el proxy, el reintento, el entorno en la nube y la configuración de la capa de transporte.
• Admite todos los métodos de autenticación compatibles con un servicio de Azure o un SDK de servicio de Azure.

Visión general

Esta guía de migración consta de las secciones siguientes:

• Cambios de nomenclatura para Spring Cloud Azure 4.0
• Cambios en el artefacto: cambio de nombre, agregado o eliminado
• Cambios de dependencia
• Cambios de autenticación
• Propiedades de configuración
• Cambios importantes en la API
• Cambios en la biblioteca

Cambios de nomenclatura

Nunca ha habido un nombre coherente o oficial para llamar a todas las bibliotecas de Azure de Spring Cloud. Algunos de ellos se llamaron Azure Spring Boot y algunos de ellos Spring on Azure. Desde la versión 4.0, empezamos a usar el nombre del proyecto Spring Cloud Azure para representar todas las bibliotecas de Azure Spring.

BOM

Usamos para enviar dos BOM para nuestras bibliotecas, el azure-spring-boot-bom y azure-spring-cloud-dependencies, pero combinamos estas dos BOM en una BOM desde 4.0, el spring-cloud-azure-dependencies. Agregue una entrada en la sección dependencyManagement del proyecto para beneficiarse de la administración de dependencias.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.22.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

Cambios en el artefacto: cambio de nombre, agregado o eliminado

Los identificadores de grupo son los mismos para las bibliotecas de Azure modernas y heredadas de Spring Cloud. Todos son com.azure.spring. Los identificadores de artefacto para las bibliotecas modernas de Azure de Spring Cloud han cambiado. Según el proyecto de Spring al que pertenece, Spring Boot, Spring Integration o Spring Cloud Stream, el patrón de identificadores de artefacto podría ser spring-cloud-azure-starter-[service], spring-integration-azure-[service]o spring-cloud-azure-stream-binder-[service]. Los inicios heredados de cada uno tienen un identificador de artefacto siguiendo el patrón azure-spring-*. Esto proporciona un medio rápido y accesible para ayudar a comprender, de un vistazo, tanto si usa inicios modernos como heredados.

En el proceso de desarrollo de Spring Cloud Azure 4.0, hemos cambiado el nombre de algunos artefactos para que sigan las nuevas convenciones de nomenclatura, elimine algunos artefactos para que la funcionalidad pueda colocarse en un artefacto más adecuado y agregue algunos artefactos nuevos para atender mejor algunos escenarios.

En la tabla siguiente se muestran las asignaciones entre el identificador de artefacto heredado y el identificador de artefacto moderno:

Cambios en las dependencias

Algunas dependencias innecesarias se incluyeron en los artefactos heredados, que hemos quitado en las bibliotecas modernas de Azure 4.0 de Spring Cloud. Asegúrese de agregar las dependencias eliminadas manualmente al proyecto para evitar bloqueos.

Las bibliotecas que tienen cambios de dependencia incluyen:

• spring-cloud-azure-starter
• spring-cloud-azure-starter-active-directory
• spring-cloud-azure-starter-active-directory-b2c

Cambios de autenticación

Spring Cloud Azure 4.0 admite todos los métodos de autenticación que admite cada SDK de servicio de Azure. Permite configurar una credencial de token global, así como proporcionar la credencial de token en cada nivel de servicio. Pero no se requiere una credencial para configurar Spring Cloud Azure 4.0 porque puede aplicar la credencial almacenada en un entorno de desarrollo local o una identidad administrada en los servicios de Azure. Asegúrese de que a la entidad de seguridad se le ha concedido permiso suficiente para acceder a los recursos de Azure de destino.

Una credencial encadenada, el DefaultAzureCredential bean se configura automáticamente de forma predeterminada y se usará en todos los componentes si no se especifica más información de autenticación. Para más información, consulte la sección DefaultAzureCredential de biblioteca cliente de Azure Identity para Java.

Propiedades de configuración

Migración de propiedades

Hemos creado un archivo additional-spring-configuration-metadata.json para suavizar la migración de propiedades al usar con spring-boot-properties-migrator. En primer lugar, agregue el siguiente migrador de propiedades a la aplicación:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-properties-migrator</artifactId>
    <scope>runtime</scope>
</dependency>

O bien, si usa Gradle:

runtime("org.springframework.boot:spring-boot-properties-migrator")

Si ejecuta la aplicación, identificará las propiedades que ya no administra Spring Cloud Azure. Si hay un reemplazo, volverá a asignar temporalmente la propiedad por usted con una advertencia. Si no hay un reemplazo, un informe de errores le proporcionará más información. En cualquier caso, la configuración debe actualizarse y la dependencia se ha quitado una vez que haya actualizado la configuración.

Antes de continuar, es recomendable usar la característica de búsqueda del IDE para comprobar que no usa una de las propiedades que ha migrado en una prueba de integración.

Configuraciones globales

El spring-cloud-azure-starter moderno le permite definir propiedades que se aplican a todos los SDK de Azure del espacio de nombres spring.cloud.azure. Esta característica no se admite en el azure-spring-boot-starterheredado. Las configuraciones globales se pueden dividir en cinco categorías, que se muestran en la tabla siguiente:

Para obtener una lista completa de las configuraciones, consulte propiedades de configuración de Azure de Spring Cloud.

Configuración de cada SDK

Para obtener más información sobre las opciones de configuración en el nivel de SDK, use los vínculos siguientes:

• de azure-spring-boot-starter-active-directory a spring-cloud-azure-starter-active-directory
• de azure-spring-boot-starter-active-directory-b2c a spring-cloud-azure-starter-active-directory-b2c
• de azure-spring-boot-starter-cosmos a spring-cloud-azure-starter-data-cosmos
• de azure-spring-boot-starter-keyvault-secrets a spring-cloud-azure-starter-keyvault-secrets
• de azure-spring-boot-starter-servicebus-jms a spring-cloud-azure-starter-servicebus-jms
• de azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-blob
• de azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-file-share
• de azure-spring-cloud-starter-eventhubs a spring-cloud-azure-starter-integration-eventhubs
• de azure-spring-cloud-starter-servicebus a spring-cloud-azure-starter-integration-servicebus
• de azure-spring-cloud-starter-storage-queue a spring-cloud-azure-starter-integration-storage-queue
• de azure-spring-cloud-stream-binder-eventhubs a spring-cloud-azure-stream-binder-eventhubs
• de azure-spring-cloud-stream-binder-servicebus-* a spring-cloud-azure-stream-binder-servicebus

Cambios importantes en la API

Para más información sobre los cambios importantes de api en cada biblioteca, use los vínculos siguientes:

• de azure-spring-boot-starter-active-directory a spring-cloud-azure-starter-active-directory
• de azure-spring-boot-starter-active-directory-b2c a spring-cloud-azure-starter-active-directory-b2c
• de azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-blob
• de azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-file-share
• de azure-spring-cloud-starter-eventhubs a spring-cloud-azure-starter-integration-eventhubs
• de azure-spring-integration-eventhubs a spring-integration-azure-eventhubs
• de azure-spring-cloud-starter-servicebus a spring-cloud-azure-starter-integration-servicebus
• de azure-spring-integration-servicebus a spring-integration-azure-servicebus
• de azure-spring-cloud-starter-storage-queue a spring-cloud-azure-starter-integration-storage-queue
• de azure-spring-integration-storage-queue a spring-integration-azure-storage-queue
• de azure-spring-cloud-stream-binder-eventhubs a spring-cloud-azure-stream-binder-eventhubs
• de azure-spring-cloud-stream-binder-servicebus-* a spring-cloud-azure-stream-binder-servicebus

Cambios en la biblioteca

Los cambios importantes en cada biblioteca se presentan de la siguiente manera.

De azure-spring-boot-starter a spring-cloud-azure-starter

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter de la versión 3 de azure-spring-boot-starter.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios de dependencia

Algunas dependencias innecesarias se incluyeron en los artefactos heredados, que hemos quitado en las bibliotecas modernas de Spring Cloud Azure 4.0. Asegúrese de agregar las dependencias eliminadas manualmente al proyecto para evitar un bloqueo accidental.

En la tabla siguiente se muestran las dependencias quitadas:

Desde azure-spring-boot-starter-active-directory a spring-cloud-azure-starter-active-directory

Esta guía está pensada para ayudar a la migración a spring-cloud-azure-starter-active-directory de la versión 3 de azure-spring-boot-starter-active-directory.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios de dependencia

Se han quitado algunas dependencias innecesarias del artefacto heredado desde la biblioteca moderna de Spring Cloud Azure 4.0. Agregue estas dependencias eliminadas al proyecto para evitar bloqueos accidentales.

En la tabla siguiente se muestran las dependencias quitadas:

Cambios en la configuración del SDK

En esta sección se incluyen los cambios sobre las propiedades agregadas, eliminadas y modificadas.

• Los dos puntos siguientes son los principales para prestar atención a:

1. El prefijo de todos los nombres de propiedad de configuración ha cambiado de azure.activedirectory a spring.cloud.azure.active-directory.
2. Se agrega spring.cloud.azure.active-directory.enabled nueva propiedad para habilitar o deshabilitar las características relacionadas con Microsoft Entra. El valor predeterminado es false.

En la tabla siguiente se muestran las asignaciones de propiedades entre azure-spring-boot-starter-active-directory y spring-cloud-azure-starter-active-directory:

• El tipo de valor de las siguientes propiedades se cambia de long a Duration:

  • jwt-connect-timeout
  • jwt-read-timeout
  • jwk-set-cache-lifespan
  • jwk-set-cache-refresh-time.

• Se quitan las siguientes propiedades:

  • azure.activedirectory.allow-telemetry
  • azure.activedirectory.user-group.enable-full-list
  • azure.activedirectory.graph-base-uri
  • azure.activedirectory.graph-membership-uri

• Se agregan las siguientes propiedades:

  • 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

Estos son algunos ejemplos de migración:

• Ejemplo 1. Caso 1

  • Para el heredado: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/memberOf

  • Para los modernos: 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

• Ejemplo 2. Caso 2

  • Para el heredado: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/transitiveMemberOf

  • Para los modernos: 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

Cambios de API

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-boot-starter-active-directory a spring-cloud-azure-starter-active-directory:

En esta sección se enumeran las clases eliminadas de azure-spring-boot-starter-active-directory.

• Se quitó la clase heredada

  • com.azure.spring.aad.webapp.AADHandleConditionalAccessFilter
  • com.azure.spring.aad.webapi.validator.AADJwtAudienceValidator
  • com.azure.spring.aad.webapi.validator.AADJwtClaimValidator

De azure-spring-boot-starter-active-directory-b2c a spring-cloud-azure-starter-active-directory-b2c

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter-active-directory-b2c de la versión 3 de azure-spring-boot-starter-active-directory-b2c.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios de dependencia

Algunas dependencias innecesarias se incluyeron en los artefactos heredados, que hemos quitado en las bibliotecas modernas de Spring Cloud Azure 4.0. Asegúrese de agregar las dependencias eliminadas manualmente al proyecto para evitar un bloqueo accidental.

En la tabla siguiente se muestran las dependencias quitadas:

Cambios en la configuración del SDK

En esta sección se incluyen los cambios sobre las propiedades agregadas, eliminadas y modificadas.

• Los dos puntos siguientes son los principales para prestar atención a:

1. Todos los nombres de propiedad de configuración cambiaron el prefijo de azure.activedirectory.b2c a spring.cloud.azure.active-directory.b2c.
2. Se agrega una nueva propiedad spring.cloud.azure.active-directory.b2c.enabled para permitir la habilitación o deshabilitación de características relacionadas con Azure AD B2C. El valor predeterminado es false.

En la tabla siguiente se muestran las asignaciones de propiedades de azure-spring-boot-starter-active-directory-b2c a spring-cloud-azure-starter-active-directory-b2c:

• Se han quitado las propiedades de azure-spring-boot-starter-active-directory-b2c:

  • azure.activedirectory.b2c.allow-telemetry
  • azure.activedirectory.b2c.tenant

• El tipo de valor de las siguientes propiedades se cambia de long a Duration:

  • jwt-connect-timeout
  • jwt-read-timeout

Cambios de API

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-boot-starter-active-directory-b2c a spring-cloud-azure-starter-active-directory-b2c:

De azure-spring-boot-starter-cosmos a spring-cloud-azure-starter-data-cosmos

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter-data-cosmos de la versión 3 de azure-spring-boot-starter-cosmos.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

Todos los nombres de propiedad de configuración cambiaron el prefijo de azure.cosmos a spring.cloud.azure.cosmos.

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-boot-starter-cosmos a spring-cloud-azure-starter-data-cosmos:

De azure-spring-boot-starter-keyvault-secrets a spring-cloud-azure-starter-keyvault-secrets

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter-keyvault-secrets de la versión 3 de azure-spring-boot-starter-keyvault-secrets.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

En esta sección se incluyen los cambios sobre las propiedades agregadas, eliminadas y modificadas.

En la tabla siguiente se muestran las asignaciones de propiedades de azure-spring-boot-starter-keyvault-secrets a spring-cloud-azure-starter-keyvault-secrets:

• Propiedades eliminadas de spring-cloud-azure-starter-keyvault-secrets

azure.keyvault.allow-telemetry azure.keyvault.order

Los siguientes puntos debe prestar atención a:

1. Todos los nombres de propiedad de configuración cambiaron el prefijo de azure.keyvault a spring.cloud.azure.keyvault.secret.
2. spring.cloud.azure.keyvault.secret.enabled se usa para habilitar todas las características del secreto de Key Vault, incluya configurar los beans de cliente secreto de Key Vault (como SecretClient y SecretAsyncClient) y agregar KeyVaultPropertySource en ConfigurableEnvironment.
3. spring.cloud.azure.keyvault.secret.property-source-enabled se usa para habilitar todos los KeyVaultPropertySource. Solo surtirá efecto cuando spring.cloud.azure.keyvault.secret.enabled=true.
4. Para las propiedades comunes de Azure (como client, proxy, retry, credential, profile) y las propiedades de Key Vault (como endpoint, service-version). Si spring.cloud.azure.keyvault.secret.property-sources[n].PROPERTY_NAME no está configurado, se usará spring.cloud.azure.keyvault.secret.PROPERTY_NAME.
5. spring.cloud.azure.keyvault.secret.property-sources[n].resource es específico de un recurso de Azure único, por lo que si no está configurado, no obtendrá valor de otros lugares.

Desde azure-spring-boot-starter-servicebus-jms a spring-cloud-azure-starter-servicebus-jms

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter-servicebus-jms de la versión 3 de azure-spring-boot-starter-servicebus-jms.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

El tipo de configuración para spring.jms.servicebus.idle-timeout cambió de long(milisegundos) a Duration patrón de legibilidad.

De azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-blob

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter-storage-blob de la versión 3 de azure-spring-boot-starter-storage.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

Todos los nombres de propiedad de configuración cambiaron el prefijo de azure.storage a spring.cloud.azure.storage.blob.

En la tabla siguiente se muestran las asignaciones de propiedades de azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-blob:

Cambios de API

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-blob:

Desde azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-file-share

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter-storage-file-share de la versión 3 de azure-spring-boot-starter-storage.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

Todos los nombres de propiedad de configuración cambiaron el prefijo de azure.storage a spring.cloud.azure.storage.fileshare.

En la tabla siguiente se muestran las asignaciones de propiedades de azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-file-share:

Cambios de API

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-boot-starter-storage a spring-cloud-azure-starter-storage-file-share:

Desde azure-spring-cloud-starter-eventhubs a spring-cloud-azure-starter-integration-eventhubs

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter-integration-eventhubs de la versión 2 de azure-spring-cloud-starter-eventhubs.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

Para ver los cambios en las entradas secundarias de este prefijo, consulte las tablas siguientes:

En la tabla siguiente se muestran las asignaciones de propiedades de azure-spring-cloud-starter-eventhubs a spring-cloud-azure-starter-integration-eventhubs:

Por ejemplo, cambie de:

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}

Para:

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}

Cambios de API

• Para conocer los cambios en las anotaciones del agente de escucha, consulte la guía de migración de la biblioteca <<migration-azure-spring-cloud-messaging, azure-spring-cloud-messaging>>.
• Quite EventHubOperation con la función de suscripción movida a la clase EventHubsMessageListenerContainer y la función de envío se movió a EventHubsTemplate.
• Cambie el nombre de EventHubInboundChannelAdapter como EventHubsInboundChannelAdapter para mantener la coherencia con el servicio de Azure Event Hubs.
• Cambie el constructor de EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) a EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) y EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Cambie CheckpointConfig estilo de creación de instancias al constructor simple en lugar del estilo de compilación.
• Quite la API EventHubOperation#setCheckpointConfig. Para establecer la configuración de punto de control para el adaptador de canal de entrada, los usuarios pueden llamar al método EventHubsContainerProperties#setCheckpointConfig.
• Quite la API EventHubOperation#setBatchConsumerConfig. Para establecer la configuración de consumo por lotes para el adaptador de canal de entrada, los usuarios pueden llamar a los dos métodos EventHubsContainerProperties#getBatch#setMaxSize y EventHubsContainerProperties#getBatch#setMaxWaitTime mientras tanto.
• Para el modo de consumo por lotes, cambie los nombres de encabezado del mensaje convertidos de mensajes por lotes.
  • Cambie el encabezado del mensaje de azure_eventhub_enqueued_time a azure_eventhubs_batch_converted_enqueued_time.
  • Cambie el encabezado del mensaje de azure_eventhub_offset a azure_eventhubs_batch_converted_offset.
  • Cambie el encabezado del mensaje de azure_eventhub_sequence_number a azure_eventhubs_batch_converted_sequence_number.
  • Cambie el encabezado del mensaje de azure_partition_key a azure_batch_converted_partition_key.
• Al publicar mensajes en Event Hubs, omita todos los encabezados de mensaje convertidos de mensajes por lotes. Los encabezados incluyen:
  • 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
• El modo de punto de comprobación de BATCH solo funciona ahora en el modo de consumo por lotes, que se puede habilitar pasando ListenerMode.BATCH al constructor EventHubsInboundChannelAdapter.

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-cloud-starter-eventhubs a spring-cloud-azure-starter-integration-eventhubs:

Fragmento de código de ejemplo

• EventHubsInboundChannelAdapter código de ejemplo:

  Código heredado:

  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;
      }
  }
  

  Código moderno:

  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;
      }
  }
  

• DefaultMessageHandler código de ejemplo:

  Código heredado:

  public class Demo {
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL")
      public MessageHandler messageSender(EventHubOperation eventhubOperation) {
          DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @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;
      }
  }
  

  Código moderno:

  public class Demo {
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL")
      public MessageHandler messageSender(EventHubsTemplate eventhubOperation) {
          DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @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;
      }
  }
  

Desde azure-spring-integration-eventhubs a spring-integration-azure-eventhubs

Esta guía está pensada para ayudar en la migración a spring-integration-azure-eventhubs de la versión 2 de azure-spring-integration-eventhubs.

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .

Cambios de API

• Quite EventHubOperation con la función de suscripción movida a la clase EventHubsMessageListenerContainer y la función de envío se movió a EventHubsTemplate.
• Cambie el nombre de EventHubInboundChannelAdapter como EventHubsInboundChannelAdapter para mantener la coherencia con el servicio de Azure Event Hubs.
• Cambie el constructor de EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) a EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) y EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Cambie CheckpointConfig estilo de creación de instancias al constructor simple en lugar del estilo de compilación.
• Quite la API EventHubOperation#setCheckpointConfig. Para establecer la configuración de punto de control para el adaptador de canal de entrada, los usuarios pueden llamar al método EventHubsContainerProperties#setCheckpointConfig.
• Quite la API EventHubOperation#setBatchConsumerConfig. Para establecer la configuración de consumo por lotes para el adaptador de canal de entrada, los usuarios pueden llamar a los dos métodos EventHubsContainerProperties#getBatch#setMaxSize y EventHubsContainerProperties#getBatch#setMaxWaitTime mientras tanto.
• Para el modo de consumo por lotes, cambie los nombres de encabezado del mensaje convertidos de mensajes por lotes.
  • Cambie el encabezado del mensaje de azure_eventhub_enqueued_time a azure_eventhubs_batch_converted_enqueued_time.
  • Cambie el encabezado del mensaje de azure_eventhub_offset a azure_eventhubs_batch_converted_offset.
  • Cambie el encabezado del mensaje de azure_eventhub_sequence_number a azure_eventhubs_batch_converted_sequence_number.
  • Cambie el encabezado del mensaje de azure_partition_key a azure_batch_converted_partition_key.
• Al publicar mensajes en Event Hubs, omita todos los encabezados de mensaje convertidos de mensajes por lotes. Los encabezados incluyen:
  • 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
• El modo de punto de comprobación de BATCH solo funciona ahora en el modo de consumo por lotes, que se puede habilitar pasando ListenerMode.BATCH al constructor EventHubsInboundChannelAdapter.

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-integration-eventhubs a spring-integration-azure-eventhubs:

Desde azure-spring-cloud-starter-servicebus a spring-cloud-azure-starter-integration-servicebus

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter-integration-servicebus de la versión 2 de azure-spring-cloud-starter-servicebus.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

Para todas las opciones de configuración admitidas en spring-cloud-azure-starter-integration-servicebus, el prefijo permanece como spring.cloud.azure.servicebus.

En la tabla siguiente se muestran las asignaciones de propiedades de azure-spring-cloud-starter-servicebus a spring-cloud-azure-starter-integration-servicebus:

Cambios de API

• Quite ServiceBusQueueOperation y ServiceBusTopicOperation con la función de suscripción movida a la clase ServiceBusMessageListenerContainer y la función de envío se movió a ServiceBusTemplate.
• Quite ServiceBusQueueInboundChannelAdapter y ServiceBusTopicInboundChannelAdaptery mueva la funcionalidad para escuchar una entidad de cola o tema de Service Bus a ServiceBusInboundChannelAdapter.
• Cambie el constructor de ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) a ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) y ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Cambie el constructor de ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) a ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) y ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Quite las API ServiceBusQueueOperation#setCheckpointConfig y ServiceBusTopicOperation#setCheckpointConfig. Para establecer la configuración del punto de control para el adaptador de canal de entrada, los usuarios pueden llamar al método ServiceBusContainerProperties#setAutoComplete en su lugar. Para deshabilitar el modo de autocompletar es equivalente a MANUAL modo de punto de control y habilitarlo desencadenará el modo RECORD.
• Quite las API ServiceBusQueueOperatio#setClientConfig y ServiceBusTopicOperation#setClientConfig. Para configurar el ServiceBusProcessorClient subyacente usado por el adaptador de canal de entrada, los usuarios pueden usar ServiceBusContainerProperties en su lugar.
• Quite CompletableFuture compatibilidad con ServiceBusTemplate y DefaultMessageHandler, admita Reactor en su lugar.
• Agregue una nueva API de ServiceBusTemplate#setDefaultEntityType para especificar el tipo de entidad, que es necesario cuando no se proporciona ningún bean de PropertiesSupplier<String, ProducerProperties> para el ProducerProperties#entityType.
• Quite el encabezado del mensaje AzureHeaders.RAW_ID. Use ServiceBusMessageHeaders.MESSAGE_ID en su lugar.

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-cloud-starter-servicebus a spring-cloud-azure-starter-integration-servicebus:

Fragmento de código de ejemplo

• ServiceBusInboundChannelAdapter código de ejemplo:

  Código heredado de uso de ServiceBusQueueInboundChannelAdapter o ServiceBusTopicInboundChannelAdapter:

  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;
      }
  
  }
  

  Código moderno:

  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;
      }
  }
  

• DefaultMessageHandler código de ejemplo:

  Código heredado, tomando la cola como ejemplo:

  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<Void>() {
              @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;
      }
  }
  

  Código moderno:

  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<Void>() {
              @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;
      }
  }
  

Desde azure-spring-integration-servicebus a spring-integration-azure-servicebus

Esta guía está pensada para ayudar en la migración a spring-integration-azure-servicebus de la versión 2 de azure-spring-integration-servicebus.

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .

Cambios de API

• Quite ServiceBusQueueOperation y ServiceBusTopicOperation con la función de suscripción movida a la clase ServiceBusMessageListenerContainer y la función de envío se movió a ServiceBusTemplate.
• Quite ServiceBusQueueInboundChannelAdapter y ServiceBusTopicInboundChannelAdaptery mueva la funcionalidad para escuchar una entidad de cola o tema de Service Bus a ServiceBusInboundChannelAdapter.
• Cambie el constructor de ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) a ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) y ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Cambie el constructor de ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) a ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) y ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Quite las API ServiceBusQueueOperation#setCheckpointConfig y ServiceBusTopicOperation#setCheckpointConfig. Para establecer la configuración del punto de control para el adaptador de canal de entrada, los usuarios pueden llamar al método ServiceBusContainerProperties#setAutoComplete en su lugar. Para deshabilitar el modo de autocompletar es equivalente a MANUAL modo de punto de control y habilitarlo desencadenará el modo RECORD.
• Quite las API ServiceBusQueueOperation#setClientConfig y ServiceBusTopicOperation#setClientConfig. Para configurar el ServiceBusProcessorClient subyacente usado por el adaptador de canal de entrada, los usuarios pueden usar ServiceBusContainerProperties en su lugar.
• Quite CompletableFuture compatibilidad con ServiceBusTemplate y DefaultMessageHandler, admita Reactor en su lugar.
• Agregue una nueva API de ServiceBusTemplate#setDefaultEntityType para especificar el tipo de entidad, que es necesario cuando no se proporciona ningún bean de PropertiesSupplier<String, ProducerProperties> para el ProducerProperties#entityType.
• Quite el encabezado del mensaje AzureHeaders.RAW_ID. Use ServiceBusMessageHeaders.MESSAGE_ID en su lugar.

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-integration-servicebus a spring-integration-azure-servicebus:

Desde azure-spring-cloud-starter-storage-queue a spring-cloud-azure-starter-integration-storage-queue

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-starter-integration-storage-queue de la versión 2 de azure-spring-cloud-starter-storage-queue.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

Todos los nombres de propiedad de configuración cambiaron el prefijo de spring.cloud.azure.storage a spring.cloud.azure.storage.queue.

En la tabla siguiente se muestran las asignaciones de propiedades de azure-spring-cloud-starter-storage-queue a spring-cloud-azure-starter-integration-storage-queue:

Cambios de API

• Quite StorageQueueOperation y proporcione StorageQueueTemplate en su lugar.
• Quite checkpoint-mode configuración en StorageQueueTemplate, solo admite el modo MANUAL.

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-cloud-starter-storage-queue a spring-cloud-azure-starter-integration-storage-queue.

Desde azure-spring-integration-storage-queue a spring-integration-azure-storage-queue

Esta guía está pensada para ayudar en la migración a spring-integration-azure-storage-queue de la versión 2 de azure-spring-integration-storage-queue.

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .

Cambios de API

• Quite StorageQueueOperation y proporcione StorageQueueTemplate en su lugar.
• Quite checkpoint-mode configuración en StorageQueueTemplate, solo admite el modo MANUAL.

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-integration-storage-queue a spring-integration-azure-storage-queue.

Desde azure-spring-cloud-stream-binder-eventhubs a spring-cloud-azure-stream-binder-eventhubs

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-stream-binder-eventhubs de la versión 2 de azure-spring-cloud-stream-binder-eventhubs.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

Para ver los cambios en las entradas secundarias para el siguiente prefijo, consulte la tabla siguiente.

En la tabla siguiente se muestran las asignaciones de propiedades de azure-spring-cloud-stream-binder-eventhubs a spring-cloud-azure-stream-binder-eventhubs:

Ejemplos de migración de configuración

Para usar la cadena de conexión para la autenticación y migrar las propiedades mencionadas anteriormente, se enumeran los cambios de configuración siguientes:

Configuración heredada:

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:
          <binding-name>:
            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

Configuración moderna:

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:
          <binding-name>:
            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

Si usa entidades de seguridad en lugar de cadenas de conexión, en las versiones anteriores a la 4.0, la aplicación se conectará primero a Azure Resource Manager (ARM) con la entidad de seguridad proporcionada y, a continuación, recuperará la cadena de conexión del espacio de nombres especificado con ARM. Al final, la aplicación usa la cadena de conexión recuperada para conectarse a Azure Event Hubs. De este modo, se debe conceder a la entidad de seguridad proporcionada el rol de colaborador de para recuperar el espacio de nombres de Azure Event Hubs asociado.

Para Azure Spring Apps 4.0, proporcionamos dos maneras de aprovechar las entidades de seguridad para la autenticación. Uno sigue usando las entidades de seguridad para conectarse a ARM y recuperar las cadenas de conexión donde se requiere el rol de Contributor para las entidades de seguridad. El otro aprovecha las entidades de seguridad para autenticarse en el identificador de Microsoft Entra y, a continuación, conectarse directamente a Azure Event Hubs. En este caso, el rol de Contributor ya no es necesario, mientras que otros roles relacionados Data son necesarios para las operaciones de mensajería. Para asegurarse de que a la entidad de seguridad se le ha concedido el permiso suficiente para acceder al recurso de Azure, consulte Autorizar el acceso con el identificador de Microsoft Entra.

Para la autenticación basada en ARM, tomando la entidad de servicio como ejemplo, la migración de configuración se muestra a continuación, donde el rol asignado no debe cambiar:

Configuración heredada:

spring:
  cloud:
    azure:
      client-id: ${AZURE_CLIENT_ID}
      client-secret: ${AZURE_CLIENT_SECRET}
      tenant-id: <tenant>
      resource-group: ${EVENTHUB_RESOURCE_GROUP}
      eventhub:
        namespace: ${EVENTHUB_NAMESPACE}

Se requieren las propiedades de configuración moderna para el identificador de suscripción de Azure y el grupo de recursos:

spring:
  cloud:
    azure:
      credential:
        client-id: ${AZURE_CLIENT_ID}
        client-secret: ${AZURE_CLIENT_SECRET}
      profile:
        tenant-id: <tenant>
        subscription-id: ${AZURE_SUBSCRIPTION_ID}
      eventhubs:
        namespace: ${EVENTHUB_NAMESPACE}
        resource:
          resource-group: ${RESOURCE_GROUP}

También puede migrar para autenticar y autorizar con el identificador de Entra de Microsoft directamente sin realizar un desvío a ARM. Asegúrese de conceder a la entidad de seguridad los roles necesarios Data para las operaciones de mensajería. Los ejemplos de configuración de la entidad de servicio y la identidad administrada se enumeran a continuación:

• Con una entidad de servicio

  spring:
    cloud:
      azure:
        credential:
          client-id: ${AZURE_CLIENT_ID}
          client-secret: ${AZURE_CLIENT_SECRET}
        profile:
          tenant-id: <tenant>
        eventhubs:
          namespace: ${EVENTHUB_NAMESPACE}
  

• Con una identidad administrada

  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}
  

Cambios de API

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-cloud-stream-binder-eventhubs a spring-cloud-azure-stream-binder-eventhubs.

Desde azure-spring-cloud-stream-binder-servicebus-* a spring-cloud-azure-stream-binder-servicebus

Esta guía está pensada para ayudar en la migración a spring-cloud-azure-stream-binder-servicebus de la versión 2 de azure-spring-cloud-stream-binder-servicebus-queue o azure-spring-cloud-stream-binder-servicebus-topic.

Para obtener información general, use los vínculos siguientes:

• Para obtener información general sobre los cambios de la versión 4.0, consulte las secciones introducción y Ventajas de migración.
• Para obtener más información sobre los cambios de estrategia en la nomenclatura del proyecto, consulte la sección Cambios de nomenclatura.
• Para obtener información sobre cómo usar una lista de materiales para todas las bibliotecas de Azure de Spring Cloud, consulte la sección boM de .
• Para obtener información sobre cómo controlar la autenticación en Spring Cloud Azure 4.0, consulte la sección Cambios de autenticación.
• Para obtener información sobre cómo aprovechar spring-boot-properties-migrator durante la migración, consulte la sección Configuración de cada SDK.
• Para obtener más información sobre los cambios de configuración globales y comunes, consulte la sección configuraciones globales de .

Cambios en la configuración del SDK

En la tabla siguiente se enumeran las nuevas propiedades de configuración de spring-cloud-azure-stream-binder-servicebus:

En la tabla siguiente se muestran las asignaciones de propiedades de azure-spring-cloud-stream-binder-servicebus-* a spring-cloud-azure-stream-binder-servicebus:

Ejemplos de migración de configuración

Configuración heredada, tomando cola como ejemplo:

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

Configuración moderna:

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

Si usa entidades de seguridad en lugar de cadenas de conexión, en las versiones anteriores a la 4.0, la aplicación se conectará primero a Azure Resource Manager (ARM) con la entidad de seguridad proporcionada y, a continuación, recuperará la cadena de conexión del espacio de nombres especificado con ARM. Al final, la aplicación usa la cadena de conexión recuperada para conectarse a Azure Service Bus. De este modo, se debe conceder a la entidad de seguridad proporcionada el rol colaborador de para recuperar el espacio de nombres de Azure Service Bus asociado.

Para Azure Spring Apps 4.0, proporcionamos dos maneras de aprovechar las entidades de seguridad para la autenticación. Uno sigue usando las entidades de seguridad para conectarse a ARM y recuperar las cadenas de conexión donde se requiere el rol de Contributor para las entidades de seguridad. El otro aprovecha las entidades de seguridad para autenticarse en microsoft Entra ID y, a continuación, conectarse directamente a Azure Service Bus. En este caso, el rol de Contributor ya no es necesario, mientras que otros roles relacionados Data son necesarios para las operaciones de mensajería. Para asegurarse de que a la entidad de seguridad se le ha concedido el permiso suficiente para acceder al recurso de Azure, consulte Autorizar el acceso con el identificador de Microsoft Entra.

Para la autenticación basada en ARM, tomando la entidad de servicio como ejemplo, la migración de configuración se muestra a continuación, donde el rol asignado no debe cambiar:

Configuración heredada:

spring:
  cloud:
    azure:
      client-id: ${AZURE_CLIENT_ID}
      client-secret: ${AZURE_CLIENT_SECRET}
      tenant-id: <tenant>
      resource-group: ${SERVICEBUS_RESOURCE_GROUP}
      servicebus:
        namespace: ${SERVICEBUS_NAMESPACE}

Se requieren las propiedades de configuración moderna para el identificador de suscripción de Azure y el grupo de recursos:

spring:
  cloud:
    azure:
      credential:
        client-id: ${AZURE_CLIENT_ID}
        client-secret: ${AZURE_CLIENT_SECRET}
      profile:
        tenant-id: <tenant>
        subscription-id: ${AZURE_SUBSCRIPTION_ID}
      servicebus:
        namespace: ${SERVICEBUS_NAMESPACE}
        resource:
          resource-group: ${SERVICEBUS_RESOURCE_GROUP}

También puede migrar para autenticar y autorizar con el identificador de Entra de Microsoft directamente sin realizar un desvío a ARM. Asegúrese de conceder a la entidad de seguridad los roles necesarios Data para las operaciones de mensajería. Los ejemplos de configuración de la entidad de servicio y la identidad administrada se enumeran a continuación:

• Con una entidad de servicio

  spring:
    cloud:
      azure:
        credential:
          client-id: ${AZURE_CLIENT_ID}
          client-secret: ${AZURE_CLIENT_SECRET}
        profile:
          tenant-id: <tenant>
        servicebus:
          namespace: ${SERVICEBUS_NAMESPACE}
  

• Con una identidad administrada

  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}
  

Cambios de API

• Quite el encabezado del mensaje AzureHeaders.RAW_ID. Use ServiceBusMessageHeaders.MESSAGE_ID en su lugar.

En la tabla siguiente se muestran las asignaciones de clases de azure-spring-cloud-stream-binder-eventhubs a spring-cloud-azure-stream-binder-eventhubs.

azure-spring-cloud-messaging

La biblioteca de com.azure.spring:azure-spring-cloud-messaging no está lista para la versión 4.0. La función de las anotaciones del agente de escucha está en rediseño, por lo que actualmente no se admiten las anotaciones de @AzureMessageListener, @AzureMessageListenersy @EnableAzureMessaging.