Guia de migração para o Spring Cloud Azure 4.0

Este guia ajuda na migração para o Spring Cloud Azure 4.0 das bibliotecas herdadas do Azure Spring.

Introdução

Chamaremos bibliotecas cuja ID de grupo e ID de artefato seguem o padrão as bibliotecas modernas e aquelas com padrão, ou bibliotecas de herdadas .

Este guia se concentrará em comparações lado a lado para configurações semelhantes entre as bibliotecas modernas e herdadas.

Familiaridade com com.azure.spring:azure-spring-boot-*, com.azure.spring:azure-spring-cloud-* ou pacote com.azure.spring:azure-spring-integration-* é assumido.

Se você não estiver familiarizado com as bibliotecas do Spring Cloud Azure 4.0, consulte o guia do desenvolvedor do Spring Cloud Azure em vez deste guia.

Benefícios de migração

Uma pergunta natural a ser feita ao considerar se a adoção de uma nova versão ou biblioteca é seus benefícios. À medida que o Azure amadureceu e foi abraçado por um grupo mais diversificado de desenvolvedores, estamos focados em aprender os padrões e práticas para dar melhor suporte à produtividade do desenvolvedor e entender as lacunas que as bibliotecas do Spring Cloud Azure têm.

Havia várias áreas de comentários consistentes expressas nas bibliotecas do Spring Cloud Azure. O mais importante é que as bibliotecas de diferentes serviços do Azure não habilitaram o conjunto completo de configurações. Além disso, a inconsistência de nomenclatura de projeto, IDs de artefato, versões e configurações tornou a curva de aprendizado íngreme.

Para melhorar a experiência de desenvolvimento em bibliotecas do Spring Cloud Azure, um conjunto de diretrizes de design foi introduzido para garantir que as bibliotecas do Spring Cloud Azure tenham uma sensação natural e idiomática em relação ao ecossistema spring. Mais detalhes estão disponíveis no documento de design para os interessados.

O Spring Cloud Azure 4.0 fornece a experiência compartilhada entre bibliotecas que integram diferentes projetos do Spring, por exemplo, Spring Boot, Spring Integration, Spring Cloud Stream e assim por diante. A experiência compartilhada inclui:

• Um BOM unificado para incluir todas as bibliotecas do Spring Cloud Azure 4.0.
• Uma convenção de nomenclatura consistente para artefatos.
• Uma maneira unificada de configurar credenciais, proxy, repetição, ambiente de nuvem e configurações de camada de transporte.
• Dá suporte a todos os métodos de autenticação compatíveis com o Serviço do Azure ou o SDK do Serviço do Azure.

Visão geral

Este guia de migração consiste nas seguintes seções:

• Alterações de nomenclatura para o Spring Cloud Azure 4.0
• Alterações de artefato: renomeada/adicionada/excluída
• Alterações de dependência
• Alterações de autenticação
• Propriedades de configuração
• Alterações interruptivas da API
• Alterações na biblioteca

Alterações de nomenclatura

Nunca houve um nome consistente ou oficial para chamar todas as bibliotecas do Azure do Spring Cloud. Alguns deles foram chamados de Azure Spring Boot e alguns deles Spring on Azure. Desde 4.0, começamos a usar o nome do projeto Spring Cloud Azure para representar todas as bibliotecas do Azure Spring.

Lista de materiais

Costumávamos enviar dois BOMs para nossas bibliotecas, o azure-spring-boot-bom e azure-spring-cloud-dependencies, mas combinamos esses dois BOMs em um BOM desde 4.0, o spring-cloud-azure-dependencies. Adicione uma entrada na seção dependencyManagement do projeto para se beneficiar do gerenciamento de dependências.

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

Alterações de artefato: renomeada/adicionada/excluída

As IDs de grupo são as mesmas para bibliotecas modernas e herdadas do Spring Cloud Azure. Estão todos com.azure.spring. As IDs de artefato para as bibliotecas modernas do Azure do Spring Cloud foram alteradas. De acordo com o projeto Spring ao qual pertence, Spring Boot, Spring Integration ou Spring Cloud Stream, o padrão de IDs do artefato pode ser spring-cloud-azure-starter-[service], spring-integration-azure-[service]ou spring-cloud-azure-stream-binder-[service]. Os inícios herdados para cada um deles têm uma ID de artefato seguindo o padrão azure-spring-*. Isso fornece um meio rápido e acessível para ajudar a entender, rapidamente, se você está usando iniciantes modernos ou herdados.

No processo de desenvolvimento do Spring Cloud Azure 4.0, renomeamos alguns artefatos para fazê-los seguir as novas convenções de nomenclatura, excluímos alguns artefatos para que a funcionalidade pudesse ser colocada em um artefato mais apropriado e adicionamos alguns novos artefatos para atender melhor a alguns cenários.

A tabela a seguir mostra os mapeamentos entre a ID do artefato herdado e a ID do artefato moderno:

Alterações de dependências

Algumas dependências desnecessárias foram incluídas nos artefatos herdados, que removemos nas bibliotecas modernas do Spring Cloud Azure 4.0. Adicione as dependências removidas manualmente ao projeto para evitar falhas.

As bibliotecas que têm alterações de dependência incluem:

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

Alterações de autenticação

O Spring Cloud Azure 4.0 dá suporte a todos os métodos de autenticação aos quais cada SDK do Serviço do Azure dá suporte. Ele permite configurar uma credencial de token global, bem como fornecer a credencial de token em cada nível de serviço. Mas uma credencial não é necessária para configurar o Spring Cloud Azure 4.0 porque pode aplicar a credencial armazenada em um ambiente de desenvolvimento local ou identidade gerenciada nos Serviços do Azure. Apenas certifique-se de que a entidade de segurança recebeu permissão suficiente para acessar os recursos de destino do Azure.

Uma credencial encadeada, o bean DefaultAzureCredential é configurado automaticamente por padrão e será usado por todos os componentes se nenhuma informação de autenticação for especificada. Para obter mais informações, consulte a seção DefaultAzureCredential da biblioteca de clientes Identidade do Azure para Java.

Propriedades de configuração

Migração de propriedades

Criamos um arquivo additional-spring-configuration-metadata.json para suavizar a migração de propriedade ao usar com spring-boot-properties-migrator. Primeiro, adicione o seguinte migrador de propriedade ao seu aplicativo:

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

Ou, se você estiver usando o Gradle:

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

Se você executar o aplicativo, ele identificará as propriedades que não são mais gerenciadas pelo Spring Cloud Azure. Se houver uma substituição, ele remapeará temporariamente a propriedade para você com um aviso. Se não houver uma substituição, um relatório de erros fornecerá mais informações. De qualquer forma, a configuração precisa ser atualizada e a dependência removida depois que você atualizar a configuração.

Antes de seguir em frente, é uma boa ideia usar o recurso de pesquisa do seu IDE para verificar se você não está usando uma das propriedades que você migrou em um teste de integração.

Configurações globais

O spring-cloud-azure-starter moderno permite definir propriedades que se aplicam a todos os SDKs do Azure no namespace spring.cloud.azure. Não havia suporte para esse recurso no azure-spring-boot-starterherdado. As configurações globais podem ser divididas em cinco categorias, mostradas na tabela a seguir:

Para obter uma lista completa de configurações, consulte propriedades de configuração do Spring Cloud Azure.

Configurar cada SDK

Para obter detalhes sobre as opções de configuração no nível do SDK, use os seguintes links:

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

Alterações interruptivas da API

Para obter detalhes sobre alterações de falha de API em cada biblioteca, use os seguintes links:

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

Alterações na biblioteca

Alterações significativas em cada biblioteca são introduzidas da seguinte maneira.

Do azure-spring-boot-starter ao spring-cloud-azure-starter

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter da versão 3 do azure-spring-boot-starter.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações de dependência

Algumas dependências desnecessárias foram incluídas nos artefatos herdados, que removemos nas bibliotecas modernas do Spring Cloud Azure 4.0. Adicione as dependências removidas manualmente ao projeto para evitar falhas não intencionais.

A tabela a seguir mostra as dependências removidas:

Do azure-spring-boot-starter-active-directory ao spring-cloud-azure-starter-active-directory

Este guia destina-se a ajudar a migração para spring-cloud-azure-starter-active-directory da versão 3 do azure-spring-boot-starter-active-directory.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações de dependência

Algumas dependências desnecessárias no artefato herdado foram removidas desde a moderna biblioteca do Spring Cloud Azure 4.0. Adicione essas dependências removidas ao seu projeto para evitar falhas não intencionais.

A tabela a seguir mostra as dependências removidas:

Alterações na configuração do SDK

Esta seção inclui as alterações sobre as propriedades adicionadas, removidas e alteradas.

• Os dois pontos a seguir são os principais para prestar atenção em:

1. O prefixo de todos os nomes de propriedade de configuração foi alterado de azure.activedirectory para spring.cloud.azure.active-directory.
2. Nova propriedade spring.cloud.azure.active-directory.enabled é adicionada para habilitar/desabilitar recursos relacionados ao Microsoft Entra. O valor padrão é false.

A tabela a seguir mostra os mapeamentos de propriedade entre azure-spring-boot-starter-active-directory e spring-cloud-azure-starter-active-directory:

• O tipo de valor das seguintes propriedades é alterado de long para Duration:

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

• As seguintes propriedades são removidas:

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

• As seguintes propriedades são adicionadas:

  • 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

Aqui estão alguns exemplos de migração:

• Exemplo 1. Caso 1

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

  • Para modern: 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

• Exemplo 2. Caso 2

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

  • Para modern: 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

Alterações de API

A tabela a seguir mostra os mapeamentos de classe de azure-spring-boot-starter-active-directory para spring-cloud-azure-starter-active-directory:

Esta seção lista as classes removidas do azure-spring-boot-starter-active-directory.

• Classe herdada removida

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

Do azure-spring-boot-starter-active-directory-b2c ao spring-cloud-azure-starter-active-directory-b2c

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-active-directory-b2c da versão 3 do azure-spring-boot-starter-active-directory-b2c.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações de dependência

Algumas dependências desnecessárias foram incluídas nos artefatos herdados, que removemos nas bibliotecas modernas do Spring Cloud Azure 4.0. Adicione as dependências removidas manualmente ao projeto para evitar falhas não intencionais.

A tabela a seguir mostra as dependências removidas:

Alterações na configuração do SDK

Esta seção inclui as alterações sobre as propriedades adicionadas, removidas e alteradas.

• Os dois pontos a seguir são os principais para prestar atenção em:

1. Todos os nomes de propriedades de configuração alteraram o prefixo de azure.activedirectory.b2c para spring.cloud.azure.active-directory.b2c.
2. Nova propriedade spring.cloud.azure.active-directory.b2c.enabled é adicionada para permitir habilitar/desabilitar recursos relacionados ao Azure AD B2C. O valor padrão é false.

A tabela a seguir mostra os mapeamentos de propriedades de azure-spring-boot-starter-active-directory-b2c para spring-cloud-azure-starter-active-directory-b2c:

• Propriedades removidas do azure-spring-boot-starter-active-directory-b2c:

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

• O tipo de valor das seguintes propriedades é alterado de long para Duration:

  • jwt-connect-timeout
  • jwt-tempo limite de leitura

Alterações de API

A tabela a seguir mostra os mapeamentos de classe de azure-spring-boot-starter-active-directory-b2c para spring-cloud-azure-starter-active-directory-b2c:

Do azure-spring-boot-starter-cosmos ao spring-cloud-azure-starter-data-cosmos

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-data-cosmos da versão 3 do azure-spring-boot-starter-cosmos.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

Todos os nomes de propriedades de configuração alteraram o prefixo de azure.cosmos para spring.cloud.azure.cosmos.

A tabela a seguir mostra os mapeamentos de classe de azure-spring-boot-starter-cosmos para spring-cloud-azure-starter-data-cosmos:

Do azure-spring-boot-starter-keyvault-secrets ao spring-cloud-azure-starter-keyvault-secrets

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-keyvault-secrets da versão 3 do azure-spring-boot-starter-keyvault-secrets.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

Esta seção inclui as alterações sobre as propriedades adicionadas, removidas e alteradas.

A tabela a seguir mostra os mapeamentos de propriedades de azure-spring-boot-starter-keyvault-secrets para spring-cloud-azure-starter-keyvault-secrets:

• Propriedades removidas do spring-cloud-azure-starter-keyvault-secrets

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

Os seguintes pontos aos quais você deve prestar atenção:

1. Todos os nomes de propriedades de configuração alteraram o prefixo de azure.keyvault para spring.cloud.azure.keyvault.secret.
2. spring.cloud.azure.keyvault.secret.enabled é usado para habilitar todos os recursos do Segredo do Key Vault, inclua configurar os clientes secretos do Key Vault (como SecretClient e SecretAsyncClient) e adicionar KeyVaultPropertySource em ConfigurableEnvironment.
3. spring.cloud.azure.keyvault.secret.property-source-enabled é usado para habilitar todos os KeyVaultPropertySource. Ele só entrará em vigor quando spring.cloud.azure.keyvault.secret.enabled=true.
4. Para propriedades comuns do Azure(como client, proxy, retry, credential, profile) e propriedades do Key Vault (como endpoint, service-version). Se spring.cloud.azure.keyvault.secret.property-sources[n].PROPERTY_NAME não estiver configurado, spring.cloud.azure.keyvault.secret.PROPERTY_NAME será usado.
5. spring.cloud.azure.keyvault.secret.property-sources[n].resource é específico para um recurso exclusivo do Azure; portanto, se ele não estiver configurado, ele não obterá valor de outros locais.

Do azure-spring-boot-starter-servicebus-jms ao spring-cloud-azure-starter-servicebus-jms

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-servicebus-jms da versão 3 de azure-spring-boot-starter-servicebus-jms.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

O tipo de configuração para spring.jms.servicebus.idle-timeout alterado de long(milissegundos) para Duration padrão de legibilidade.

Do azure-spring-boot-starter-storage ao spring-cloud-azure-starter-storage-blob

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-storage-blob da versão 3 do azure-spring-boot-starter-storage.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

Todos os nomes de propriedades de configuração alteraram o prefixo de azure.storage para spring.cloud.azure.storage.blob.

A tabela a seguir mostra os mapeamentos de propriedades de azure-spring-boot-starter-storage para spring-cloud-azure-starter-storage-blob:

Alterações de API

A tabela a seguir mostra os mapeamentos de classe de azure-spring-boot-starter-storage para spring-cloud-azure-starter-storage-blob:

Do azure-spring-boot-starter-storage ao spring-cloud-azure-starter-storage-file-share

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-storage-file-share da versão 3 do azure-spring-boot-starter-storage.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

Todos os nomes de propriedades de configuração alteraram o prefixo de azure.storage para spring.cloud.azure.storage.fileshare.

A tabela a seguir mostra os mapeamentos de propriedades de azure-spring-boot-starter-storage para spring-cloud-azure-starter-storage-file-share:

Alterações de API

A tabela a seguir mostra os mapeamentos de classe de azure-spring-boot-starter-storage para spring-cloud-azure-starter-storage-file-share:

Do azure-spring-cloud-starter-eventhubs ao spring-cloud-azure-starter-integration-eventhubs

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-integration-eventhubs da versão 2 de azure-spring-cloud-starter-eventhubs.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

Para obter alterações nas entradas filho desse prefixo, consulte as seguintes tabelas:

A tabela a seguir mostra mapeamentos de propriedades de azure-spring-cloud-starter-eventhubs para spring-cloud-azure-starter-integration-eventhubs:

Por exemplo, altere de:

spring:
  cloud:
    azure:
      eventhub:
        connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
        checkpoint-storage-account: ${AZURE_CHECKPOINT_STORAGE_ACCOUNT_NAME}
        checkpoint-access-key: ${AZURE_CHECKPOINT_ACCOUNT_KEY}
        checkpoint-container: ${AZURE_CHECKPOINT_CONTAINER_NAME}

Para:

spring:
  cloud:
    azure:
      eventhubs:
        connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
        processor:
          checkpoint-store:
            container-name: ${AZURE_STORAGE_CONTAINER_NAME}
            account-name: ${AZURE_STORAGE_ACCOUNT_NAME}
            account-key: ${AZURE_STORAGE_ACCOUNT_KEY}

Alterações de API

• Para obter as alterações nas anotações do ouvinte, consulte o guia de migração do <<biblioteca de>> migration-azure-spring-cloud-messaging, azure-spring-cloud-messaging.
• Solte EventHubOperation com a função de assinatura movida para a classe EventHubsMessageListenerContainer e a função de envio movida para EventHubsTemplate.
• Renomeie EventHubInboundChannelAdapter como EventHubsInboundChannelAdapter para manter-se consistente com o serviço dos Hubs de Eventos do Azure.
• Altere o construtor de EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) para EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) e EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Altere CheckpointConfig estilo de instanciação para o construtor simples em vez de estilo de build.
• Remover EventHubOperation#setCheckpointConfigde API. Para definir a configuração de ponto de verificação para o adaptador de canal de entrada, os usuários podem chamar o método EventHubsContainerProperties#setCheckpointConfig.
• Remover EventHubOperation#setBatchConsumerConfigde API. Para definir a configuração de consumo em lote para o adaptador de canal de entrada, os usuários podem chamar os dois métodos EventHubsContainerProperties#getBatch#setMaxSize e EventHubsContainerProperties#getBatch#setMaxWaitTime enquanto isso.
• Para o modo de consumo em lote, altere os nomes de cabeçalho da mensagem convertidos de mensagens em lote.
  • Alterar o cabeçalho da mensagem de azure_eventhub_enqueued_time para azure_eventhubs_batch_converted_enqueued_time.
  • Alterar o cabeçalho da mensagem de azure_eventhub_offset para azure_eventhubs_batch_converted_offset.
  • Alterar o cabeçalho da mensagem de azure_eventhub_sequence_number para azure_eventhubs_batch_converted_sequence_number.
  • Alterar o cabeçalho da mensagem de azure_partition_key para azure_batch_converted_partition_key.
• Ao publicar mensagens nos Hubs de Eventos, ignore todos os cabeçalhos de mensagem convertidos de mensagens em lote. Os cabeçalhos incluem:
  • 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
• O modo de ponto de verificação BATCH só funciona no modo de consumo em lote agora, que pode ser habilitado passando ListenerMode.BATCH para o construtor EventHubsInboundChannelAdapter.

A tabela a seguir mostra os mapeamentos de classe de azure-spring-cloud-starter-eventhubs para spring-cloud-azure-starter-integration-eventhubs:

Snippet de código de exemplo

• EventHubsInboundChannelAdapter código de exemplo:

  Código herdado:

  public class Demo {
      @Bean
      public EventHubInboundChannelAdapter messageChannelAdapter(
          @Qualifier("INPUT_CHANNEL") MessageChannel inputChannel, EventHubOperation   eventhubOperation) {
          eventhubOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode  (CheckpointMode.MANUAL).build());
          EventHubInboundChannelAdapter adapter = new EventHubInboundChannelAdapter("EVENTHUB_NAME",
              eventhubOperation, "CONSUMER_GROUP");
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  }
  

  Código moderno:

  public class Demo {
      @Bean
      public EventHubsMessageListenerContainer messageListenerContainer(EventHubsProcessorFactory processorFactory) {
          EventHubsContainerProperties containerProperties = new EventHubsContainerProperties();
          containerProperties.setEventHubName("EVENTHUB_NAME");
          containerProperties.setConsumerGroup("CONSUMER_GROUP");
          CheckpointConfig config = new CheckpointConfig(CheckpointMode.MANUAL);
          containerProperties.setCheckpointConfig(config);
          return new EventHubsMessageListenerContainer(processorFactory, containerProperties);
      }
  
      @Bean
      public EventHubsInboundChannelAdapter messageChannelAdapter(@Qualifier("INPUT_CHANNEL") MessageChannel inputChannel,
                                                                  EventHubsMessageListenerContainer listenerContainer) {
          EventHubsInboundChannelAdapter adapter = new EventHubsInboundChannelAdapter(listenerContainer);
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  }
  

• DefaultMessageHandler código de exemplo:

  Código herdado:

  public class Demo {
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL")
      public MessageHandler messageSender(EventHubOperation eventhubOperation) {
          DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @Override
              public void onSuccess(Void result) {
                  LOGGER.info("Message was sent successfully.");
              }
  
              @Override
              public void onFailure(Throwable ex) {
                  LOGGER.error("There was an error sending the message.", ex);
              }
          });
          return handler;
      }
  }
  

  Código moderno:

  public class Demo {
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL")
      public MessageHandler messageSender(EventHubsTemplate eventhubOperation) {
          DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @Override
              public void onSuccess(Void result) {
                  LOGGER.info("Message was sent successfully.");
              }
  
              @Override
              public void onFailure(Throwable ex) {
                  LOGGER.error("There was an error sending the message.", ex);
              }
          });
  
          return handler;
      }
  }
  

Do azure-spring-integration-eventhubs ao spring-integration-azure-eventhubs

Este guia destina-se a ajudar na migração para spring-integration-azure-eventhubs da versão 2 do azure-spring-integration-eventhubs.

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.

Alterações de API

• Solte EventHubOperation com a função de assinatura movida para a classe EventHubsMessageListenerContainer e a função de envio movida para EventHubsTemplate.
• Renomeie EventHubInboundChannelAdapter como EventHubsInboundChannelAdapter para manter-se consistente com o serviço dos Hubs de Eventos do Azure.
• Altere o construtor de EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) para EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) e EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Altere CheckpointConfig estilo de instanciação para o construtor simples em vez de estilo de build.
• Remover EventHubOperation#setCheckpointConfigde API. Para definir a configuração de ponto de verificação para o adaptador de canal de entrada, os usuários podem chamar o método EventHubsContainerProperties#setCheckpointConfig.
• Remover EventHubOperation#setBatchConsumerConfigde API. Para definir a configuração de consumo em lote para o adaptador de canal de entrada, os usuários podem chamar os dois métodos EventHubsContainerProperties#getBatch#setMaxSize e EventHubsContainerProperties#getBatch#setMaxWaitTime enquanto isso.
• Para o modo de consumo em lote, altere os nomes de cabeçalho da mensagem convertidos de mensagens em lote.
  • Alterar o cabeçalho da mensagem de azure_eventhub_enqueued_time para azure_eventhubs_batch_converted_enqueued_time.
  • Alterar o cabeçalho da mensagem de azure_eventhub_offset para azure_eventhubs_batch_converted_offset.
  • Alterar o cabeçalho da mensagem de azure_eventhub_sequence_number para azure_eventhubs_batch_converted_sequence_number.
  • Alterar o cabeçalho da mensagem de azure_partition_key para azure_batch_converted_partition_key.
• Ao publicar mensagens nos Hubs de Eventos, ignore todos os cabeçalhos de mensagem convertidos de mensagens em lote. Os cabeçalhos incluem:
  • 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
• O modo de ponto de verificação BATCH só funciona no modo de consumo em lote agora, que pode ser habilitado passando ListenerMode.BATCH para o construtor EventHubsInboundChannelAdapter.

A tabela a seguir mostra os mapeamentos de classe de azure-spring-integration-eventhubs para spring-integration-azure-eventhubs:

Do azure-spring-cloud-starter-servicebus ao spring-cloud-azure-starter-integration-servicebus

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-integration-servicebus da versão 2 de azure-spring-cloud-starter-servicebus.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

Para todas as opções de configuração com suporte no spring-cloud-azure-starter-integration-servicebus, o prefixo permanece como spring.cloud.azure.servicebus.

A tabela a seguir mostra os mapeamentos de propriedades de azure-spring-cloud-starter-servicebus para spring-cloud-azure-starter-integration-servicebus:

Alterações de API

• Solte ServiceBusQueueOperation e ServiceBusTopicOperation com a função de assinatura movida para o ServiceBusMessageListenerContainer de classe e a função de envio movida para ServiceBusTemplate.
• Solte ServiceBusQueueInboundChannelAdapter e ServiceBusTopicInboundChannelAdaptere mova a funcionalidade para ouvir uma entidade de fila/tópico do Barramento de Serviço para ServiceBusInboundChannelAdapter.
• Altere o construtor de ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) para ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) e ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Altere o construtor de ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) para ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) e ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Remover APIs ServiceBusQueueOperation#setCheckpointConfig e ServiceBusTopicOperation#setCheckpointConfig. Para definir a configuração de ponto de verificação para o adaptador de canal de entrada, os usuários podem chamar o método ServiceBusContainerProperties#setAutoComplete em vez disso. Desabilitar o modo de preenchimento automático é equivalente a MANUAL modo de ponto de verificação e habilitá-lo disparará o modo de RECORD.
• Remover APIs ServiceBusQueueOperatio#setClientConfig e ServiceBusTopicOperation#setClientConfig. Para configurar o ServiceBusProcessorClient subjacente usado pelo adaptador de canal de entrada, os usuários podem usar ServiceBusContainerProperties em vez disso.
• Solte CompletableFuture suporte em ServiceBusTemplate e DefaultMessageHandler, suporte Reactor em vez disso.
• Adicione uma nova API de ServiceBusTemplate#setDefaultEntityType para especificar o tipo de entidade, que é necessário quando nenhum bean de PropertiesSupplier<String, ProducerProperties> é fornecido para o ProducerProperties#entityType.
• Remover o cabeçalho da mensagem AzureHeaders.RAW_ID. Em vez disso, use ServiceBusMessageHeaders.MESSAGE_ID.

A tabela a seguir mostra os mapeamentos de classe de azure-spring-cloud-starter-servicebus para spring-cloud-azure-starter-integration-servicebus:

Snippet de código de exemplo

• ServiceBusInboundChannelAdapter código de exemplo:

  Código herdado de usar 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;
      }
  
  }
  

  Código moderno:

  public class Demo {
      @Bean("queue-listener-container")
      public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) {
          ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties();
          containerProperties.setEntityName("QUEUE_NAME");
          containerProperties.setAutoComplete(false);
          return new ServiceBusMessageListenerContainer(processorFactory, containerProperties);
      }
  
      @Bean
      public ServiceBusInboundChannelAdapter queueMessageChannelAdapter(
          @Qualifier("INPUT_CHANNEL") MessageChannel inputChannel,
          @Qualifier("queue-listener-container") ServiceBusMessageListenerContainer listenerContainer) {
          ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer);
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  
      @Bean("topic-listener-container")
      public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) {
          ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties();
          containerProperties.setEntityName("TOPIC_NAME");
          containerProperties.setSubscriptionName("SUBSCRIPTION_NAME");
          containerProperties.setAutoComplete(false);
          return new ServiceBusMessageListenerContainer(processorFactory, containerProperties);
      }
  
      @Bean
      public ServiceBusInboundChannelAdapter topicMessageChannelAdapter(
          @Qualifier("INPUT_CHANNEL") MessageChannel inputChannel,
          @Qualifier("topic-listener-container") ServiceBusMessageListenerContainer listenerContainer) {
          ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer);
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  }
  

• DefaultMessageHandler código de exemplo:

  Código herdado, fazendo fila como exemplo:

  public class Demo {
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL_NAME")
      public MessageHandler queueMessageSender(ServiceBusQueueOperation queueOperation) {
          DefaultMessageHandler handler = new DefaultMessageHandler("QUEUE_NAME", queueOperation);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @Override
              public void onSuccess(Void result) {
                  LOGGER.info("Message was sent successfully.");
              }
              @Override
              public void onFailure(Throwable ex) {
                  LOGGER.info("There was an error sending the message.");
              }
          });
          return handler;
      }
  }
  

  Código moderno:

  public class Demo {
  
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL_NAME")
      public MessageHandler queueMessageSender(ServiceBusTemplate serviceBusTemplate) {
          serviceBusTemplate.setDefaultEntityType(ServiceBusEntityType.QUEUE);
          DefaultMessageHandler handler = new DefaultMessageHandler("QUEUE_NAME", serviceBusTemplate);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @Override
              public void onSuccess(Void result) {
                  LOGGER.info("Message was sent successfully for {}.", "QUEUE_NAME");
              }
  
              @Override
              public void onFailure(Throwable ex) {
                  LOGGER.info("There was an error sending the message.");
              }
          });
  
          return handler;
      }
  }
  

Do azure-spring-integration-servicebus ao spring-integration-azure-servicebus

Este guia destina-se a ajudar na migração para spring-integration-azure-servicebus da versão 2 do azure-spring-integration-servicebus.

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.

Alterações de API

• Solte ServiceBusQueueOperation e ServiceBusTopicOperation com a função de assinatura movida para o ServiceBusMessageListenerContainer de classe e a função de envio movida para ServiceBusTemplate.
• Solte ServiceBusQueueInboundChannelAdapter e ServiceBusTopicInboundChannelAdaptere mova a funcionalidade para ouvir uma entidade de fila/tópico do Barramento de Serviço para ServiceBusInboundChannelAdapter.
• Altere o construtor de ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) para ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) e ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Altere o construtor de ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) para ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) e ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Remover APIs ServiceBusQueueOperation#setCheckpointConfig e ServiceBusTopicOperation#setCheckpointConfig. Para definir a configuração de ponto de verificação para o adaptador de canal de entrada, os usuários podem chamar o método ServiceBusContainerProperties#setAutoComplete em vez disso. Desabilitar o modo de preenchimento automático é equivalente a MANUAL modo de ponto de verificação e habilitá-lo disparará o modo de RECORD.
• Remover APIs ServiceBusQueueOperation#setClientConfig e ServiceBusTopicOperation#setClientConfig. Para configurar o ServiceBusProcessorClient subjacente usado pelo adaptador de canal de entrada, os usuários podem usar ServiceBusContainerProperties em vez disso.
• Solte CompletableFuture suporte em ServiceBusTemplate e DefaultMessageHandler, suporte Reactor em vez disso.
• Adicione uma nova API de ServiceBusTemplate#setDefaultEntityType para especificar o tipo de entidade, que é necessário quando nenhum bean de PropertiesSupplier<String, ProducerProperties> é fornecido para o ProducerProperties#entityType.
• Remover o cabeçalho da mensagem AzureHeaders.RAW_ID. Em vez disso, use ServiceBusMessageHeaders.MESSAGE_ID.

A tabela a seguir mostra os mapeamentos de classe de azure-spring-integration-servicebus para spring-integration-azure-servicebus:

Do azure-spring-cloud-starter-storage-queue para spring-cloud-azure-starter-integration-storage-queue

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-integration-storage-queue da versão 2 do azure-spring-cloud-starter-storage-queue.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

Todos os nomes de propriedades de configuração alteraram o prefixo de spring.cloud.azure.storage para spring.cloud.azure.storage.queue.

A tabela a seguir mostra os mapeamentos de propriedades de azure-spring-cloud-starter-storage-queue para spring-cloud-azure-starter-integration-storage-queue:

Alterações de API

• Solte StorageQueueOperation e forneça StorageQueueTemplate.
• Solte checkpoint-mode configuração em StorageQueueTemplate, dê suporte apenas ao modo MANUAL.

A tabela a seguir mostra os mapeamentos de classe de azure-spring-cloud-starter-storage-queue para spring-cloud-azure-starter-integration-storage-queue.

Do azure-spring-integration-storage-queue ao spring-integration-azure-storage-queue

Este guia destina-se a ajudar na migração para spring-integration-azure-storage-queue da versão 2 do azure-spring-integration-storage-queue.

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.

Alterações de API

• Solte StorageQueueOperation e forneça StorageQueueTemplate.
• Solte checkpoint-mode configuração em StorageQueueTemplate, dê suporte apenas ao modo MANUAL.

A tabela a seguir mostra os mapeamentos de classe de azure-spring-integration-storage-queue para spring-integration-azure-storage-queue.

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

Este guia destina-se a ajudar na migração para spring-cloud-azure-stream-binder-eventhubs da versão 2 de azure-spring-cloud-stream-binder-eventhubs.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

Para obter alterações nas entradas filho para o prefixo a seguir, consulte a tabela a seguir.

A tabela a seguir mostra mapeamentos de propriedades de azure-spring-cloud-stream-binder-eventhubs para spring-cloud-azure-stream-binder-eventhubs:

Exemplos de migração de configuração

Para usar a cadeia de conexão para autenticação e migrar as propriedades mencionadas acima, as alterações de configuração são listadas da seguinte maneira:

Configuração herdada:

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

Configuração moderna:

spring:
  cloud:
    azure:
      eventhubs:
        connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
        processor:
          checkpoint-store:
            container-name: ${AZURE_STORAGE_CONTAINER_NAME}
            account-name:  ${AZURE_STORAGE_ACCOUNT_NAME}
            account-key: ${AZURE_STORAGE_ACCOUNT_KEY}
    stream:
      eventhubs:
        bindings:
          <binding-name>:
            consumer:
              batch:
                max-size: ${AZURE_MAX_BATCH_SIZE}
                max-wait-time: ${AZURE_MAX_WAIT_TIME}
              checkpoint:
                mode: ${AZURE_CHECKPOINT_MODE}
                count: ${AZURE_CHECKPOINT_COUNT}
                interval: ${AZURE_CHECKPOINT_INTERVAL}
              initial-partition-event-position:
                0:
                  offset: earliest
                1:
                  sequence-number: 100
                2:
                  enqueued-date-time: 2022-01-12T13:32:47.650005Z
                4:
                  inclusive: false

Se você usar entidades de segurança em vez de cadeias de conexão, em versões antes da 4.0, o aplicativo primeiro se conectará ao ARM (Azure Resource Manager) com a entidade de segurança fornecida e, em seguida, recuperará a cadeia de conexão do namespace especificado com o ARM. No final, o aplicativo usa a cadeia de conexão recuperada para se conectar aos Hubs de Eventos do Azure. Dessa forma, a entidade de segurança fornecida deve ser concedida com a função Colaborador para recuperar o namespace associado dos Hubs de Eventos do Azure.

Para o Azure Spring Apps 4.0, fornecemos duas maneiras de aproveitar as entidades de segurança para autenticação. Uma ainda está usando as entidades de segurança para se conectar ao ARM e recuperar as cadeias de conexão em que a função Contributor é necessária para as entidades de segurança. O outro aproveita as entidades de segurança para se autenticar na ID do Microsoft Entra e, em seguida, conectar-se diretamente aos Hubs de Eventos do Azure. Nesse caso, a função Contributor não é mais necessária, enquanto outras funções relacionadas Data são necessárias para operações de mensagens. Para garantir que a entidade de segurança tenha recebido a permissão suficiente para acessar o recurso do Azure, consulte Autorizar acesso com a ID do Microsoft Entra.

Para autenticação com base no ARM, usando a entidade de serviço como exemplo, a migração de configuração é listada a seguir, em que a função atribuída não deve ser alterada:

Configuração herdada:

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}

Configuração moderna, as propriedades da ID da assinatura do Azure e do grupo de recursos são necessárias:

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}

Você também pode migrar para autenticar e autorizar com a ID do Microsoft Entra diretamente sem fazer um desvio para o ARM. Conceda à entidade de segurança as funções de Data necessárias para operações de mensagens. Os exemplos de configuração da entidade de serviço e da identidade gerenciada são listados da seguinte maneira:

• Com uma entidade de serviço

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

• Com uma identidade gerenciada

  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}
  

Alterações de API

A tabela a seguir mostra os mapeamentos de classe de azure-spring-cloud-stream-binder-eventhubs para spring-cloud-azure-stream-binder-eventhubs.

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

Este guia destina-se a ajudar na migração para spring-cloud-azure-stream-binder-servicebus da versão 2 do azure-spring-cloud-stream-binder-servicebus-queue ou azure-spring-cloud-stream-binder-servicebus-topic.

Para obter informações gerais, use os seguintes links:

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções de Introdução e de Migração.
• Para saber mais sobre as alterações de estratégia na nomenclatura do projeto, consulte a seção Alterações de nomenclatura.
• Para saber como usar um BOM para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.
• Para saber como lidar com a autenticação no Spring Cloud Azure 4.0, consulte a seção Alterações de Autenticação.
• Para saber como aproveitar spring-boot-properties-migrator durante a migração, consulte a seção Configurar cada SDK.
• Para saber mais sobre as alterações de configuração globais e comuns, consulte a seção de configurações globais .

Alterações na configuração do SDK

A tabela a seguir lista as novas propriedades de configuração de spring-cloud-azure-stream-binder-servicebus:

A tabela a seguir mostra os mapeamentos de propriedades de azure-spring-cloud-stream-binder-servicebus-* para spring-cloud-azure-stream-binder-servicebus:

Exemplos de migração de configuração

Configuração herdada, tomando fila como exemplo:

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

Configuração moderna:

spring:
  cloud:
    azure:
      servicebus:
        connection-string: ${AZURE_SERVICEBUS_BINDER_CONNECTION_STRING}
    stream:
      function:
        definition: consume;supply
      bindings:
        consume-in-0:
          destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
        supply-out-0:
          destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
      servicebus:
        bindings:
          consume-in-0:
            consumer:
              auto-complete: false
          supply-out-0:
            producer:
              entity-type: queue #set as topic if needed

Se você usar entidades de segurança em vez de cadeias de conexão, em versões antes da 4.0, o aplicativo primeiro se conectará ao ARM (Azure Resource Manager) com a entidade de segurança fornecida e, em seguida, recuperará a cadeia de conexão do namespace especificado com o ARM. No final, o aplicativo usa a cadeia de conexão recuperada para se conectar ao Barramento de Serviço do Azure. Dessa forma, a entidade de segurança fornecida deve ser concedida com a função Colaborador para recuperar o namespace do Barramento de Serviço do Azure associado.

Para o Azure Spring Apps 4.0, fornecemos duas maneiras de aproveitar as entidades de segurança para autenticação. Uma ainda está usando as entidades de segurança para se conectar ao ARM e recuperar as cadeias de conexão em que a função Contributor é necessária para as entidades de segurança. O outro aproveita as entidades de segurança para autenticar na ID do Microsoft Entra e, em seguida, conectar-se diretamente ao Barramento de Serviço do Azure. Nesse caso, a função Contributor não é mais necessária, enquanto outras funções relacionadas Data são necessárias para operações de mensagens. Para garantir que a entidade de segurança tenha recebido a permissão suficiente para acessar o recurso do Azure, consulte Autorizar acesso com a ID do Microsoft Entra.

Para autenticação com base no ARM, usando a entidade de serviço como exemplo, a migração de configuração é listada a seguir, em que a função atribuída não deve ser alterada:

Configuração herdada:

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}

Configuração moderna, as propriedades da ID da assinatura do Azure e do grupo de recursos são necessárias:

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}

Você também pode migrar para autenticar e autorizar com a ID do Microsoft Entra diretamente sem fazer um desvio para o ARM. Conceda à entidade de segurança as funções de Data necessárias para operações de mensagens. Os exemplos de configuração da entidade de serviço e da identidade gerenciada são listados da seguinte maneira:

• Com uma entidade de serviço

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

• Com uma identidade gerenciada

  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}
  

Alterações de API

• Remover o cabeçalho da mensagem AzureHeaders.RAW_ID. Em vez disso, use ServiceBusMessageHeaders.MESSAGE_ID.

A tabela a seguir mostra os mapeamentos de classe de azure-spring-cloud-stream-binder-eventhubs para spring-cloud-azure-stream-binder-eventhubs.

azure-spring-cloud-messaging

A biblioteca de com.azure.spring:azure-spring-cloud-messaging não está pronta para 4.0. A função de anotações do ouvinte está em reformulação, portanto, as anotações @AzureMessageListener, @AzureMessageListenerse @EnableAzureMessaging não têm suporte no momento.