次の方法で共有

Microsoft.DocumentDB databaseAccounts/mongodbDatabases 2024-08-15

  • [アーティクル]

Bicep リソース定義

databaseAccounts/mongodbDatabases リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-08-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

AutoscaleSettings

名前 形容 価値
maxThroughput リソースをスケールアップできる最大スループットを表します。 int

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

名前 形容 価値
autoscaleSettings 自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 AutoscaleSettings
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

名前 形容 価値
場所 リソースが属するリソース グループの場所。 糸
名前 リソース名 string (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: databaseAccounts
プロパティ Azure Cosmos DB MongoDB データベースを作成および更新するためのプロパティ。 MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions の
資源 MongoDB データベースの標準 JSON 形式 MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource (必須)

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

名前 形容 価値
createMode リソースの作成モードを示す列挙型。 'Default'
'Restore'
身分証明書 Cosmos DB MongoDB データベースの名前 string (必須)
restoreParameters 復元に関する情報を示すパラメーター ResourceRestoreParameters

ResourceRestoreParameters

名前 形容 価値
restoreSource 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 糸
restoreTimestampInUtc アカウントを復元する必要がある時間 (ISO-8601 形式)。 糸
restoreWithTtlDisabled 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 bool

タグ

名前 形容 価値

クイック スタートのサンプル

次のクイック スタート サンプルでは、このリソースの種類をデプロイします。

Bicep ファイル 形容
MongoDB API 用の Azure Cosmos アカウントを作成する このテンプレートでは、2 つのコレクションで共有スループットと専用スループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。
MongoDB API 自動スケール 用の Azure Cosmos アカウントを作成する このテンプレートでは、共有スループットと専用自動スケーリング スループットの両方を使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。

ARM テンプレート リソース定義

databaseAccounts/mongodbDatabases リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
  "apiVersion": "2024-08-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

AutoscaleSettings

名前 形容 価値
maxThroughput リソースをスケールアップできる最大スループットを表します。 int

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

名前 形容 価値
autoscaleSettings 自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 AutoscaleSettings
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

名前 形容 価値
apiVersion API のバージョン '2024-08-15'
場所 リソースが属するリソース グループの場所。 糸
名前 リソース名 string (必須)
プロパティ Azure Cosmos DB MongoDB データベースを作成および更新するためのプロパティ。 MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases'

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions の
資源 MongoDB データベースの標準 JSON 形式 MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource (必須)

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

名前 形容 価値
createMode リソースの作成モードを示す列挙型。 'Default'
'Restore'
身分証明書 Cosmos DB MongoDB データベースの名前 string (必須)
restoreParameters 復元に関する情報を示すパラメーター ResourceRestoreParameters

ResourceRestoreParameters

名前 形容 価値
restoreSource 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 糸
restoreTimestampInUtc アカウントを復元する必要がある時間 (ISO-8601 形式)。 糸
restoreWithTtlDisabled 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 bool

タグ

名前 形容 価値

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
MongoDB API 用の Azure Cosmos アカウントを作成する

Azure にデプロイする 		このテンプレートでは、2 つのコレクションで共有スループットと専用スループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。
MongoDB API 自動スケール 用の Azure Cosmos アカウントを作成する

Azure にデプロイする 		このテンプレートでは、共有スループットと専用自動スケーリング スループットの両方を使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。

Terraform (AzAPI プロバイダー) リソース定義

databaseAccounts/mongodbDatabases リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-08-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

プロパティ値

AutoscaleSettings

名前 形容 価値
maxThroughput リソースをスケールアップできる最大スループットを表します。 int

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

名前 形容 価値
autoscaleSettings 自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 AutoscaleSettings
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

名前 形容 価値
場所 リソースが属するリソース グループの場所。 糸
名前 リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts
プロパティ Azure Cosmos DB MongoDB データベースを作成および更新するためのプロパティ。 MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-08-15"

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions の
資源 MongoDB データベースの標準 JSON 形式 MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource (必須)

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

名前 形容 価値
createMode リソースの作成モードを示す列挙型。 'Default'
'Restore'
身分証明書 Cosmos DB MongoDB データベースの名前 string (必須)
restoreParameters 復元に関する情報を示すパラメーター ResourceRestoreParameters

ResourceRestoreParameters

名前 形容 価値
restoreSource 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 糸
restoreTimestampInUtc アカウントを復元する必要がある時間 (ISO-8601 形式)。 糸
restoreWithTtlDisabled 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 bool

タグ

名前 形容 価値