次の方法で共有


Microsoft.DocumentDB databaseAccounts/gremlinDatabases/throughputSettings 2024-12-01-preview

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2024-12-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'default'
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
      throughputBuckets: [
        {
          id: int
          maxThroughputPercentage: int
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

AutoscaleSettingsResource

名前 形容 価値
autoUpgradePolicy Cosmos DB リソースの自動アップグレード ポリシー AutoUpgradePolicyResource の
maxThroughput スケールアップできる最大スループット コンテナーを表します。 int (必須)

AutoUpgradePolicyResource

名前 形容 価値
throughputPolicy 自動アップグレードに準拠する必要があるサービスのスループット ポリシーを表します ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

ManagedServiceIdentity

名前 形容 価値
種類 リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities の

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings

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

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

タグ

名前 形容 価値

ThroughputBucketResource

名前 形容 価値
身分証明書 スループット バケット ID を表します int (必須)
maxThroughputPercentage バケットで使用できる最大スループットの割合を表します。 int (必須)

ThroughputPolicyResource

名前 形容 価値
incrementPercent スループット ポリシーが開始されるたびにスループットを増加できる割合を表します。 int
isEnabled ThroughputPolicy がアクティブかどうかを判断します bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名前 形容 価値
autoscaleSettings 自動スケール設定用の Cosmos DB リソース。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 AutoscaleSettingsResource の
スループット Cosmos DB リソースのスループットの値。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 int
throughputBuckets Cosmos DB コンテナーに適用されるスループット バケットの制限の配列 ThroughputBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

名前 形容 価値
資源 リソース スループットの標準 JSON 形式 ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (必須)

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int",
      "throughputBuckets": [
        {
          "id": "int",
          "maxThroughputPercentage": "int"
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

AutoscaleSettingsResource

名前 形容 価値
autoUpgradePolicy Cosmos DB リソースの自動アップグレード ポリシー AutoUpgradePolicyResource の
maxThroughput スケールアップできる最大スループット コンテナーを表します。 int (必須)

AutoUpgradePolicyResource

名前 形容 価値
throughputPolicy 自動アップグレードに準拠する必要があるサービスのスループット ポリシーを表します ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

ManagedServiceIdentity

名前 形容 価値
種類 リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities の

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings

名前 形容 価値
apiVersion API のバージョン '2024-12-01-preview'
同一性 リソースの ID。 ManagedServiceIdentity の
場所 リソースが属するリソース グループの場所。
名前 リソース名 'default' (必須)
プロパティ Azure Cosmos DB リソースのスループットを更新するプロパティ。 ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings'

タグ

名前 形容 価値

ThroughputBucketResource

名前 形容 価値
身分証明書 スループット バケット ID を表します int (必須)
maxThroughputPercentage バケットで使用できる最大スループットの割合を表します。 int (必須)

ThroughputPolicyResource

名前 形容 価値
incrementPercent スループット ポリシーが開始されるたびにスループットを増加できる割合を表します。 int
isEnabled ThroughputPolicy がアクティブかどうかを判断します bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名前 形容 価値
autoscaleSettings 自動スケール設定用の Cosmos DB リソース。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 AutoscaleSettingsResource の
スループット Cosmos DB リソースのスループットの値。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 int
throughputBuckets Cosmos DB コンテナーに適用されるスループット バケットの制限の配列 ThroughputBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

名前 形容 価値
資源 リソース スループットの標準 JSON 形式 ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (必須)

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

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

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
        throughputBuckets = [
          {
            id = int
            maxThroughputPercentage = int
          }
        ]
      }
    }
  })
}

プロパティ値

AutoscaleSettingsResource

名前 形容 価値
autoUpgradePolicy Cosmos DB リソースの自動アップグレード ポリシー AutoUpgradePolicyResource の
maxThroughput スケールアップできる最大スループット コンテナーを表します。 int (必須)

AutoUpgradePolicyResource

名前 形容 価値
throughputPolicy 自動アップグレードに準拠する必要があるサービスのスループット ポリシーを表します ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

ManagedServiceIdentity

名前 形容 価値
種類 リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities の

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings

名前 形容 価値
同一性 リソースの ID。 ManagedServiceIdentity の
場所 リソースが属するリソース グループの場所。
名前 リソース名 'default' (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts/gremlinDatabases
プロパティ Azure Cosmos DB リソースのスループットを更新するプロパティ。 ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2024-12-01-preview"

タグ

名前 形容 価値

ThroughputBucketResource

名前 形容 価値
身分証明書 スループット バケット ID を表します int (必須)
maxThroughputPercentage バケットで使用できる最大スループットの割合を表します。 int (必須)

ThroughputPolicyResource

名前 形容 価値
incrementPercent スループット ポリシーが開始されるたびにスループットを増加できる割合を表します。 int
isEnabled ThroughputPolicy がアクティブかどうかを判断します bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名前 形容 価値
autoscaleSettings 自動スケール設定用の Cosmos DB リソース。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 AutoscaleSettingsResource の
スループット Cosmos DB リソースのスループットの値。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 int
throughputBuckets Cosmos DB コンテナーに適用されるスループット バケットの制限の配列 ThroughputBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

名前 形容 価値
資源 リソース スループットの標準 JSON 形式 ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (必須)