Udostępnij przez


Szybki start: wdrażanie klastra usługi Azure DocumentDB przy użyciu Bicep

W tym przewodniku szybkiego startu wdrożysz nowy klaster usługi Azure DocumentDB przy użyciu języka Bicep. Ten przewodnik Szybki start zawiera instrukcje krok po kroku ułatwiające szybkie rozpoczęcie pracy. Ten klaster zawiera wszystkie zasoby bazy danych MongoDB, kolekcje i dokumenty. Zapewnia on unikatowy punkt końcowy dla narzędzi i zestawów SDK (Software Development Kit) w celu nawiązywania połączenia z usługą Azure DocumentDB i wykonywania operacji.

Wymagania wstępne

  • Subskrypcja platformy Azure

Konfigurowanie środowiska

Skonfiguruj środowisko interfejsu wiersza polecenia platformy Azure, aby zarządzać zasobami usługi Azure DocumentDB w ramach subskrypcji.

  1. Rozpocznij w pustym katalogu.

  2. Zaloguj się do Azure CLI.

    az login
    
  3. Sprawdź docelową subskrypcję platformy Azure.

    az account show
    

    Uwaga / Notatka

    Jeśli nie masz połączenia z oczekiwaną subskrypcją, użyj tego polecenia, aby zmienić subskrypcję:

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

    Aby uzyskać więcej informacji, zobacz Zarządzanie subskrypcjami platformy Azure za pomocą interfejsu wiersza polecenia platformy Azure.

Przygotuj szablon Bicep

Utwórz i skonfiguruj plik Bicep, aby zdefiniować zasoby wymagane do wdrożenia klastra usługi Azure DocumentDB.

  1. Utwórz nowy plik main.bicep w katalogu projektu.

  2. Dodaj ten szablon do zawartości pliku.

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

    Wskazówka

    Aby uzyskać więcej informacji na temat opcji przy użyciu Microsoft.DocumentDB/mongoclusters zasobu, zobacz Microsoft.DocumentDB/mongoclusters dokumentację.

Wdrażanie szablonu

Wdróż szablon utworzony w poprzednim kroku przy użyciu wdrożenia usługi Azure Resource Manager.

  1. Użyj polecenia , az group create aby utworzyć nową grupę zasobów w ramach subskrypcji.

    az group create \
        --name "<resource-group-name>" \
        --location "<location>"
    
  2. Użyj polecenia az deployment group create, aby wdrożyć szablon bicep. Następnie zostanie wyświetlony monit o wprowadzenie wartości parametrów adminUsername i adminPassword .

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

    Wskazówka

    Alternatywnie użyj --parameters opcji , aby przekazać plik parametrów ze wstępnie zdefiniowanymi wartościami.

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

    W tym przykładzie plik JSON wprowadza wartości clusteradmin oraz P@ssw.rd odpowiednio dla parametrów adminUsername i 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. Przed przejściem poczekaj na zakończenie operacji wdrażania.

Przeglądanie wdrożonych zasobów

Wyświetl listę zasobów usługi Azure DocumentDB wdrożonych w grupie zasobów.

  1. Użyj polecenia az resource list , aby uzyskać listę zasobów w grupie zasobów.

    az resource list \
        --resource-group "<resource-group-name>" \
        --namespace "Microsoft.DocumentDB" \
        --resource-type "mongoClusters" \
        --query "[].name" \
        --output json
    
  2. W przykładowych danych wyjściowych poszukaj zasobów, które mają typ Microsoft.DocumentDB/mongoClusters. Oto przykład typu danych wyjściowych, których można oczekiwać:

    [
      "msdocs-documentdb-example-cluster"
    ]
    

Uprzątnij zasoby

Po zakończeniu pracy z klastrem usługi Azure DocumentDB możesz usunąć utworzone zasoby platformy Azure, aby nie ponosić dodatkowych opłat.

  1. Użyj polecenia az group delete , aby usunąć grupę zasobów z subskrypcji.

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

    Ważne

    Przed uruchomieniem tego polecenia upewnij się, że zasoby nie są już potrzebne, ponieważ trwale je usuwa.