Compartilhar via

Início Rápido: Implantar um cluster do Azure DocumentDB usando o Bicep

Neste início rápido, você implantará um novo cluster do Azure DocumentDB usando o Bicep. Este início rápido fornece instruções passo a passo para ajudá-lo a começar rapidamente. Esse cluster contém todos os recursos do MongoDB: bancos de dados, coleções e documentos. Ele fornece um ponto de extremidade exclusivo para ferramentas e kits de desenvolvimento de software (SDKs) se conectarem ao Azure DocumentDB e realizarem operações.

Pré-requisitos

  • Uma assinatura do Azure

    • Se você não tiver uma assinatura do Azure, crie uma conta gratuita

Configurar o ambiente

Configure seu ambiente da CLI do Azure para gerenciar recursos do Azure DocumentDB em sua assinatura.

  1. Inicie em um diretório vazio.

  2. Entre na CLI do Azure.

    az login

  3. Verifique sua assinatura do Azure de destino.

    az account show

    Observação

    Se você não estiver conectado à assinatura esperada, use este comando para alterar sua assinatura:

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

    Para obter mais informações, consulte gerenciar assinaturas do Azure com a CLI do Azure.

Preparar o modelo Bicep

Crie e configure um arquivo Bicep para definir os recursos necessários para implantar um cluster do Azure DocumentDB.

  1. Crie um novo arquivo main.bicep no diretório do projeto.

  2. Adicione este modelo ao conteúdo do arquivo.

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

    Dica

    Para obter mais informações sobre as opções que usam o Microsoft.DocumentDB/mongoclusters recurso, consulte Microsoft.DocumentDB/mongoclusters a documentação.

Implantar o modelo

Implante o modelo criado na etapa anterior usando uma implantação do Azure Resource Manager.

  1. Use o az group create comando para criar um novo grupo de recursos em sua assinatura.

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

  2. Use az deployment group create para implantar o modelo bicep. Em seguida, você será solicitado a inserir um valor para os parâmetros adminUsername e adminPassword.

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

    Dica

    Como alternativa, use a opção --parameters para passar um arquivo de parâmetros com valores predefinidos.

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

    Este exemplo de arquivo JSON injeta os valores clusteradmin e P@ssw.rd para os parâmetros adminUsername e adminPassword, respectivamente.

    {
  "$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. Aguarde a conclusão da operação de implantação antes de continuar.

Examinar os recursos implantados

Liste os recursos do Azure DocumentDB implantados em seu grupo de recursos.

  1. Use az resource list para obter uma lista de recursos em seu grupo de recursos.

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

  2. Na saída de exemplo, procure recursos que tenham um tipo de Microsoft.DocumentDB/mongoClusters. Aqui está um exemplo do tipo de saída a ser esperado:

    [
  "msdocs-documentdb-example-cluster"
]

Limpar os recursos

Quando terminar de usar o cluster do Azure DocumentDB, você poderá excluir os recursos do Azure criados para não incorrer em mais encargos.

  1. Use az group delete para remover o grupo de recursos da sua assinatura.

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

    Importante

    Verifique se você não precisa mais dos recursos antes de executar esse comando, pois ele os exclui permanentemente.

Conteúdo relacionado

  • Last updated on