Delen via


Quickstart: Een Azure DocumentDB-cluster implementeren met Bicep

In deze quickstart implementeert u een nieuw Azure DocumentDB-cluster met bicep. 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 Bicep-sjabloon voorbereiden

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

  1. Maak een nieuw main.bicep-bestand in uw projectmap.

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

    @description('Cluster name')
    @minLength(8)
    @maxLength(40)
    param clusterName string = 'msdocs-${uniqueString(resourceGroup().id)}'
    
    @description('Location for the cluster.')
    param location string = resourceGroup().location
    
    @description('Username for admin user')
    param adminUsername string
    
    @secure()
    @description('Password for admin user')
    @minLength(8)
    @maxLength(128)
    param adminPassword string
    
    resource cluster 'Microsoft.DocumentDB/mongoClusters@2025-09-01' = {
      name: clusterName
      location: location
      properties: {
        administrator: {
          userName: adminUsername
          password: adminPassword
        }
        serverVersion: '8.0'
        sharding: {
          shardCount: 1
        }
        storage: {
          sizeGb: 32
        }
        highAvailability: {
          targetMode: 'Disabled'
        }
        compute: {
          tier: 'M10'
        }
      }
    }
    
    resource firewallRules 'Microsoft.DocumentDB/mongoClusters/firewallRules@2025-09-01' = {
      parent: cluster
      name: 'AllowAllAzureServices'
      properties: {
        startIpAddress: '0.0.0.0'
        endIpAddress: '0.0.0.0'
      }
    }
    

    Aanbeveling

    Zie de documentatie voor meer informatie over opties die de Microsoft.DocumentDB/mongoclusters resource gebruikenMicrosoft.DocumentDB/mongoclusters.

De sjabloon implementeren

Implementeer de sjabloon die u in de vorige stap hebt gemaakt met behulp van een Azure Resource Manager-implementatie.

  1. Gebruik de az group create opdracht om een nieuwe resourcegroep in uw abonnement te maken.

    az group create \
        --name "<resource-group-name>" \
        --location "<location>"
    
  2. Gebruik az deployment group create om de bicep-sjabloon uit te rollen. Vervolgens wordt u gevraagd om een waarde voor de adminUsername en adminPassword parameters in te voeren.

    az deployment group create \
        --resource-group "<resource-group-name>" \
        --template-file 'main.bicep'
    

    Aanbeveling

    U kunt ook de --parameters optie gebruiken om een parameterbestand met vooraf gedefinieerde waarden door te geven.

    az deployment group create \
        --resource-group "<resource-group-name>" \
        --template-file 'main.bicep' \
        --parameters @main.parameters.json
    

    Dit voorbeeld van een JSON-bestand injecteert clusteradmin en P@ssw.rd waarden voor respectievelijk de adminUsername en adminPassword parameters.

    {
      "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
      "contentVersion": "1.0.0.0",
      "parameters": {
        "adminUsername": {
          "value": "clusteradmin"
        },
        "adminPassword": {
          "value": "P@ssw.rd"
        }
      }
    }
    
  3. 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

Wanneer u klaar bent met uw Azure DocumentDB-cluster, kunt u de Azure-resources verwijderen die u hebt gemaakt, zodat er geen kosten in rekening worden gebracht.

  1. 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.