Поделиться через

Краткое руководство: Разверните кластер Azure DocumentDB, используя Bicep

В этом кратком руководстве описано, как развернуть новый кластер Azure DocumentDB с помощью Bicep. В этом кратком руководстве приведены пошаговые инструкции, которые помогут вам быстро приступить к работе. Этот кластер содержит все ресурсы MongoDB: базы данных, коллекции и документы. Она предоставляет уникальную конечную точку для средств и пакетов SDK для подключения к Azure DocumentDB и выполнения операций.

Предпосылки

Настройка среды

Настройте среду Azure CLI для управления ресурсами Azure DocumentDB в подписке.

  1. Начните в пустом каталоге.

  2. Войдите в Azure CLI.

    az login

  3. Проверьте целевую подписку Azure.

    az account show

    Замечание

    Если вы не подключены к ожидаемой подписке, используйте эту команду, чтобы изменить подписку:

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

    Дополнительные сведения см. в статье об управлении подписками Azure с помощью Azure CLI.

Подготовка шаблона Bicep

Создайте и настройте Bicep-файл, чтобы определить ресурсы, необходимые для развертывания кластера Azure DocumentDB.

  1. Создайте файл main.bicep в каталоге проекта.

  2. Добавьте этот шаблон в содержимое файла.

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

    Подсказка

    Дополнительные сведения о параметрах ресурса Microsoft.DocumentDB/mongoclusters см. в документации Microsoft.DocumentDB/mongoclusters.

Развертывание шаблона

Разверните шаблон, созданный на предыдущем шаге, с помощью развертывания Azure Resource Manager.

  1. az group create Используйте команду для создания новой группы ресурсов в подписке.

    az group create \
    --name "<resource-group-name>" \
    --location "<location>"

  2. Используйте az deployment group create для развертывания шаблона Bicep. Затем вам будет предложено ввести значение для adminUsername параметров и adminPassword параметров.

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

    Подсказка

    Кроме того, используйте --parameters параметр для передачи файла параметров с предопределенными значениями.

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

    В этом примере JSON-файл внедряет значения clusteradmin и P@ssw.rd для параметров adminUsername и 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. Дождитесь завершения операции развертывания перед переходом.

Проверка развернутых ресурсов

Перечислите ресурсы Azure DocumentDB, развернутые в группе ресурсов.

  1. Используйте az resource list, чтобы получить список ресурсов в вашей группе ресурсов.

    az resource list \
    --resource-group "<resource-group-name>" \
    --namespace "Microsoft.DocumentDB" \
    --resource-type "mongoClusters" \
    --query "[].name" \
    --output json

  2. В примере выходных данных найдите ресурсы с типом Microsoft.DocumentDB/mongoClusters. Ниже приведен пример типа выходных данных, которые следует ожидать:

    [
  "msdocs-documentdb-example-cluster"
]

Очистите ресурсы

После завершения работы с кластером Azure DocumentDB можно удалить созданные ресурсы Azure, чтобы не взиматься дополнительная плата.

  1. Используется az group delete для удаления группы ресурсов из подписки.

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

    Это важно

    Убедитесь, что перед выполнением этой команды ресурсы больше не требуются, так как они удаляются безвозвратно.

Связанный контент

  • Last updated on