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

Este guia ajuda com a migração para o Spring Cloud Azure 4.0 a partir de bibliotecas herdadas do Azure Spring.

Introdução

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

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

A familiaridade com com.azure.spring:azure-spring-boot-*, com.azure.spring:azure-spring-cloud-* ou com.azure.spring:azure-spring-integration-* pacote é assumida.

Se você é novo nas bibliotecas do Spring Cloud Azure 4.0, consulte o Guia do desenvolvedor do Spring Cloud Azure em vez deste guia.

Benefícios da migração

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

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

Para melhorar a experiência de desenvolvimento nas 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 do Spring. Mais detalhes estão disponíveis no de documentos de design para os interessados.

O Spring Cloud Azure 4.0 fornece a experiência compartilhada entre bibliotecas integrando-se com diferentes projetos Spring, por exemplo, Spring Boot, Spring Integration, Spring Cloud Stream e assim por diante. A experiência partilhada inclui:

• Uma lista técnica unificada para incluir todas as bibliotecas do Spring Cloud Azure 4.0.
• Uma convenção de nomenclatura consistente para artefatos.
• Uma maneira unificada de configurar as configurações de credencial, proxy, nova tentativa, ambiente de nuvem e camada de transporte.
• Suporte a todos os métodos de autenticação suportados por um Serviço do Azure ou 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 artefatos: renomeado / adicionado / excluído
• Alterações de dependência
• Alterações de autenticação
• Propriedades de configuração
• Alterações de quebra de API
• Alterações na biblioteca

Alterações de nomenclatura

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

Lista técnica

Nós costumávamos enviar duas listas técnicas para nossas bibliotecas, a azure-spring-boot-bom e a azure-spring-cloud-dependencies, mas combinamos essas duas listas técnicas em uma lista técnica desde a 4.0, a spring-cloud-azure-dependencies. Adicione uma entrada na seção dependencyManagement do seu projeto para se beneficiar do gerenciamento de dependência.

<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 artefatos: renomeado / adicionado / excluído

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 Spring Cloud Azure foram alteradas. De acordo com o projeto Spring ao qual pertence, Spring Boot, Spring Integration ou Spring Cloud Stream, o padrão de IDs de artefato pode ser spring-cloud-azure-starter-[service], spring-integration-azure-[service]ou spring-cloud-azure-stream-binder-[service]. Os iniciadores herdados de cada um 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 legados.

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 melhor atender 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. Certifique-se de adicionar as dependências removidas manualmente ao seu 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 suportados por cada SDK de Serviço do Azure. Ele permite que você configure uma credencial de token global, bem como forneça 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 ele 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 do Azure de destino.

Uma credencial encadeada, o bean DefaultAzureCredential é configurado automaticamente por padrão e será usado por todos os componentes se não forem especificadas mais informações de autenticação. Para obter mais informações, consulte a seção DefaultAzureCredential de biblioteca de cliente do Azure Identity para Java.

Propriedades de configuração

Migração de propriedades

Criamos um arquivo de additional-spring-configuration-metadata.json para facilitar a migração de propriedade ao usar com o spring-boot-properties-migrator. Primeiro, adicione o seguinte migrador de propriedades 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, ela irá 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 tem de ser atualizada e a dependência removida depois de atualizar a configuração.

Antes de prosseguir, é uma boa ideia usar o recurso de pesquisa do IDE para verificar se você não está usando uma das propriedades migradas 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. Esse recurso não era suportado 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:

• De azure-spring-boot-starter-active-directory para spring-cloud-azure-starter-active-directory
• De azure-spring-boot-starter-active-directory-b2c para spring-cloud-azure-starter-active-directory-b2c
• De azure-spring-boot-starter-cosmos para spring-cloud-azure-starter-data-cosmos
• De azure-spring-boot-starter-keyvault-secrets para spring-cloud-azure-starter-keyvault-secrets
• De azure-spring-boot-starter-servicebus-jms para spring-cloud-azure-starter-servicebus-jms
• 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
• De azure-spring-cloud-starter-eventhubs para spring-cloud-azure-starter-integration-eventhubs
• De azure-spring-cloud-starter-servicebus para spring-cloud-azure-starter-integration-servicebus
• De azure-spring-cloud-starter-storage-queue para spring-cloud-azure-starter-integration-storage-queue
• De azure-spring-cloud-stream-binder-eventhubs para spring-cloud-azure-stream-binder-eventhubs
• De azure-spring-cloud-stream-binder-servicebus-* para spring-cloud-azure-stream-binder-servicebus

Alterações de quebra de API

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

• De azure-spring-boot-starter-active-directory para spring-cloud-azure-starter-active-directory
• De azure-spring-boot-starter-active-directory-b2c para spring-cloud-azure-starter-active-directory-b2c
• 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
• De azure-spring-cloud-starter-eventhubs para spring-cloud-azure-starter-integration-eventhubs
• De azure-spring-integration-eventhubs para spring-integration-azure-eventhubs
• De azure-spring-cloud-starter-servicebus para spring-cloud-azure-starter-integration-servicebus
• De azure-spring-integration-servicebus para spring-integration-azure-servicebus
• De azure-spring-cloud-starter-storage-queue para spring-cloud-azure-starter-integration-storage-queue
• De azure-spring-integration-storage-queue para spring-integration-azure-storage-queue
• De azure-spring-cloud-stream-binder-eventhubs para spring-cloud-azure-stream-binder-eventhubs
• De azure-spring-cloud-stream-binder-servicebus-* para spring-cloud-azure-stream-binder-servicebus

Alterações na biblioteca

As alterações de quebra em cada biblioteca são introduzidas da seguinte forma.

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

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter a partir da versão 3 doazure-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 Introdução e Benefícios da 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 uma lista técnica 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 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. Certifique-se de adicionar as dependências removidas manualmente ao seu projeto para evitar falhas não intencionais.

A tabela a seguir mostra as dependências removidas:

De azure-spring-boot-starter-active-directory para spring-cloud-azure-starter-active-directory

Este guia destina-se a ajudar na 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 Introdução e Benefícios da 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 uma lista técnica 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 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 seguintes são os principais a prestar atenção:

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

A tabela a seguir mostra os mapeamentos de propriedades 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

• São adicionadas as seguintes propriedades:

  • spring.cloud.azure.active-directory.enabled
  • spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint
  • spring.cloud.azure.active-directory.grupo-de-usuário.usar-membros-transitivos

Eis alguns exemplos de migração:

• Exemplo 1. Caso 1

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

  • Para moderno: 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 legado: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/transitiveMemberOf

  • Para moderno: 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 na 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

De azure-spring-boot-starter-active-directory-b2c para 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 Introdução e Benefícios da 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 uma lista técnica 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 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. Certifique-se de adicionar as dependências removidas manualmente 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 seguintes são os principais a prestar atenção:

1. Todos os nomes de propriedades de configuração alteraram o prefixo de azure.activedirectory.b2c para spring.cloud.azure.active-directory.b2c.
2. Novos spring.cloud.azure.active-directory.b2c.enabled de propriedade são adicionados 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-read-timeout

Alterações na 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:

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

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-data-cosmos a partir 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 Introdução e Benefícios da 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 uma lista técnica 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 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:

De azure-spring-boot-starter-keyvault-secrets para 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 Introdução e Benefícios da 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 uma lista técnica 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 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 de spring-cloud-azure-starter-keyvault-secrets

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

Os seguintes pontos 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 Key Vault Secret, incluir configurar beans de cliente secreto 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. 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 Cofre da Chave (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 de um recurso exclusivo do Azure, portanto, se não estiver configurado, não obterá valor de outros locais.

De azure-spring-boot-starter-servicebus-jms para 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 do 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 Introdução e Benefícios da 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 uma lista técnica 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 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 para legibilidade.

De azure-spring-boot-starter-storage para 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 Introdução e Benefícios da 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 uma lista técnica 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 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 na API

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

De azure-spring-boot-starter-storage para 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 Introdução e Benefícios da 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 uma lista técnica 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 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 na API

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

De azure-spring-cloud-starter-eventhubs para spring-cloud-azure-starter-integration-eventhubs

Este guia destina-se a ajudar na migração para spring-cloud-azure-starter-integration-eventhubs partir da versão 2 do 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 Introdução e Benefícios da 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 uma lista técnica 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 Configurações globais.

Alterações na configuração do SDK

Para alterações nas entradas filho para esse prefixo, consulte as tabelas a seguir:

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 na API

• Para obter as alterações nas anotações do ouvinte, consulte o guia de migração da 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 a consistência 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 compilação.
• Solte a API EventHubOperation#setCheckpointConfig. Para definir a configuração do ponto de verificação para o adaptador de canal de entrada, os usuários podem chamar o método EventHubsContainerProperties#setCheckpointConfig.
• Solte a API EventHubOperation#setBatchConsumerConfig. 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 dos cabeçalhos das mensagens convertidas de mensagens em lote.
  • Altere o cabeçalho da mensagem de azure_eventhub_enqueued_time para azure_eventhubs_batch_converted_enqueued_time.
  • Altere o cabeçalho da mensagem de azure_eventhub_offset para azure_eventhubs_batch_converted_offset.
  • Altere o cabeçalho da mensagem de azure_eventhub_sequence_number para azure_eventhubs_batch_converted_sequence_number.
  • Altere o cabeçalho da mensagem de azure_partition_key para azure_batch_converted_partition_key.
• Ao publicar mensagens em Hubs de Eventos, ignore todos os cabeçalhos de mensagens 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:

Exemplo de trecho de código

• EventHubsInboundChannelAdapter código de exemplo:

  Código legado:

  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 legado:

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

De azure-spring-integration-eventhubs a 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 Introdução e Benefícios da 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 uma lista técnica para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.

Alterações na 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 a consistência 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 compilação.
• Solte a API EventHubOperation#setCheckpointConfig. Para definir a configuração do ponto de verificação para o adaptador de canal de entrada, os usuários podem chamar o método EventHubsContainerProperties#setCheckpointConfig.
• Solte a API EventHubOperation#setBatchConsumerConfig. 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 dos cabeçalhos das mensagens convertidas de mensagens em lote.
  • Altere o cabeçalho da mensagem de azure_eventhub_enqueued_time para azure_eventhubs_batch_converted_enqueued_time.
  • Altere o cabeçalho da mensagem de azure_eventhub_offset para azure_eventhubs_batch_converted_offset.
  • Altere o cabeçalho da mensagem de azure_eventhub_sequence_number para azure_eventhubs_batch_converted_sequence_number.
  • Altere o cabeçalho da mensagem de azure_partition_key para azure_batch_converted_partition_key.
• Ao publicar mensagens em Hubs de Eventos, ignore todos os cabeçalhos de mensagens 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:

De azure-spring-cloud-starter-servicebus para 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 do 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 Introdução e Benefícios da 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 uma lista técnica 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 Configurações globais.

Alterações na configuração do SDK

Para todas as opções de configuração suportadas 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 na API

• Solte ServiceBusQueueOperation e ServiceBusTopicOperation com a função de assinatura movida para a classe ServiceBusMessageListenerContainer 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 Service Bus 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).
• Solte APIs ServiceBusQueueOperation#setCheckpointConfig e ServiceBusTopicOperation#setCheckpointConfig. Para definir a configuração do ponto de verificação para o adaptador de canal de entrada, os usuários podem chamar o método ServiceBusContainerProperties#setAutoComplete em vez disso. Para desativar o modo de preenchimento automático é equivalente a MANUAL modo de ponto de verificação e para ativá-lo irá acionar o modo RECORD.
• Solte APIs ServiceBusQueueOperatio#setClientConfig e ServiceBusTopicOperation#setClientConfig. Para configurar o ServiceBusProcessorClient subjacente usado pelo adaptador de canal de entrada, os usuários podem usá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.
• Solte o cabeçalho da mensagem AzureHeaders.RAW_ID. Use ServiceBusMessageHeaders.MESSAGE_ID em vez disso.

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

Exemplo de trecho de código

• ServiceBusInboundChannelAdapter código de exemplo:

  Código herdado do uso de 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, tomando a 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;
      }
  }
  

De azure-spring-integration-servicebus para 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 Introdução e Benefícios da 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 uma lista técnica para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.

Alterações na API

• Solte ServiceBusQueueOperation e ServiceBusTopicOperation com a função de assinatura movida para a classe ServiceBusMessageListenerContainer 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 Service Bus 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).
• Solte APIs ServiceBusQueueOperation#setCheckpointConfig e ServiceBusTopicOperation#setCheckpointConfig. Para definir a configuração do ponto de verificação para o adaptador de canal de entrada, os usuários podem chamar o método ServiceBusContainerProperties#setAutoComplete em vez disso. Para desativar o modo de preenchimento automático é equivalente a MANUAL modo de ponto de verificação e para ativá-lo irá acionar o modo RECORD.
• Solte APIs ServiceBusQueueOperation#setClientConfig e ServiceBusTopicOperation#setClientConfig. Para configurar o ServiceBusProcessorClient subjacente usado pelo adaptador de canal de entrada, os usuários podem usá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.
• Solte o cabeçalho da mensagem AzureHeaders.RAW_ID. Use ServiceBusMessageHeaders.MESSAGE_ID em vez disso.

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

De 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 Introdução e Benefícios da 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 uma lista técnica 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 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 na API

• Solte StorageQueueOperation e forneça StorageQueueTemplate em vez disso.
• Solte checkpoint-mode configuração no StorageQueueTemplate, suporte apenas o 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.

De azure-spring-integration-storage-queue para spring-integration-azure-storage-queue

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

• Para obter uma visão geral das alterações na versão 4.0, consulte as seções Introdução e Benefícios da 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 uma lista técnica para todas as bibliotecas do Spring Cloud Azure, consulte a seção BOM.

Alterações na API

• Solte StorageQueueOperation e forneça StorageQueueTemplate em vez disso.
• Solte checkpoint-mode configuração no StorageQueueTemplate, suporte apenas o 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 para 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 do 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 Introdução e Benefícios da 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 uma lista técnica 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 Configurações globais.

Alterações na configuração do SDK

Para 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 forma:

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 anteriores à 4.0, o aplicativo primeiro se conectará ao Azure Resource Manager (ARM) com a entidade de segurança fornecida e, em seguida, recuperará a cadeia de conexão do namespace especificado com 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 receber a função de de 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. Um ainda está usando os principais para se conectar ao ARM e recuperar as cadeias de conexão onde a função Contributor é necessária para os principais. O outro aproveita as entidades de segurança para autenticar a 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 a Data são necessárias para operações de mensagens. Para se certificar de que a entidade de segurança recebeu a permissão suficiente para aceder ao recurso do Azure, consulte Autorizar acesso com o Microsoft Entra ID.

Para autenticação baseada em ARM, tomando a entidade de serviço como exemplo, a migração de configuração é listada da seguinte forma, onde 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}

A configuração moderna, as propriedades para a ID de assinatura do Azure e o grupo de recursos são necessários:

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 o Microsoft Entra ID diretamente sem fazer um desvio para ARM. Certifique-se de conceder a entidade de segurança necessária Data funções para operações de mensagens. Os exemplos de configuração da entidade de serviço e da identidade gerenciada estão listados da seguinte forma:

• 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 na 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-* para 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 Introdução e Benefícios da 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 uma lista técnica 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 Configurações globais.

Alterações na configuração do SDK

A tabela a seguir lista as novas propriedades de configuração do 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 a 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 anteriores à 4.0, o aplicativo primeiro se conectará ao Azure Resource Manager (ARM) com a entidade de segurança fornecida e, em seguida, recuperará a cadeia de conexão do namespace especificado com 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 de de Colaborador para recuperar o namespace associado do Barramento de Serviço do Azure.

Para o Azure Spring Apps 4.0, fornecemos duas maneiras de aproveitar as entidades de segurança para autenticação. Um ainda está usando os principais para se conectar ao ARM e recuperar as cadeias de conexão onde a função Contributor é necessária para os principais. O outro aproveita as entidades de segurança para autenticar a 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 a Data são necessárias para operações de mensagens. Para se certificar de que a entidade de segurança recebeu a permissão suficiente para aceder ao recurso do Azure, consulte Autorizar acesso com o Microsoft Entra ID.

Para autenticação baseada em ARM, tomando a entidade de serviço como exemplo, a migração de configuração é listada da seguinte forma, onde 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}

A configuração moderna, as propriedades para a ID de assinatura do Azure e o grupo de recursos são necessários:

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 o Microsoft Entra ID diretamente sem fazer um desvio para ARM. Certifique-se de conceder a entidade de segurança necessária Data funções para operações de mensagens. Os exemplos de configuração da entidade de serviço e da identidade gerenciada estão listados da seguinte forma:

• 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 na API

• Solte o cabeçalho da mensagem AzureHeaders.RAW_ID. Use ServiceBusMessageHeaders.MESSAGE_ID em vez disso.

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 com.azure.spring:azure-spring-cloud-messaging não está pronta para a versão 4.0. A função de anotações de ouvinte está sendo redesenhada, portanto, as anotações @AzureMessageListener, @AzureMessageListenerse @EnableAzureMessaging não são suportadas no momento.