Guide de migration pour Spring Cloud Azure 4.0

Ce guide vous aide à migrer vers Spring Cloud Azure 4.0 à partir de bibliothèques Azure Spring héritées.

Introduction

Nous allons appeler des bibliothèques dont l’ID de groupe et l’ID d’artefact suivent le modèle des bibliothèques modernes, ainsi que celles avec le modèle com.azure.spring:azure-spring-boot-*com.azure.spring:spring-cloud-azure-* , com.azure.spring:azure-spring-cloud-*ou com.azure.spring:azure-spring-integration-* les bibliothèques héritées.

Ce guide se concentre sur les comparaisons côte à côte pour des configurations similaires entre les bibliothèques modernes et héritées.

La connaissance du com.azure.spring:azure-spring-boot-*package ou com.azure.spring:azure-spring-integration-* de l’utilisation com.azure.spring:azure-spring-cloud-* du package est supposée.

Si vous débutez avec les bibliothèques Spring Cloud Azure 4.0, consultez le guide du développeur Spring Cloud Azure plutôt que ce guide.

Avantages de la migration

Une question naturelle à poser lorsque vous envisagez d’adopter une nouvelle version ou bibliothèque est ses avantages. À mesure qu’Azure a mûri et a été adopté par un groupe plus diversifié de développeurs, nous nous sommes concentrés sur l’apprentissage des modèles et des pratiques afin de mieux prendre en charge la productivité des développeurs et de comprendre les lacunes que présentent les bibliothèques Azure Spring Cloud.

Plusieurs domaines de commentaires cohérents ont été exprimés dans les bibliothèques Azure Spring Cloud. Le plus important est que les bibliothèques pour différents services Azure n’ont pas activé l’ensemble complet de configurations. En outre, l’incohérence du nommage de projet, des ID d’artefacts, des versions et des configurations a rendu la courbe d’apprentissage raide.

Pour améliorer l’expérience de développement dans les bibliothèques Azure Spring Cloud, un ensemble de directives de conception a été introduit pour s’assurer que les bibliothèques Azure Spring Cloud ont une sensation naturelle et idiomatique par rapport à l’écosystème Spring. Vous trouverez plus d’informations dans le document de conception pour ceux qui vous intéressent.

Spring Cloud Azure 4.0 offre l’expérience partagée entre les bibliothèques qui s’intègrent à différents projets Spring, par exemple Spring Boot, Spring Integration, Spring Cloud Stream, et ainsi de suite. L’expérience partagée comprend :

• Un boM unifié pour inclure toutes les bibliothèques Spring Cloud Azure 4.0.
• Convention d’affectation de noms cohérente pour les artefacts.
• Un moyen unifié de configurer les informations d’identification, le proxy, les nouvelles tentatives, l’environnement cloud et les paramètres de couche de transport.
• La prise en charge de toutes les méthodes d’authentification prises en charge par un service Azure ou le Kit de développement logiciel (SDK) Azure Service.

Vue d’ensemble

Ce guide de migration se compose des sections suivantes :

• Modifications de nommage pour Spring Cloud Azure 4.0
• Modifications d’artefact : renommé / ajouté / supprimé
• Changements de dépendances
• Modifications de l’authentification
• Propriétés de configuration
• Changements cassants de l’API
• Modifications apportées à la bibliothèque

Modifications des dénominations

Il n’y a jamais eu de nom cohérent ou officiel pour appeler toutes les bibliothèques Azure Spring Cloud. Certains d’entre eux ont été appelés Azure Spring Boot et certains d’entre eux Spring on Azure. Depuis la version 4.0, nous avons commencé à utiliser le nom Spring Cloud Azure du projet pour représenter toutes les bibliothèques Azure Spring.

Nomenclature

Nous avons utilisé pour expédier deux BOM pour nos bibliothèques, le azure-spring-boot-bom et azure-spring-cloud-dependencies, mais nous avons combiné ces deux BOM en un boM depuis 4.0, le spring-cloud-azure-dependencies. Ajoutez une entrée dans la dependencyManagement section de votre projet pour tirer parti de la gestion des dépendances.

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

Modifications d’artefact : renommé / ajouté / supprimé

Les ID de groupe sont identiques pour les bibliothèques Azure Spring Cloud modernes et héritées. Ils sont tous com.azure.spring. Les ID d’artefact pour les bibliothèques Azure Spring Cloud modernes ont changé. Selon le projet Spring auquel il appartient, Spring Boot, Spring Integration ou Spring Cloud Stream, le modèle d’ID d’artefact peut être spring-cloud-azure-starter-[service], spring-integration-azure-[service]ou spring-cloud-azure-stream-binder-[service]. Les starters hérités pour chacun possèdent un ID d’artefact suivant le modèle azure-spring-*. Cela fournit un moyen rapide et accessible pour vous aider à comprendre, en un clin d’œil, que vous utilisiez des démarrages modernes ou hérités.

Dans le processus de développement d’Azure Spring Cloud 4.0, nous avons renommé certains artefacts pour les faire suivre les nouvelles conventions d’affectation de noms, supprimé certains artefacts afin que la fonctionnalité puisse être placée dans un artefact plus approprié et ajouté de nouveaux artefacts pour mieux servir certains scénarios.

Le tableau suivant présente les mappages entre l’ID d’artefact hérité et l’ID d’artefact moderne :

Modifications des dépendances

Certaines dépendances inutiles ont été incluses dans les artefacts hérités, que nous avons supprimés dans les bibliothèques Spring Cloud Azure 4.0 modernes. Veillez à ajouter manuellement les dépendances supprimées à votre projet pour éviter les blocages.

Les bibliothèques qui ont des modifications de dépendance sont les suivantes :

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

Modifications de l’authentification

Spring Cloud Azure 4.0 prend en charge toutes les méthodes d’authentification que chaque Kit de développement logiciel (SDK) du service Azure prend en charge. Il vous permet de configurer des informations d’identification de jeton globales, ainsi que de fournir les informations d’identification du jeton à chaque niveau de service. Toutefois, les informations d’identification ne sont pas nécessaires pour configurer Spring Cloud Azure 4.0, car elles peuvent appliquer les informations d’identification stockées dans un environnement de développement local ou une identité managée dans Azure Services. Assurez-vous que le principal a reçu une autorisation suffisante pour accéder aux ressources Azure cibles.

Les informations d’identification chaînées sont DefaultAzureCredential configurées automatiquement par défaut et sont utilisées par tous les composants si aucune information d’authentification supplémentaire n’est spécifiée. Pour plus d’informations, consultez la section DefaultAzureCredential de la bibliothèque de client Azure Identity pour Java.

Propriétés de configuration

Migration des propriétés

Nous avons créé un fichier additional-spring-configuration-metadata.json pour faciliter la migration des propriétés lors de l’utilisation avec spring-boot-properties-migrator. Tout d’abord, ajoutez la migration de propriété suivante à votre application :

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

Ou, si vous utilisez Gradle :

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

Si vous exécutez l’application, elle identifie les propriétés qui ne sont plus gérées par Spring Cloud Azure. S’il existe un remplacement, il remapira temporairement la propriété pour vous avec un avertissement. S’il n’y a pas de remplacement, un rapport d’erreurs vous fournira plus d’informations. Dans les deux cas, la configuration doit être mise à jour et la dépendance supprimée une fois que vous avez mis à jour la configuration.

Avant de continuer, il est judicieux d’utiliser la fonctionnalité de recherche de votre IDE pour double-case activée que vous n’utilisez pas l’une des propriétés que vous avez migrées dans un test d’intégration.

Configurations globales

La version moderne spring-cloud-azure-starter vous permet de définir des propriétés qui s’appliquent à tous les Kits de développement logiciel (SDK) Azure dans l’espace de noms spring.cloud.azure. Cette fonctionnalité n’a pas été prise en charge dans l’ancien azure-spring-boot-starter. Les configurations globales peuvent être divisées en cinq catégories, indiquées dans le tableau suivant :

Préfixe	Description
spring.cloud.azure.client	Configure les clients de transport sous chaque Kit de développement logiciel (SDK) Azure.
spring.cloud.azure.credential	Configure comment s’authentifier avec l’ID Microsoft Entra.
spring.cloud.azure.profile	Configure l’environnement cloud Azure.
spring.cloud.azure.proxy	Configure les options de proxy, s’applique à tous les clients du Kit de développement logiciel (SDK) Azure.
spring.cloud.azure.retry	Configure les options de nouvelle tentative, s’applique à tous les clients du Kit de développement logiciel (SDK) Azure. Les options de nouvelle tentative ont pris en charge une partie des kits SDK, il n’y a pas spring.cloud.azure.cosmos.retry.

Pour obtenir la liste complète des configurations, consultez les propriétés de configuration d’Azure Spring Cloud.

Configurer chaque Kit de développement logiciel (SDK)

Pour plus d’informations sur les options de configuration au niveau du Kit de développement logiciel (SDK), utilisez les liens suivants :

• D’azure-spring-boot-starter-active-directory à spring-cloud-azure-starter-active-directory
• D’azure-spring-boot-starter-active-directory-b2c à spring-cloud-azure-starter-active-directory-b2c
• D’azure-spring-boot-starter-cosmos à spring-cloud-azure-starter-data-cosmos
• D’azure-spring-boot-starter-keyvault-secrets à spring-cloud-azure-starter-keyvault-secrets
• D’azure-spring-boot-starter-servicebus-jms à spring-cloud-azure-starter-servicebus-jms
• D’azure-spring-boot-starter-storage à spring-cloud-azure-starter-storage-blob
• D’azure-spring-boot-starter-storage à spring-cloud-azure-starter-storage-file-share
• D’azure-spring-cloud-starter-eventhubs à spring-cloud-azure-starter-integration-eventhubs
• D’azure-spring-cloud-starter-servicebus à spring-cloud-azure-starter-integration-servicebus
• D’azure-spring-cloud-starter-storage-queue à spring-cloud-azure-starter-integration-storage-queue
• À partir d’azure-spring-cloud-stream-binder-eventhubs vers spring-cloud-azure-stream-binder-eventhubs
• D’azure-spring-cloud-stream-binder-servicebus-* à spring-cloud-azure-stream-binder-servicebus

Changements cassants de l’API

Pour plus d’informations sur les changements cassants d’API dans chaque bibliothèque, utilisez les liens suivants :

• D’azure-spring-boot-starter-active-directory à spring-cloud-azure-starter-active-directory
• D’azure-spring-boot-starter-active-directory-b2c à spring-cloud-azure-starter-active-directory-b2c
• D’azure-spring-boot-starter-storage à spring-cloud-azure-starter-storage-blob
• D’azure-spring-boot-starter-storage à spring-cloud-azure-starter-storage-file-share
• D’azure-spring-cloud-starter-eventhubs à spring-cloud-azure-starter-integration-eventhubs
• D’azure-spring-integration-eventhubs à spring-integration-azure-eventhubs
• D’azure-spring-cloud-starter-servicebus à spring-cloud-azure-starter-integration-servicebus
• D’azure-spring-integration-servicebus à spring-integration-azure-servicebus
• D’azure-spring-cloud-starter-storage-queue à spring-cloud-azure-starter-integration-storage-queue
• D’azure-spring-integration-storage-queue à spring-integration-azure-storage-queue
• À partir d’azure-spring-cloud-stream-binder-eventhubs vers spring-cloud-azure-stream-binder-eventhubs
• D’azure-spring-cloud-stream-binder-servicebus-* à spring-cloud-azure-stream-binder-servicebus

Modifications apportées à la bibliothèque

Les changements cassants dans chaque bibliothèque sont introduits comme suit.

D’azure-spring-boot-starter à spring-cloud-azure-starter

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter à partir de la version 3 d’azure-spring-boot-starter.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Changements de dépendances

Certaines dépendances inutiles ont été incluses dans les artefacts hérités, que nous avons supprimés dans les bibliothèques Spring Cloud Azure 4.0 modernes. Veillez à ajouter manuellement les dépendances supprimées à votre projet pour éviter un blocage involontaire.

Le tableau suivant présente les dépendances supprimées :

D’azure-spring-boot-starter-active-directory à spring-cloud-azure-starter-active-directory

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-active-directory à partir de la version 3 d’azure-spring-boot-starter-active-directory.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Changements de dépendances

Certaines dépendances inutiles dans l’artefact hérité ont été supprimées depuis la bibliothèque Spring Cloud Azure 4.0 moderne. Ajoutez ces dépendances supprimées à votre projet pour éviter un blocage involontaire.

Le tableau suivant présente les dépendances supprimées :

Modifications de configuration du Kit de développement logiciel (SDK)

Cette section inclut les modifications apportées aux propriétés ajoutées, supprimées et modifiées.

• Les deux points suivants sont les principaux à faire attention à :

1. Le préfixe de toutes les propriétés de configuration a changé de azure.activedirectory à spring.cloud.azure.active-directory.
2. Une nouvelle propriété spring.cloud.azure.active-directory.enabled est ajoutée pour activer/désactiver les fonctionnalités associées à Microsoft Entra. La valeur par défaut est false.

Le tableau suivant montre les mappages de propriétés entre azure-spring-boot-starter-active-directory et spring-cloud-azure-starter-active-directory:

• Le type de valeur des propriétés suivantes est remplacé par longDuration:

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

• Les propriétés suivantes sont supprimées :

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

• Les propriétés suivantes sont ajoutées :

  • 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

Voici quelques exemples de migration :

• Exemple 1. Cas 1

  • Pour l’héritage : azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/memberOf

  • Pour moderne : 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

• Exemple 2. Cas 2

  • Pour l’héritage : azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/transitiveMemberOf

  • Pour moderne : 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

Modifications d'API

Le tableau suivant montre les mappages de classes à partir de azure-spring-boot-starter-active-directory :spring-cloud-azure-starter-active-directory

Cette section répertorie les classes supprimées d’azure-spring-boot-starter-active-directory.

• Classe héritée supprimée

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

D’azure-spring-boot-starter-active-directory-b2c à spring-cloud-azure-starter-active-directory-b2c

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-active-directory-b2c à partir de la version 3 d’azure-spring-boot-starter-active-directory-b2c.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Changements de dépendances

Certaines dépendances inutiles ont été incluses dans les artefacts hérités, que nous avons supprimés dans les bibliothèques Spring Cloud Azure 4.0 modernes. Veillez à ajouter manuellement les dépendances supprimées à votre projet pour éviter un blocage involontaire.

Le tableau suivant présente les dépendances supprimées :

Modifications de configuration du Kit de développement logiciel (SDK)

Cette section inclut les modifications apportées aux propriétés ajoutées, supprimées et modifiées.

• Les deux points suivants sont les principaux à faire attention à :

1. Tous les noms de propriétés de configuration ont changé le préfixe de azure.activedirectory.b2c .spring.cloud.azure.active-directory.b2c
2. Une nouvelle propriété spring.cloud.azure.active-directory.b2c.enabled est ajoutée pour autoriser les fonctionnalités associées à l’activation/désactivation d’Azure AD B2C. La valeur par défaut est false (Faux).

Le tableau suivant montre les mappages de propriétés à partir de azure-spring-boot-starter-active-directory-b2c :spring-cloud-azure-starter-active-directory-b2c

• Suppression des propriétés d’azure-spring-boot-starter-active-directory-b2c :

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

• Le type de valeur des propriétés suivantes est remplacé par longDuration:

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

Modifications d'API

Le tableau suivant montre les mappages de classes à partir de azure-spring-boot-starter-active-directory-b2c :spring-cloud-azure-starter-active-directory-b2c

D’azure-spring-boot-starter-cosmos à spring-cloud-azure-starter-data-cosmos

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-data-cosmos à partir de la version 3 d’azure-spring-boot-starter-cosmos.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Tous les noms de propriétés de configuration ont changé le préfixe de azure.cosmos .spring.cloud.azure.cosmos

Le tableau suivant montre les mappages de classes à partir de azure-spring-boot-starter-cosmos :spring-cloud-azure-starter-data-cosmos

D’azure-spring-boot-starter-keyvault-secrets à spring-cloud-azure-starter-keyvault-secrets

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-keyvault-secrets à partir de la version 3 d’azure-spring-boot-starter-keyvault-secrets.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Cette section inclut les modifications apportées aux propriétés ajoutées, supprimées et modifiées.

Le tableau suivant montre les mappages de propriétés à partir de azure-spring-boot-starter-keyvault-secrets :spring-cloud-azure-starter-keyvault-secrets

• Suppression des propriétés de spring-cloud-azure-starter-keyvault-secrets

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

Les points suivants doivent vous intéresser :

1. Tous les noms de propriétés de configuration ont changé le préfixe de azure.keyvault .spring.cloud.azure.keyvault.secret
2. spring.cloud.azure.keyvault.secret.enabledest utilisé pour activer toutes les fonctionnalités de secret Key Vault, notamment configurer les haricots clients de secret Key Vault (comme SecretClient et ) et les ajouter KeyVaultPropertySourceConfigurableEnvironment.SecretAsyncClient
3. spring.cloud.azure.keyvault.secret.property-source-enabled est utilisé pour activer tout KeyVaultPropertySource. Elle n’aura effet que lorsque spring.cloud.azure.keyvault.secret.enabled=true.
4. Pour les propriétés courantes Azure (telles queclient, , proxy, retrycredential, profile) et les propriétés Key Vault (par exempleendpoint, service-version). S’il spring.cloud.azure.keyvault.secret.property-sources[n].PROPERTY_NAME n’est pas configuré, spring.cloud.azure.keyvault.secret.PROPERTY_NAME il est utilisé.
5. spring.cloud.azure.keyvault.secret.property-sources[n].resource est spécifique à une ressource Azure unique. Par conséquent, si elle n’est pas configurée, elle n’obtient pas de valeur à partir d’autres emplacements.

D’azure-spring-boot-starter-servicebus-jms à spring-cloud-azure-starter-servicebus-jms

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-servicebus-jms à partir de la version 3 d’azure-spring-boot-starter-servicebus-jms.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Type de configuration pour spring.jms.servicebus.idle-timeout passer de long(millisecondes) au Duration modèle pour la lisibilité.

D’azure-spring-boot-starter-storage à spring-cloud-azure-starter-storage-blob

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-storage-blob à partir de la version 3 d’azure-spring-boot-starter-storage.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Tous les noms de propriétés de configuration ont changé le préfixe de azure.storage .spring.cloud.azure.storage.blob

Le tableau suivant montre les mappages de propriétés à partir de azure-spring-boot-starter-storage :spring-cloud-azure-starter-storage-blob

Propriétés héritées	Propriétés modernes
azure.storage.account-name	spring.cloud.azure.storage.blob.account-name
azure.storage.account-key	spring.cloud.azure.storage.blob.account-key
azure.storage.blob-endpoint	spring.cloud.azure.storage.blob.endpoint

Modifications d'API

Le tableau suivant montre les mappages de classes à partir de azure-spring-boot-starter-storage :spring-cloud-azure-starter-storage-blob

D’azure-spring-boot-starter-storage à spring-cloud-azure-starter-storage-file-share

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-storage-file-share à partir de la version 3 d’azure-spring-boot-starter-storage.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Tous les noms de propriétés de configuration ont changé le préfixe de azure.storage .spring.cloud.azure.storage.fileshare

Le tableau suivant montre les mappages de propriétés à partir de azure-spring-boot-starter-storage :spring-cloud-azure-starter-storage-file-share

Propriétés héritées	Propriétés modernes
azure.storage.account-name	spring.cloud.azure.storage.fileshare.account-name
azure.storage.account-key	spring.cloud.azure.storage.fileshare.account-key
azure.storage.file-endpoint	spring.cloud.azure.storage.fileshare.endpoint

Modifications d'API

Le tableau suivant montre les mappages de classes à partir de azure-spring-boot-starter-storage :spring-cloud-azure-starter-storage-file-share

D’azure-spring-cloud-starter-eventhubs à spring-cloud-azure-starter-integration-eventhubs

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-integration-eventhubs à partir de la version 2 d’azure-spring-cloud-starter-eventhubs.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Pour connaître les modifications apportées aux entrées enfants pour ce préfixe, consultez les tableaux suivants :

Le tableau suivant présente les mappages de propriétés de azure-spring-cloud-starter-eventhubs :spring-cloud-azure-starter-integration-eventhubs

Par exemple, changez 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}

to:

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}

Modifications d'API

• Pour connaître les modifications apportées aux annotations de l’écouteur, consultez le guide de migration de la <<bibliothèque migration-azure-spring-cloud-messaging, azure-spring-cloud-messaging>> .
• Supprimer EventHubOperation avec la fonction d’abonnement déplacée vers la classe EventHubsMessageListenerContainer et la fonction d’envoi déplacée vers EventHubsTemplate.
• Renommez-le EventHubInboundChannelAdapter pour EventHubsInboundChannelAdapter rester cohérent avec le service d’Azure Event Hubs.
• Modifiez le constructeur de EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) vers EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) et EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Remplacez CheckpointConfig le style d’instanciation par le constructeur simple au lieu du style de build.
• Supprimer l’API EventHubOperation#setCheckpointConfig. Pour définir la configuration case activée point de l’adaptateur de canal entrant, les utilisateurs peuvent appeler la méthodeEventHubsContainerProperties#setCheckpointConfig.
• Supprimer l’API EventHubOperation#setBatchConsumerConfig. Pour définir la configuration consommatrice de lots pour l’adaptateur de canal entrant, les utilisateurs peuvent appeler les deux méthodes EventHubsContainerProperties#getBatch#setMaxSize et EventHubsContainerProperties#getBatch#setMaxWaitTime pendant ce temps.
• Pour le mode de consommation par lots, modifiez les noms d’en-têtes de message convertis à partir de messages par lots.
  • Modifier l’en-tête de message de azure_eventhub_enqueued_time vers azure_eventhubs_batch_converted_enqueued_time.
  • Modifier l’en-tête de message de azure_eventhub_offset vers azure_eventhubs_batch_converted_offset.
  • Modifier l’en-tête de message de azure_eventhub_sequence_number vers azure_eventhubs_batch_converted_sequence_number.
  • Modifier l’en-tête de message de azure_partition_key vers azure_batch_converted_partition_key.
• Lors de la publication de messages dans Event Hubs, ignorez tous les en-têtes de message convertis à partir de messages par lots. Les en-têtes sont les suivants :
  • 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
• Le BATCH mode case activée point fonctionne uniquement en mode de consommation par lots maintenant, qui peut être activé en passant ListenerMode.BATCH au constructeur EventHubsInboundChannelAdapter.

Le tableau suivant montre les mappages de classes à partir de azure-spring-cloud-starter-eventhubs :spring-cloud-azure-starter-integration-eventhubs

Exemple d’extrait de code

• EventHubsInboundChannelAdapter exemple de code :

  Code hérité :

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

  Code moderne :

  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 exemple de code :

  Code hérité :

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

  Code moderne :

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

D’azure-spring-integration-eventhubs à spring-integration-azure-eventhubs

Ce guide est destiné à faciliter la migration vers spring-integration-azure-eventhubs à partir de la version 2 d’azure-spring-integration-eventhubs.

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .

Modifications d'API

• Supprimer EventHubOperation avec la fonction d’abonnement déplacée vers la classe EventHubsMessageListenerContainer et la fonction d’envoi déplacée vers EventHubsTemplate.
• Renommez-le EventHubInboundChannelAdapter pour EventHubsInboundChannelAdapter rester cohérent avec le service d’Azure Event Hubs.
• Modifiez le constructeur de EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) vers EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) et EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Remplacez CheckpointConfig le style d’instanciation par le constructeur simple au lieu du style de build.
• Supprimer l’API EventHubOperation#setCheckpointConfig. Pour définir la configuration case activée point de l’adaptateur de canal entrant, les utilisateurs peuvent appeler la méthodeEventHubsContainerProperties#setCheckpointConfig.
• Supprimer l’API EventHubOperation#setBatchConsumerConfig. Pour définir la configuration consommatrice de lots pour l’adaptateur de canal entrant, les utilisateurs peuvent appeler les deux méthodes EventHubsContainerProperties#getBatch#setMaxSize et EventHubsContainerProperties#getBatch#setMaxWaitTime pendant ce temps.
• Pour le mode de consommation par lots, modifiez les noms d’en-têtes de message convertis à partir de messages par lots.
  • Modifier l’en-tête de message de azure_eventhub_enqueued_time vers azure_eventhubs_batch_converted_enqueued_time.
  • Modifier l’en-tête de message de azure_eventhub_offset vers azure_eventhubs_batch_converted_offset.
  • Modifier l’en-tête de message de azure_eventhub_sequence_number vers azure_eventhubs_batch_converted_sequence_number.
  • Modifier l’en-tête de message de azure_partition_key vers azure_batch_converted_partition_key.
• Lors de la publication de messages dans Event Hubs, ignorez tous les en-têtes de message convertis à partir de messages par lots. Les en-têtes sont les suivants :
  • 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
• Le BATCH mode case activée point fonctionne uniquement en mode de consommation par lots maintenant, qui peut être activé en passant ListenerMode.BATCH au constructeur EventHubsInboundChannelAdapter.

Le tableau suivant montre les mappages de classes à partir de azure-spring-integration-eventhubs :spring-integration-azure-eventhubs

D’azure-spring-cloud-starter-servicebus à spring-cloud-azure-starter-integration-servicebus

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-integration-servicebus à partir de la version 2 d’azure-spring-cloud-starter-servicebus.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Pour toutes les options de configuration prises en charge, spring-cloud-azure-starter-integration-servicebusle préfixe reste en tant que spring.cloud.azure.servicebus.

Le tableau suivant montre les mappages de propriétés à partir de azure-spring-cloud-starter-servicebus :spring-cloud-azure-starter-integration-servicebus

Modifications d'API

• Supprimez ServiceBusQueueOperation et ServiceBusTopicOperation avec la fonction d’abonnement déplacée vers la classe ServiceBusMessageListenerContainer et la fonction d’envoi déplacée vers ServiceBusTemplate.
• Supprimez et ServiceBusTopicInboundChannelAdapterdéplacez ServiceBusQueueInboundChannelAdapter les fonctionnalités permettant d’écouter une entité file d’attente/rubrique Service Bus vers ServiceBusInboundChannelAdapter.
• Modifiez le constructeur de ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) vers ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) et ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Modifiez le constructeur de ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) vers ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) et ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Supprimer des ServiceBusQueueOperation#setCheckpointConfig API et ServiceBusTopicOperation#setCheckpointConfig. Pour définir la configuration case activée point pour l’adaptateur de canal entrant, les utilisateurs peuvent appeler la méthode ServiceBusContainerProperties#setAutoComplete à la place. Pour désactiver le mode de saisie semi-automatique, il équivaut au MANUAL mode case activée point et à l’activer déclenche le RECORD mode.
• Supprimer des ServiceBusQueueOperatio#setClientConfig API et ServiceBusTopicOperation#setClientConfig. Pour configurer le sous-jacent ServiceBusProcessorClient utilisé par l’adaptateur de canal entrant, les utilisateurs peuvent utiliser ServiceBusContainerProperties à la place.
• Supprimez CompletableFuture la prise en charge et ServiceBusTemplateDefaultMessageHandlerla prise en charge Reactor à la place.
• Ajoutez une nouvelle API de ServiceBusTemplate#setDefaultEntityType sorte à spécifier le type d’entité, qui est requis lorsqu’aucune bean of PropertiesSupplier<String, ProducerProperties> n’est fournie pour le ProducerProperties#entityType.
• Supprimer l’en-tête AzureHeaders.RAW_IDde message . Utilisez ServiceBusMessageHeaders.MESSAGE_ID à la place.

Le tableau suivant montre les mappages de classes à partir de azure-spring-cloud-starter-servicebus :spring-cloud-azure-starter-integration-servicebus

Exemple d’extrait de code

• ServiceBusInboundChannelAdapter exemple de code :

  Code hérité d’utilisation ServiceBusQueueInboundChannelAdapter ou 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;
      }
  
  }
  

  Code moderne :

  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 exemple de code :

  Code hérité, en prenant la file d’attente comme exemple :

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

  Code moderne :

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

D’azure-spring-integration-servicebus à spring-integration-azure-servicebus

Ce guide est destiné à faciliter la migration vers spring-integration-azure-servicebus à partir de la version 2 d’azure-spring-integration-servicebus.

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .

Modifications d'API

• Supprimez ServiceBusQueueOperation et ServiceBusTopicOperation avec la fonction d’abonnement déplacée vers la classe ServiceBusMessageListenerContainer et la fonction d’envoi déplacée vers ServiceBusTemplate.
• Supprimez et ServiceBusTopicInboundChannelAdapterdéplacez ServiceBusQueueInboundChannelAdapter les fonctionnalités permettant d’écouter une entité file d’attente/rubrique Service Bus vers ServiceBusInboundChannelAdapter.
• Modifiez le constructeur de ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) vers ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) et ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Modifiez le constructeur de ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) vers ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) et ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Supprimer des ServiceBusQueueOperation#setCheckpointConfig API et ServiceBusTopicOperation#setCheckpointConfig. Pour définir la configuration case activée point pour l’adaptateur de canal entrant, les utilisateurs peuvent appeler la méthode ServiceBusContainerProperties#setAutoComplete à la place. Pour désactiver le mode de saisie semi-automatique, il équivaut au MANUAL mode case activée point et à l’activer déclenche le RECORD mode.
• Supprimer des ServiceBusQueueOperation#setClientConfig API et ServiceBusTopicOperation#setClientConfig. Pour configurer le sous-jacent ServiceBusProcessorClient utilisé par l’adaptateur de canal entrant, les utilisateurs peuvent utiliser ServiceBusContainerProperties à la place.
• Supprimez CompletableFuture la prise en charge et ServiceBusTemplateDefaultMessageHandlerla prise en charge Reactor à la place.
• Ajoutez une nouvelle API de ServiceBusTemplate#setDefaultEntityType sorte à spécifier le type d’entité, qui est requis lorsqu’aucune bean of PropertiesSupplier<String, ProducerProperties> n’est fournie pour le ProducerProperties#entityType.
• Supprimer l’en-tête AzureHeaders.RAW_IDde message . Utilisez ServiceBusMessageHeaders.MESSAGE_ID à la place.

Le tableau suivant montre les mappages de classes à partir de azure-spring-integration-servicebus :spring-integration-azure-servicebus

D’azure-spring-cloud-starter-storage-queue à spring-cloud-azure-starter-integration-storage-queue

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-starter-integration-storage-queue à partir de la version 2 d’azure-spring-cloud-starter-storage-queue.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Tous les noms de propriétés de configuration ont changé le préfixe de spring.cloud.azure.storage .spring.cloud.azure.storage.queue

Le tableau suivant montre les mappages de propriétés à partir de azure-spring-cloud-starter-storage-queue :spring-cloud-azure-starter-integration-storage-queue

Modifications d'API

• Supprimez et fournissez StorageQueueOperationStorageQueueTemplate à la place.
• Supprimer checkpoint-mode la configuration dans StorageQueueTemplate, prend uniquement en charge le MANUAL mode.

Le tableau suivant montre les mappages de classes de azure-spring-cloud-starter-storage-queue vers spring-cloud-azure-starter-integration-storage-queue.

D’azure-spring-integration-storage-queue à spring-integration-azure-storage-queue

Ce guide est destiné à faciliter la migration vers spring-integration-azure-storage-queue à partir de la version 2 d’azure-spring-integration-storage-queue.

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .

Modifications d'API

• Supprimez et fournissez StorageQueueOperationStorageQueueTemplate à la place.
• Supprimer checkpoint-mode la configuration dans StorageQueueTemplate, prend uniquement en charge le MANUAL mode.

Le tableau suivant montre les mappages de classes de azure-spring-integration-storage-queue vers spring-integration-azure-storage-queue.

À partir d’azure-spring-cloud-stream-binder-eventhubs vers spring-cloud-azure-stream-binder-eventhubs

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-stream-binder-eventhubs à partir de la version 2 d’azure-spring-cloud-stream-binder-eventhubs.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Pour connaître les modifications apportées aux entrées enfants pour le préfixe suivant, consultez le tableau suivant.

Le tableau suivant présente les mappages de propriétés de azure-spring-cloud-stream-binder-eventhubs :spring-cloud-azure-stream-binder-eventhubs

Exemples de migration de configuration

Pour utiliser la chaîne de connexion pour l’authentification et migrer les propriétés mentionnées ci-dessus, les modifications de configuration sont répertoriées comme suit :

Configuration héritée :

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

Configuration moderne :

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 vous utilisez des principaux de sécurité au lieu de chaîne de connexion s, dans les versions antérieures à la version 4.0, l’application se connecte d’abord à Azure Resource Manager (ARM) avec le principal de sécurité fourni, puis récupère la chaîne de connexion de l’espace de noms spécifié avec ARM. À la fin, l’application utilise le chaîne de connexion récupéré pour se connecter à Azure Event Hubs. De cette façon, le principal de sécurité fourni doit être accordé avec le rôle Contributeur pour récupérer l’espace de noms Azure Event Hubs associé.

Pour Azure Spring Apps 4.0, nous fournissons deux façons d’exploiter les principaux de sécurité pour l’authentification. L’un utilise toujours les principaux pour se connecter à ARM et récupérer les chaîne de connexion où le Contributor rôle est requis pour les principaux. L’autre tire parti des principaux de sécurité pour s’authentifier auprès de Microsoft Entra ID, puis se connecter directement à Azure Event Hubs. Dans ce cas, le Contributor rôle n’est plus nécessaire, tandis que d’autres Data rôles associés sont requis pour les opérations de messagerie. Pour vous assurer que le principal de sécurité a reçu l’autorisation suffisante pour accéder à la ressource Azure, consultez Autoriser l’accès avec l’ID Microsoft Entra.

Pour l’authentification basée sur ARM, en prenant par exemple le principal de service, la migration de configuration est répertoriée ci-dessous, où le rôle affecté ne doit pas changer :

Configuration héritée :

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}

La configuration moderne, les propriétés de l’ID d’abonnement Azure et du groupe de ressources sont requises :

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}

Vous pouvez également migrer vers l’authentification et l’autorisation avec l’ID Microsoft Entra directement sans effectuer un détour vers ARM. Veillez à accorder les rôles nécessaires Data au principal de sécurité pour les opérations de messagerie. Les exemples de configuration du principal de service et de l’identité managée sont répertoriés comme suit :

• Avec un principal de service

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

• Avec une identité managée

  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}
  

Modifications d'API

Le tableau suivant montre les mappages de classes de azure-spring-cloud-stream-binder-eventhubs vers spring-cloud-azure-stream-binder-eventhubs.

D’azure-spring-cloud-stream-binder-servicebus-* à spring-cloud-azure-stream-binder-servicebus

Ce guide est destiné à faciliter la migration vers spring-cloud-azure-stream-binder-servicebus à partir de la version 2 d’azure-spring-cloud-stream-binder-servicebus-queueou azure-spring-cloud-stream-binder-servicebus-topic.

Pour obtenir des informations générales, utilisez les liens suivants :

• Pour obtenir une vue d’ensemble des modifications apportées à la version 4.0, consultez les sections Avantages de l’introduction et de la migration.
• Pour en savoir plus sur les modifications de stratégie dans l’affectation de noms de projet, consultez la section Modifications de nommage .
• Pour savoir comment utiliser une boM pour toutes les bibliothèques Azure Spring Cloud, consultez la section BOM .
• Pour savoir comment gérer l’authentification dans Spring Cloud Azure 4.0, consultez la section Modifications de l’authentification.
• Pour savoir comment tirer parti spring-boot-properties-migrator pendant la migration, consultez la section Configurer chaque kit SDK .
• Pour en savoir plus sur les modifications de configuration globales et courantes, consultez la section Configurations globales.

Modifications de configuration du Kit de développement logiciel (SDK)

Le tableau suivant répertorie les nouvelles propriétés de configuration de spring-cloud-azure-stream-binder-servicebus:

Le tableau suivant montre les mappages de propriétés à partir de azure-spring-cloud-stream-binder-servicebus-* :spring-cloud-azure-stream-binder-servicebus

Exemples de migration de configuration

Configuration héritée, en prenant la file d’attente comme exemple :

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

Configuration moderne :

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 vous utilisez des principaux de sécurité au lieu de chaîne de connexion s, dans les versions antérieures à la version 4.0, l’application se connecte d’abord à Azure Resource Manager (ARM) avec le principal de sécurité fourni, puis récupère la chaîne de connexion de l’espace de noms spécifié avec ARM. À la fin, l’application utilise le chaîne de connexion récupéré pour se connecter à Azure Service Bus. De cette façon, le principal de sécurité fourni doit être accordé avec le rôle Contributeur pour récupérer l’espace de noms Azure Service Bus associé.

Pour Azure Spring Apps 4.0, nous fournissons deux façons d’exploiter les principaux de sécurité pour l’authentification. L’un utilise toujours les principaux pour se connecter à ARM et récupérer les chaîne de connexion où le Contributor rôle est requis pour les principaux. L’autre tire parti des principaux de sécurité pour s’authentifier auprès de Microsoft Entra ID, puis se connecter directement à Azure Service Bus. Dans ce cas, le Contributor rôle n’est plus nécessaire, tandis que d’autres Data rôles associés sont requis pour les opérations de messagerie. Pour vous assurer que le principal de sécurité a reçu l’autorisation suffisante pour accéder à la ressource Azure, consultez Autoriser l’accès avec l’ID Microsoft Entra.

Pour l’authentification basée sur ARM, en prenant par exemple le principal de service, la migration de configuration est répertoriée ci-dessous, où le rôle affecté ne doit pas changer :

Configuration héritée :

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}

La configuration moderne, les propriétés de l’ID d’abonnement Azure et du groupe de ressources sont requises :

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}

Vous pouvez également migrer vers l’authentification et l’autorisation avec l’ID Microsoft Entra directement sans effectuer un détour vers ARM. Veillez à accorder les rôles nécessaires Data au principal de sécurité pour les opérations de messagerie. Les exemples de configuration du principal de service et de l’identité managée sont répertoriés comme suit :

• Avec un principal de service

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

• Avec une identité managée

  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}
  

Modifications d'API

• Supprimer l’en-tête AzureHeaders.RAW_IDde message . Utilisez ServiceBusMessageHeaders.MESSAGE_ID à la place.

Le tableau suivant montre les mappages de classes de azure-spring-cloud-stream-binder-eventhubs vers spring-cloud-azure-stream-binder-eventhubs.

azure-spring-cloud-messaging

La com.azure.spring:azure-spring-cloud-messaging bibliothèque n’est pas prête pour la version 4.0. La fonction d’annotations de l’écouteur est en cours de refonte. Par conséquent, @AzureMessageListenersles annotations et @EnableAzureMessaging les @AzureMessageListenerannotations ne sont pas prises en charge actuellement.