Azure SDK-clients automatisch configureren

Spring Boot vereenvoudigt de ontwikkelervaring van Spring Cloud Azure. Spring Cloud Azure-starters zijn een set handige afhankelijkheidsdescriptors die u in uw toepassing kunt opnemen. De starters verwerken de object instantiërings- en configuratielogica, zodat u dat niet hoeft te doen. Elke starter is afhankelijk van spring-cloud-azure-starter om essentiële configuratie-bits te bieden, zoals de Azure-cloudomgeving en verificatiegegevens. U kunt deze als eigenschappen configureren in bijvoorbeeld een YAML-bestand, zoals wordt weergegeven in het volgende voorbeeld:

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

Notitie

De eigenschap cloud is optioneel.

De waarden die zijn toegestaan voor tenant-id zijn: common, organizations, consumersof de tenant-id. Zie voor meer informatie over deze waarden het Het verkeerde eindpunt (persoonlijke en organisatieaccounts) gebruikt sectie van Fout AADSTS50020 - Gebruikersaccount van id-provider bestaat niet in tenant. Zie App met één tenant converteren naar multitenant op Microsoft Entra IDvoor meer informatie over het converteren van uw app met één tenant.

Deze eigenschappen zijn optioneel. Als u ze niet opgeeft, probeert Spring Boot deze automatisch voor u te vinden. Raadpleeg de documentatie voor meer informatie over hoe Spring Boot deze eigenschappen vindt.

Afhankelijkheid instellen

U kunt Spring Cloud Azure starters op twee manieren gebruiken. De eerste manier is om Azure-SDK's te gebruiken met de spring-cloud-azure-starter-afhankelijkheid, zoals wordt weergegeven in het volgende voorbeeld:

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

De tweede manier is om te voorkomen dat Azure SDK afhankelijkheden worden toegevoegd en in plaats daarvan de Spring Cloud Azure Starter voor elke service rechtstreeks opneemt. Met Azure Cosmos DB voegt u bijvoorbeeld de volgende afhankelijkheid toe:

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

Tip

Zie de sectie Starter-afhankelijkheden van de Spring Cloud Azure-ontwikkelaarshandleidingvoor de lijst met ondersteunde starters.

Configuratie

Notitie

Als u een beveiligingsprincipaal gebruikt om te verifiëren en autoriseren met Microsoft Entra ID voor toegang tot een Azure-resource, moet u ervoor zorgen dat de beveiligingsprincipaal over voldoende machtigingen beschikt om toegang te krijgen tot de Azure resource. Zie Toegang autoriseren met Microsoft Entra IDvoor meer informatie.

Configuratie-eigenschappen voor elke Azure-service staan onder het voorvoegselspring.cloud.azure.<azure-service>.

Tip

Zie Configuratie-eigenschappen van Spring Cloud Azurevoor de lijst met alle eigenschappen van Spring Cloud Azure-configuratie.

Basisgebruik

Voeg de volgende eigenschappen toe aan het bestand application.yaml om de Azure Cosmos DB-client automatisch te configureren.

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

Vervolgens zijn zowel CosmosClient als CosmosAsyncClient beschikbaar in de context en kunt u ze automatisch injecteren, zoals in het volgende voorbeeld wordt weergegeven:

class Demo {
@Autowired
private CosmosClient cosmosClient;

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

Voorbeelden

Bekijk de azure-spring-boot-samples opslagplaats op GitHub.