Configurar automaticamente os clientes do SDK do Azure

O Spring Boot simplifica a experiência de desenvolvimento do Spring Cloud Azure. Os starters do Spring Cloud Azure são um conjunto de descritores de dependências práticos para incluir na sua aplicação. Os starters encarregam-se da instanciação de objetos e da lógica de configuração, para que não tenha de tratar disso. Cada iniciante depende de spring-cloud-azure-starter para fornecer bits críticos de configuração, como o ambiente de nuvem do Azure e informações de autenticação. Você pode configurá-los 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}

Observação

A propriedade cloud é opcional.

Os valores permitidos para tenant-id são: common, organizations, consumersou o ID do locatário. Para obter mais informações sobre estes valores, consulte a secção Utilizou o ponto final errado (contas pessoais e organizacionais) de Erro AADSTS50020 - A conta de utilizador do fornecedor de identidades não existe no inquilino. 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.

Estas propriedades são opcionais. Se não os especificar, o Spring Boot tenta encontrá-los automaticamente para si. Para obter detalhes sobre como o Spring Boot encontra essas propriedades, consulte a documentação.

Configuração de dependência

Podes usar os starters do Spring Cloud Azure de duas formas. 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 forma é evitar adicionar dependências do SDK do Azure e, em vez disso, incluir diretamente o Spring Cloud Azure Starter para cada serviço. Por exemplo, com o Azure Cosmos DB, adiciona-se 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 suportados, consulte a secção Starter dependencies do guia do programador do Spring Cloud Azure.

Configuração

Observação

Se usar um principal de segurança para autenticar e autorizar no Microsoft Entra ID para aceder a um recurso do Azure, certifique-se de que o principal de segurança tem permissões suficientes para aceder ao recurso do Azure. Para obter mais informações, consulte Autorizar acesso com o Microsoft Entra ID.

As propriedades de configuração para cada serviço Azure estão sob o prefixo spring.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.

Utilização básica

Adicione as seguintes propriedades ao seu ficheiro 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

Depois, tanto CosmosClient como CosmosAsyncClient estão disponíveis no contexto e podes auto-ligá-los, como mostrado no exemplo seguinte:

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

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