共用方式為


快速入門:使用 Terraform 部署 Azure DocumentDB 叢集

在這個快速入門中,你將使用 Terraform 部署一個新的 Azure DocumentDB 叢集。 這個快速入門提供逐步指引,幫助你快速開始。 這個叢集包含你所有的 MongoDB 資源:資料庫、收藏和文件。 它提供一個獨特的端點,讓工具與軟體開發套件(SDK)連接 Azure DocumentDB 並執行操作。

先決條件

  • Azure 訂用帳戶

    • 如果您沒有 Azure 訂用帳戶,請建立 免費帳戶

設定環境

設定你的 Azure CLI 環境,管理訂閱中的 Azure DocumentDB 資源。

  1. 從空白目錄開始。

  2. 登入 Azure CLI。

    az login
    
  3. 請檢查您的目標 Azure 訂用帳戶。

    az account show
    

    備註

    如果你沒有連接到預期的訂閱,請使用這個指令更改你的訂閱:

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

    欲了解更多資訊,請參閱 使用 Azure CLI 管理 Azure 訂閱

準備 Terraform 設定

建立並設定一個 Terraform 檔案,以定義部署 Azure DocumentDB 叢集所需的資源。

  1. 在你的專案目錄中建立一個新的 main.tf 檔案。

  2. 將此設定加入檔案內容中。

    variable "admin_username" {
      type = string
      description = "Username for default administrator account"
    }
    
    variable "admin_password" {
      type = string
      description = "Password for default administrator account"
      sensitive = true
    }
    
    terraform {
      required_providers {
        azurerm = {
          source = "hashicorp/azurerm"
          version = "~> 4.0"
        }
      }
    }
    
    provider "azurerm" {
      features { }
    }
    
    resource "azurerm_resource_group" "resource_group" {
      name     = "example-resource-group"
      location = "West US"
    }
    
    resource "azurerm_mongo_cluster" "cluster" {
      name                   = "example-mongo-cluster"
      resource_group_name    = azurerm_resource_group.resource_group.name
      location               = azurerm_resource_group.resource_group.location
      administrator_username = var.admin_username
      administrator_password = var.admin_password
      shard_count            = "1"
      compute_tier           = "M10"
      high_availability_mode = "Disabled"
      storage_size_in_gb     = "32"
      version                = "8.0"
    }
    

    小提示

    欲了解更多使用該 azurerm_mongo_cluster 資源的選項資訊,請參閱 azurerm Terraform 註冊局中的提供者文件

部署設定

使用執行計畫部署前一步建立的設定檔。

  1. 使用 Terraform CLI 初始化 Terraform 部署。

    terraform init --upgrade
    
  2. 建立執行計畫,並儲存到一個名為 main.tfplan 的檔案。 當被要求提供 admin_usernameadmin_password 變數時,提供數值。

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform plan --out "main.tfplan"
    

    備註

    此指令暫時設定 ARM_SUBSCRIPTION_ID 環境變數。 此為從版本 4.0 開始的 azurerm 提供者的必要設定。如需詳細資訊,請參閱 azurerm 中的訂用帳戶 ID

  3. 套用執行計畫來部署資源到 Azure。

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform apply "main.tfplan"
    
  4. 等部署作業完成後再繼續。

檢閱已部署的資源

列出已部署到你的資源群組的 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"
    ]
    

清理資源

移除 Terraform 設定中所有定義的資源。

  1. 用指令 destroy 銷毀由 Terraform 管理的資源。

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform destroy
    

    小提示

    或者,您也可以使用 az group delete 以下方式將資源群組從您的訂閱中移除:

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

    這很重要

    執行這個指令前,請確定你不再需要這些資源,因為這會永久刪除它們。

  2. 請確認任何與繼續刪除相關的提示。