Microsoft.Sql servers/databases

  • 發行項

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.Sql/servers/databases@2023-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    autoPauseDelay: int
    availabilityZone: 'string'
    catalogCollation: 'string'
    collation: 'string'
    createMode: 'string'
    elasticPoolId: 'string'
    encryptionProtector: 'string'
    encryptionProtectorAutoRotation: bool
    federatedClientId: 'string'
    freeLimitExhaustionBehavior: 'string'
    highAvailabilityReplicaCount: int
    isLedgerOn: bool
    keys: {
      {customized property}: {}
    }
    licenseType: 'string'
    longTermRetentionBackupResourceId: 'string'
    maintenanceConfigurationId: 'string'
    manualCutover: bool
    maxSizeBytes: int
    minCapacity: json('decimal-as-string')
    performCutover: bool
    preferredEnclaveType: 'string'
    readScale: 'string'
    recoverableDatabaseId: 'string'
    recoveryServicesRecoveryPointId: 'string'
    requestedBackupStorageRedundancy: 'string'
    restorableDroppedDatabaseId: 'string'
    restorePointInTime: 'string'
    sampleName: 'string'
    secondaryType: 'string'
    sourceDatabaseDeletionDate: 'string'
    sourceDatabaseId: 'string'
    sourceResourceId: 'string'
    useFreeLimit: bool
    zoneRedundant: bool
  }
}

屬性值

servers/databases

名稱 描述 值
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。		 字串 (必要)

字元限制：1-128

合法字元：
不能使用：
<>*%&:\/? 或控制字元

不能以句號或空格結尾。
location 資源位置。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku 資料庫 SKU。

SKU 清單可能會因區域和支援供應專案而有所不同。 若要判斷 SKU (包括 SKU 名稱、層/版本、系列和容量) ，這些 SKU 可供您在 Azure 區域中的訂用帳戶使用，請使用 Capabilities_ListByLocation REST API 或下列其中一個命令：

Azure CLI：
az sql db list-editions -l {location} -o table



Azure PowerShell：
Get-AzSqlServerServiceObjective -Location {location}

 Sku
父系 (parent) 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱： 伺服器
身分識別 資料庫的 Azure Active Directory 身分識別。 DatabaseIdentity
properties 資源屬性。 DatabaseProperties

DatabaseIdentity

名稱 描述 值
類型 身分識別類型 'None'
'UserAssigned'
userAssignedIdentities 要使用的使用者指派身分識別的資源標識碼 DatabaseIdentityUserAssignedIdentities

DatabaseIdentityUserAssignedIdentities

名稱 描述 值
{自定義屬性} DatabaseUserIdentity

DatabaseUserIdentity

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

DatabaseProperties

名稱 描述 值
autoPauseDelay 在幾分鐘后自動暫停資料庫的時間。 值為 -1 表示自動暫停已停用 int
availabilityZone 指定資料庫釘選到的可用性區域。 '1'
'2'
'3'
'NoPreference'
catalogCollation 元資料目錄的定序。 'DATABASE_DEFAULT'
'SQL_Latin1_General_CP1_CI_AS'
collation 資料庫的定序。 字串
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 包含此資料庫之彈性集區的資源標識碼。 字串
encryptionProtector 如果資料庫已設定每個資料庫客戶管理的金鑰，則資料庫的 Azure 金鑰保存庫 URI。 字串
encryptionProtectorAutoRotation 啟用或停用資料庫加密保護裝置 AKV 金鑰自動輪替的旗標。 bool
federatedClientId 每個資料庫 CMK 案例用於跨租使用者的用戶端識別碼 字串

約束：
最小長度 = 36
最大長度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
freeLimitExtionBehavior 指定免費資料庫的每月可用限制耗盡時的行為。

AutoPause：資料庫將在當月剩餘的可用限制耗盡時自動暫停。

BillForUsage：資料庫在免費限制耗盡時會繼續上線，而且任何超額都會計費。		 'AutoPause'
'BillOverUsage'
highAvailabilityReplicaCount 與用來提供高可用性之資料庫相關聯的次要複本數目。 不適用於彈性集區內的超大規模資料庫。 int
isLedgerOn 不論此資料庫是否為總賬資料庫，這表示資料庫中的所有數據表都是總賬數據表。 注意：建立資料庫之後，無法變更此屬性的值。 bool
金鑰 要使用的使用者指派身分識別的資源標識碼 DatabasePropertiesKeys
licenseType 要套用此資料庫的授權類型。 LicenseIncluded如果您需要授權，或BasePrice您擁有授權且符合 Azure Hybrid Benefit 資格。 'BasePrice'
'LicenseIncluded'
longTermRetentionBackupResourceId 與此資料庫建立作業相關聯的長期保留備份資源標識符。 字串
maintenanceConfigurationId 指派給資料庫的維護組態標識碼。 此組態會定義維護更新發生的期間。 字串
manualCutover 客戶是否需要在將資料庫更新至超大規模資料庫作業期間完成客戶控制的手動完全移轉。

只有在將資料庫從 業務關鍵/常規用途/進階/標準層調整為超大規模資料庫層時，此屬性才適用。

指定manualCutover時，調整作業會等候使用者輸入觸發切換至超大規模資料庫。

若要觸發完全移轉，請在調整作業處於等候狀態時提供 『performCutover』 參數。		 bool
maxSizeBytes 以位元組表示的資料庫大小上限。 int
minCapacity 資料庫一律已配置的最小容量，如果未暫停 若要指定十進位值，請使用 json () 函式。 int 或 json decimal
performCutover 在調整作業進行期間觸發客戶控制的手動完全移轉。

這個屬性參數僅適用於與 『manualCutover』 參數一起起始的調整作業。

只有在已將資料庫從 業務關鍵/常規用途/進階/標準層調整為超大規模資料庫層時，才適用此屬性。

指定 performCutover 時，調整作業會觸發完全移轉，並執行超大規模資料庫的角色變更。		 bool
preferredEnclaveType 在資料庫上要求的記憶體保護區類型，也就是預設或 VBS記憶體保護區。 'Default'
'VBS'
readScale 唯讀路由的狀態。 如果啟用，讓應用程式意圖在其 連接字串 中設為唯讀的連線，可能會路由傳送至相同區域中的唯讀次要複本。 不適用於彈性集區內的超大規模資料庫。 'Disabled'
'Enabled'
recoverableDatabaseId 與此資料庫建立作業相關聯的可復原資料庫資源標識符。 字串
recoveryServicesRecoveryPointId 與此資料庫建立作業相關聯的恢復點資源標識碼。 字串
requestedBackupStorageRedundancy 用來儲存此資料庫的備份的記憶體帳戶類型。 'Geo'
'GeoZone'
'Local'
'Zone'
restorableDroppedDatabaseId 與這個資料庫的建立作業相關聯的可還原卸除資料庫資源標識符。 字串
restorePointInTime 指定將還原以建立新資料庫之源資料庫) 格式 (ISO8601 時間點。 字串
sampleName 建立此資料庫時要套用的範例架構名稱。 'AdventureWorksLT'
'WideWorldImportersFull'
'WideWorldImportersStd'
secondaryType 如果資料庫是次要資料庫，則為次要類型。 有效值為 Geo、Named 和 Standby。 'Geo'
'Named'
'Standby'
sourceDatabaseDeletionDate 指定刪除資料庫的時間。 字串
sourceDatabaseId 與此資料庫建立作業相關聯的源資料庫資源標識符。 字串
sourceResourceId 與此資料庫建立作業相關聯的來源資源標識符。

只有 DataWarehouse 版本才支援此屬性，並允許跨訂用帳戶還原。

指定 sourceResourceId 時，sourceDatabaseId、recoverableDatabaseId、restoreableDroppedDatabaseId 和 sourceDatabaseDeletionDate 不得指定，而且 CreateMode 必須是 PointInTimeRestore、Restore 或 Recover。

當 createMode 是 PointInTimeRestore 時，sourceResourceId 必須是現有資料庫或現有 sql 集區的資源標識碼，而且必須指定 restorePointInTime。

當 createMode 為 Restore 時，sourceResourceId 必須是可還原卸除資料庫的資源識別碼或可還原的卸除 SQL 集區。

當 createMode 為 Recovery 時，sourceResourceId 必須是可復原資料庫或可復原 SQL 集區的資源標識符。

當來源訂用帳戶屬於與目標訂用帳戶不同的租使用者時，“x-ms-authorization-auxiliary” 標頭必須包含來源租使用者的驗證令牌。 如需 「x-ms-authorization-auxiliary」 標頭的詳細資訊，請參閱 /azure/azure-resource-manager/management/authentication-multi-tenant		 字串
useFreeLimit 資料庫是否使用免費的每月限制。 在訂用帳戶中的一個資料庫上允許。 bool
zoneRedundant 不論此資料庫是否為區域備援，這表示此資料庫的複本將會分散到多個可用性區域。 bool

DatabasePropertiesKeys

名稱 描述 值
{自定義屬性} DatabaseKey

DatabaseKey

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

SKU

名稱 描述 值
處理能力 特定 SKU 的容量。 int
family 如果服務有不同層代的硬體，則針對相同的SKU，則可以在這裡擷取。 字串
NAME SKU 的名稱，通常是字母 + 數字代碼，例如 P3。 字串 (必要)
{1}size{2} 特定 SKU 的大小 字串
tier 特定 SKU 的層級或版本，例如基本、進階。 字串

快速入門範本

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

範本 描述
具有 SQL Database 的 Django 應用程式

部署至 Azure		 此範本會使用 Azure Linux CustomScript 擴充功能來部署應用程式。 此範例會建立Ubuntu VM、執行 Python、Django 和 Apache 的無訊息安裝，然後建立簡單的 Django 應用程式。 此範本也會建立一個 SQL Database，其中範例數據表包含一些使用查詢在網頁瀏覽器中顯示的範例數據
Azure 中的 EPiserverCMS

部署至 Azure		 此範本可讓您在 Azure 中建立 EpiServerCMS 部署所需的資源
使用 Azure SQL Database 自動調整 LANSA Windows VM ScaleSet

部署至 Azure		 此範本會部署具有擴展集中所需 VM 計數的 Windows VMSS，以及安裝到每個 VM 的 LANSA MSI。 部署 VM 擴展集之後，就會使用自定義腳本擴充功能來安裝 LANSA MSI)
使用試用授權部署 Octopus Deploy 3.0

部署至 Azure		 此範本可讓您使用試用版授權部署單一 Octopus Deploy 3.0 伺服器。 這會部署在單一 Windows Server 2012R2 VM 上， (Standard D2) 和 SQL DB (S1 層) 到資源群組指定的位置。
Orchard CMS 影片入口網站 Web 應用程式

部署至 Azure		 此範本可讓您輕鬆地在 Azure App 服務 Web Apps 上部署一個可啟用及設定 Azure 媒體服務模組的一種方式。
可調整的 Umbraco CMS Web 應用程式

部署至 Azure		 此範本提供在 Azure App 服務 Web Apps 上部署 umbraco CMS Web 應用程式的簡單方式。
簡單 Umbraco CMS Web 應用程式

部署至 Azure		 此範本提供在 Azure App 服務 Web Apps 上部署 umbraco CMS Web 應用程式的簡單方式。
Enterprise Governance-AppService、SQL DB、AD、OMS、Runbook

部署至 Azure		 企業或大型的雲端採用需要負責任且有效率的治理模型，才能從其雲端部署衍生價值。 CloudWise (解決方案的程式代碼名稱) ，是 Azure 合作夥伴快速入門提供的複合解決方案，是客戶、系統整合者和合作夥伴的採用啟用者，可提供可自助、自動化的治理和作業解決方案，著重於優化成本、改善您的應用程式 () 可靠性、降低商務風險。 解決方案強調可見度和控制的核心治理要素。
具有 ILB ASE 的 eShop 網站

部署至 Azure		 App Service 環境是 Azure App Service 的進階服務方案選項，提供完全隔離的專用環境，能夠極為安全地執行 Azure App Service 應用程式，包括 Web Apps、Mobile Apps 和 API Apps。
使用 Azure SQL 私人端點的 WebApp

部署至 Azure		 此範本示範如何建立 Web 應用程式，以取用指向 Azure SQL Server 的私人端點
具有高可用性的遠端桌面服務

部署至 Azure		 此 ARM 範例程式代碼會部署具有高可用性的 遠端桌面服務 2019 工作階段集合 實驗室。 目標是使用 Windows Server 2019 部署遠端桌面服務的完整備援高可用性解決方案。
在 Azure 架構上部署運動分析

部署至 Azure		 建立已啟用 ADLS Gen 2 的 Azure 記憶體帳戶、具有記憶體帳戶連結服務的 Azure Data Factory 實例， (部署) 和 Azure Databricks 實例時 Azure SQL 資料庫。 部署範本的使用者 AAD 身分識別和 ADF 實例的受控識別將會獲得記憶體帳戶上的記憶體 Blob 數據參與者角色。 此外，還有選項可用來部署 Azure 金鑰保存庫 實例、Azure SQL 資料庫，以及用於串流使用案例的 Azure 事件中樞 () 。 部署 Azure 金鑰保存庫 時，系統會將部署範本之使用者的數據處理站受控識別和 AAD 身分識別授與 金鑰保存庫 秘密使用者角色。
具有 SQL Database、Azure Cosmos DB、Azure 搜尋服務的 Web 應用程式

部署至 Azure		 此範本會布建 Web 應用程式、SQL Database、Azure Cosmos DB、Azure 搜尋服務和 Application Insights。
使用 Azure DMS 遷移至 Azure SQL 資料庫

部署至 Azure		 Azure 資料移轉服務 (DMS) 的設計目的是簡化將內部部署資料庫移轉至 Azure 的程式。 DMS 將簡化現有內部部署 SQL Server 和 Oracle 資料庫的移轉至 Azure 虛擬機中的 Azure SQL 資料庫、Azure SQL 受控執行個體 或 Microsoft SQL Server。 此範本會部署 Azure 資料庫移轉服務的實例、已安裝 SQL Server 的 Azure VM，該 VM 會作為其上預先建立的資料庫，以及目標 Azure SQL DB 伺服器，該伺服器將會有預先建立的資料庫架構，以便從來源移轉至目標伺服器。 此範本也會部署所需的資源，例如 NIC、vnet 等，以支援來源 VM、DMS 服務和目標伺服器。
在 VNET 中使用自訂 Ambari + Hive 中繼存放區 DB 的 HDInsight

部署至 Azure		 此範本可讓您在現有的虛擬網路中建立 HDInsight 叢集，此叢集具有新的 SQL DB，可同時作為自定義 Ambari DB 和 Hive 中繼存放區。 您必須有現有的 SQL Sever、記憶體帳戶和 VNET。
部署 HDInsight 叢集和 SQL 資料庫

部署至 Azure		 此範本可讓您建立 HDInsight 叢集和用於測試 Sqoop 的 SQL Database。
私人端點範例

部署至 Azure		 此範本示範如何建立指向 Azure SQL Server 的私人端點
Azure SQL 寫入事件中樞稽核的伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入事件中樞
Azure SQL 寫入 Log Analytics 稽核的伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入 Log Analytics (OMS 工作區)
具有透明加密的專用SQL集區

部署至 Azure		 使用透明數據加密建立 SQL Server 和專用 SQL 集區 (先前稱為 SQL DW) 。
建立 SQL Server 和資料庫

部署至 Azure		 此範本可讓您建立 SQL Database和伺服器。
使用 TDE 布建 SQL Database

部署至 Azure		 此範本會布建已針對 Azure 流量開啟防火牆的 SQL Server，以及具有透明數據加密 (TDE) 的 SQL 資料庫。
部署新的 SQL 彈性集區

部署至 Azure		 此範本可讓您部署新的 SQL 彈性集區及其新的相關聯 SQL Server，以及要指派給它的新 SQL Database。
使用故障轉移群組建立 Azure SQL 伺服器和資料庫

部署至 Azure		 建立兩個 Azure SQL 伺服器、資料庫和故障轉移群組。
使用 Azure SQL 後端 App Service 環境

部署至 Azure		 此範本會建立 App Service 環境 搭配 Azure SQL 後端以及私人端點，以及通常用於私人/隔離環境中的相關聯資源。
使用 SQL Database 布建行動應用程式

部署至 Azure		 此範本會布建行動應用程式、SQL Database和通知中樞。 它會在資料庫和通知中樞的行動應用程式中設定 連接字串。
具有受控識別、SQL Server和 ΑΙ 的 Web 應用程式

部署至 Azure		 針對應用程式 + 資料 + 受控識別 + 監視部署 Azure 基礎結構的簡單範例
使用範本建立 Web 應用程式 + Redis 快取 + SQL DB

部署至 Azure		 此範本會建立具有 Redis 快取和 SQL Database 的 Azure Web 應用程式。
使用 SQL Database 布建 Web 應用程式

部署至 Azure		 此範本會布建 Web 應用程式、SQL Database、自動調整設定、警示規則和 App Insights。 它會在資料庫的 Web 應用程式中設定 連接字串。
建立、設定及部署 Web 應用程式至 Azure VM

部署至 Azure		 使用 SQL Azure 資料庫建立及設定 Windows VM，並使用 PowerShell DSC 將 Web 應用程式部署至環境
使用 Azure SQL 在 Linux 上使用 Sonarqube Docker Web 應用程式

部署至 Azure		 此範本會使用官方 Sonarqube 映像，並將 Sonarqube 部署在 Azure App 服務 Web 應用程式 Linux 容器中，並由 Azure SQL 伺服器支援。

ARM 範本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.Sql/servers/databases",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "autoPauseDelay": "int",
    "availabilityZone": "string",
    "catalogCollation": "string",
    "collation": "string",
    "createMode": "string",
    "elasticPoolId": "string",
    "encryptionProtector": "string",
    "encryptionProtectorAutoRotation": "bool",
    "federatedClientId": "string",
    "freeLimitExhaustionBehavior": "string",
    "highAvailabilityReplicaCount": "int",
    "isLedgerOn": "bool",
    "keys": {
      "{customized property}": {}
    },
    "licenseType": "string",
    "longTermRetentionBackupResourceId": "string",
    "maintenanceConfigurationId": "string",
    "manualCutover": "bool",
    "maxSizeBytes": "int",
    "minCapacity": "[json('decimal-as-string')]",
    "performCutover": "bool",
    "preferredEnclaveType": "string",
    "readScale": "string",
    "recoverableDatabaseId": "string",
    "recoveryServicesRecoveryPointId": "string",
    "requestedBackupStorageRedundancy": "string",
    "restorableDroppedDatabaseId": "string",
    "restorePointInTime": "string",
    "sampleName": "string",
    "secondaryType": "string",
    "sourceDatabaseDeletionDate": "string",
    "sourceDatabaseId": "string",
    "sourceResourceId": "string",
    "useFreeLimit": "bool",
    "zoneRedundant": "bool"
  }
}

屬性值

servers/databases

名稱 描述 值
類型 資源類型 'Microsoft.Sql/servers/databases'
apiVersion 資源 API 版本 '2023-05-01-preview'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。		 字串 (必要)

字元限制：1-128

合法字元：
不能使用：
<>*%&:\/? 或控制字元

不能以句號或空格結尾。
location 資源位置。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku 資料庫 SKU。

SKU 清單可能會因區域和支援供應專案而有所不同。 若要判斷 SKU (包括 SKU 名稱、層/版本、系列和容量) ，這些 SKU 可供您在 Azure 區域中的訂用帳戶使用，請使用 Capabilities_ListByLocation REST API 或下列其中一個命令：

Azure CLI：
az sql db list-editions -l {location} -o table



Azure PowerShell：
Get-AzSqlServerServiceObjective -Location {location}

 Sku
身分識別 資料庫的 Azure Active Directory 身分識別。 DatabaseIdentity
properties 資源屬性。 DatabaseProperties

DatabaseIdentity

名稱 描述 值
類型 身分識別類型 'None'
'UserAssigned'
userAssignedIdentities 要使用的使用者指派身分識別的資源標識碼 DatabaseIdentityUserAssignedIdentities

DatabaseIdentityUserAssignedIdentities

名稱 描述 值
{自定義屬性} DatabaseUserIdentity

DatabaseUserIdentity

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

DatabaseProperties

名稱 描述 值
autoPauseDelay 在幾分鐘后自動暫停資料庫的時間。 值為 -1 表示自動暫停已停用 int
availabilityZone 指定資料庫釘選到的可用性區域。 '1'
'2'
'3'
'NoPreference'
catalogCollation 元資料目錄的定序。 'DATABASE_DEFAULT'
'SQL_Latin1_General_CP1_CI_AS'
collation 資料庫的定序。 字串
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 包含此資料庫之彈性集區的資源標識碼。 字串
encryptionProtector 如果資料庫已設定每個資料庫客戶管理的金鑰，則資料庫的 Azure 金鑰保存庫 URI。 字串
encryptionProtectorAutoRotation 啟用或停用資料庫加密保護裝置 AKV 金鑰自動輪替的旗標。 bool
federatedClientId 每個資料庫 CMK 案例用於跨租使用者的用戶端識別碼 字串

約束：
最小長度 = 36
最大長度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
freeLimitExtionBehavior 指定免費資料庫的每月可用限制耗盡時的行為。

AutoPause：資料庫將在當月剩餘的可用限制耗盡時自動暫停。

BillForUsage：資料庫在免費限制耗盡時會繼續上線，而且任何超額都會計費。		 'AutoPause'
'BillOverUsage'
highAvailabilityReplicaCount 與用來提供高可用性之資料庫相關聯的次要複本數目。 不適用於彈性集區內的超大規模資料庫。 int
isLedgerOn 不論此資料庫是否為總賬資料庫，這表示資料庫中的所有數據表都是總賬數據表。 注意：建立資料庫之後，無法變更此屬性的值。 bool
金鑰 要使用的使用者指派身分識別的資源標識碼 DatabasePropertiesKeys
licenseType 要套用此資料庫的授權類型。 LicenseIncluded如果您需要授權，或BasePrice如果您有授權且符合 Azure Hybrid Benefit 資格。 'BasePrice'
'LicenseIncluded'
longTermRetentionBackupResourceId 與此資料庫建立作業相關聯的長期保留備份資源標識符。 字串
maintenanceConfigurationId 指派給資料庫的維護組態標識碼。 此組態會定義維護更新發生的期間。 字串
manualCutover 客戶是否需要在將資料庫更新至超大規模資料庫作業期間完成客戶控制的手動完全移轉。

只有在將資料庫從 業務關鍵/常規用途/進階/標準層調整為超大規模資料庫層時，此屬性才適用。

指定manualCutover時，調整作業會等候使用者輸入觸發切換至超大規模資料庫。

若要觸發完全移轉，請在調整作業處於等候狀態時提供 『performCutover』 參數。		 bool
maxSizeBytes 以位元組表示的資料庫大小上限。 int
minCapacity 資料庫一律已配置的最小容量，如果未暫停 若要指定十進位值，請使用 json () 函式。 int 或 json decimal
performCutover 在調整作業進行期間觸發客戶控制的手動完全移轉。

這個屬性參數僅適用於與 『manualCutover』 參數一起起始的調整作業。

只有在已將資料庫從 業務關鍵/常規用途/進階/標準層調整為超大規模資料庫層時，才適用此屬性。

指定 performCutover 時，調整作業會觸發完全移轉，並執行超大規模資料庫的角色變更。		 bool
preferredEnclaveType 在資料庫上要求的記憶體保護區類型，也就是預設或 VBS記憶體保護區。 'Default'
'VBS'
readScale 唯讀路由的狀態。 如果啟用，則應用程式意圖設定為唯讀的連線 連接字串 可能會路由傳送至相同區域中的唯讀次要複本。 不適用於彈性集區內的超大規模資料庫。 'Disabled'
'Enabled'
recoverableDatabaseId 與此資料庫建立作業相關聯的可復原資料庫資源標識符。 字串
recoveryServicesRecoveryPointId 與此資料庫建立作業相關聯的恢復點資源標識碼。 字串
requestedBackupStorageRedundancy 用來儲存此資料庫的備份的記憶體帳戶類型。 'Geo'
'GeoZone'
'Local'
'Zone'
restorableDroppedDatabaseId 與這個資料庫的建立作業相關聯的可還原卸除資料庫資源標識符。 字串
restorePointInTime 指定將還原以建立新資料庫之源資料庫) 格式 (ISO8601 時間點。 字串
sampleName 建立此資料庫時要套用的範例架構名稱。 'AdventureWorksLT'
'WideWorldImportersFull'
'WideWorldImportersStd'
secondaryType 如果資料庫是次要資料庫，則為次要類型。 有效值為 Geo、Named 和 Standby。 'Geo'
'Named'
'Standby'
sourceDatabaseDeletionDate 指定刪除資料庫的時間。 字串
sourceDatabaseId 與此資料庫建立作業相關聯的源資料庫資源標識符。 字串
sourceResourceId 與此資料庫建立作業相關聯的來源資源標識符。

只有 DataWarehouse 版本才支援此屬性，並允許跨訂用帳戶還原。

指定 sourceResourceId 時，sourceDatabaseId、recoverableDatabaseId、restoreableDroppedDatabaseId 和 sourceDatabaseDeletionDate 不得指定，而且 CreateMode 必須是 PointInTimeRestore、Restore 或 Recover。

當 createMode 是 PointInTimeRestore 時，sourceResourceId 必須是現有資料庫或現有 sql 集區的資源標識碼，而且必須指定 restorePointInTime。

當 createMode 為 Restore 時，sourceResourceId 必須是可還原卸除資料庫的資源識別碼或可還原的卸除 SQL 集區。

當 createMode 為 Recovery 時，sourceResourceId 必須是可復原資料庫或可復原 SQL 集區的資源標識符。

當來源訂用帳戶屬於與目標訂用帳戶不同的租使用者時，“x-ms-authorization-auxiliary” 標頭必須包含來源租使用者的驗證令牌。 如需 「x-ms-authorization-auxiliary」 標頭的詳細資訊，請參閱 /azure/azure-resource-manager/management/authentication-multi-tenant		 字串
useFreeLimit 資料庫是否使用免費的每月限制。 在訂用帳戶中的一個資料庫上允許。 bool
zoneRedundant 不論此資料庫是否為區域備援，這表示此資料庫的複本將會分散到多個可用性區域。 bool

DatabasePropertiesKeys

名稱 描述 值
{自定義屬性} DatabaseKey

DatabaseKey

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

SKU

名稱 描述 值
處理能力 特定 SKU 的容量。 int
family 如果服務有不同層代的硬體，則針對相同的SKU，則可以在這裡擷取。 字串
NAME SKU 的名稱，通常是字母 + 數字代碼，例如 P3。 字串 (必要)
{1}size{2} 特定 SKU 的大小 字串
tier 特定 SKU 的層級或版本，例如基本、進階。 字串

快速入門範本

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

範本 描述
具有 SQL Database 的 Django 應用程式

部署至 Azure		 此範本會使用 Azure Linux CustomScript 擴充功能來部署應用程式。 此範例會建立Ubuntu VM、執行 Python、Django 和 Apache 的無訊息安裝，然後建立簡單的 Django 應用程式。 此範本也會建立 SQL Database，其中包含使用查詢在網頁瀏覽器中顯示的一些範例數據範例數據表
Azure 中的 EPiserverCMS

部署至 Azure		 此範本可讓您在 Azure 中建立 EpiServerCMS 部署所需的資源
使用 Azure SQL Database 自動調整 LANSA Windows VM ScaleSet

部署至 Azure		 此範本會部署具有擴展集中所需 VM 計數的 Windows VMSS，以及安裝到每個 VM 的 LANSA MSI。 部署 VM 擴展集之後，就會使用自定義腳本擴充功能來安裝 LANSA MSI)
使用試用授權部署 Octopus Deploy 3.0

部署至 Azure		 此範本可讓您使用試用版授權部署單一 Octopus Deploy 3.0 伺服器。 這會部署在單一 Windows Server 2012R2 VM 上， (Standard D2) 和 SQL DB (S1 層) 到資源群組指定的位置。
Orchard CMS 影片入口網站 Web 應用程式

部署至 Azure		 此範本可讓您輕鬆地在 Azure App 服務 Web Apps 上部署一個可啟用和設定 Azure 媒體服務模組的 Orchard CMS。
可調整的 Umbraco CMS Web 應用程式

部署至 Azure		 此範本可讓您輕鬆地在 Azure App 服務 Web Apps 上部署 umbraco CMS Web 應用程式。
簡單 Umbraco CMS Web 應用程式

部署至 Azure		 此範本可讓您輕鬆地在 Azure App 服務 Web Apps 上部署 umbraco CMS Web 應用程式。
Enterprise Governance-AppService、SQL DB、AD、OMS、Runbook

部署至 Azure		 企業或大型的雲端採用需要負責任且有效率的治理模型，才能從其雲端部署衍生價值。 CloudWise (解決方案) 的程式代碼名稱，是 Azure 合作夥伴快速入門中提供的複合解決方案，是客戶、系統整合者和合作夥伴的採用啟用者，可提供自助式、自動化的治理和作業解決方案，著重於優化成本、改善應用程式 () 可靠性、降低商務風險。 此解決方案強調可見度和控制的核心治理要素。
使用 ILB ASE 的 eShop 網站

部署至 Azure		 App Service 環境是 Azure App Service 的進階服務方案選項，提供完全隔離的專用環境，能夠極為安全地執行 Azure App Service 應用程式，包括 Web Apps、Mobile Apps 和 API Apps。
使用 Azure SQL 私人端點的 WebApp

部署至 Azure		 此範本示範如何建立 Web 應用程式，以取用指向 Azure SQL Server 的私人端點
具有高可用性的遠端桌面服務

部署至 Azure		 此 ARM 範例程式代碼會部署具有高可用性的 遠端桌面服務 2019 工作階段集合 實驗室。 目標是使用 Windows Server 2019 部署遠端桌面服務的完整備援高可用性解決方案。
在 Azure 架構上部署運動分析

部署至 Azure		 建立已啟用 ADLS Gen 2 的 Azure 記憶體帳戶、具有記憶體帳戶連結服務的 Azure Data Factory 實例， (部署) 和 Azure Databricks 實例時 Azure SQL 資料庫。 部署範本的使用者 AAD 身分識別和 ADF 實例的受控識別，將會獲得記憶體帳戶上的記憶體 Blob 數據參與者角色。 您也可以選擇部署 Azure 金鑰保存庫 實例、Azure SQL 資料庫，以及用於串流使用案例的 Azure 事件中樞 () 。 部署 Azure 金鑰保存庫 時，部署範本之用戶的數據處理站受控識別和 AAD 身分識別將會獲得 金鑰保存庫 秘密使用者角色。
具有 SQL Database、Azure Cosmos DB、Azure 搜尋服務的 Web 應用程式

部署至 Azure		 此範本會布建 Web 應用程式、SQL Database、Azure Cosmos DB、Azure 搜尋服務和 Application Insights。
使用 Azure DMS 遷移至 Azure SQL 資料庫

部署至 Azure		 Azure 資料移轉服務 (DMS) 的設計目的是簡化將內部部署資料庫移轉至 Azure 的程式。 DMS 會簡化將現有的內部部署 SQL Server 和 Oracle 資料庫移轉至 Azure 虛擬機中的 Azure SQL 資料庫、Azure SQL 受控執行個體 或 Microsoft SQL Server。 此範本會部署 Azure 資料庫移轉服務的實例、其上安裝 SQL Server 的 Azure VM，其會作為來源伺服器，其中具有預先建立的資料庫，以及目標 Azure SQL DB 伺服器，其具有要從來源移轉至目標伺服器的預先建立資料庫架構。 此範本也會部署所需的資源，例如 NIC、vnet 等，以支援來源 VM、DMS 服務和目標伺服器。
具有 VNET 中自定義 Ambari + Hive 中繼存放區 DB 的 HDInsight

部署至 Azure		 此範本可讓您使用新的 SQL DB，在現有的虛擬網路中建立 HDInsight 叢集，以做為自定義 Ambari DB 和 Hive 中繼存放區。 您必須擁有現有的 SQL Sever、記憶體帳戶和 VNET。
部署 HDInsight 叢集和 SQL 資料庫

部署至 Azure		 此範本可讓您建立 HDInsight 叢集和測試 Sqoop 的 SQL Database。
私人端點範例

部署至 Azure		 此範本示範如何建立指向 Azure SQL Server 的私人端點
Azure SQL 寫入事件中樞稽核的伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入事件中樞
已將稽核寫入Log Analytics的 Azure SQL 伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核功能的 Azure SQL 伺服器，以將稽核記錄寫入 Log Analytics (OMS 工作區)
具有透明加密的專用SQL集區

部署至 Azure		 使用透明數據加密建立 SQL Server 和專用 SQL 集區 (先前稱為 SQL DW) 。
建立 SQL Server 和資料庫

部署至 Azure		 此範本可讓您建立 SQL Database和伺服器。
使用 TDE 布建 SQL Database

部署至 Azure		 此範本會布建已針對 Azure 流量開啟防火牆的 SQL Server，並使用透明數據加密 (TDE) 的 SQL 資料庫。
部署新的 SQL 彈性集區

部署至 Azure		 此範本可讓您部署新的 SQL 彈性集區及其新的相關聯 SQL Server，以及要指派給它的新 SQL Database。
使用故障轉移群組建立 Azure SQL 伺服器和資料庫

部署至 Azure		 建立兩部 Azure SQL 伺服器、資料庫和故障轉移群組。
使用 Azure SQL 後端 App Service 環境

部署至 Azure		 此範本會建立具有 Azure SQL 後端以及私人端點的 App Service 環境，以及通常用於私人/隔離環境中的相關聯資源。
使用 SQL Database 布建行動應用程式

部署至 Azure		 此範本會布建行動應用程式、SQL Database和通知中樞。 它會在資料庫和通知中樞的行動應用程式中設定 連接字串。
具有受控識別、SQL Server和 ΑΙ 的 Web 應用程式

部署至 Azure		 為應用程式 + 資料 + 受控識別 + 監視部署 Azure 基礎結構的簡單範例
使用範本建立 Web 應用程式 + Redis 快取 + SQL DB

部署至 Azure		 此範本會建立具有 Redis 快取和 SQL Database 的 Azure Web 應用程式。
使用 SQL Database 布建 Web 應用程式

部署至 Azure		 此範本會布建 Web 應用程式、SQL Database、自動調整設定、警示規則和 App Insights。 它會在資料庫的 Web 應用程式中設定 連接字串。
建立、設定 Web 應用程式並將其部署至 Azure VM

部署至 Azure		 使用 SQL Azure 資料庫建立及設定 Windows VM，並使用 PowerShell DSC 將 Web 應用程式部署至環境
使用 Azure SQL 在 Linux 上使用 Sonarqube Docker Web 應用程式

部署至 Azure		 此範本會使用官方 Sonarqube 映像，並將 Sonarqube 部署在 Azure App 服務 Web 應用程式 Linux 容器中，並由 Azure SQL Server 支援。

Terraform (AzAPI 提供者) 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/databases@2023-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "UserAssigned"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      autoPauseDelay = int
      availabilityZone = "string"
      catalogCollation = "string"
      collation = "string"
      createMode = "string"
      elasticPoolId = "string"
      encryptionProtector = "string"
      encryptionProtectorAutoRotation = bool
      federatedClientId = "string"
      freeLimitExhaustionBehavior = "string"
      highAvailabilityReplicaCount = int
      isLedgerOn = bool
      keys = {
        {customized property} = {}
      }
      licenseType = "string"
      longTermRetentionBackupResourceId = "string"
      maintenanceConfigurationId = "string"
      manualCutover = bool
      maxSizeBytes = int
      minCapacity = "decimal-as-string"
      performCutover = bool
      preferredEnclaveType = "string"
      readScale = "string"
      recoverableDatabaseId = "string"
      recoveryServicesRecoveryPointId = "string"
      requestedBackupStorageRedundancy = "string"
      restorableDroppedDatabaseId = "string"
      restorePointInTime = "string"
      sampleName = "string"
      secondaryType = "string"
      sourceDatabaseDeletionDate = "string"
      sourceDatabaseId = "string"
      sourceResourceId = "string"
      useFreeLimit = bool
      zoneRedundant = bool
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

屬性值

servers/databases

名稱 描述 值
類型 資源類型 “Microsoft.Sql/servers/databases@2023-05-01-preview”
NAME 資源名稱 字串 (必要)

字元限制：1-128

合法字元：
不能使用：
<>*%&:\/? 或控制字元

不能以句號或空格結尾。
location 資源位置。 字串 (必要)
parent_id 此資源之父系的資源標識碼。 類型資源的識別碼： 伺服器
tags 資源標籤。 標記名稱和值的字典。
sku 資料庫 SKU。

SKU 清單可能會因區域和支援供應專案而有所不同。 若要判斷 SKU (包括 SKU 名稱、層/版本、系列和容量) ，這些 SKU 可供您在 Azure 區域中的訂用帳戶使用，請使用 Capabilities_ListByLocation REST API 或下列其中一個命令：

Azure CLI：
az sql db list-editions -l {location} -o table



Azure PowerShell：
Get-AzSqlServerServiceObjective -Location {location}

 Sku
身分識別 資料庫的 Azure Active Directory 身分識別。 DatabaseIdentity
properties 資源屬性。 DatabaseProperties

DatabaseIdentity

名稱 描述 值
類型 身分識別類型 “UserAssigned”
identity_ids 要使用的使用者指派身分識別的資源標識碼 使用者身分識別標識碼的陣列。

DatabaseIdentityUserAssignedIdentities

名稱 描述 值
{自定義屬性} DatabaseUserIdentity

DatabaseUserIdentity

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

DatabaseProperties

名稱 描述 值
autoPauseDelay 在幾分鐘后自動暫停資料庫的時間。 值為 -1 表示自動暫停已停用 int
availabilityZone 指定資料庫釘選到的可用性區域。 「1」
"2"
"3"
“NoPreference”
catalogCollation 元資料目錄的定序。 “DATABASE_DEFAULT”
“SQL_Latin1_General_CP1_CI_AS”
collation 資料庫的定序。 字串
createMode 指定資料庫建立模式。

默認值：一般資料庫建立。

複製：建立資料庫做為現有資料庫的複本。 sourceDatabaseId 必須指定為源資料庫的資源標識碼。

次要：建立資料庫做為現有資料庫的次要複本。 sourceDatabaseId 必須指定為現有主資料庫的資源標識碼。

PointInTimeRestore：藉由還原現有資料庫的時間點備份來建立資料庫。 sourceDatabaseId 必須指定為現有資料庫的資源標識符，而且必須指定 restorePointInTime。

復原：藉由還原異地復寫備份來建立資料庫。 sourceDatabaseId 必須指定為可復原的資料庫資源標識碼，才能還原。

還原：藉由還原已刪除資料庫的備份來建立資料庫。 必須指定sourceDatabaseId。 如果 sourceDatabaseId 是資料庫的原始資源識別碼，則必須指定 sourceDatabaseDeletionDate。 否則，sourceDatabaseId 必須是可還原的卸除資料庫資源標識符，而且會忽略 sourceDatabaseDeletionDate。 restorePointInTime 也可以指定從先前的時間點還原。

RestoreLongTermRetentionBackup：從長期保留保存庫還原來建立資料庫。 recoveryServicesRecoveryPointResourceId 必須指定為恢復點資源標識符。

DataWarehouse 版本不支援 Copy、Secondary 和 RestoreLongTermRetentionBackup。		 "Copy"
“Default”
“OnlineSecondary”
“PointInTimeRestore”
“Recovery”
“還原”
“RestoreExternalBackup”
“RestoreExternalBackupSecondary”
“RestoreLongTermRetentionBackup”
“次要”
elasticPoolId 包含此資料庫之彈性集區的資源標識碼。 字串
encryptionProtector 如果資料庫的 Azure 金鑰保存庫 URI 是針對每個資料庫客戶管理的金鑰進行設定，則為資料庫。 字串
encryptionProtectorAutoRotation 啟用或停用資料庫加密保護裝置 AKV 金鑰自動輪替的旗標。 bool
federatedClientId 每個資料庫 CMK 案例用於跨租使用者的用戶端識別碼 字串

約束：
最小長度 = 36
最大長度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
freeLimitEx連線到Behavior 指定免費資料庫的每月免費限制耗盡時的行為。

AutoPause：資料庫會在當月剩餘的可用限制耗盡時自動暫停。

BillForUsage：資料庫在免費限制耗盡時會繼續上線，而且任何超額都會計費。		 “AutoPause”
“BillOverUsage”
highAvailabilityReplicaCount 與用來提供高可用性之資料庫相關聯的次要複本數目。 不適用於彈性集區內的超大規模資料庫。 int
isLedgerOn 不論此資料庫是否為總賬資料庫，這表示資料庫中的所有數據表都是總賬數據表。 注意：建立資料庫之後，就無法變更此屬性的值。 bool
金鑰 要使用的使用者指派身分識別的資源標識碼 DatabasePropertiesKeys
licenseType 要套用至此資料庫的授權類型。 LicenseIncluded如果您需要授權，或BasePrice如果您有授權且符合 Azure Hybrid Benefit 資格。 “BasePrice”
“LicenseIncluded”
longTermRetentionBackupResourceId 與此資料庫建立作業相關聯的長期保留備份資源標識符。 字串
maintenanceConfigurationId 指派給資料庫的維護組態標識碼。 此組態會定義發生維護更新的期間。 字串
manualCutover 客戶是否需要在更新資料庫作業期間完成客戶控制的手動完全移轉至超大規模資料庫層。

只有在將資料庫從 業務關鍵/常規用途/進階/標準層調整為超大規模資料庫層時，才適用此屬性。

指定manualCutover時，調整作業會等候使用者輸入觸發超大規模資料庫完全移轉。

若要觸發完全移轉，請在調整作業處於等候狀態時提供 『performCutover』 參數。		 bool
maxSizeBytes 以位元組表示的資料庫大小上限。 int
minCapacity 資料庫一律已配置的最小容量，如果未暫停 指定十進位值做為字元串。 int 或 json decimal
performCutover 若要在調整作業進行期間觸發客戶控制的手動完全移轉。

這個屬性參數只適用於與 『manualCutover』 參數一起起始的調整作業。

只有當已將資料庫從 業務關鍵/常規用途/進階/標準層調整為超大規模資料庫層時，才適用此屬性。

指定 performCutover 時，調整作業會觸發完全移轉，並執行超大規模資料庫的角色變更。		 bool
preferredEnclaveType 資料庫上要求的記憶體保護區類型，也就是預設或 VBS記憶體保護區。 “預設值”
“VBS”
readScale 唯讀路由的狀態。 如果啟用，將應用程式意圖設定為唯讀的連線 連接字串 可能會路由傳送至相同區域中的唯讀次要複本。 不適用於彈性集區內的超大規模資料庫。 “Disabled”
“Enabled”
recoverableDatabaseId 與這個資料庫建立作業相關聯的可復原資料庫資源標識符。 字串
recoveryServicesRecoveryPointId 與此資料庫建立作業相關聯的恢復點資源標識碼。 字串
requestedBackupStorageRedundancy 用來儲存此資料庫的備份的記憶體帳戶類型。 “Geo”
“GeoZone”
“Local”
“區域”
restorableDroppedDatabaseId 與這個資料庫的建立作業相關聯的可還原已卸除資料庫資源標識碼。 字串
restorePointInTime 指定將還原以建立新資料庫之源資料庫) (ISO8601 時間點。 字串
sampleName 建立此資料庫時要套用的範例架構名稱。 “AdventureWorksLT”
“WideWorldImportersFull”
“WideWorldImportersStd”
secondaryType 如果資料庫是輔助資料庫，則為次要類型。 有效值為 Geo、Named 和 Standby。 “Geo”
“Named”
“待命”
sourceDatabaseDeletionDate 指定刪除資料庫的時間。 字串
sourceDatabaseId 與此資料庫建立作業相關聯的源資料庫資源標識符。 字串
sourceResourceId 與這個資料庫建立作業相關聯的來源資源標識符。

此屬性僅支援 DataWarehouse 版本，並允許跨訂用帳戶還原。

指定 sourceResourceId 時，sourceDatabaseId、recoverableDatabaseId、restoreableDroppedDatabaseId 和 sourceDatabaseDeletionDate 不得指定，而且 CreateMode 必須是 PointInTimeRestore、Restore 或 Recover。

當 createMode 是 PointInTimeRestore 時，sourceResourceId 必須是現有資料庫或現有 SQL 集區的資源識別碼，而且必須指定 restorePointInTime。

當 createMode 為 Restore 時，sourceResourceId 必須是可還原的已卸除資料庫或可還原的已卸除 SQL 集區的資源識別符。

當 createMode 為 Recover 時，sourceResourceId 必須是可復原資料庫或可復原 SQL 集區的資源標識碼。

當來源訂用帳戶屬於與目標訂用帳戶不同的租使用者時，“x-ms-authorization-auxiliary” 標頭必須包含來源租使用者的驗證令牌。 如需 「x-ms-authorization-auxiliary」 標頭的詳細資訊，請參閱 /azure/azure-resource-manager/management/authenticate-multi-tenant		 字串
useFreeLimit 資料庫是否使用免費的每月限制。 在訂用帳戶中的一個資料庫上允許。 bool
zoneRedundant 不論此資料庫是否為區域備援，這表示此資料庫的複本會分散到多個可用性區域。 bool

DatabasePropertiesKeys

名稱 描述 值
{自定義屬性} DatabaseKey

DatabaseKey

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

SKU

名稱 描述 值
處理能力 特定 SKU 的容量。 int
family 如果服務有不同的硬體世代，則針對相同的 SKU，則可以在這裡擷取。 字串
NAME SKU 的名稱，通常是字母 + 編號代碼，例如 P3。 需要字串 ()
{1}size{2} 特定 SKU 的大小 字串
tier 特定 SKU 的層級或版本，例如基本、進階。 字串