Microsoft.DocumentDB databaseAccounts/mongodbDatabases/throughputSettings 2022-11-15-preview
- 最新
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep リソース定義
databaseAccounts/mongodbDatabases/throughputSettings リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2022-11-15-preview' = {
name: 'default'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
resource: {
autoscaleSettings: {
autoUpgradePolicy: {
throughputPolicy: {
incrementPercent: int
isEnabled: bool
}
}
maxThroughput: int
}
throughput: int
}
}
}
プロパティ値
databaseAccounts/mongodbDatabases/throughputSettings
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
'default' |
| location | リソースが属しているリソース グループの場所。 | string |
| tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
型のリソースのシンボル名: mongodbDatabases |
| identity | リソースの ID。 | ManagedServiceIdentity |
| properties | Azure Cosmos DB リソースのスループットを更新するためのプロパティ。 | ThroughputSettingsUpdatePropertiesOrThroughputSettin... (必須) |
ManagedServiceIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned': リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスから ID を削除します。 |
|
| userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
| 名前 | 説明 | 値 |
|---|---|---|
| resource | リソース スループットの標準的な JSON 形式 | ThroughputSettingsResourceOrThroughputSettingsGetPro... (必須) |
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名前 | 説明 | 値 |
|---|---|---|
| autoscaleSettings | 自動スケーリング設定用の Cosmos DB リソース。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 | AutoscaleSettingsResource |
| throughput | Cosmos DB リソースのスループットの値。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 | INT |
AutoscaleSettingsResource
| 名前 | 説明 | 値 |
|---|---|---|
| autoUpgradePolicy | Cosmos DB リソースの自動アップグレード ポリシー | AutoUpgradePolicyResource |
| maxThroughput | スケールアップできる最大スループット コンテナーを表します。 | int (必須) |
AutoUpgradePolicyResource
| 名前 | 説明 | 値 |
|---|---|---|
| throughputPolicy | 自動アップグレードのためにどのサービスに準拠する必要があるスループット ポリシーを表します | ThroughputPolicyResource |
ThroughputPolicyResource
| 名前 | 説明 | 値 |
|---|---|---|
| incrementPercent | スループット ポリシーが開始されるたびにスループットが増加する割合を表します。 | INT |
| isEnabled | ThroughputPolicy がアクティブかどうかを判断します | [bool] |
ARM テンプレート リソース定義
databaseAccounts/mongodbDatabases/throughputSettings リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings リソースを作成するには、テンプレートに次の JSON を追加します。
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
"apiVersion": "2022-11-15-preview",
"name": "default",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"resource": {
"autoscaleSettings": {
"autoUpgradePolicy": {
"throughputPolicy": {
"incrementPercent": "int",
"isEnabled": "bool"
}
},
"maxThroughput": "int"
},
"throughput": "int"
}
}
}
プロパティ値
databaseAccounts/mongodbDatabases/throughputSettings
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings' |
| apiVersion | リソース API のバージョン | '2022-11-15-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
'default' |
| location | リソースが属しているリソース グループの場所。 | string |
| tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| identity | リソースの ID。 | ManagedServiceIdentity |
| properties | Azure Cosmos DB リソースのスループットを更新するためのプロパティ。 | ThroughputSettingsUpdatePropertiesOrThroughputSettin... (必須) |
ManagedServiceIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned': リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 |
|
| userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
| 名前 | 説明 | 値 |
|---|---|---|
| resource | リソース スループットの標準的な JSON 形式 | ThroughputSettingsResourceOrThroughputSettingsGetPro... (必須) |
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名前 | 説明 | 値 |
|---|---|---|
| autoscaleSettings | 自動スケーリング設定用の Cosmos DB リソース。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 | AutoscaleSettingsResource |
| throughput | Cosmos DB リソースのスループットの値。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。 | INT |
AutoscaleSettingsResource
| 名前 | 説明 | 値 |
|---|---|---|
| autoUpgradePolicy | Cosmos DB リソースの自動アップグレード ポリシー | AutoUpgradePolicyResource |
| maxThroughput | スケールアップできる最大スループット コンテナーを表します。 | int (必須) |
AutoUpgradePolicyResource
| 名前 | 説明 | 値 |
|---|---|---|
| throughputPolicy | 自動アップグレードのためにどのサービスに準拠する必要があるスループット ポリシーを表します | ThroughputPolicyResource |
ThroughputPolicyResource
| 名前 | 説明 | 値 |
|---|---|---|
| incrementPercent | スループット ポリシーが開始されるたびにスループットが増加する割合を表します。 | INT |
| isEnabled | ThroughputPolicy がアクティブかどうかを判断します | [bool] |
Terraform (AzAPI プロバイダー) リソース定義
databaseAccounts/mongodbDatabases/throughputSettings リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2022-11-15-preview"
name = "default"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
resource = {
autoscaleSettings = {
autoUpgradePolicy = {
throughputPolicy = {
incrementPercent = int
isEnabled = bool
}
}
maxThroughput = int
}
throughput = int
}
}
})
}
プロパティ値
databaseAccounts/mongodbDatabases/throughputSettings
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2022-11-15-preview" |
| name | リソース名 | "default" |
| location | リソースが属しているリソース グループの場所。 | string |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: mongodbDatabases |
| tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグの名前と値のディクショナリ。 |
| identity | リソースの ID。 | ManagedServiceIdentity |
| properties | Azure Cosmos DB リソースのスループットを更新するためのプロパティ。 | ThroughputSettingsUpdatePropertiesOrThroughputSettin... (必須) |
ManagedServiceIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned": リソースに使用される ID の種類。 型 "SystemAssigned,UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 "None" では、サービスから ID が削除されます。 |
|
| identity_ids | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 | ユーザー ID ID の配列。 |
ManagedServiceIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
| 名前 | 説明 | 値 |
|---|---|---|
| resource | リソース スループットの標準 JSON 形式 | ThroughputSettingsResourceOrThroughputSettingsGetPro... (必須) |
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名前 | 説明 | 値 |
|---|---|---|
| autoscaleSettings | 自動スケーリング設定用の Cosmos DB リソース。 スループットが必要か、自動scaleSettings が必要ですが、両方は必要ありません。 | AutoscaleSettingsResource |
| throughput | Cosmos DB リソースのスループットの値。 スループットが必要か、自動scaleSettings が必要ですが、両方は必要ありません。 | INT |
AutoscaleSettingsResource
| 名前 | 説明 | 値 |
|---|---|---|
| autoUpgradePolicy | Cosmos DB リソースの自動アップグレード ポリシー | AutoUpgradePolicyResource |
| maxThroughput | スケールアップできる最大スループット コンテナーを表します。 | int (必須) |
AutoUpgradePolicyResource
| 名前 | 説明 | 値 |
|---|---|---|
| throughputPolicy | 自動アップグレードのためにどのサービスに準拠する必要があるスループット ポリシーを表します | ThroughputPolicyResource |
ThroughputPolicyResource
| 名前 | 説明 | 値 |
|---|---|---|
| incrementPercent | スループット ポリシーが開始されるたびにスループットが増加する割合を表します。 | INT |
| isEnabled | ThroughputPolicy がアクティブかどうかを判断します | [bool] |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示