Referência de configuração Spring Cloud Azure

  • Aplica-se a: ✅ Version 4.20.0, ✅ Version 5.25.0, ✅ Version 6.5.0, ✅ Version 7.4.0

Este artigo descreve todas as propriedades comuns de configuração do Spring Cloud Azure, incluindo definições para autenticação, transporte do cliente, opções de proxy, comportamento de retentativas e configuração do ambiente cloud entre SDKs de serviços Azure baseados em HTTP e em AMQP.

Configuração para cada SDK do Serviço do Azure

A maioria dos SDKs de Serviço do Azure pode ser dividida em duas categorias por tipo de transporte: baseado em HTTP ou baseado em AMQP. Há propriedades que são comuns a todos os SDKs, como entidades de autenticação e configurações de ambiente do Azure, ou comuns a clientes baseados em HTTP, como nível de log para registrar solicitações e respostas HTTP. A partir do Spring Cloud Azure 4.0, adicionamos cinco categorias comuns de propriedades de configuração que você pode especificar para cada serviço do Azure.

A tabela a seguir lista as propriedades comuns a vários serviços:

Propriedade Descrição
spring.cloud.azure.azure-service.client Configura os clientes de transporte abaixo de um SDK de serviço do Azure.
spring.cloud.azure.azure-service.credential Configura a autenticação com o Microsoft Entra ID para um SDK de serviço do Azure.
spring.cloud.azure.azure-service.profile Configura o ambiente de nuvem do Azure para um SDK de serviço do Azure.
spring.cloud.azure.azure-service.proxy Configura as opções de proxy para um SDK de serviço do Azure.
spring.cloud.azure.azure-service.retry Configura as opções de repetição aplicáveis a um SDK de serviço do Azure. As opções de retentativa suportaram parte dos SDKs, não spring.cloud.azure.cosmos.retryhá .

Os prefixos de propriedades de configuração foram unificados para o namespace spring.cloud.azure desde o Spring Cloud Azure 4.0 para tornar as propriedades de configuração mais consistentes e intuitivas. A tabela a seguir fornece uma revisão rápida dos prefixos para serviços do Azure com suporte:

Serviço do Azure Prefixo da propriedade de configuração Link de propriedades de configuração
Azure App Configuration spring.cloud.azure.appconfiguration propriedades de configuração da Configuração do Aplicativo
Azure Cosmos DB spring.cloud.azure.cosmos propriedades de configuração do Azure Cosmos DB
Hubs de Eventos do Azure spring.cloud.azure.eventhubs propriedades de configuração dos Hubs de Eventos
Certificado do Azure Key Vault spring.cloud.azure.keyvault.certificate propriedades de configuração dos Certificados do Cofre da Chave
Segredo do Azure Key Vault spring.cloud.azure.keyvault.secret propriedades de configuração do Key Vault Secrets
Azure Service Bus spring.cloud.azure.servicebus propriedades de configuração do Service Bus
Armazenamento do Azure Blob spring.cloud.azure.storage.blob propriedades de configuração do Blob de Armazenamento
Compartilhamento de arquivos de armazenamento do Azure spring.cloud.azure.storage.fileshare Propriedades de configuração do Compartilhamento de Arquivos de Armazenamento
Fila de Armazenamento do Azure spring.cloud.azure.storage.queue propriedades de configuração da fila de armazenamento

Configuração global para SDKs de Serviço do Azure

Há algumas propriedades que você pode compartilhar entre diferentes serviços do Azure, por exemplo, para usar a mesma entidade de serviço para acessar o Azure Cosmos DB e os Hubs de Eventos do Azure. O Spring Cloud Azure 4.0 permite definir propriedades que se aplicam a todos os SDKs do Azure no namespace spring.cloud.azure.

A tabela a seguir lista as propriedades globais:

Propriedade Descrição
spring.cloud.azure.client Configura os clientes de transporte; aplica-se a todos os SDKs do Azure por padrão.
spring.cloud.azure.credential Configura a autenticação com o Microsoft Entra ID para todos os SDKs do Azure por padrão.
spring.cloud.azure.profile Configura o ambiente de nuvem do Azure para todos os SDKs do Azure por padrão.
spring.cloud.azure.proxy Configura as opções de proxy aplicáveis a todos os clientes do SDK do Azure por padrão.
spring.cloud.azure.retry Configura as opções de repetição aplicáveis a todos os clientes do SDK do Azure por padrão.

Observação

As propriedades configuradas em cada serviço do Azure substituirão as configurações globais.

Exemplos de configuração

Configuração de repetição global para SDKs de Serviço do Azure

O exemplo a seguir mostra como configurar o comportamento de repetição para qualquer cliente do SDK do Azure baseado no protocolo HTTP ou AMQP:

spring.cloud.azure:
  retry:
    mode: exponential
    exponential:
      max-retries: 4
      base-delay: PT0.0801S
      max-delay: PT9S

Repetir configuração para a origem da propriedade Key Vault

O exemplo de configuração a seguir mostra como configurar o comportamento de repetição para o cliente Segredo do Cofre de Chaves do Azure:

spring.cloud.azure:
  keyvault:
    secret:
      property-source-enabled: true
      property-sources:
        - endpoint: <your-Azure-Key-Vault-endpoint>
          retry:
            mode: exponential
            exponential:
              max-retries: 4
              base-delay: PT0.0801S
              max-delay: PT9S
  • Last updated on