Microsoft.DocumentDB databaseAccounts/mongodbDatabases 2022-08-15

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-08-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
    }
  }
}

プロパティ値

databaseAccounts/mongodbDatabases

Name 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
string (必須)
location リソースが属しているリソース グループの場所。 string
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

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

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

Name 説明
options 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
resource MongoDB データベースの標準 JSON 形式 MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (必須)

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

Name 説明
autoscaleSettings 自動スケーリング設定を指定します。 AutoscaleSettings
throughput 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 INT

AutoscaleSettings

Name 説明
maxThroughput リソースがスケールアップできる最大スループットを表します。 INT

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Name 説明
id Cosmos DB MongoDB データベースの名前 string (必須)

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

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

Template 説明
MongoDB API 用の Azure Cosmos アカウントを作成する

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

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

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

databaseAccounts/mongodbDatabases リソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
  "apiVersion": "2022-08-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "id": "string"
    }
  }
}

プロパティ値

databaseAccounts/mongodbDatabases

Name 説明
type リソースの種類 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases'
apiVersion リソース API のバージョン '2022-08-15'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)
location リソースが属しているリソース グループの場所。 string
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties Azure Cosmos DB MongoDB データベースを作成および更新するためのプロパティ。 MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (必須)

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

Name 説明
options 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
resource MongoDB データベースの標準 JSON 形式 MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (必須)

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

Name 説明
autoscaleSettings 自動スケーリングの設定を指定します。 AutoscaleSettings
throughput 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 INT

AutoscaleSettings

Name 説明
maxThroughput リソースをスケールアップできる最大スループットを表します。 INT

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Name 説明
id Cosmos DB MongoDB データベースの名前 string (必須)

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

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

Template 説明
MongoDB API 用の Azure Cosmos アカウントを作成する

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

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

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

databaseAccounts/mongodbDatabases リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-08-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
      }
    }
  })
}

プロパティ値

databaseAccounts/mongodbDatabases

Name 説明
type リソースの種類 "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-08-15"
name リソース名 string (必須)
location リソースが属しているリソース グループの場所。 string
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグ名と値のディクショナリ。
properties Azure Cosmos DB MongoDB データベースを作成および更新するためのプロパティ。 MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (必須)

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

Name 説明
options 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
resource MongoDB データベースの標準 JSON 形式 MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (必須)

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

Name 説明
autoscaleSettings 自動スケーリングの設定を指定します。 AutoscaleSettings
throughput 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 INT

AutoscaleSettings

Name 説明
maxThroughput リソースをスケールアップできる最大スループットを表します。 INT

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Name 説明
id Cosmos DB MongoDB データベースの名前 string (必須)