Microsoft.DocumentDB databaseAccounts/sqlDatabases
- [アーティクル]
-
-
Bicep リソース定義
databaseAccounts/sqlDatabases リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.DocumentDB/databaseAccounts/sqlDatabases リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-05-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
}
}
}
プロパティ値
databaseAccounts/sqlDatabases
| 名前 |
説明 |
値 |
| name |
リソース名
Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location |
リソースが属しているリソース グループの場所。 |
string |
| tags |
タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 |
タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| parent |
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。
詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
種類のリソースのシンボリック名: databaseAccounts |
| properties |
Azure Cosmos DB SQL データベースを作成および更新するためのプロパティ。 |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (必須) |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| 名前 |
説明 |
値 |
| autoscaleSettings |
自動スケーリングの設定を指定します。 注: スループットまたは自動scaleSettings は必須ですが、両方は必要ありません。 |
AutoscaleSettings |
| throughput |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
INT |
AutoscaleSettings
| 名前 |
説明 |
値 |
| maxThroughput |
リソースがスケールアップできる最大スループットを表します。 |
INT |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| 名前 |
説明 |
値 |
| createMode |
リソースの作成モードを示す列挙型。 |
'Default'
'Restore' |
| id |
Cosmos DB SQL データベースの名前 |
string (必須) |
| restoreParameters |
復元に関する情報を示すパラメーター |
ResourceRestoreParameters |
ResourceRestoreParameters
| 名前 |
説明 |
値 |
| restoreSource |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
string |
| restoreTimestampInUtc |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
ARM テンプレート リソース定義
databaseAccounts/sqlDatabases リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.DocumentDB/databaseAccounts/sqlDatabases リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
"apiVersion": "2024-05-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
}
}
}
}
プロパティ値
databaseAccounts/sqlDatabases
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
'Microsoft.DocumentDB/databaseAccounts/sqlDatabases' |
| apiVersion |
リソース API のバージョン |
'2024-05-15' |
| name |
リソース名
JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location |
リソースが属しているリソース グループの場所。 |
string |
| tags |
タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 |
タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| properties |
Azure Cosmos DB SQL データベースを作成および更新するためのプロパティ。 |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (必須) |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| 名前 |
説明 |
値 |
| autoscaleSettings |
自動スケーリング設定を指定します。 注: スループットまたは autoscaleSettings が必要ですが、両方は必要ありません。 |
AutoscaleSettings |
| throughput |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
INT |
AutoscaleSettings
| 名前 |
説明 |
値 |
| maxThroughput |
リソースがスケールアップできる最大スループットを表します。 |
INT |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| 名前 |
説明 |
値 |
| createMode |
リソースの作成モードを示す列挙型。 |
'Default'
'Restore' |
| id |
Cosmos DB SQL データベースの名前 |
string (必須) |
| restoreParameters |
復元に関する情報を示すパラメーター |
ResourceRestoreParameters |
ResourceRestoreParameters
| 名前 |
説明 |
値 |
| restoreSource |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
string |
| restoreTimestampInUtc |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
databaseAccounts/sqlDatabases リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.DocumentDB/databaseAccounts/sqlDatabases リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-05-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
}
}
})
}
プロパティ値
databaseAccounts/sqlDatabases
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-05-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 SQL データベースを作成および更新するためのプロパティ。 |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (必須) |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| 名前 |
説明 |
値 |
| autoscaleSettings |
自動スケーリングの設定を指定します。 注: スループットまたは自動scaleSettings は必須ですが、両方は必要ありません。 |
AutoscaleSettings |
| throughput |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
INT |
AutoscaleSettings
| 名前 |
説明 |
値 |
| maxThroughput |
リソースをスケールアップできる最大スループットを表します。 |
INT |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| 名前 |
説明 |
値 |
| createMode |
リソースの作成モードを示す列挙型。 |
"Default"
"復元" |
| id |
Cosmos DB SQL データベースの名前 |
string (必須) |
| restoreParameters |
復元に関する情報を示すパラメーター |
ResourceRestoreParameters |
ResourceRestoreParameters
| 名前 |
説明 |
値 |
| restoreSource |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
string |
| restoreTimestampInUtc |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
string |
