Database interface

套件:

@azure/arm-sql

資料庫資源。

Extends

TrackedResource

屬性

autoPauseDelay	在幾分鐘后自動暫停資料庫的時間。 -1 值表示已停用自動暫停
availabilityZone	指定資料庫釘選到的可用性區域。
catalogCollation	元資料目錄的定序。
collation	資料庫的定序。
createMode	指定資料庫建立模式。 默認值：定期建立資料庫。 複製：建立資料庫做為現有資料庫的複本。 sourceDatabaseId 必須指定為源資料庫的資源標識碼。 次要：建立資料庫做為現有資料庫的次要複本。 sourceDatabaseId 必須指定為現有主資料庫的資源標識碼。 PointInTimeRestore：藉由還原現有資料庫的時間點備份來建立資料庫。 sourceDatabaseId 必須指定為現有資料庫的資源標識符，而且必須指定 restorePointInTime。 復原：藉由還原異地復寫備份來建立資料庫。 sourceDatabaseId 必須指定為要還原的可復原資料庫資源標識符。 還原：藉由還原已刪除資料庫的備份來建立資料庫。 必須指定sourceDatabaseId。 如果 sourceDatabaseId 是資料庫的原始資源識別碼，則必須指定 sourceDatabaseDeletionDate。 否則，sourceDatabaseId 必須是可還原的卸除資料庫資源標識符，而且會忽略 sourceDatabaseDeletionDate。 restorePointInTime 也可以指定為從先前的時間點還原。 RestoreLongTermRetentionBackup：從長期保留保存庫還原來建立資料庫。 recoveryServicesRecoveryPointResourceId 必須指定為恢復點資源標識符。 DataWarehouse 版本不支援 Copy、Secondary 和 RestoreLongTermRetentionBackup。
creationDate	資料庫的建立日期（ISO8601格式）。 注意：這個屬性不會串行化。 它只能由伺服器填入。
currentBackupStorageRedundancy	用來儲存此資料庫的備份的記憶體帳戶類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。
currentServiceObjectiveName	資料庫目前的服務等級目標名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
currentSku	SKU 的名稱和層。 注意：這個屬性不會串行化。 它只能由伺服器填入。
databaseId	資料庫的標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。
defaultSecondaryLocation	這個資料庫的預設次要區域。 注意：這個屬性不會串行化。 它只能由伺服器填入。
earliestRestoreDate	這會記錄此資料庫最早的開始日期和時間（ISO8601格式）。 注意：這個屬性不會串行化。 它只能由伺服器填入。
elasticPoolId	包含此資料庫之彈性集區的資源標識碼。
encryptionProtector	如果資料庫已針對每個資料庫客戶管理的金鑰進行設定，則為資料庫的 Azure 金鑰保存庫 URI。
failoverGroupId	此資料庫所屬的故障轉移群組資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。
federatedClientId	用於每個資料庫跨租使用者的用戶端標識碼 CMK 案例
highAvailabilityReplicaCount	與用來提供高可用性之資料庫相關聯的次要複本數目。 不適用於彈性集區內的超大規模資料庫。
identity	資料庫的 Azure Active Directory 身分識別。
isInfraEncryptionEnabled	此資料庫已啟用基礎結構加密。 注意：這個屬性不會串行化。 它只能由伺服器填入。
isLedgerOn	這個資料庫是否為總賬資料庫，這表示資料庫中的所有數據表都是總賬數據表。 注意：建立資料庫之後，就無法變更此屬性的值。
keys	要使用的使用者指派身分識別的資源標識碼
kind	資料庫種類。 這是用於 Azure 入口網站體驗的元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
licenseType	要套用此資料庫的授權類型。 如果您需要授權，或擁有授權且符合 Azure Hybrid Benefit 資格，請 LicenseIncludedBasePrice。
longTermRetentionBackupResourceId	與此資料庫建立作業相關聯的長期保留備份資源標識符。
maintenanceConfigurationId	指派給資料庫的維護組態標識碼。 此組態會定義維護更新發生的期間。
managedBy	管理資料庫的資源。 注意：這個屬性不會串行化。 它只能由伺服器填入。
manualCutover	客戶控制手動完全移轉是否需要在更新資料庫作業期間完成超大規模資料庫層。 只有在將資料庫從業務關鍵/一般用途/進階/標準層調整為超大規模資料庫層時，才適用此屬性。 指定manualCutover時，調整作業會等候使用者輸入觸發超大規模資料庫完全移轉。 若要觸發完全移轉，請在調整作業處於等候狀態時提供 『performCutover』 參數。
maxLogSizeBytes	這個資料庫的記錄大小上限。 注意：這個屬性不會串行化。 它只能由伺服器填入。
maxSizeBytes	以位元組表示的資料庫大小上限。
minCapacity	資料庫一律配置的最小容量，如果未暫停，則為
pausedDate	用戶設定或動作暫停資料庫的日期（ISO8601格式）。 如果資料庫已就緒，則為 Null。 注意：這個屬性不會串行化。 它只能由伺服器填入。
performCutover	在調整作業進行中時，觸發客戶控制的手動完全移轉。 這個屬性參數僅適用於起始與 'manualCutover' 參數一起起始的調整作業。 只有當資料庫從業務關鍵/一般用途/進階/標準層調整至超大規模資料庫層級正在進行時，才適用此屬性。 指定了performCutover時，調整作業會觸發完全移轉，並執行超大規模資料庫的角色變更。
preferredEnclaveType	資料庫上要求的記憶體保護區類型，也就是預設或 VBS記憶體保護區。
readScale	唯讀路由的狀態。 如果啟用，在其連接字串中將應用程式意圖設定為唯讀的連線，可能會路由傳送至相同區域中的唯讀次要複本。 不適用於彈性集區內的超大規模資料庫。
recoverableDatabaseId	與此資料庫建立作業相關聯的可復原資料庫資源標識符。
recoveryServicesRecoveryPointId	與此資料庫建立作業相關聯的恢復點資源標識碼。
requestedBackupStorageRedundancy	要用來儲存此資料庫的備份的記憶體帳戶類型。
requestedServiceObjectiveName	資料庫所要求的服務等級目標名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
restorableDroppedDatabaseId	與這個資料庫建立作業相關聯的可還原卸除資料庫資源標識符。
restorePointInTime	指定要還原以建立新資料庫的源資料庫的時間點（ISO8601格式）。
resumedDate	使用者動作或資料庫登入繼續資料庫的日期（ISO8601格式）。 如果資料庫暫停，則為 Null。 注意：這個屬性不會串行化。 它只能由伺服器填入。
sampleName	建立這個資料庫時要套用的範例架構名稱。
secondaryType	如果資料庫是輔助資料庫，則為次要類型。 有效值為 Geo、Named 和 Standby。
sku	資料庫 SKU。 SKU 清單可能會因區域和支援供應項目而異。 若要判斷 Azure 區域中訂用帳戶可用的 SKU（包括 SKU 名稱、層/版本、系列和容量），請使用 Capabilities_ListByLocation REST API 或下列其中一個命令： az sql db list-editions -l <location> -o table Get-AzSqlServerServiceObjective -Location <location>
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」 標頭的詳細資訊，請參閱 https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
status	資料庫的狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
zoneRedundant	此資料庫是否為區域備援，這表示此資料庫的複本會分散到多個可用性區域。

繼承的屬性

id	資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。
location	資源位置。
name	資源名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
tags	資源標籤。
type	資源類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

屬性詳細資料

autoPauseDelay

在幾分鐘后自動暫停資料庫的時間。 -1 值表示已停用自動暫停

autoPauseDelay?: number

屬性值

number

availabilityZone

指定資料庫釘選到的可用性區域。

availabilityZone?: string

屬性值

string

catalogCollation

元資料目錄的定序。

catalogCollation?: string

屬性值

string

collation

資料庫的定序。

collation?: string

屬性值

string

createMode

指定資料庫建立模式。

默認值：定期建立資料庫。

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

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

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

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

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

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

DataWarehouse 版本不支援 Copy、Secondary 和 RestoreLongTermRetentionBackup。

createMode?: string

屬性值

string

creationDate

資料庫的建立日期（ISO8601格式）。 注意：這個屬性不會串行化。 它只能由伺服器填入。

creationDate?: Date

屬性值

Date

currentBackupStorageRedundancy

用來儲存此資料庫的備份的記憶體帳戶類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

currentBackupStorageRedundancy?: string

屬性值

string

currentServiceObjectiveName

資料庫目前的服務等級目標名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

currentServiceObjectiveName?: string

屬性值

string

currentSku

SKU 的名稱和層。 注意：這個屬性不會串行化。 它只能由伺服器填入。

currentSku?: Sku

屬性值

Sku

databaseId

資料庫的標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。

databaseId?: string

屬性值

string

defaultSecondaryLocation

這個資料庫的預設次要區域。 注意：這個屬性不會串行化。 它只能由伺服器填入。

defaultSecondaryLocation?: string

屬性值

string

earliestRestoreDate

這會記錄此資料庫最早的開始日期和時間（ISO8601格式）。 注意：這個屬性不會串行化。 它只能由伺服器填入。

earliestRestoreDate?: Date

屬性值

Date

elasticPoolId

包含此資料庫之彈性集區的資源標識碼。

elasticPoolId?: string

屬性值

string

encryptionProtector

如果資料庫已針對每個資料庫客戶管理的金鑰進行設定，則為資料庫的 Azure 金鑰保存庫 URI。

encryptionProtector?: string

屬性值

string

failoverGroupId

此資料庫所屬的故障轉移群組資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。

failoverGroupId?: string

屬性值

string

federatedClientId

用於每個資料庫跨租使用者的用戶端標識碼 CMK 案例

federatedClientId?: string

屬性值

string

highAvailabilityReplicaCount

與用來提供高可用性之資料庫相關聯的次要複本數目。 不適用於彈性集區內的超大規模資料庫。

highAvailabilityReplicaCount?: number

屬性值

number

identity

資料庫的 Azure Active Directory 身分識別。

identity?: DatabaseIdentity

屬性值

DatabaseIdentity

isInfraEncryptionEnabled

此資料庫已啟用基礎結構加密。 注意：這個屬性不會串行化。 它只能由伺服器填入。

isInfraEncryptionEnabled?: boolean

屬性值

boolean

isLedgerOn

這個資料庫是否為總賬資料庫，這表示資料庫中的所有數據表都是總賬數據表。 注意：建立資料庫之後，就無法變更此屬性的值。

isLedgerOn?: boolean

屬性值

boolean

keys

要使用的使用者指派身分識別的資源標識碼

keys?: {[propertyName: string]: DatabaseKey}

屬性值

{[propertyName: string]: DatabaseKey}

kind

資料庫種類。 這是用於 Azure 入口網站體驗的元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

kind?: string

屬性值

string

licenseType

要套用此資料庫的授權類型。 如果您需要授權，或擁有授權且符合 Azure Hybrid Benefit 資格，請 LicenseIncludedBasePrice。

licenseType?: string

屬性值

string

longTermRetentionBackupResourceId

與此資料庫建立作業相關聯的長期保留備份資源標識符。

longTermRetentionBackupResourceId?: string

屬性值

string

maintenanceConfigurationId

指派給資料庫的維護組態標識碼。 此組態會定義維護更新發生的期間。

maintenanceConfigurationId?: string

屬性值

string

managedBy

管理資料庫的資源。 注意：這個屬性不會串行化。 它只能由伺服器填入。

managedBy?: string

屬性值

string

manualCutover

客戶控制手動完全移轉是否需要在更新資料庫作業期間完成超大規模資料庫層。

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

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

若要觸發完全移轉，請在調整作業處於等候狀態時提供 『performCutover』 參數。

manualCutover?: boolean

屬性值

boolean

maxLogSizeBytes

這個資料庫的記錄大小上限。 注意：這個屬性不會串行化。 它只能由伺服器填入。

maxLogSizeBytes?: number

屬性值

number

maxSizeBytes

以位元組表示的資料庫大小上限。

maxSizeBytes?: number

屬性值

number

minCapacity

資料庫一律配置的最小容量，如果未暫停，則為

minCapacity?: number

屬性值

number

pausedDate

用戶設定或動作暫停資料庫的日期（ISO8601格式）。 如果資料庫已就緒，則為 Null。 注意：這個屬性不會串行化。 它只能由伺服器填入。

pausedDate?: Date

屬性值

Date

performCutover

在調整作業進行中時，觸發客戶控制的手動完全移轉。

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

只有當資料庫從業務關鍵/一般用途/進階/標準層調整至超大規模資料庫層級正在進行時，才適用此屬性。

指定了performCutover時，調整作業會觸發完全移轉，並執行超大規模資料庫的角色變更。

performCutover?: boolean

屬性值

boolean

preferredEnclaveType

資料庫上要求的記憶體保護區類型，也就是預設或 VBS記憶體保護區。

preferredEnclaveType?: string

屬性值

string

readScale

唯讀路由的狀態。 如果啟用，在其連接字串中將應用程式意圖設定為唯讀的連線，可能會路由傳送至相同區域中的唯讀次要複本。 不適用於彈性集區內的超大規模資料庫。

readScale?: string

屬性值

string

recoverableDatabaseId

與此資料庫建立作業相關聯的可復原資料庫資源標識符。

recoverableDatabaseId?: string

屬性值

string

recoveryServicesRecoveryPointId

與此資料庫建立作業相關聯的恢復點資源標識碼。

recoveryServicesRecoveryPointId?: string

屬性值

string

requestedBackupStorageRedundancy

要用來儲存此資料庫的備份的記憶體帳戶類型。

requestedBackupStorageRedundancy?: string

屬性值

string

requestedServiceObjectiveName

資料庫所要求的服務等級目標名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

requestedServiceObjectiveName?: string

屬性值

string

restorableDroppedDatabaseId

與這個資料庫建立作業相關聯的可還原卸除資料庫資源標識符。

restorableDroppedDatabaseId?: string

屬性值

string

restorePointInTime

指定要還原以建立新資料庫的源資料庫的時間點（ISO8601格式）。

restorePointInTime?: Date

屬性值

Date

resumedDate

使用者動作或資料庫登入繼續資料庫的日期（ISO8601格式）。 如果資料庫暫停，則為 Null。 注意：這個屬性不會串行化。 它只能由伺服器填入。

resumedDate?: Date

屬性值

Date

sampleName

建立這個資料庫時要套用的範例架構名稱。

sampleName?: string

屬性值

string

secondaryType

如果資料庫是輔助資料庫，則為次要類型。 有效值為 Geo、Named 和 Standby。

secondaryType?: string

屬性值

string

sku

資料庫 SKU。

SKU 清單可能會因區域和支援供應項目而異。 若要判斷 Azure 區域中訂用帳戶可用的 SKU（包括 SKU 名稱、層/版本、系列和容量），請使用 Capabilities_ListByLocation REST API 或下列其中一個命令：

az sql db list-editions -l <location> -o table

Get-AzSqlServerServiceObjective -Location <location>

sku?: Sku

屬性值

Sku

sourceDatabaseDeletionDate

指定刪除資料庫的時間。

sourceDatabaseDeletionDate?: Date

屬性值

Date

sourceDatabaseId

與這個資料庫建立作業相關聯的源資料庫資源標識符。

sourceDatabaseId?: string

屬性值

string

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」 標頭的詳細資訊，請參閱 https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

sourceResourceId?: string

屬性值

string

status

資料庫的狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

status?: string

屬性值

string

zoneRedundant

此資料庫是否為區域備援，這表示此資料庫的複本會分散到多個可用性區域。

zoneRedundant?: boolean

屬性值

boolean

繼承的屬性詳細資料

id

資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自TrackedResource.id

location

資源位置。

location: string

屬性值

string

繼承自TrackedResource.location

name

資源名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自TrackedResource.name 的

tags

資源標籤。

tags?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承自TrackedResource.tags

type

資源類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自TrackedResource.type