Microsoft.DocumentDB 資料庫Accounts/sqlDatabases
- 最新
- 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-預覽版
- 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/sqlDatabases 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-02-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
}
}
}
屬性值
databaseAccounts/sqlDatabases
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
字串 (必要) |
| location | 資源所屬資源群組的位置。 | 字串 |
| tags | 標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| 父系 (parent) | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱： databaseAccounts |
| 身分識別 | 資源的身分識別。 | ManagedServiceIdentity |
| properties | 建立和更新 Azure Cosmos DB SQL 資料庫的屬性。 | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... 必要 () |
ManagedServiceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned'：用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 同時包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 |
|
| userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
| 名稱 | 描述 | 值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 | CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| 資源 | SQL 資料庫的標準 JSON 格式 | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... 必要 () |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| 名稱 | 描述 | 值 |
|---|---|---|
| autoscaleSettings | 指定自動調整設定。 注意：需要輸送量或 autoscaleSettings，但不需要兩者。 | AutoscaleSettings |
| 輸送量 | 每秒要求單位數。 例如，「輸送量」：10000。 | int |
AutoscaleSettings
| 名稱 | 描述 | 值 |
|---|---|---|
| maxThroughput | 代表最大輸送量，資源可以相應增加為 。 | int |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| 名稱 | 描述 | 值 |
|---|---|---|
| createMode | 列舉，表示資源建立模式。 | 'Default' 'PointInTimeRestore' 'Restore' |
| id | Cosmos DB SQL 資料庫的名稱 | 需要字串 () |
| restoreParameters | 用來指出還原相關信息的參數 | ResourceRestoreParameters |
ResourceRestoreParameters
| 名稱 | 描述 | 值 |
|---|---|---|
| restoreSource | 必須起始還原之可還原資料庫帳戶的標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 字串 |
| restoreTimestampInUtc | 帳戶必須還原的時間 (ISO-8601 格式) 。 | 字串 |
| restoreWithTtlDisabled | 指定還原的帳戶是否在成功還原時停用存留時間。 | bool |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
建立免費層的 Azure Cosmos DB 帳戶 |
此範本會使用具有共用輸送量和容器的資料庫，為 SQL API 建立免費層 Azure Cosmos DB 帳戶。 |
| 建立 Core (SQL) API 的 Azure Cosmos DB 帳戶 |
此範本會建立 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含具有多個其他選項的資料庫和容器。 |
| Azure Cosmos DB 帳戶 SQL API 與分析存放區 |
此範本會建立 Core (SQL) API 的 Azure Cosmos 帳戶，並搭配使用分析存放區設定的資料庫和容器。 |
| 使用自動調整建立 Azure Cosmos DB 帳戶 SQL API |
此範本會建立 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含具有多個其他選項的自動調整輸送量和容器。 |
| 建立 Azure Cosmos DB Core (SQL) API 預存程式 |
此範本會建立 Core (SQL) API 的 Azure Cosmos DB 帳戶，以及具有預存程式、觸發程式和使用者定義函式的容器。 |
| 使用 Cosmos DB 連線部署 Azure Data Explorer DB |
使用 Cosmos DB 連線部署 Azure Data Explorer DB。 |
ARM 範本資源定義
databaseAccounts/sqlDatabases 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
"apiVersion": "2024-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
}
}
}
}
屬性值
databaseAccounts/sqlDatabases
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases' |
| apiVersion | 資源 API 版本 | '2024-02-15-preview' |
| NAME | 資源名稱 請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。 |
字串 (必要) |
| location | 資源所屬資源群組的位置。 | 字串 |
| tags | 標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| 身分識別 | 資源的身分識別。 | ManagedServiceIdentity |
| properties | 建立和更新 Azure Cosmos DB SQL 資料庫的屬性。 | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... 必要 () |
ManagedServiceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned'：用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 同時包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 |
|
| userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
| 名稱 | 描述 | 值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 | CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| 資源 | SQL 資料庫的標準 JSON 格式 | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... 必要 () |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| 名稱 | 描述 | 值 |
|---|---|---|
| autoscaleSettings | 指定自動調整設定。 注意：需要輸送量或 autoscaleSettings，但不需要兩者。 | AutoscaleSettings |
| 輸送量 | 每秒要求單位數。 例如，「輸送量」：10000。 | int |
AutoscaleSettings
| 名稱 | 描述 | 值 |
|---|---|---|
| maxThroughput | 代表最大輸送量，資源可以相應增加。 | int |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| 名稱 | 描述 | 值 |
|---|---|---|
| createMode | 表示資源建立模式的列舉。 | 'Default' 'PointInTimeRestore' 'Restore' |
| id | Cosmos DB SQL 資料庫的名稱 | 字串 (必要) |
| restoreParameters | 用來指出還原相關信息的參數 | ResourceRestoreParameters |
ResourceRestoreParameters
| 名稱 | 描述 | 值 |
|---|---|---|
| restoreSource | 必須起始還原之可還原之資料庫帳戶的標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 字串 |
| restoreTimestampInUtc | 帳戶必須還原的時間 (ISO-8601 格式) 。 | 字串 |
| restoreWithTtlDisabled | 指定還原的帳戶是否在成功還原時停用存留時間。 | bool |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
| 建立免費層的 Azure Cosmos DB 帳戶 |
此範本會使用具有共用輸送量和容器的資料庫，為 SQL API 建立免費層 Azure Cosmos DB 帳戶。 |
| 建立 Core (SQL) API 的 Azure Cosmos DB 帳戶 |
此範本會建立 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含具有多個其他選項的資料庫和容器。 |
| Azure Cosmos DB 帳戶 SQL API 與分析存放區 |
此範本會建立 Core (SQL) API 的 Azure Cosmos 帳戶，並搭配使用分析存放區設定的資料庫和容器。 |
| 使用自動調整建立 Azure Cosmos DB 帳戶 SQL API |
此範本會建立 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含具有多個其他選項的自動調整輸送量和容器。 |
| 建立 Azure Cosmos DB Core (SQL) API 預存程式 |
此範本會建立 Core (SQL) API 的 Azure Cosmos DB 帳戶，以及具有預存程式、觸發程式和使用者定義函式的容器。 |
| 使用 Cosmos DB 連線部署 Azure Data Explorer DB |
使用 Cosmos DB 連線部署 Azure Data Explorer DB。 |
Terraform (AzAPI 提供者) 資源定義
databaseAccounts/sqlDatabases 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-02-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
}
}
})
}
屬性值
databaseAccounts/sqlDatabases
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-02-15-preview” |
| NAME | 資源名稱 | 需要字串 () |
| location | 資源所屬之資源群組的位置。 | 字串 |
| parent_id | 此資源父系之資源的標識碼。 | 類型資源的標識碼： databaseAccounts |
| tags | 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 | 標記名稱和值的字典。 |
| 身分識別 | 資源的身分識別。 | ManagedServiceIdentity |
| properties | 用來建立和更新 Azure Cosmos DB SQL 資料庫的屬性。 | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... 必要 () |
ManagedServiceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”：用於資源的身分識別類型。 類型 「SystemAssigned，UserAssigned」 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 「None」 會從服務中移除任何身分識別。 |
|
| identity_ids | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | 使用者身分識別標識碼的陣列。 |
ManagedServiceIdentityUserAssignedIdentities
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
| 名稱 | 描述 | 值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 | CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| 資源 | SQL 資料庫的標準 JSON 格式 | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... 必要 () |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| 名稱 | 描述 | 值 |
|---|---|---|
| autoscaleSettings | 指定自動調整設定。 注意：需要輸送量或 autoscaleSettings，但不需要兩者。 | AutoscaleSettings |
| 輸送量 | 每秒要求單位數。 例如，「輸送量」：10000。 | int |
AutoscaleSettings
| 名稱 | 描述 | 值 |
|---|---|---|
| maxThroughput | 代表最大輸送量，資源可以相應增加。 | int |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| 名稱 | 描述 | 值 |
|---|---|---|
| createMode | 表示資源建立模式的列舉。 | “Default” “PointInTimeRestore” “Restore” |
| id | Cosmos DB SQL 資料庫的名稱 | 字串 (必要) |
| restoreParameters | 用來指出還原相關信息的參數 | ResourceRestoreParameters |
ResourceRestoreParameters
| 名稱 | 描述 | 值 |
|---|---|---|
| restoreSource | 必須起始還原之可還原之資料庫帳戶的標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 字串 |
| restoreTimestampInUtc | 帳戶必須還原的時間 (ISO-8601 格式) 。 | 字串 |
| restoreWithTtlDisabled | 指定還原的帳戶是否在成功還原時停用存留時間。 | bool |
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應