Delen via


Quickstart: Een Azure DocumentDB-cluster implementeren met Behulp van Terraform

In deze quickstart implementeert u een nieuw Azure DocumentDB-cluster met behulp van Terraform. Deze quickstart bevat stapsgewijze instructies om snel aan de slag te gaan. Dit cluster bevat al uw MongoDB-resources: databases, verzamelingen en documenten. Het biedt een uniek eindpunt voor hulpprogramma's en SDK's (Software Development Kits) om verbinding te maken met Azure DocumentDB en bewerkingen uit te voeren.

Vereiste voorwaarden

  • Een Azure-abonnement

Omgeving configureren

Stel uw Azure CLI-omgeving in om Azure DocumentDB-resources in uw abonnement te beheren.

  1. Begin in een lege map.

  2. Meld u aan bij Azure CLI.

    az login
    
  3. Controleer uw Azure-doelabonnement.

    az account show
    

    Opmerking

    Als u niet bent verbonden met het verwachte abonnement, gebruikt u deze opdracht om uw abonnement te wijzigen:

    az account set --subscription "<subscription-name>"
    

    Zie Azure-abonnementen beheren met de Azure CLI voor meer informatie.

De Terraform-configuratie voorbereiden

Maak en configureer een Terraform-bestand om de resources te definiëren die nodig zijn voor het implementeren van een Azure DocumentDB-cluster.

  1. Maak een nieuw main.tf-bestand in de projectmap.

  2. Voeg deze configuratie toe aan de inhoud van het bestand.

    variable "admin_username" {
      type = string
      description = "Username for default administrator account"
    }
    
    variable "admin_password" {
      type = string
      description = "Password for default administrator account"
      sensitive = true
    }
    
    terraform {
      required_providers {
        azurerm = {
          source = "hashicorp/azurerm"
          version = "~> 4.0"
        }
      }
    }
    
    provider "azurerm" {
      features { }
    }
    
    resource "azurerm_resource_group" "resource_group" {
      name     = "example-resource-group"
      location = "West US"
    }
    
    resource "azurerm_mongo_cluster" "cluster" {
      name                   = "example-mongo-cluster"
      resource_group_name    = azurerm_resource_group.resource_group.name
      location               = azurerm_resource_group.resource_group.location
      administrator_username = var.admin_username
      administrator_password = var.admin_password
      shard_count            = "1"
      compute_tier           = "M10"
      high_availability_mode = "Disabled"
      storage_size_in_gb     = "32"
      version                = "8.0"
    }
    

    Aanbeveling

    Zie de providerdocumentatie in de Terraform Registry voor meer informatie over opties voor het gebruik van de azurerm_mongo_cluster resource.

De configuratie implementeren

Implementeer het configuratiebestand dat u in de vorige stap hebt gemaakt met behulp van een uitvoeringsplan.

  1. Initialiseer de Terraform-implementatie met Terraform CLI.

    terraform init --upgrade
    
  2. Maak een uitvoeringsplan en sla het op in een bestand met de naam main.tfplan. Geef waarden op wanneer u hierom wordt gevraagd admin_username en admin_password variabelen.

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform plan --out "main.tfplan"
    

    Opmerking

    Met deze opdracht wordt de ARM_SUBSCRIPTION_ID omgevingsvariabele tijdelijk ingesteld. Deze instelling is vereist voor de azurerm provider vanaf versie 4.0. Voor meer informatie, zie subscription ID in azurerm.

  3. Pas het uitvoeringsplan toe om resources te implementeren in Azure.

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform apply "main.tfplan"
    
  4. Wacht tot de implementatiebewerking is voltooid voordat u verdergaat.

Geïmplementeerde middelen beoordelen

Vermeld de Azure DocumentDB-resources die zijn geïmplementeerd in uw resourcegroep.

  1. Gebruik az resource list om een lijst met resources in uw resourcegroep op te halen.

    az resource list \
        --resource-group "<resource-group-name>" \
        --namespace "Microsoft.DocumentDB" \
        --resource-type "mongoClusters" \
        --query "[].name" \
        --output json
    
  2. Zoek in de voorbeelduitvoer naar resources met een type Microsoft.DocumentDB/mongoClusters. Hier volgt een voorbeeld van het type uitvoer dat u kunt verwachten:

    [
      "msdocs-documentdb-example-cluster"
    ]
    

De hulpbronnen opschonen

Verwijder alle resources die zijn gedefinieerd in uw Terraform-configuratie.

  1. Vernietig uw resources die worden beheerd door Terraform met behulp van het destroy commando.

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform destroy
    

    Aanbeveling

    Alternatief, gebruik az group delete om de resourcegroep uit uw abonnement te verwijderen:

    az group delete \
        --name "<resource-group-name>" \
        --yes \
        --no-wait
    

    Belangrijk

    Zorg ervoor dat u de resources niet meer nodig hebt voordat u deze opdracht uitvoert, omdat deze definitief worden verwijderd.

  2. Bevestig alle relevante aanwijzingen om door te gaan met het verwijderen.