Configurar automaticamente clientes do SDK do Azure

O Spring Boot simplifica a experiência de desenvolvimento do Spring Cloud Azure. Os iniciadores do Spring Cloud Azure são um conjunto de descritores de dependência convenientes a serem incluídos em seu aplicativo. Os starters cuidam da instanciação de objetos e da lógica de configuração, para que você não precise se preocupar com isso. Cada início depende de spring-cloud-azure-starter para fornecer bits críticos de configuração, como o ambiente de nuvem do Azure e as informações de autenticação. Você pode configurá-las como propriedades em, por exemplo, um arquivo YAML, conforme mostrado no exemplo a seguir:

spring:
  cloud:
    azure:
      profile:
        tenant-id: <tenant>
        cloud-type: Azure
      credential:
        client-id: ${AZURE_CLIENT_ID}

Nota

A propriedade cloud é opcional.

Os valores permitidos para tenant-id são: common, organizations, consumersou a ID do locatário. Para obter mais informações sobre esses valores, consulte a seção Uso do ponto de extremidade incorreto (contas pessoais e de organização) do Error AADSTS50020 – A conta de usuário do provedor de identidade não existe no locatário. Para obter informações sobre como converter seu aplicativo de locatário único, consulte Converter aplicativo de locatário único em multilocatário no Microsoft Entra ID.

Essas propriedades são opcionais. Se você não especificá-las, o Spring Boot tentará encontrá-las automaticamente para você. Para obter detalhes sobre como o Spring Boot localiza essas propriedades, consulte a documentação.

Configuração de dependência

Você pode usar os starters do Spring Cloud Azure de duas maneiras. A primeira maneira é usar os SDKs do Azure com a dependência spring-cloud-azure-starter, conforme mostrado no exemplo a seguir:

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-cosmos</artifactId>
</dependency>
<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>

A segunda maneira é evitar adicionar dependências do SDK do Azure e, em vez disso, incluir o Spring Cloud Azure Starter diretamente para cada serviço. Por exemplo, com Azure Cosmos DB, você adiciona a seguinte dependência:

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter-cosmos</artifactId>
</dependency>

Dica

Para obter a lista de starters compatíveis, consulte a seção Starter dependencies do Spring Cloud Azure developer guide.

Configuração

Nota

Se você usar uma entidade de segurança para autenticar e autorizar com Microsoft Entra ID para acessar um recurso de Azure, verifique se a entidade de segurança tem permissão suficiente para acessar o recurso de Azure. Para obter mais informações, consulte Autorizar o acesso com o Microsoft Entra ID.

As propriedades de configuração para cada serviço Azure estão sob o prefixospring.cloud.azure.<azure-service>.

Dica

Para obter a lista de todas as propriedades de configuração do Spring Cloud Azure, consulte propriedades de configuração do Spring Cloud Azure.

Uso básico

Adicione as propriedades a seguir ao arquivo application.yaml para configurar automaticamente o cliente Azure Cosmos DB.

spring:
  cloud:
    azure:
      cosmos:
        database: ${AZURE_COSMOS_DATABASE_NAME}
        endpoint: ${AZURE_COSMOS_ENDPOINT}
        consistency-level: eventual
        connection-mode: direct

Em seguida, ambos CosmosClient e CosmosAsyncClient estão disponíveis no contexto e você pode configurá-los automaticamente, conforme mostrado no exemplo a seguir:

class Demo {
@Autowired
private CosmosClient cosmosClient;

    @Override
    public void run() {
        User item = User.randomUser();
        CosmosContainer container = cosmosClient.getDatabase(databaseName).getContainer(containerName);
        container.createItem(item);
    }
}

Amostras

Consulte o azure-spring-boot-samples repositório no GitHub.