Microsoft.Sql servers/databases 2017-03-01-preview

發行項
12/19/2024

Bicep 資源定義

伺服器/資料庫資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Sql/servers/databases 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Sql/servers/databases@2017-03-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    catalogCollation: 'string'
    collation: 'string'
    createMode: 'string'
    elasticPoolId: 'string'
    longTermRetentionBackupResourceId: 'string'
    maxSizeBytes: int
    recoverableDatabaseId: 'string'
    recoveryServicesRecoveryPointId: 'string'
    restorableDroppedDatabaseId: 'string'
    restorePointInTime: 'string'
    sampleName: 'string'
    sourceDatabaseDeletionDate: 'string'
    sourceDatabaseId: 'string'
    zoneRedundant: bool
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

DatabaseProperties

名字	描述	價值
catalogCollation	元資料目錄的定序。	'DATABASE_DEFAULT' 'SQL_Latin1_General_CP1_CI_AS'
整理	資料庫的定序。	字串
createMode	指定資料庫建立模式。默認值：定期建立資料庫。複製：建立資料庫做為現有資料庫的複本。 sourceDatabaseId 必須指定為源資料庫的資源標識碼。次要：建立資料庫做為現有資料庫的次要複本。 sourceDatabaseId 必須指定為現有主資料庫的資源標識碼。 PointInTimeRestore：藉由還原現有資料庫的時間點備份來建立資料庫。 sourceDatabaseId 必須指定為現有資料庫的資源標識符，而且必須指定 restorePointInTime。復原：藉由還原異地復寫備份來建立資料庫。 sourceDatabaseId 必須指定為要還原的可復原資料庫資源標識符。還原：藉由還原已刪除資料庫的備份來建立資料庫。必須指定sourceDatabaseId。如果 sourceDatabaseId 是資料庫的原始資源識別碼，則必須指定 sourceDatabaseDeletionDate。否則，sourceDatabaseId 必須是可還原的卸除資料庫資源標識符，而且會忽略 sourceDatabaseDeletionDate。 restorePointInTime 也可以指定為從先前的時間點還原。 RestoreLongTermRetentionBackup：從長期保留保存庫還原來建立資料庫。 recoveryServicesRecoveryPointResourceId 必須指定為恢復點資源標識符。 DataWarehouse 版本不支援 Copy、Secondary 和 RestoreLongTermRetentionBackup。	'Copy' 'Default' 'OnlineSecondary' 'PointInTimeRestore' 'Recovery' 'Restore' 'RestoreExternalBackup' 'RestoreExternalBackupSecondary' 'RestoreLongTermRetentionBackup' 'Secondary'
elasticPoolId	包含此資料庫之彈性集區的資源標識碼。	字串
longTermRetentionBackupResourceId	與此資料庫建立作業相關聯的長期保留備份資源標識符。	字串
maxSizeBytes	以位元組表示的資料庫大小上限。	int
recoverableDatabaseId	與此資料庫建立作業相關聯的可復原資料庫資源標識符。	字串
recoveryServicesRecoveryPointId	與此資料庫建立作業相關聯的恢復點資源標識碼。	字串
restorableDroppedDatabaseId	與這個資料庫建立作業相關聯的可還原卸除資料庫資源標識符。	字串
restorePointInTime	指定要還原以建立新資料庫的源資料庫的時間點（ISO8601格式）。	字串
sampleName	建立這個資料庫時要套用的範例架構名稱。	'AdventureWorksLT' 'WideWorldImportersFull' 'WideWorldImportersStd'
sourceDatabaseDeletionDate	指定刪除資料庫的時間。	字串
sourceDatabaseId	與這個資料庫建立作業相關聯的源資料庫資源標識符。	字串
zoneRedundant	此資料庫是否為區域備援，這表示此資料庫的複本會分散到多個可用性區域。	bool

Microsoft.Sql/servers/databases

名字	描述	價值
位置	資源位置。	字串（必要）
名字	資源名稱	字串（必要）
父母	在 Bicep 中，您可以指定子資源的父資源。只有在父資源外部宣告子資源時，才需要新增這個屬性。如需詳細資訊，請參閱父資源外部的子資源。	類型的資源符號名稱：伺服器
性能	資源屬性。	DatabaseProperties
sku	SKU 的名稱和層。	Sku
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤

Sku

名字	描述	價值
能力	特定 SKU 的容量。	int
家庭	如果服務有不同世代的硬體，針對相同的 SKU，則可以在這裡擷取。	字串
名字	SKU 的名稱，通常是字母 + 數位碼，例如 P3。	字串（必要）
大小	特定 SKU 的大小	字串
層	特定 SKU 的階層或版本，例如基本、進階。	字串

TrackedResourceTags

名字	描述	價值

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
使用寫入 Log Analytics 稽核的 Azure SQL Server	此樣本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入 Log Analytics （OMS 工作區）
建立 SQL Server 和資料庫	此範本可讓您建立 SQL Database 和 Server。
使用透明加密專用 SQL 集區	使用透明數據加密建立 SQL Server 和專用 SQL 集區（先前稱為 SQL DW）。
在 Azure 架構上部署體育分析	建立已啟用 ADLS Gen 2 的 Azure 記憶體帳戶、具有記憶體帳戶連結服務的 Azure Data Factory 實例（如果已部署的 Azure SQL Database），以及 Azure Databricks 實例。部署範本和 ADF 實例受控識別的使用者 AAD 身分識別，將會在記憶體帳戶上授與記憶體 Blob 數據參與者角色。還有一個選項可用來部署 Azure Key Vault 實例、Azure SQL Database 和 Azure 事件中樞（適用於串流使用案例）。部署 Azure Key Vault 時，部署範本之使用者的 Data Factory 受控識別和 AAD 身分識別將會獲得 Key Vault 秘密使用者角色。
私人端點範例	此範本示範如何建立指向 Azure SQL Server 的私人端點
使用 SQL Database 布建 Web 應用程式	此範本會布建 Web 應用程式、SQL Database、自動調整設定、警示規則和 App Insights。它會在資料庫的 Web 應用程式中設定連接字串。
使用 Azure SQL 在 Linux 上 Sonarqube Docker Web 應用程式	此範本會使用官方 Sonarqube 映像，並在 Azure SQL Server 支援下，在 Azure App Service Web 應用程式 Linux 容器中部署 Sonarqube。
具有受控識別、SQL Server 和的 Web 應用程式	針對應用程式 + 資料 + 受控識別 + 監視部署 Azure 基礎結構的簡單範例

ARM 樣本資源定義

伺服器/資料庫資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Sql/servers/databases 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Sql/servers/databases",
  "apiVersion": "2017-03-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "catalogCollation": "string",
    "collation": "string",
    "createMode": "string",
    "elasticPoolId": "string",
    "longTermRetentionBackupResourceId": "string",
    "maxSizeBytes": "int",
    "recoverableDatabaseId": "string",
    "recoveryServicesRecoveryPointId": "string",
    "restorableDroppedDatabaseId": "string",
    "restorePointInTime": "string",
    "sampleName": "string",
    "sourceDatabaseDeletionDate": "string",
    "sourceDatabaseId": "string",
    "zoneRedundant": "bool"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

DatabaseProperties

名字	描述	價值
catalogCollation	元資料目錄的定序。	'DATABASE_DEFAULT' 'SQL_Latin1_General_CP1_CI_AS'
整理	資料庫的定序。	字串
createMode	指定資料庫建立模式。默認值：定期建立資料庫。複製：建立資料庫做為現有資料庫的複本。 sourceDatabaseId 必須指定為源資料庫的資源標識碼。次要：建立資料庫做為現有資料庫的次要複本。 sourceDatabaseId 必須指定為現有主資料庫的資源標識碼。 PointInTimeRestore：藉由還原現有資料庫的時間點備份來建立資料庫。 sourceDatabaseId 必須指定為現有資料庫的資源標識符，而且必須指定 restorePointInTime。復原：藉由還原異地復寫備份來建立資料庫。 sourceDatabaseId 必須指定為要還原的可復原資料庫資源標識符。還原：藉由還原已刪除資料庫的備份來建立資料庫。必須指定sourceDatabaseId。如果 sourceDatabaseId 是資料庫的原始資源識別碼，則必須指定 sourceDatabaseDeletionDate。否則，sourceDatabaseId 必須是可還原的卸除資料庫資源標識符，而且會忽略 sourceDatabaseDeletionDate。 restorePointInTime 也可以指定為從先前的時間點還原。 RestoreLongTermRetentionBackup：從長期保留保存庫還原來建立資料庫。 recoveryServicesRecoveryPointResourceId 必須指定為恢復點資源標識符。 DataWarehouse 版本不支援 Copy、Secondary 和 RestoreLongTermRetentionBackup。	'Copy' 'Default' 'OnlineSecondary' 'PointInTimeRestore' 'Recovery' 'Restore' 'RestoreExternalBackup' 'RestoreExternalBackupSecondary' 'RestoreLongTermRetentionBackup' 'Secondary'
elasticPoolId	包含此資料庫之彈性集區的資源標識碼。	字串
longTermRetentionBackupResourceId	與此資料庫建立作業相關聯的長期保留備份資源標識符。	字串
maxSizeBytes	以位元組表示的資料庫大小上限。	int
recoverableDatabaseId	與此資料庫建立作業相關聯的可復原資料庫資源標識符。	字串
recoveryServicesRecoveryPointId	與此資料庫建立作業相關聯的恢復點資源標識碼。	字串
restorableDroppedDatabaseId	與這個資料庫建立作業相關聯的可還原卸除資料庫資源標識符。	字串
restorePointInTime	指定要還原以建立新資料庫的源資料庫的時間點（ISO8601格式）。	字串
sampleName	建立這個資料庫時要套用的範例架構名稱。	'AdventureWorksLT' 'WideWorldImportersFull' 'WideWorldImportersStd'
sourceDatabaseDeletionDate	指定刪除資料庫的時間。	字串
sourceDatabaseId	與這個資料庫建立作業相關聯的源資料庫資源標識符。	字串
zoneRedundant	此資料庫是否為區域備援，這表示此資料庫的複本會分散到多個可用性區域。	bool

Microsoft.Sql/servers/databases

名字	描述	價值
apiVersion	API 版本	'2017-03-01-preview'
位置	資源位置。	字串（必要）
名字	資源名稱	字串（必要）
性能	資源屬性。	DatabaseProperties
sku	SKU 的名稱和層。	Sku
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
類型	資源類型	'Microsoft.Sql/servers/databases'

Sku

名字	描述	價值
能力	特定 SKU 的容量。	int
家庭	如果服務有不同世代的硬體，針對相同的 SKU，則可以在這裡擷取。	字串
名字	SKU 的名稱，通常是字母 + 數位碼，例如 P3。	字串（必要）
大小	特定 SKU 的大小	字串
層	特定 SKU 的階層或版本，例如基本、進階。	字串

TrackedResourceTags

名字	描述	價值

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
使用寫入 Log Analytics 稽核的 Azure SQL Server	此樣本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入 Log Analytics （OMS 工作區）
建立 SQL Server 和資料庫	此範本可讓您建立 SQL Database 和 Server。
使用透明加密專用 SQL 集區	使用透明數據加密建立 SQL Server 和專用 SQL 集區（先前稱為 SQL DW）。
部署新的 SQL 彈性集區	此範本可讓您使用新的相關聯的 SQL Server 和新的 SQL Database 來部署新的 SQL 彈性集區，並將其指派給它。
在 Azure 架構上部署體育分析	建立已啟用 ADLS Gen 2 的 Azure 記憶體帳戶、具有記憶體帳戶連結服務的 Azure Data Factory 實例（如果已部署的 Azure SQL Database），以及 Azure Databricks 實例。部署範本和 ADF 實例受控識別的使用者 AAD 身分識別，將會在記憶體帳戶上授與記憶體 Blob 數據參與者角色。還有一個選項可用來部署 Azure Key Vault 實例、Azure SQL Database 和 Azure 事件中樞（適用於串流使用案例）。部署 Azure Key Vault 時，部署範本之使用者的 Data Factory 受控識別和 AAD 身分識別將會獲得 Key Vault 秘密使用者角色。
使用 VNET 中的自訂 Ambari + Hive 中繼存放區 DB HDInsight	此範本可讓您使用新的 SQL DB，在現有的虛擬網路中建立 HDInsight 叢集，以作為自訂 Ambari DB 和 Hive 中繼存放區。您必須擁有現有的 SQL Sever、記憶體帳戶和 VNET。
私人端點範例	此範本示範如何建立指向 Azure SQL Server 的私人端點
使用 SQL Database 布建 Web 應用程式	此範本會布建 Web 應用程式、SQL Database、自動調整設定、警示規則和 App Insights。它會在資料庫的 Web 應用程式中設定連接字串。
具有高可用性的遠端桌面服務	此 ARM 範例程式代碼會部署具有高可用性的遠端桌面服務 2019 會話集合實驗室。目標是使用 Windows Server 2019 部署遠端桌面服務的完整備援高可用性解決方案。
使用 Azure SQL 在 Linux 上 Sonarqube Docker Web 應用程式	此範本會使用官方 Sonarqube 映像，並在 Azure SQL Server 支援下，在 Azure App Service Web 應用程式 Linux 容器中部署 Sonarqube。
具有受控識別、SQL Server 和的 Web 應用程式	針對應用程式 + 資料 + 受控識別 + 監視部署 Azure 基礎結構的簡單範例
WebApp 取用 Azure SQL 私人端點	此範本示範如何建立 Web 應用程式，以取用指向 Azure SQL Server 的私人端點

Terraform （AzAPI 提供者）資源定義

伺服器/資料庫資源類型可以使用目標作業來部署：

資源群組

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Sql/servers/databases 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/databases@2017-03-01-preview"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      catalogCollation = "string"
      collation = "string"
      createMode = "string"
      elasticPoolId = "string"
      longTermRetentionBackupResourceId = "string"
      maxSizeBytes = int
      recoverableDatabaseId = "string"
      recoveryServicesRecoveryPointId = "string"
      restorableDroppedDatabaseId = "string"
      restorePointInTime = "string"
      sampleName = "string"
      sourceDatabaseDeletionDate = "string"
      sourceDatabaseId = "string"
      zoneRedundant = bool
    }
  })
}

屬性值

DatabaseProperties

名字	描述	價值
catalogCollation	元資料目錄的定序。	'DATABASE_DEFAULT' 'SQL_Latin1_General_CP1_CI_AS'
整理	資料庫的定序。	字串
createMode	指定資料庫建立模式。默認值：定期建立資料庫。複製：建立資料庫做為現有資料庫的複本。 sourceDatabaseId 必須指定為源資料庫的資源標識碼。次要：建立資料庫做為現有資料庫的次要複本。 sourceDatabaseId 必須指定為現有主資料庫的資源標識碼。 PointInTimeRestore：藉由還原現有資料庫的時間點備份來建立資料庫。 sourceDatabaseId 必須指定為現有資料庫的資源標識符，而且必須指定 restorePointInTime。復原：藉由還原異地復寫備份來建立資料庫。 sourceDatabaseId 必須指定為要還原的可復原資料庫資源標識符。還原：藉由還原已刪除資料庫的備份來建立資料庫。必須指定sourceDatabaseId。如果 sourceDatabaseId 是資料庫的原始資源識別碼，則必須指定 sourceDatabaseDeletionDate。否則，sourceDatabaseId 必須是可還原的卸除資料庫資源標識符，而且會忽略 sourceDatabaseDeletionDate。 restorePointInTime 也可以指定為從先前的時間點還原。 RestoreLongTermRetentionBackup：從長期保留保存庫還原來建立資料庫。 recoveryServicesRecoveryPointResourceId 必須指定為恢復點資源標識符。 DataWarehouse 版本不支援 Copy、Secondary 和 RestoreLongTermRetentionBackup。	'Copy' 'Default' 'OnlineSecondary' 'PointInTimeRestore' 'Recovery' 'Restore' 'RestoreExternalBackup' 'RestoreExternalBackupSecondary' 'RestoreLongTermRetentionBackup' 'Secondary'
elasticPoolId	包含此資料庫之彈性集區的資源標識碼。	字串
longTermRetentionBackupResourceId	與此資料庫建立作業相關聯的長期保留備份資源標識符。	字串
maxSizeBytes	以位元組表示的資料庫大小上限。	int
recoverableDatabaseId	與此資料庫建立作業相關聯的可復原資料庫資源標識符。	字串
recoveryServicesRecoveryPointId	與此資料庫建立作業相關聯的恢復點資源標識碼。	字串
restorableDroppedDatabaseId	與這個資料庫建立作業相關聯的可還原卸除資料庫資源標識符。	字串
restorePointInTime	指定要還原以建立新資料庫的源資料庫的時間點（ISO8601格式）。	字串
sampleName	建立這個資料庫時要套用的範例架構名稱。	'AdventureWorksLT' 'WideWorldImportersFull' 'WideWorldImportersStd'
sourceDatabaseDeletionDate	指定刪除資料庫的時間。	字串
sourceDatabaseId	與這個資料庫建立作業相關聯的源資料庫資源標識符。	字串
zoneRedundant	此資料庫是否為區域備援，這表示此資料庫的複本會分散到多個可用性區域。	bool

Microsoft.Sql/servers/databases

名字	描述	價值
位置	資源位置。	字串（必要）
名字	資源名稱	字串（必要）
parent_id	此資源為父系之資源的標識碼。	類型資源的標識碼：伺服器
性能	資源屬性。	DatabaseProperties
sku	SKU 的名稱和層。	Sku
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.Sql/servers/databases@2017-03-01-preview”

Sku

名字	描述	價值
能力	特定 SKU 的容量。	int
家庭	如果服務有不同世代的硬體，針對相同的 SKU，則可以在這裡擷取。	字串
名字	SKU 的名稱，通常是字母 + 數位碼，例如 P3。	字串（必要）
大小	特定 SKU 的大小	字串
層	特定 SKU 的階層或版本，例如基本、進階。	字串

TrackedResourceTags

名字	描述	價值

共用方式為

Microsoft.Sql servers/databases 2017-03-01-preview

Bicep 資源定義

資源格式

屬性值

DatabaseProperties

Microsoft.Sql/servers/databases

Sku

TrackedResourceTags

快速入門範例

ARM 樣本資源定義

資源格式

屬性值

DatabaseProperties

Microsoft.Sql/servers/databases

Sku

TrackedResourceTags

快速入門範本

Terraform （AzAPI 提供者）資源定義

資源格式

屬性值

DatabaseProperties

Microsoft.Sql/servers/databases

Sku

TrackedResourceTags

意見反應

其他資源

共用方式為

Microsoft.Sql servers/databases 2017-03-01-preview

Bicep 資源定義

資源格式

屬性值

DatabaseProperties

Microsoft.Sql/servers/databases

Sku

TrackedResourceTags

快速入門範例

ARM 樣本資源定義

資源格式

屬性值

DatabaseProperties

Microsoft.Sql/servers/databases

Sku

TrackedResourceTags

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

DatabaseProperties

Microsoft.Sql/servers/databases

Sku

TrackedResourceTags

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義