Condividi tramite


Guida introduttiva: Distribuire un cluster di Azure DocumentDB con Bicep

In questa guida introduttiva si distribuisce un nuovo cluster di Azure DocumentDB usando Bicep. Questa guida introduttiva fornisce istruzioni dettagliate per iniziare rapidamente. Questo cluster contiene tutte le risorse mongoDB: database, raccolte e documenti. Fornisce un endpoint univoco per gli strumenti e gli SDK (Software Development Kit) per connettersi ad Azure DocumentDB ed eseguire operazioni.

Prerequisiti

  • Una sottoscrizione di Azure

Configurare l'ambiente

Configurare l'ambiente di Azure CLI per gestire le risorse di Azure DocumentDB nel tuo abbonamento.

  1. Iniziare in una directory vuota.

  2. Accedere all'interfaccia della riga di comando di Azure.

    az login
    
  3. Verifica l'abbonamento Azure di destinazione.

    az account show
    

    Annotazioni

    Se non si è connessi alla sottoscrizione prevista, usare questo comando per modificare la sottoscrizione:

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

    Per altre informazioni, vedere Gestire le sottoscrizioni di Azure con l'interfaccia della riga di comando di Azure.

Preparare il modello Bicep

Creare e configurare un file Bicep per definire le risorse necessarie per la distribuzione di un cluster di Azure DocumentDB.

  1. Creare un nuovo file main.bicep nella directory del progetto.

  2. Aggiungere questo modello al contenuto del file.

    @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'
      }
    }
    

    Suggerimento

    Per informazioni sulle opzioni utilizzando la risorsa Microsoft.DocumentDB/mongoclusters, vedere la documentazione Microsoft.DocumentDB/mongoclusters.

Implementare il modello

Distribuire il modello creato nel passaggio precedente usando una distribuzione di Azure Resource Manager.

  1. Usare il az group create comando per creare un nuovo gruppo di risorse nella sottoscrizione.

    az group create \
        --name "<resource-group-name>" \
        --location "<location>"
    
  2. Usare az deployment group create per distribuire il modello Bicep. Verrà quindi richiesto di immettere un valore per i adminUsername parametri e adminPassword .

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

    Suggerimento

    In alternativa, usare l'opzione --parameters per passare un file di parametri con valori predefiniti.

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

    Questo file JSON di esempio inserisce clusteradmin e P@ssw.rd i valori rispettivamente per i adminUsername parametri e adminPassword .

    {
      "$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. Attendere il completamento dell'operazione di distribuzione prima di procedere.

Esaminare le risorse distribuite

Elencare le risorse di Azure DocumentDB distribuite nel gruppo di risorse.

  1. Usare az resource list per ottenere un elenco di risorse nel gruppo di risorse.

    az resource list \
        --resource-group "<resource-group-name>" \
        --namespace "Microsoft.DocumentDB" \
        --resource-type "mongoClusters" \
        --query "[].name" \
        --output json
    
  2. Nell'output di esempio, cerca le risorse che hanno un tipo di Microsoft.DocumentDB/mongoClusters. Di seguito è riportato un esempio del tipo di output previsto:

    [
      "msdocs-documentdb-example-cluster"
    ]
    

Pulire le risorse

Al termine dell'operazione con il cluster Azure DocumentDB, è possibile eliminare le risorse di Azure create in modo che non vengano addebitati altri addebiti.

  1. Usare az group delete per rimuovere il gruppo di risorse dalla sottoscrizione.

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

    Importante

    Assicurarsi che le risorse non siano più necessarie prima di eseguire questo comando, perché vengono eliminate definitivamente.