Automatyczne konfigurowanie klientów zestawu Azure SDK

Platforma Spring Boot upraszcza programowanie platformy Azure spring Cloud. Szablony startowe platformy Azure spring Cloud to zestaw wygodnych deskryptorów zależności do uwzględnienia w aplikacji. Szablony startowe obsługują tworzenie wystąpień obiektów i logikę konfiguracji, więc nie trzeba tego robić. Każdy start zależy od spring-cloud-azure-starter, aby zapewnić krytyczne bity konfiguracji, takie jak środowisko chmury platformy Azure i informacje o uwierzytelnianiu. Można je skonfigurować jako właściwości w pliku YAML, jak pokazano w poniższym przykładzie:

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

Nuta

Właściwość cloud jest opcjonalna.

Dozwolone wartości dla tenant-id to: common, organizations, consumerslub identyfikator dzierżawy. Aby uzyskać więcej informacji na temat tych wartości, zobacz sekcję Użyto nieprawidłowego punktu końcowego (kont osobistych i organizacji) sekcji Błąd AADSTS50020 — konto użytkownika od dostawcy tożsamości nie istnieje wdzierżawy. Aby uzyskać informacje na temat konwertowania aplikacji z jedną dzierżawą, zobacz Convert single-tenant app to multitenant on Microsoft Entra ID.

Te właściwości są opcjonalne i, jeśli nie zostaną określone, platforma Spring Boot spróbuje automatycznie je znaleźć. Aby uzyskać szczegółowe informacje na temat sposobu odnajdywania tych właściwości przez platformę Spring Boot, zapoznaj się z dokumentacją.

Konfiguracja zależności

Istnieją dwa sposoby korzystania z szablonów startowych platformy Azure spring Cloud. Pierwszym sposobem jest użycie zestawów SDK platformy Azure z zależnością spring-cloud-azure-starter, jak pokazano w poniższym przykładzie:

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

Drugim sposobem jest uniknięcie dodawania zależności zestawu Azure SDK i zamiast tego dołączanie szablonu startowego Spring Cloud Azure dla każdej usługi bezpośrednio. Na przykład w usłudze Azure Cosmos DB należy dodać następującą zależność:

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

Napiwek

Aby uzyskać listę obsługiwanych szablonów startowych, zobacz sekcję Starter dependencies (Spring Cloud Azure developer guide).

Konfiguracja

Nuta

Jeśli używasz podmiotu zabezpieczeń do uwierzytelniania i autoryzacji za pomocą identyfikatora Entra firmy Microsoft na potrzeby uzyskiwania dostępu do zasobu platformy Azure, upewnij się, że podmiot zabezpieczeń otrzymał wystarczające uprawnienia dostępu do zasobu platformy Azure. Aby uzyskać więcej informacji, zobacz Authorize access with Microsoft Entra ID.

Właściwości konfiguracji dla każdej usługi platformy Azure mają prefiks spring.cloud.azure.<azure-service>.

Napiwek

Aby uzyskać listę wszystkich właściwości konfiguracji platformy Azure spring Cloud, zobacz Właściwości konfiguracji platformy Azure spring Cloud.

Podstawowe użycie

Dodanie następujących właściwości do pliku application.yaml spowoduje automatyczne skonfigurowanie klienta usługi Azure Cosmos DB.

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

Następnie zarówno CosmosClient, jak i CosmosAsyncClient są dostępne w kontekście i mogą być automatycznie wirowane, jak pokazano w poniższym przykładzie:

class Demo {
@Autowired
private CosmosClient cosmosClient;

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

Próbki

Zobacz repozytorium w witrynie azure-spring-boot-samples GitHub.