Share via

Microsoft.DocumentDB throughputPools 2023-11-15-preview

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.DocumentDB/throughputPools@2023-11-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    maxThroughput: int
    provisioningState: 'string'
  }
}

プロパティ値

throughputPools

名前 説明 値
name リソース名 string (必須)
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties Azure Cosmos DB スループット プールを更新するためのプロパティ。 ThroughputPoolProperties

ThroughputPoolProperties

名前 説明 値
maxThroughput プール内の CosmosDB リソース間で共有されるスループットの値。 INT
provisioningState ThroughputPool のプロビジョニング状態。 'Canceled'
'削除中'
'Failed'
'初期化中'
'InternallyReady'
'Online'
'Succeeded'
'初期化されていない'
'更新中'

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

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

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/throughputPools",
  "apiVersion": "2023-11-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "maxThroughput": "int",
    "provisioningState": "string"
  }
}

プロパティ値

throughputPools

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/throughputPools'
apiVersion リソース API のバージョン '2023-11-15-preview'
name リソース名 string (必須)
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties Azure Cosmos DB スループット プールを更新するためのプロパティ。 ThroughputPoolProperties

ThroughputPoolProperties

名前 説明 値
maxThroughput プール内の CosmosDB リソース間で共有されるスループットの値。 INT
provisioningState ThroughputPool のプロビジョニング状態。 'Canceled'
'削除中'
'Failed'
'初期化中'
'InternallyReady'
'Online'
'Succeeded'
'初期化されていない'
'更新中'

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/throughputPools@2023-11-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      maxThroughput = int
      provisioningState = "string"
    }
  })
}

プロパティ値

throughputPools

名前 説明 値
type リソースの種類 "Microsoft.DocumentDB/throughputPools@2023-11-15-preview"
name リソース名 string (必須)
location リソースが保存されている地理的な場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。
properties Azure Cosmos DB スループット プールを更新するためのプロパティ。 ThroughputPoolProperties

ThroughputPoolProperties

名前 説明 値
maxThroughput プール内の CosmosDB リソース間で共有されるスループットの値。 INT
provisioningState ThroughputPool のプロビジョニング状態。 "キャンセル済み"
"削除中"
"Failed"
"初期化中"
"InternallyReady"
"オンライン"
"Succeeded"
"初期化されていません"
"更新中"