快速入門：使用 Bicep 範本建立 Azure Cosmos DB for MongoDB 虛擬核心叢集

適用於： MongoDB 虛擬核心

在本快速入門中，您會建立新的 Azure Cosmos DB for MongoDB 虛擬核心叢集。 此叢集包含您的所有 MongoDB 資源：資料庫、集合和文件。 此叢集為各種工具和 SDK 提供唯一的端點，用以連線至 Azure Cosmos DB 並執行日常作業。

必要條件

• 具有有效訂用帳戶的 Azure 帳戶。 免費建立帳戶。

檢閱 Bicep 檔案

此快速入門中使用的 Bicep 檔案是來自 Azure 快速入門範本。

@description('Azure Cosmos DB MongoDB vCore cluster name')
@maxLength(44)
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@2022-10-15-preview' = {
  name: clusterName
  location: location
  properties: {
    administratorLogin: adminUsername
    administratorLoginPassword: adminPassword
    nodeGroupSpecs: [
        {
            kind: 'Shard'
            shardCount: 1
            sku: 'M40'
            diskSizeGB: 128
            enableHa: false
        }
    ]
  }
}

resource firewallRules 'Microsoft.DocumentDB/mongoClusters/firewallRules@2022-10-15-preview' = {
  parent: cluster
  name: 'AllowAllAzureServices'
  properties: {
    startIpAddress: '0.0.0.0'
    endIpAddress: '0.0.0.0'
  }
}

注意

請注意，在上方的程序碼中，shardGroupSpecs 稱為 nodeGroupSpecs。

Bicep 檔案中定義了兩個 Azure 資源：

• Microsoft.DocumentDB/mongoclusters：建立 Azure Cosmos DB for MongoDB 虛擬核心叢集。
  • Microsoft.DocumentDB/mongoClusters/firewallRules：建立 Azure Cosmos DB for MongoDB 虛擬核心叢集的防火牆規則。

部署 Bicep 檔案

使用 Bicep 範本建立 Azure Cosmos DB for MongoDB 虛擬核心叢集。

Azure CLI

1. 建立 resourceGroupName 和 location 的殼層變數

   # Variable for resource group name and location
   resourceGroupName="msdocs-cosmos-quickstart-rg"
   location="eastus"
   

2. 如果您尚未登入，請使用 az login 命令登入 Azure CLI。

3. 使用 az group create 命令在您的訂用帳戶中建立新的資源群組。

   az group create \
       --name $resourceGroupName \
       --location $location
   

4. 使用 az deployment group create 部署 bicep 範本。 接著，系統會提示您輸入 adminUsername 和 adminPassword 參數的值。

   az deployment group create \
       --resource-group $resourceGroupName \
       --template-file 'main.bicep'
   

   提示

   或者，使用 --parameters 選項傳入具有預先定義值的參數檔案。

   az deployment group create \
       --resource-group $resourceGroupName \
       --template-file 'main.bicep' \
       --parameters @main.parameters.json
   

   此範例 JSON 檔案會分別為 adminUsername 和 adminPassword 參數插入 clusteradmin 和 P@ssw.rd 值。

   {
     "$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"
       }
     }
   }
   

5. 等待部署作業完成後，再繼續操作。

Azure PowerShell

1. 建立 RESOURCE_GROUP_NAME 和 LOCATION 的殼層變數

   # Variable for resource group name and location
   $RESOURCE_GROUP_NAME = "msdocs-cosmos-quickstart-rg"
   $LOCATION = "East US"
   

2. 如果您尚未登入，請使用 Connect-AzAccount Cmdlet 登入 Azure PowerShell。

3. 使用 New-AzResourceGroup Cmdlet 在您的訂用帳戶中建立新的資源群組。

   $parameters = @{
       Name = $RESOURCE_GROUP_NAME
       Location = $LOCATION
   }
   New-AzResourceGroup @parameters
   

4. 使用 New-AzResourceGroupDeployment 部署 bicep 範本。 接著，系統會提示您輸入 adminUsername 和 adminPassword 參數的值。

   $parameters = @{
       ResourceGroupName = $RESOURCE_GROUP_NAME
       TemplateFile = "main.bicep"
   }
   New-AzResourceGroupDeployment @parameters
   

   提示

   或者，使用 -TemplateParameterFile 選項傳入具有預先定義值的參數檔案。

   $parameters = @{
       ResourceGroupName = $RESOURCE_GROUP_NAME
       TemplateFile = "main.bicep"
       TemplateParameterFile = "main.parameters.json"
   }
   New-AzResourceGroupDeployment @parameters
   

   此範例 JSON 檔案會分別為 adminUsername 和 adminPassword 參數插入 clusteradmin 和 P@ssw.rd 值。

   {
     "$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"
       }
     }
   }
   

5. 等待部署作業完成後，再繼續操作。

檢閱已部署的資源

列出 Bicep 範本部署至目標資源群組的資源。

Azure CLI

1. 使用 az resource list 取得資源群組中的資源清單。

   az resource list \
       --resource-group $resourceGroupName \
       --location $location \
       --output tsv
   

2. 在範例輸出中，尋找類型為 Microsoft.DocumentDB/mongoClusters 的資源。 以下範例顯示預期的輸出類型：

   Name                  ResourceGroup                Location    Type                                Status
   --------------------  ---------------------------  ----------  ----------------------------------  --------
   msdocs-sz2dac3xtwzzu  msdocs-cosmos-quickstart-rg  eastus      Microsoft.DocumentDB/mongoClusters
   

Azure PowerShell

1. 使用 Get-AzResource 取得資源群組中的資源清單。

   $parameters = @{
       ResourceGroupName = $RESOURCE_GROUP_NAME
   }
   Get-AzResource @parameters
   

2. 在範例輸出中，尋找類型為 Microsoft.DocumentDB/mongoClusters 的資源。 以下範例顯示預期的輸出類型：

   Name              : msdocs-sz2dac3xtwzzu
   ResourceGroupName : msdocs-cosmos-quickstart-rg
   ResourceType      : Microsoft.DocumentDB/mongoClusters
   Location          : eastus
   ResourceId        : /subscriptions/abcdef01-2345-6789-0abc-def012345678/resourceGroups/msdocs-cosmos-quickstart-rg/providers/Microsoft.DocumentDB/mongoClusters/msdocs-sz2dac3xtwzzu
   Tags              : 
   

清除資源

使用完您的 Azure Cosmos DB for MongoDB 虛擬核心叢集後，您可以將建立的 Azure 資源刪除，以免產生更多費用。

Azure CLI

1. 使用 az group delete 從您的訂用帳戶中移除資源群組。

   az group delete \
       --name $resourceGroupName
   

Azure PowerShell

1. 使用 Remove-AzResourceGroup 從您的訂用帳戶中移除資源群組。

   $parameters = @{
       Name = $RESOURCE_GROUP_NAME
   }
   Remove-AzResourceGroup @parameters
   

後續步驟

在此指南中，您已了解如何建立 Azure Cosmos DB for MongoDB 虛擬核心叢集。 現在，您可以將資料移轉至您的叢集。

將資料移轉至 Azure Cosmos DB for MongoDB 虛擬核心