次の方法で共有

クイック スタート: Bicep を使用して Azure DocumentDB クラスターをデプロイする

このクイック スタートでは、Bicep を使用して新しい Azure DocumentDB クラスターをデプロイします。 このクイック スタートでは、すぐに使い始めるのに役立つ詳細な手順を説明します。 このクラスターには、すべての MongoDB リソース (データベース、コレクション、ドキュメント) が含まれています。 ツールとソフトウェア開発キット (SDK) が Azure DocumentDB に接続して操作を実行するための固有のエンドポイントを提供します。

[前提条件]

  • Azure サブスクリプション

    • Azure サブスクリプションをお持ちでない場合は、無料アカウントを作成してください

  • Azure Cloud Shell で Bash 環境を使用します。 詳細については、「Azure Cloud Shell の概要」を参照してください。

  • CLI 参照コマンドをローカルで実行する場合は、Azure CLI を インストール します。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。 詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。

    • ローカル インストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。 認証プロセスを完了するには、ターミナルに表示される手順に従います。 その他のサインイン オプションについては、「 Azure CLI を使用した Azure への認証」を参照してください。

    • 初回使用時にインストールを求められたら、Azure CLI 拡張機能をインストールします。 拡張機能の詳細については、「Azure CLI で拡張機能を使用および管理する」を参照してください。

    • az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。 最新バージョンにアップグレードするには、az upgrade を実行します。

環境の構成

サブスクリプション内の Azure DocumentDB リソースを管理するように Azure CLI 環境を設定します。

  1. 空のディレクトリから開始します。

  2. Azure CLI にサインインします。

    az login

  3. ターゲットの Azure サブスクリプションを確認します。

    az account show

    注

    想定したサブスクリプションに接続していない場合は、次のコマンドを使用してサブスクリプションを変更します。

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

    詳細については、 Azure CLI を使用した Azure サブスクリプションの管理に関するページを参照してください。

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

    Important

    完全に削除されるため、このコマンドを実行する前にリソースが不要になっていることを確認します。

関連コンテンツ

  • Last updated on