Spring Cloud Azure 4.0 の移行ガイド

このガイドは、従来の Azure Spring ライブラリから Spring Cloud Azure 4.0 への移行に役立ちます。

紹介

グループ ID と成果物 ID が com.azure.spring:spring-cloud-azure-* ライブラリ パターンに従うライブラリと、パターン com.azure.spring:azure-spring-boot-*、com.azure.spring:azure-spring-cloud-*、または com.azure.spring:azure-spring-integration-* ライブラリを するライブラリを呼び出します。

このガイドでは、最新のライブラリとレガシ ライブラリの間で類似した構成を並べて比較することに重点を置きます。

com.azure.spring:azure-spring-boot-*、com.azure.spring:azure-spring-cloud-*、または com.azure.spring:azure-spring-integration-* パッケージに関する知識が前提です。

Spring Cloud Azure 4.0 ライブラリを初めて使用する場合は、このガイドではなく、Spring Cloud Azure 開発者ガイドを参照してください。

移行の利点

新しいバージョンまたはライブラリを採用するかどうかを検討する際に尋ねる自然な質問は、その利点です。 Azureは成熟し、より多様な開発者グループに受け入れられてきたので、開発者の生産性を最大限にサポートし、Spring Cloud Azure ライブラリのギャップを理解するためのパターンとプラクティスを学習することに重点を置いています。

Spring Cloud Azure ライブラリ全体で、一貫したフィードバックが複数の領域で表現されていました。 最も重要なのは、さまざまなAzure サービスのライブラリで、構成の完全なセットが有効になっていないということです。 さらに、プロジェクトの名前付け、成果物 ID、バージョン、構成の不整合により、学習曲線が急激になりました。

Spring Cloud Azure ライブラリ全体の開発エクスペリエンスを向上させるために、Spring Cloud Azure ライブラリが Spring エコシステムに関して自然で慣用的な感覚を持っていることを確認するための一連の設計ガイドラインが導入されました。 詳細については、design ドキュメントを参照してください。

Spring Cloud Azure 4.0 は、Spring Boot、Spring Integration、Spring Cloud Stream など、さまざまな Spring プロジェクトと統合されたライブラリ間で共有エクスペリエンスを提供します。 共有エクスペリエンスには次のものが含まれます。

• すべての Spring Cloud Azure 4.0 ライブラリを含む統合 BOM。
• 成果物の一貫した名前付け規則。
• 資格情報、プロキシ、再試行、クラウド環境、トランスポート層の設定を構成するための統合された方法。
• Azure サービスまたは Azure Service SDK がサポートするすべての認証方法をサポートします。

概要

この移行ガイドは、次のセクションで構成されています。

• Spring Cloud Azure 4.0 の名前付けの変更
• アーティファクトの変更: 名前の変更/追加/削除
• 依存関係の変更
• 認証の変更
• 構成プロパティ
• API の破壊的変更
• ライブラリの変更

名前付けの変更

すべての Spring Cloud Azure ライブラリを呼び出す一貫性のある正式な名前はありませんでした。 それらの一部は Azure Spring Boot と呼ばれ、その一部は Spring on Azure。 4.0 以降、プロジェクト名 Spring Cloud Azure を使用して、Azure Spring ライブラリをすべて表すようになりました。

BOM

以前はライブラリ用の 2 つの BOM (azure-spring-boot-bom と azure-spring-cloud-dependencies) を出荷してきましたが、4.0 以降、この 2 つの BOM を 1 つの BOM に組み合わせ、spring-cloud-azure-dependencies。 依存関係管理のメリットを得るために、プロジェクトの dependencyManagement セクションにエントリを追加します。

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

アーティファクトの変更: 名前の変更/追加/削除

グループ ID は、最新の Spring Cloud Azure ライブラリと従来の Spring Cloud ライブラリで同じです。 これらはすべて com.azure.springです。 最新の Spring Cloud Azure ライブラリのアーティファクト ID が変更されました。 所属する Spring プロジェクト、Spring Boot、Spring Integration、または Spring Cloud Stream に応じて、アーティファクト ID パターンは、spring-cloud-azure-starter-[service]、spring-integration-azure-[service]、または spring-cloud-azure-stream-binder-[service]できます。 各レガシ スターターには、パターン azure-spring-*に続く成果物 ID があります。 これにより、最新のスターターとレガシ スターターのどちらを使用しているかを一目で理解するのに役立つ、すばやくアクセス可能な手段が提供されます。

Spring Cloud Azure 4.0 の開発プロセスでは、新しい名前付け規則に従うようにいくつかの成果物の名前を変更し、機能をより適切な成果物に配置できるようにいくつかの成果物を削除し、いくつかのシナリオにより適切に対応できるように新しい成果物をいくつか追加しました。

次の表は、レガシ成果物 ID と最新の成果物 ID の間のマッピングを示しています。

依存関係の変更

従来の成果物には不要な依存関係がいくつか含まれていました。これは、最新の Spring Cloud Azure 4.0 ライブラリで削除されています。 クラッシュを防ぐために、削除された依存関係をプロジェクトに手動で追加してください。

依存関係の変更があるライブラリは次のとおりです。

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

認証の変更

Spring Cloud Azure 4.0 では、各 Azure Service SDK でサポートされているすべての認証方法がサポートされています。 これにより、グローバル トークン資格情報を構成し、各サービス レベルでトークン資格情報を指定できます。 ただし、Spring Cloud Azure 4.0 を構成するために資格情報は必要ありません。これは、Azure Services のローカル開発環境またはマネージド ID に格納されている資格情報を適用できるためです。 ターゲット Azure リソースにアクセスするための十分なアクセス許可がプリンシパルに付与されていることを確認してください。

チェーンされた資格情報。DefaultAzureCredential Bean は既定で自動構成され、認証情報がそれ以上指定されていない場合は、すべてのコンポーネントによって使用されます。 詳細については、「< Java の id クライアント ライブラリのDefaultAzureCredential>Azure セクションを参照してください。

構成プロパティ

プロパティの移行

spring-boot-properties-migratorで使用するときにプロパティの移行をスムーズにするために、additional-spring-configuration-metadata.json ファイルを作成しました。 まず、次のプロパティ 移行ツールをアプリケーションに追加します。

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

または、Gradle を使用している場合:

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

アプリを実行すると、Spring Cloud Azure によって管理されなくなったプロパティが識別されます。 置き換えがある場合は、一時的にプロパティが警告で再マップされます。 置き換えがない場合は、エラー レポートに詳細情報が表示されます。 いずれの場合も、構成を更新し、構成を更新したら依存関係を削除する必要があります。

先に進む前に、IDE の検索機能を使用して、統合テストで移行したプロパティの 1 つを使用していないことを再確認することをお勧めします。

グローバル構成

モダン spring-cloud-azure-starterを使用すると、名前空間 spring.cloud.azure内のすべてのAzure SDKsに適用されるプロパティを定義できます。 この機能は、レガシ azure-spring-boot-starterではサポートされていませんでした。 グローバル構成は、次の表に示す 5 つのカテゴリに分けることができます。

構成の完全な一覧については、「Spring Cloud Azure 構成プロパティɰ」を参照してください。

各 SDK を構成する

SDK レベルの構成オプションの詳細については、次のリンクを使用してください。

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

API の破壊的変更

各ライブラリでの API の破壊的変更の詳細については、次のリンクを使用してください。

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

ライブラリの変更

各ライブラリの破壊的変更を次に示します。

azure-spring-boot-starter から spring-cloud-azure-starter へ

このガイドは、azure-spring-boot-starter のバージョン 3 からspring-cloud-azure-starterへの移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

依存関係の変更

一部の不要な依存関係は、従来の成果物に含まれていました。これは、最新の Spring Cloud Azure 4.0 ライブラリで削除されています。 意図しないクラッシュを防ぐために、削除された依存関係をプロジェクトに手動で追加してください。

次の表は、削除された依存関係を示しています。

azure-spring-boot-starter-active-directory から spring-cloud-azure-starter-active-directory へ

このガイドは、azure-spring-boot-starter-active-directory のバージョン 3 からspring-cloud-azure-starter-active-directoryへの移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

依存関係の変更

従来の成果物の不要な依存関係の一部は、最新の Spring Cloud Azure 4.0 ライブラリ以降に削除されています。 これらの削除された依存関係をプロジェクトに追加して、意図しないクラッシュを防ぎます。

次の表は、削除された依存関係を示しています。

SDK 構成の変更

このセクションには、追加、削除、および変更されたプロパティに関する変更が含まれています。

• 注意を払う主なポイントは次の 2 つあります。

1. すべての構成プロパティ名のプレフィックスが azure.activedirectory から spring.cloud.azure.active-directoryに変更されました。
2. 関連する機能<有効または無効にするために、新しいプロパティ が追加Microsoft Entra。 既定値は false です。

次の表に、azure-spring-boot-starter-active-directory と spring-cloud-azure-starter-active-directoryの間のプロパティ マッピングを示します。

• 次のプロパティの値型が long から Durationに変更されます。

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

• 次のプロパティは削除されます。

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

• 次のプロパティが追加されます。

  • 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

移行の例をいくつか次に示します。

• 例 1. ケース 1

  • レガシの場合: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/memberOf

  • 最新の場合: 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

• 例 2. ケース 2

  • レガシの場合: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/transitiveMemberOf

  • 最新の場合: 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

API の変更

次の表は、azure-spring-boot-starter-active-directory から spring-cloud-azure-starter-active-directoryへのクラス マッピングを示しています。

このセクションでは、 azure-spring-boot-starter-active-directoryから削除されたクラスの一覧を示します。

• レガシ クラスを削除しました

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

azure-spring-boot-starter-active-directory-b2c から spring-cloud-azure-starter-active-directory-b2c へ

このガイドは、azure-spring-boot-starter-active-directory-b2c のバージョン 3 からspring-cloud-azure-starter-active-directory-b2cへの移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

依存関係の変更

一部の不要な依存関係は、従来の成果物に含まれていました。これは、最新の Spring Cloud Azure 4.0 ライブラリで削除されています。 意図しないクラッシュを防ぐために、削除された依存関係をプロジェクトに手動で追加してください。

次の表は、削除された依存関係を示しています。

SDK 構成の変更

このセクションには、追加、削除、および変更されたプロパティに関する変更が含まれています。

• 注意を払う主なポイントは次の 2 つあります。

1. すべての構成プロパティ名でプレフィックスが azure.activedirectory.b2c から spring.cloud.azure.active-directory.b2cに変更されました。
2. 新しいプロパティ spring.cloud.azure.active-directory.b2c.enabled が追加され、AD B2C 関連機能Azure有効または無効にできます。 既定値は false です。

次の表は、azure-spring-boot-starter-active-directory-b2c から spring-cloud-azure-starter-active-directory-b2cへのプロパティ マッピングを示しています。

• azure-spring-boot-starter-active-directory-b2cからプロパティを削除しました。

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

• 次のプロパティの値型が long から Durationに変更されます。

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

API の変更

次の表は、azure-spring-boot-starter-active-directory-b2c から spring-cloud-azure-starter-active-directory-b2cへのクラス マッピングを示しています。

azure-spring-boot-starter-cosmos から spring-cloud-azure-starter-data-cosmos へ

このガイドは、azure-spring-boot-starter-cosmos のバージョン 3 からspring-cloud-azure-starter-data-cosmosへの移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

すべての構成プロパティ名でプレフィックスが azure.cosmos から spring.cloud.azure.cosmosに変更されました。

次の表は、azure-spring-boot-starter-cosmos から spring-cloud-azure-starter-data-cosmosへのクラス マッピングを示しています。

azure-spring-boot-starter-keyvault-secrets から spring-cloud-azure-starter-keyvault-secrets へ

このガイドは、azure-spring-boot-starter-keyvault-secrets のバージョン 3 からspring-cloud-azure-starter-keyvault-secretsへの移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

このセクションには、追加、削除、および変更されたプロパティに関する変更が含まれています。

次の表は、azure-spring-boot-starter-keyvault-secrets から spring-cloud-azure-starter-keyvault-secretsへのプロパティ マッピングを示しています。

• spring-cloud-azure-starter-keyvault-secretsからプロパティを削除しました。

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

次の点に注意する必要があります。

1. すべての構成プロパティ名でプレフィックスが azure.keyvault から spring.cloud.azure.keyvault.secretに変更されました。
2. spring.cloud.azure.keyvault.secret.enabledは、すべてのKey Vaultシークレット機能を有効にするために使用されます。Key Vaultシークレット クライアント Bean (SecretClient、SecretAsyncClient など) を構成し、KeyVaultPropertySource に ConfigurableEnvironment を追加します。
3. spring.cloud.azure.keyvault.secret.property-source-enabled は、すべての KeyVaultPropertySourceを有効にするために使用されます。 これは、spring.cloud.azure.keyvault.secret.enabled=true場合にのみ有効になります.
4. Azure一般的なプロパティ (client、proxy、retry、credential、profile) およびKey Vaultプロパティ (endpoint、service-version など) の場合。 spring.cloud.azure.keyvault.secret.property-sources[n].PROPERTY_NAME が構成されていない場合は、spring.cloud.azure.keyvault.secret.PROPERTY_NAME が使用されます。
5. spring.cloud.azure.keyvault.secret.property-sources[n].resource は一意のAzure リソースに固有であるため、構成されていない場合は、他の場所から値を取得しません。

azure-spring-boot-starter-servicebus-jms から spring-cloud-azure-starter-servicebus-jms へ

このガイドは、azure-spring-boot-starter-servicebus-jms のバージョン 3 からspring-cloud-azure-starter-servicebus-jmsへの移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

読みやすくするために、 spring.jms.servicebus.idle-timeout の構成の種類が long (ミリ秒) から Duration パターンに変更されました。

azure-spring-boot-starter-storage から spring-cloud-azure-starter-storage-blob へ

このガイドは、azure-spring-boot-starter-storage のバージョン 3 からspring-cloud-azure-starter-storage-blobへの移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

すべての構成プロパティ名でプレフィックスが azure.storage から spring.cloud.azure.storage.blobに変更されました。

次の表は、azure-spring-boot-starter-storage から spring-cloud-azure-starter-storage-blobへのプロパティ マッピングを示しています。

API の変更

次の表は、azure-spring-boot-starter-storage から spring-cloud-azure-starter-storage-blobへのクラス マッピングを示しています。

azure-spring-boot-starter-storage から spring-cloud-azure-starter-storage-file-share へ

このガイドは、azure-spring-boot-starter-storage のバージョン 3 からspring-cloud-azure-starter-storage-file-shareへの移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

すべての構成プロパティ名でプレフィックスが azure.storage から spring.cloud.azure.storage.fileshareに変更されました。

次の表は、azure-spring-boot-starter-storage から spring-cloud-azure-starter-storage-file-shareへのプロパティ マッピングを示しています。

API の変更

次の表は、azure-spring-boot-starter-storage から spring-cloud-azure-starter-storage-file-shareへのクラス マッピングを示しています。

azure-spring-cloud-starter-eventhubs から spring-cloud-azure-starter-integration-eventhubs へ

このガイドは、azure-spring-cloud-starter-eventhubs のバージョン 2 から spring-cloud-azure-starter-integration-eventhubs への移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

このプレフィックスの子エントリの変更については、次の表を参照してください。

次の表は、azure-spring-cloud-starter-eventhubs から spring-cloud-azure-starter-integration-eventhubsへのプロパティ マッピングを示しています。

たとえば、次の値から変更します。

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}

宛先：

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}

API の変更

• リスナー注釈の変更については、<<migration-azure-spring-cloud-messaging、azure-spring-cloud-messaging>> ライブラリの移行ガイドを参照してください。
• サブスクライブ関数を持つ EventHubOperation をクラス EventHubsMessageListenerContainer に移動し、送信関数を EventHubsTemplateに移動します。
• Azure Event Hubsのサービスと一貫性を保つために、EventHubInboundChannelAdapter の名前を EventHubsInboundChannelAdapter に変更します。
• コンストラクターを EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) から EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) および EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode)に変更します。
• CheckpointConfig インスタンス化スタイルをビルド スタイルではなく単純なコンストラクターに変更します。
• API EventHubOperation#setCheckpointConfigを削除します。 受信チャネル アダプターのチェックポイント構成を設定するには、EventHubsContainerProperties#setCheckpointConfigメソッドを呼び出すことができます。
• API EventHubOperation#setBatchConsumerConfigを削除します。 受信チャネル アダプターのバッチ消費構成を設定するには、ユーザーは 2 つのメソッドを EventHubsContainerProperties#getBatch#setMaxSize し、その間 EventHubsContainerProperties#getBatch#setMaxWaitTime 呼び出すことができます。
• バッチ使用モードの場合は、バッチ処理されたメッセージから変換されたメッセージ ヘッダー名を変更します。
  • メッセージ ヘッダーを azure_eventhub_enqueued_time から azure_eventhubs_batch_converted_enqueued_timeに変更します。
  • メッセージ ヘッダーを azure_eventhub_offset から azure_eventhubs_batch_converted_offsetに変更します。
  • メッセージ ヘッダーを azure_eventhub_sequence_number から azure_eventhubs_batch_converted_sequence_numberに変更します。
  • メッセージ ヘッダーを azure_partition_key から azure_batch_converted_partition_keyに変更します。
• Event Hubs にメッセージを発行する場合は、バッチ処理されたメッセージから変換されたすべてのメッセージ ヘッダーを無視します。 ヘッダーには次のものが含まれます。
  • 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
• BATCH チェックポイント モードはバッチ消費モードでのみ機能します。このモードは、EventHubsInboundChannelAdapter コンストラクターに ListenerMode.BATCH を渡すことによって有効にすることができます。

次の表は、azure-spring-cloud-starter-eventhubs から spring-cloud-azure-starter-integration-eventhubsへのクラス マッピングを示しています。

サンプル コード スニペット

• EventHubsInboundChannelAdapter サンプル コード:

  レガシ コード:

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

  最新のコード:

  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 サンプル コード:

  レガシ コード:

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

  最新のコード:

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

azure-spring-integration-eventhubs から spring-integration-azure-eventhubs へ

このガイドは、azure-spring-integration-eventhubs のバージョン 2 から spring-integration-azure-eventhubs への移行を支援することを目的としています。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。

API の変更

• サブスクライブ関数を持つ EventHubOperation をクラス EventHubsMessageListenerContainer に移動し、送信関数を EventHubsTemplateに移動します。
• Azure Event Hubsのサービスと一貫性を保つために、EventHubInboundChannelAdapter の名前を EventHubsInboundChannelAdapter に変更します。
• コンストラクターを EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) から EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) および EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode)に変更します。
• CheckpointConfig インスタンス化スタイルをビルド スタイルではなく単純なコンストラクターに変更します。
• API EventHubOperation#setCheckpointConfigを削除します。 受信チャネル アダプターのチェックポイント構成を設定するには、EventHubsContainerProperties#setCheckpointConfigメソッドを呼び出すことができます。
• API EventHubOperation#setBatchConsumerConfigを削除します。 受信チャネル アダプターのバッチ消費構成を設定するには、ユーザーは 2 つのメソッドを EventHubsContainerProperties#getBatch#setMaxSize し、その間 EventHubsContainerProperties#getBatch#setMaxWaitTime 呼び出すことができます。
• バッチ使用モードの場合は、バッチ処理されたメッセージから変換されたメッセージ ヘッダー名を変更します。
  • メッセージ ヘッダーを azure_eventhub_enqueued_time から azure_eventhubs_batch_converted_enqueued_timeに変更します。
  • メッセージ ヘッダーを azure_eventhub_offset から azure_eventhubs_batch_converted_offsetに変更します。
  • メッセージ ヘッダーを azure_eventhub_sequence_number から azure_eventhubs_batch_converted_sequence_numberに変更します。
  • メッセージ ヘッダーを azure_partition_key から azure_batch_converted_partition_keyに変更します。
• Event Hubs にメッセージを発行する場合は、バッチ処理されたメッセージから変換されたすべてのメッセージ ヘッダーを無視します。 ヘッダーには次のものが含まれます。
  • 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
• BATCH チェックポイント モードはバッチ消費モードでのみ機能します。このモードは、EventHubsInboundChannelAdapter コンストラクターに ListenerMode.BATCH を渡すことによって有効にすることができます。

次の表は、azure-spring-integration-eventhubs から spring-integration-azure-eventhubsへのクラス マッピングを示しています。

azure-spring-cloud-starter-servicebus から spring-cloud-azure-starter-integration-servicebus へ

このガイドは、azure-spring-cloud-starter-servicebus のバージョン 2 から spring-cloud-azure-starter-integration-servicebus への移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

spring-cloud-azure-starter-integration-servicebusでサポートされているすべての構成オプションでは、プレフィックスは spring.cloud.azure.servicebusのままです。

次の表は、azure-spring-cloud-starter-servicebus から spring-cloud-azure-starter-integration-servicebusへのプロパティ マッピングを示しています。

API の変更

• サブスクライブ関数を持つ ServiceBusQueueOperation と ServiceBusTopicOperation をドロップしてクラス ServiceBusMessageListenerContainer に移動し、送信関数を ServiceBusTemplateに移動します。
• ServiceBusQueueInboundChannelAdapter と ServiceBusTopicInboundChannelAdapter を削除し、Service Bus キュー/トピック エンティティをリッスンする機能を ServiceBusInboundChannelAdapter に移動します。
• コンストラクターを ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) から ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) および ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)に変更します。
• コンストラクターを ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) から ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) および ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)に変更します。
• API ServiceBusQueueOperation#setCheckpointConfig と ServiceBusTopicOperation#setCheckpointConfigを削除します。 受信チャネル アダプターのチェックポイント構成を設定するには、代わりにメソッド ServiceBusContainerProperties#setAutoComplete を呼び出すことができます。 オートコンプリート モードを無効にすると、チェックポイント モード MANUAL 同じになり、有効にすると RECORD モードがトリガーされます。
• API ServiceBusQueueOperatio#setClientConfig と ServiceBusTopicOperation#setClientConfigを削除します。 受信チャネル アダプターによって使用される基になる ServiceBusProcessorClient を構成するために、ユーザーは代わりに ServiceBusContainerProperties を使用できます。
• CompletableFuture と ServiceBusTemplateで DefaultMessageHandler サポートを削除し、代わりに Reactor をサポートします。
• ServiceBusTemplate#setDefaultEntityType の新しい API を追加してエンティティ型を指定します。これは、PropertiesSupplier<String, ProducerProperties>に ProducerProperties#entityType の Bean が指定されていない場合に必要です。
• メッセージ ヘッダー AzureHeaders.RAW_IDを削除します。 ServiceBusMessageHeaders.MESSAGE_ID を代わりに使用します。

次の表は、azure-spring-cloud-starter-servicebus から spring-cloud-azure-starter-integration-servicebusへのクラス マッピングを示しています。

サンプル コード スニペット

• ServiceBusInboundChannelAdapter サンプル コード:

  ServiceBusQueueInboundChannelAdapter または 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;
      }
  
  }
  

  最新のコード:

  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 サンプル コード:

  キューを例として受け取るレガシ コード:

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

  最新のコード:

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

azure-spring-integration-servicebus から spring-integration-azure-servicebus へ

このガイドは、azure-spring-integration-servicebus のバージョン 2 から spring-integration-azure-servicebus への移行を支援することを目的としています。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。

API の変更

• サブスクライブ関数を持つ ServiceBusQueueOperation と ServiceBusTopicOperation をドロップしてクラス ServiceBusMessageListenerContainer に移動し、送信関数を ServiceBusTemplateに移動します。
• ServiceBusQueueInboundChannelAdapter と ServiceBusTopicInboundChannelAdapter を削除し、Service Bus キュー/トピック エンティティをリッスンする機能を ServiceBusInboundChannelAdapter に移動します。
• コンストラクターを ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) から ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) および ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)に変更します。
• コンストラクターを ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) から ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) および ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode)に変更します。
• API ServiceBusQueueOperation#setCheckpointConfig と ServiceBusTopicOperation#setCheckpointConfigを削除します。 受信チャネル アダプターのチェックポイント構成を設定するには、代わりにメソッド ServiceBusContainerProperties#setAutoComplete を呼び出すことができます。 オートコンプリート モードを無効にすると、チェックポイント モード MANUAL 同じになり、有効にすると RECORD モードがトリガーされます。
• API ServiceBusQueueOperation#setClientConfig と ServiceBusTopicOperation#setClientConfigを削除します。 受信チャネル アダプターによって使用される基になる ServiceBusProcessorClient を構成するために、ユーザーは代わりに ServiceBusContainerProperties を使用できます。
• CompletableFuture と ServiceBusTemplateで DefaultMessageHandler サポートを削除し、代わりに Reactor をサポートします。
• ServiceBusTemplate#setDefaultEntityType の新しい API を追加してエンティティ型を指定します。これは、PropertiesSupplier<String, ProducerProperties>に ProducerProperties#entityType の Bean が指定されていない場合に必要です。
• メッセージ ヘッダー AzureHeaders.RAW_IDを削除します。 ServiceBusMessageHeaders.MESSAGE_ID を代わりに使用します。

次の表は、azure-spring-integration-servicebus から spring-integration-azure-servicebusへのクラス マッピングを示しています。

azure-spring-cloud-starter-storage-queue から spring-cloud-azure-starter-integration-storage-queue へ

このガイドは、azure-spring-cloud-starter-storage-queue のバージョン 2 から spring-cloud-azure-starter-integration-storage-queue への移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

すべての構成プロパティ名でプレフィックスが spring.cloud.azure.storage から spring.cloud.azure.storage.queueに変更されました。

次の表は、azure-spring-cloud-starter-storage-queue から spring-cloud-azure-starter-integration-storage-queueへのプロパティ マッピングを示しています。

API の変更

• StorageQueueOperation を削除し、代わりに StorageQueueTemplate を指定します。
• checkpoint-modeのドロップ StorageQueueTemplate 構成では、MANUAL モードのみがサポートされます。

次の表に、azure-spring-cloud-starter-storage-queue から spring-cloud-azure-starter-integration-storage-queueへのクラス マッピングを示します。

azure-spring-integration-storage-queue から spring-integration-azure-storage-queue へ

このガイドは、azure-spring-integration-storage-queue のバージョン 2 から spring-integration-azure-storage-queue への移行を支援することを目的としています。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。

API の変更

• StorageQueueOperation を削除し、代わりに StorageQueueTemplate を指定します。
• checkpoint-modeのドロップ StorageQueueTemplate 構成では、MANUAL モードのみがサポートされます。

次の表に、azure-spring-integration-storage-queue から spring-integration-azure-storage-queueへのクラス マッピングを示します。

azure-spring-cloud-stream-binder-eventhubs から spring-cloud-azure-stream-binder-eventhubs へ

このガイドは、azure-spring-cloud-stream-binder-eventhubs のバージョン 2 から spring-cloud-azure-stream-binder-eventhubs への移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

次のプレフィックスの子エントリの変更については、次の表を参照してください。

次の表は、azure-spring-cloud-stream-binder-eventhubs から spring-cloud-azure-stream-binder-eventhubsへのプロパティ マッピングを示しています。

構成移行の例

認証にconnection stringを使用し、上記のプロパティを移行するには、構成の変更を次に示します。

従来の構成:

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

最新の構成:

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

接続文字列の代わりにセキュリティ プリンシパルを使用する場合、4.0 より前のバージョンでは、アプリケーションは最初に指定されたセキュリティ プリンシパルを使用して Azure Resource Manager (ARM) に接続し、ARM を使用して指定された名前空間のconnection stringを取得します。 最終的に、アプリケーションは取得したconnection stringを使用してAzure Event Hubsに接続します。 このようにして、指定されたセキュリティ プリンシパルを Contributor ロールと共に付与して、関連付けられているAzure Event Hubs名前空間を取得する必要があります。

Azure Spring Apps 4.0 では、認証にセキュリティ プリンシパルを利用する 2 つの方法が用意されています。 プリンシパルを使用して ARM に接続し、プリンシパルに Contributor ロールが必要な接続文字列を取得します。 もう 1 つでは、セキュリティ プリンシパルを利用してMicrosoft Entra IDに対する認証を行い、Azure Event Hubsに直接接続します。 この場合、Contributor ロールは不要になりましたが、メッセージング操作には他の Data 関連ロールが必要です。 Azure リソースにアクセスするための十分なアクセス許可がセキュリティ プリンシパルに付与されていることを確認するには、「アクセスを Microsoft Entra IDを参照してください。

ARM に基づく認証の場合、サービス プリンシパルを例にとると、割り当てられたロールが変更されない構成移行が次のように表示されます。

従来の構成:

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}

最新の構成では、Azureサブスクリプション ID とリソース グループのプロパティが必要です。

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}

ARM に迂回することなく、Microsoft Entra IDで直接認証と承認を行うために移行することもできます。 メッセージング操作に必要な Data ロールをセキュリティ プリンシパルに付与してください。 サービス プリンシパルとマネージド ID の構成例を次に示します。

• サービス プリンシパルを使用する

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

• マネージド ID を使用する

  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}
  

API の変更

次の表に、azure-spring-cloud-stream-binder-eventhubs から spring-cloud-azure-stream-binder-eventhubsへのクラス マッピングを示します。

azure-spring-cloud-stream-binder-servicebus-* から spring-cloud-azure-stream-binder-servicebus へ

このガイドは、バージョン 2 のazure-spring-cloud-stream-binder-servicebus-queueまたはazure-spring-cloud-stream-binder-servicebus-topicからspring-cloud-azure-stream-binder-servicebusへの移行を支援することを目的としています。

一般的な情報については、次のリンクを使用してください。

• 4.0 の変更点の概要については、「の概要 と移行の利点 セクション 参照してください。
• プロジェクトの名前付けにおける戦略の変更の詳細については、「名前付けの変更」セクションを参照してください。
• すべての Spring Cloud Azure ライブラリに対して 1 つの BOM を使用する方法については、「BOM」セクションを参照してください。
• Spring Cloud Azure 4.0 で認証を処理する方法については、「認証の変更」セクションを参照してください。
• 移行中に spring-boot-properties-migrator を活用する方法については、「各 SDK の構成」セクションを参照してください。
• グローバルおよび一般的な構成の変更の詳細については、「グローバル構成 」セクションを参照してください。

SDK 構成の変更

次の表に、spring-cloud-azure-stream-binder-servicebusの新しい構成プロパティを示します。

次の表は、azure-spring-cloud-stream-binder-servicebus-* から spring-cloud-azure-stream-binder-servicebusへのプロパティ マッピングを示しています。

構成移行の例

従来の構成(例としてキューを使用):

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

最新の構成:

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

接続文字列の代わりにセキュリティ プリンシパルを使用する場合、4.0 より前のバージョンでは、アプリケーションは最初に指定されたセキュリティ プリンシパルを使用して Azure Resource Manager (ARM) に接続し、ARM を使用して指定された名前空間のconnection stringを取得します。 最終的に、アプリケーションは取得したconnection stringを使用してAzure Service Busに接続します。 このようにして、指定されたセキュリティ プリンシパルを Contributor ロールで付与し、関連付けられているAzure Service Bus名前空間を取得する必要があります。

Azure Spring Apps 4.0 では、認証にセキュリティ プリンシパルを利用する 2 つの方法が用意されています。 プリンシパルを使用して ARM に接続し、プリンシパルに Contributor ロールが必要な接続文字列を取得します。 もう 1 つでは、セキュリティ プリンシパルを利用してMicrosoft Entra IDに対する認証を行い、Azure Service Busに直接接続します。 この場合、Contributor ロールは不要になりましたが、メッセージング操作には他の Data 関連ロールが必要です。 Azure リソースにアクセスするための十分なアクセス許可がセキュリティ プリンシパルに付与されていることを確認するには、「アクセスを Microsoft Entra IDを参照してください。

ARM に基づく認証の場合、サービス プリンシパルを例にとると、割り当てられたロールが変更されない構成移行が次のように表示されます。

従来の構成:

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}

最新の構成では、Azureサブスクリプション ID とリソース グループのプロパティが必要です。

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}

ARM に迂回することなく、Microsoft Entra IDで直接認証と承認を行うために移行することもできます。 メッセージング操作に必要な Data ロールをセキュリティ プリンシパルに付与してください。 サービス プリンシパルとマネージド ID の構成例を次に示します。

• サービス プリンシパルを使用する

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

• マネージド ID を使用する

  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}
  

API の変更

• メッセージ ヘッダー AzureHeaders.RAW_IDを削除します。 ServiceBusMessageHeaders.MESSAGE_ID を代わりに使用します。

次の表に、azure-spring-cloud-stream-binder-eventhubs から spring-cloud-azure-stream-binder-eventhubsへのクラス マッピングを示します。

azure-spring-cloud-messaging

com.azure.spring:azure-spring-cloud-messaging ライブラリは 4.0 の準備ができていません。 リスナー注釈の機能は再設計中であるため、@AzureMessageListener、@AzureMessageListeners、および @EnableAzureMessaging 注釈は現在サポートされていません。