共用方式為

Databases - Update

  • 參考
服務:
SQL Database
API 版本:
2023-08-01

更新現有的資料庫。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2023-08-01

URI 參數

名稱 位於 必要 類型 Description
databaseName
 path True

string

資料庫的名稱。
resourceGroupName
 path True

string

包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
serverName
 path True

string

伺服器的名稱。
subscriptionId
 path True

string

識別 Azure 訂用帳戶的訂用帳戶標識碼。
api-version
 query True

string

要用於要求的 API 版本。

要求本文

名稱 類型 Description
identity

DatabaseIdentity

資料庫身分識別
properties.autoPauseDelay

integer (int32)

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

CatalogCollationType

元資料目錄的定序。
properties.collation

string

資料庫的定序。
properties.createMode

CreateMode

指定資料庫建立模式。

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

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

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

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

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

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

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

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

string (arm-id)

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

string

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

boolean

啟用或停用資料庫加密保護裝置 AKV 金鑰自動輪替的旗標。
properties.federatedClientId

string (uuid)

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

FreeLimitExhaustionBehavior

指定免費資料庫用完每月可用限制時的行為。

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

BillForUsage：資料庫會在免費限制用盡時繼續上線，並收取任何超額費用。
properties.highAvailabilityReplicaCount

integer (int32)

與用來提供高可用性的商業關鍵、進階或超大規模資料庫相關聯的次要複本數目。 不適用於彈性集區內的超大規模資料庫。
properties.isLedgerOn

boolean

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

<string,  DatabaseKey>

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

DatabaseLicenseType

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

string (arm-id)

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

string

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

boolean

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

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

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

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

integer (int64)

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

number (double)

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

boolean

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

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

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

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

AlwaysEncryptedEnclaveType

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

DatabaseReadScale

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

string (arm-id)

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

string (arm-id)

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

BackupStorageRedundancy

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

string (arm-id)

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

string (date-time)

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

SampleName

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

SecondaryType

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

string (date-time)

指定刪除資料庫的時間。
properties.sourceDatabaseId

string (arm-id)

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

boolean

資料庫是否使用免費每月限制。 在訂用帳戶中的一個資料庫上允許。
properties.zoneRedundant

boolean

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

Sku

SKU 的名稱和層。
tags

object

資源標籤。

回應

名稱 類型 Description
200 OK

Database

已成功更新資料庫。
202 Accepted

正在更新資料庫。

標題

Location: string
Other Status Codes

ErrorResponse

錯誤回應： ***

  • 400 ManagedInstanceStoppingOrStopped - 實例處於停止/停止狀態時提交的衝突作業

  • 400 ManagedInstanceStarting - 實例處於啟動狀態時提交的衝突作業

  • 400 InvalidDatabaseCreateOrUpdateRequest - 建立或更新資料庫作業的要求本文無效。

  • 400 InvalidResourceId - 無效的資源識別碼。

  • 400 InvalidSourceDatabaseId - 無效的源資料庫標識符。

  • 400 不符ResourceGroupNameWithUrl - 提供的資源組名不符合 Url 中的名稱。

  • 400 不相符ServerNameWithUrl - 提供的伺服器名稱不符合 Url 中的名稱。

  • 400 MismatchingSubscriptionWithUrl - 提供的訂用帳戶不符合 Url 中的訂用帳戶。

  • 400 MissingCollation - 需要定序。

  • 400 MissingMaxSizeBytes - 需要 MaxSizeBytes。

  • 400 MissingSkuName - 需要 Sku 名稱。

  • 400 MissingSourceDatabaseId - 遺漏源資料庫標識符。

  • 400 InvalidLicenseType - 指定的授權類型無效。

  • 400 InvalidSkuName - 無效的 SKU 名稱。

  • 400 不相符SkuNameAndCapacity - SKU 名稱和容量不符。

  • 400 不符SkuNameAndTier - SKU 名稱和層級不符。

  • 400 不相符SkuNameAndFamily - SKU 名稱和系列不符。

  • 400 LedgerNotAllowedWithSpecifiedCreateMode - 指定建立模式不允許 IsLedgerOn。

  • 400 LedgerNotAllowedOnSampleDatabase - 範例資料庫的 IsLedgerOn 不允許建立資料庫。

  • 400 FreeLimitDatabaseNotAllowedInNonDefaultCreate - 非預設建立模式不允許建立免費限制資料庫。

  • 400 AvailabilityZoneNotSupported - 資料庫和彈性集區的要求可用性區域無效。

  • 400 MethodNotAllowedOnSpecifiedCreateMode - 指定的建立模式上不允許 Http Patch 或 Merge

  • 400 DatabaseNameDoesNotMatchSourceDatabaseId - 指定的資料庫名稱不符合 sourceDatabaseId 中的資料庫名稱。

  • 400 ElasticPoolNotSupportedForExternalBackupRestore - 外部備份還原不支持彈性集區

  • 400 InvalidRecoverableDatabaseId - 無效的可復原資料庫標識符。

  • 400 InvalidRecoveryServicesRecoveryPointId - 無效的復原服務恢復點標識符。

  • 400 InvalidRestorableDroppedDatabaseDeletionDate - 指定的可還原卸除資料庫刪除日期無效

  • 400 InvalidRestorableDroppedDatabaseId - 無效的可還原卸除資料庫標識符

  • 400 MissingRecoverableDatabaseId - 遺漏可復原的資料庫標識符。

  • 400 MissingRecoveryServicesRecoveryPointId - 遺漏復原服務恢復點標識符。

  • 400 MissingRestorableDroppedDatabaseId - 遺漏 restorableDroppedDatabaseId

  • 400 MissingRestorePointInTime - 遺漏還原時間點

  • 400 MissingSourceDatabaseDeletionDate - 遺漏源資料庫刪除日期

  • 400 MissingStorageContainerSasToken - 遺失記憶體容器 SAS 令牌

  • 400 MissingStorageContainerUri - 遺漏記憶體容器 URI

  • 400 RestoreableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - 無法在還原建立模式中指定 sourceDatabaseId 時指定 restoreableDroppedDatabaseId

  • 400 MultipleIdentitiesOnDatabase - 資料庫層級僅支援一個使用者指派的受控識別。

  • 400 MultipleIdentityDelegationsOnDatabase - 資料庫層級僅支援一個身分識別委派。

  • 400 MissingPrimaryDelegatedIdentityClientId - 若要使用委派的身分識別，請提供主要委派的身分識別用戶端標識符。

  • 400 LongTermRetentionMigrationRequestNotSupported - 不允許訂用帳戶 LTR 備份移轉功能。

  • 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - 不允許來源和目標訂用帳戶通訊 LTR 備份複製功能。

  • 400 LongTermRetentionMigrationParameterMissing - 作業遺漏的必要參數。

  • 400 LongTermRetentionMigrationSameServerNotSupported - 不支援 LTR 複製功能來複製相同伺服器內的 LTR 備份。

  • 400 LongTermRetentionMigrationTargetServerNotFound - 目標伺服器不存在或尚未準備好進行 LTR 備份複製作業。

  • 400 LongTermRetentionMigrationTargetDatabaseNotFound - 目標資料庫不存在於伺服器上。

  • 400 LongTermRetentionMigrationStorageTypeNotSupported - 目標區域中不支援指定的備份記憶體備援。

  • 400 LongTermRetentionMigrationStorageMismatch - 資料庫的主動備份備援與客戶要求的備份備援不符。

  • 400 LtrOperationFailedBackupImmutable - 刪除長期保留備份失敗，因為備份是不可變的。

  • 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR 移轉僅支援受控實例和 Azure SQL DB LTR 備份。

  • 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - LTR 複製作業不允許變更備份記憶體備援。

  • 400 LtrRestoreFailedArchiveStorageTier - 不支援還原封存的長期保留備份。 還原只能在解除凍結或定期的長期保留備份上執行。

  • 400 LtrArchiveStorageTierNotEnabled - 未啟用封存長期保留備份。

  • 400 LtrArchiveWrongParameters - Desired （backupStorageAccessTier， operationMode） 組合不支援 ChangeLongTermRetentionBackupAccessTier。 只允許 （封存、移動） 和 （經常性，複製） 。

  • 400 LTRArchiveRedundancyChangeFailed - 當設定具有「封存」備份記憶體存取層的長期保留原則時，不支援將備份記憶體備援類型更新為區域備援記憶體

  • 400 LongTermRetentionMigrationSubscriptionNotFound - 找不到訂用帳戶。

  • 400 ElasticPoolOverStorageUsage - 在達到彈性集區的儲存限制時，嘗試將數據寫入資料庫。

  • 400 TokenTooLong - 提供的令牌太長。

  • 400 SourceDatabaseEncryptionProtectorKeyUriRequiredForPerDatabaseCMKCopyOrReplication - 地理輔助資料庫遺漏地理主資料庫的 AKV

  • 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary - 異地複寫中的所有資料庫都必須包含與源資料庫的加密保護裝置相同的密鑰數據。 請將索引鍵 '{0}' 與相同的索引鍵數據新增至目標資料庫 '{1}'。

  • 400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary - 啟用資料庫層級 TDE 保護裝置的自動輪替時，來源和目標資料庫都必須連線到相同的密鑰保存庫。 請將金鑰 '{0}' （從連接到源資料庫的相同金鑰儲存函式庫） 新增至目標資料庫'{1}'。

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName - 嘗試復寫以資料庫層級加密保護裝置設定的資料庫時，主資料庫目前使用的密鑰必須傳遞至輔助資料庫 '{0}'

  • 400 CannotMoveOrDropJobAccountDatabase - 無法卸除與作業帳戶相關聯的資料庫。

  • 400 JobAgentDatabaseEditionUnsupported - 不支援指定的資料庫服務等級目標當做作業代理程序資料庫使用。

  • 400 ServerNotFound - 找不到要求的伺服器。

  • 400 InvalidMaxSizeTierCombination - 指定的層不支援指定的資料庫大小上限。

  • 400 InvalidTier - 使用者指定了無效的階層。

  • 400 CannotUseReservedDatabaseName - 無法在此作業中使用保留的資料庫名稱。

  • 400 InvalidServerName - 指定的伺服器名稱無效。

  • 400 ProvisioningDisabled - 顯示來自資源作業授權者的錯誤訊息，而不需變更

  • 400 CannotUpdateIsLedgerDatabase - 無法更新現有資料庫的總賬屬性。

  • 400 InvalidCollation - 伺服器無法辨識定序。

  • 400 UnableToResolveRemoteServer - 遠端夥伴伺服器名稱無法解決，因為伺服器名稱或 DNS 連線問題無效。

  • 400 RemoteDatabaseCopyPermission - 用戶沒有足夠的許可權在指定的伺服器上建立資料庫複本。

  • 400 SourceDatabaseNotFound - 源資料庫不存在。

  • 400 ChangeUnsupportedOnEntity - 用戶嘗試在指定的實體上嘗試建立/更新/刪除作業不受支援。

  • 400 UpdateNotAllowedInCurrentReplicationState - 資料庫上不允許其目前復寫狀態的作業。

  • 400 GeoReplicaLimitReached - 已達到每個複本複寫限制。

  • 400 ReplicationSourceAndTargetMustHaveSameName - 複寫來源和目標資料庫必須具有相同的名稱。

  • 400 ReplicationSourceAndTargetMustBeInDifferentServers - 複寫來源和目標資料庫必須位於不同的邏輯伺服器中。

  • 400 SourceServerNotFound - CreateDatabaseAsCopy API 呼叫中提供之源資料庫標識符的伺服器部分不會對應至現有的伺服器。

  • 400 InvalidDatabaseCreateMode - 建立資料庫的要求無效。

  • 400 TierChangeUnsupportedDueToMemoryOptimizedObject - 資料庫無法更新其 SKU，因為它具有記憶體優化物件。

  • 400 PartnerDBNotCompatibleForSGXEnclave - 只有在兩個資料庫都在 DC 系列硬體上執行時，才支援設定已啟用記憶體保護區資料庫的 GeoDR 連結或更新 SLO。

  • 400 InvalidAddSecondaryPermission - 使用者沒有足夠的許可權在指定的伺服器上新增次要複本。

  • 400 UnsupportedServiceName - 指定的名稱是無效的名稱，因為它包含一或多個不支援的 Unicode 字元。

  • 400 CurrentDatabaseLogSizeExceedsMaxSize - 使用者嘗試將資料庫變更為記錄大小低於目前使用量的 SKU。

  • 400 TierChangeUnsupportedDueToCDCEnabledDatabase - 資料庫無法更新其 SKU，因為它已啟用 CDC。

  • 400 IsLedgerDatabaseIsNotSupportedOnResourceType - 此資源類型不支持變更總賬屬性。

  • 400 InvalidSku - 使用者指定了無效的 SKU。

  • 400 InvalidTierSkuCombination - 指定的層不支援指定的 SKU。

  • 400 FeatureDisabledOnSelectedEdition - 用戶嘗試使用目前資料庫版本已停用的功能。

  • 400 OfferDisabledOnSubscription - 訂用帳戶供應項目類型受限於布建要求的資源。

  • 400 InvalidTargetSubregion - 不可讀取次要伺服器的目標伺服器不在DR配對的 Azure 區域中。

  • 400 CurrentDatabaseSizeExceedsMaxSize - 使用者嘗試將資料庫的大小上限縮減為小於目前使用量的大小。

  • 400 AzureKeyVaultKeyDisabled - 無法完成伺服器上的作業，因為 Azure Key Vault 密鑰已停用。

  • 400 AzureKeyVaultInvalidExpirationDate - 作業無法完成，因為 Azure Key Vault 密鑰到期日無效。

  • 400 PartnerServerNotCompatible - 使用者嘗試將資料庫從 SAWA V1 伺服器複製到斯特林伺服器，反之亦然。

  • 400 IncorrectReplicationLinkState - 作業預期資料庫在復寫連結上處於預期狀態。

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty - 作業無法完成，因為 Azure Key Vault URI 為 Null 或空白。

  • 400 UnableToCreateGeoChain - 用戶嘗試建立輔助資料庫（鏈結），即使已設定自動上傳總帳摘要

  • 400 TargetElasticPoolDoesNotExist - 彈性集區不存在於伺服器上。

  • 400 AzureKeyVaultNoServerIdentity - 伺服器識別未正確設定。

  • 400 ElasticPoolSkuCombinationInvalid - 只有當 sku 指定為 'ElasticPool' 時，才能一起指定彈性集區和 sku。

  • 400 AzureKeyVaultInvalidUri - 來自 Azure Key Vault 的無效回應。 請使用有效的 Azure Key Vault URI。

  • 400 ElasticPoolTierCombinationInvalid - 資料庫層與彈性集區服務層級不同。

  • 400 AzureKeyVaultMissingPermissions - 伺服器缺少 Azure Key Vault 的必要許可權。

  • 400 ElasticPoolNameRequired - 用戶嘗試建立或更新資料庫到彈性集區服務目標，而不指定彈性集區的名稱。

  • 400 InvalidReadScaleEdition - 用戶嘗試在不支援它的資料庫類型上啟用讀取規模。

  • 400 InvalidReadScaleUnits - 用戶嘗試提供不支持的讀取小數字數值。

  • 400 SecurityAzureKeyVaultInvalidKeyName - 作業無法完成，因為伺服器密鑰名稱無效。

  • 400 GeoSecondaryMaxSizeUpdateFailed - 異地輔助資料庫是不支援所要求 maxsize 值的 SLO，或異地輔助資料庫位於不支援的區域，或異地輔助資料庫上的更新作業已在進行中。

  • 400 AdalGenericError - 作業無法完成，因為發生 Azure Active Directory 錯誤。

  • 400 ElasticPoolInconsistentDtuGuaranteeSettings - 嘗試為超過彈性集區所要求 DTU 的彈性集區中的資料庫提供 DTU 分鐘。

  • 400 AdalServicePrincipalNotFound - 作業無法完成，因為找不到 Azure Active Directory 連結庫服務主體錯誤。

  • 400 AzureKeyVaultMalformedVaultUri - 提供的 Key Vault URI 無效。

  • 400 ElasticPoolDatabaseCountOverLimit - 達到彈性集區的資料庫計數限制時，嘗試建立或新增資料庫至彈性集區。

  • 400 RequestedDatabaseSizeRequiresShrink - 使用者嘗試 ALTER DATABASE MODIFY MAXSIZE，將資料庫的 MAXSIZE 修改為較小的大小，然後修改目前的大小。

  • 400 CannotChangeToOrFromDataWarehouseTier - 使用者嘗試將資料庫的 SKU 從 DataWarehouse 層變更為非 DataWarehouse 層，反之亦然。

  • 400 CurrentDatabaseSizeExceedsDbMaxSize - 使用者嘗試將資料庫的大小上限縮減為小於目前使用量的大小。

  • 400 ElasticPoolDecreaseStorageLimitBelowUsage - 嘗試降低其記憶體使用量下方彈性集區的儲存限制。

  • 400 CannotUseTrailingWhitespacesInDatabaseName - 資料庫名稱驗證失敗。

  • 400 UpdateNotAllowedOnPausedDatabase - 使用者嘗試在暫停的資料庫上執行更新。

  • 400 SecurityAdalPrincipalCertExpiredError - 作業無法完成，因為 Azure Key Vault 主體憑證已過期。

  • 400 DatabaseNameInUse - 資料庫已經存在。 選擇不同的資料庫名稱。

  • 400 SameKeyMaterialNotFoundOnRemoteServer - 輔助伺服器沒有主伺服器加密保護裝置的密鑰內容。

  • 400 RegionDoesNotSupportVersion - 用戶嘗試在不支援該伺服器版本的位置建立指定版本的伺服器。

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的 Key Vault URI 無效。

  • 400 KeyMaterialNotFoundOnRemoteServer - 遠端伺服器無法存取做為 TDE 保護裝置的金鑰數據。

  • 400 AzureKeyVaultRsaKeyNotSupported - 提供的密鑰保存庫使用不支援的 RSA 金鑰大小或密鑰類型。 支援的 RSA 金鑰大小為 2048 或 3072，而密鑰類型為 RSA 或 RSA-HSM。

  • 400 SourceDatabaseEditionCouldNotBeUpgraded - 源資料庫的版本不能高於目標資料庫。

  • 400 TargetDatabaseEditionCouldNotBeDowngraded - 目標資料庫的版本不能低於源資料庫。

  • 400 UpdateNotAllowedIfGeoDrOperationInProgress - 作業是不允許的，因為伺服器 '{0}' 上資料庫 '{1}' 的複製或故障轉移作業目前正在進行中。

  • 400 SecurityAzureKeyVaultGeoChainError - 使用 Azure Key Vault 啟用透明數據加密時，不支援建立次要複本（稱為鏈結的程式）。

  • 400 ElasticPoolOverFileSpace - 彈性集區中的檔案空間不足。

  • 400 InvalidLicenseType - 用戶嘗試使用不支援的授權類型來建立或更新資料庫或彈性集區。

  • 400 UnsupportedCapacity - 用戶嘗試建立或更新容量不支持的資料庫。

  • 400 RestoreToFreeEditionNotSupported - 還原和 GeoRestore 目標不能是免費資料庫。

  • 免費資料庫不支援 400 RestoreNotSupportedForFreeEdition - 還原和 GeoRestore。

  • 400 InvalidDroppedDatabase - 在支持的復原期間內，卸除的源資料庫不存在於伺服器上。

  • 400 InvalidLiveDatabase - 源資料庫不存在於支援的復原期間內的伺服器上。 如果還原已卸除的資料庫，請指定其刪除日期。

  • 400 InvalidVldbRecoverySlo - 超大規模資料庫復原需要來源和目標資料庫，才能使用超大規模資料庫服務等級目標。

  • 400 CannotUpdateToFreeDatabase - 不支援將資料庫更新至免費 SKU。

  • 400 InvalidVldbRestoreSlo - 超大規模資料庫點-In-Time 還原需要來源和目標資料庫，才能使用超大規模資料庫服務等級目標。

  • 400 CannotSpecifyPoolOrSlo - 版本不支援指定彈性集區和/或變更服務等級目標或版本。

  • 400 InvalidBackupStorageAccountType - 使用者在資料庫建立/更新期間傳遞 zrs/lrs，但由於客戶未列入允許清單或因為 zrs 無法在指定區域中使用而失敗。

  • 400 DatabaseInvalidSkuPropertyCombination - 要求 SKU 的屬性不一致。 請檢查是否已指定有效的組合。 如需詳細資訊，請參閱 https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability。

  • 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - 用戶嘗試建立具名複本，超過每個主資料庫允許的數目

  • 400 UnsupportedBackupStorageRedundancyForEdition - 版本不支援要求的備份記憶體備援

  • 400 DatabaseIsCurrentlyPinned - Microsoft已釘選您的資料庫 SQL Server 引擎版本。 為了確保您的資料庫不會遇到生產問題，您資料庫上任何未來的調整作業都會遭到封鎖，直到未釘選為止。 如需調整的協助，請連絡Microsoft支持人員。

  • 400 RestoreTargetEditionSizeInsufficient - 使用者嘗試將資料庫還原到小於來源目前配置大小的版本。

  • 400 DatabaseCreationBlockedForNonActivatedCMKServer - 啟用 CMK 的工作區會封鎖 SQL 集區建立，直到工作區啟用為止。 首先，在工作區密鑰的 Azure Key Vault 上啟用清除保護，並授與工作區受控識別所需的許可權（取得、包裝密鑰、解除包裝密鑰）。 接下來，在授與存取權之後，啟動您的工作區。

  • 400 InvalidIdentityId - 提供的一或多個識別標識碼不是有效的 ARM 資源識別碼（s）。 請輸入有效的標識碼，然後再試一次。

  • 400 UmiMissingAkvPermissions - 使用者所提供的 PrimaryUserAssignedIdentityId 無法存取提供的 KeyId

  • 400 InvalidNumberOfIdentities - 資料庫層級僅支援一個使用者指派的受控識別。

  • 400 NoRestorePointAvailable - 源資料庫尚未完成其第一次備份，以支援還原作業。 請稍後重試還原要求。

  • 400 DatabaseNamedReplicaChainingNotAllowed - 用戶嘗試建立不允許之具名複本的具名複本。

  • 400 DatabaseNamedReplicaInvalidOperation - 使用者嘗試在具名復本上執行不支持的作業。

  • 400 DatabaseNamedReplicaInvalidSourceDatabase - 用戶嘗試在與源資料庫不同的訂用帳戶或區域中建立具名複本。

  • 400 DatabaseNamedReplicaSourceDatabaseNotZoneRedundant - 無法在此具名復本上啟用區域備援，因為主要超大規模資料庫不是區域備援。

  • 400 CannotAssignIdentityToMaster - 無法將身分識別指派給系統資料庫。 資料庫識別無法指派給 'master'、'model'、'tempdb'、'msdb' 或 'resource' 資料庫。

  • 400 PerDatabaseCMKDWNotSupported - Datawarehouse 版本不支援預覽中的資料庫層級 CMK。

  • 400 MissingThumbprintCrm - CRM 資料庫的還原作業失敗，因為缺少必要的 TDE 憑證。 請重試還原作業至現有的彈性集區。

  • 400 ElasticPoolOverStorage - 當達到彈性集區的儲存限制時，嘗試將數據寫入資料庫。

  • 400 RestoreTargetEditionSizeInsufficientV2 - 使用者嘗試將資料庫還原到小於所還原資料庫配置大小的版本。

  • 400 ResourcePoolStorageLimitHitDuringRestore - 由於集區中剩餘的記憶體容量，還原的資料庫無法還原到資源集區。

  • 400 PerDatabaseCMKRestoreNotSupported - 在預覽中設定資料庫層級 CMK 時，不支持資料庫還原。

  • 超大規模資料庫版本不支援 400 PerDatabaseCMKHSNotSupported - 預覽版的資料庫層級 CMK。

  • 400 PerDatabaseCMKGeoReplicationNotSupported - 在預覽中設定資料庫層級 CMK 時，不支援異地復寫和資料庫複製。

  • 400 InvalidStandbyGeoEdition - 用戶嘗試建立以 DTU 為基礎的待命地理位置。

  • 400 ElasticPoolInconsistentVcoreGuaranteeSettings - 每個資料庫的資料庫和虛擬核心數目不能超過彈性集區要求的 VCore 數目。

  • 400 GeoRestoreBackupStorageTypeNotSupported - 針對未設定為使用異地備援備份記憶體的資料庫發出資料庫復原要求時無效。

  • 400 RestoreHyperscaleToNonHyperscale - 不支援將超大規模資料庫備份還原至非超大規模資料庫服務層級，反之亦然。

  • 400 SubscriptionDoesNotHaveAccessToServer - 訂用帳戶無法存取指定的伺服器（s）

  • 400 RecoveryPointDoesNotExist - 指定的恢復點不存在或無效。

  • 400 LtrBackupNotFound - 指定的長期保留備份不存在。

  • 400 InvalidPointInTime - 指定的時間點對資料庫無效。

  • 400 GeoRestoreCannotResolveTargetCluster - 無法解析伺服器的目標叢集

  • 400 CannotSpecifyEditionOrSloWhenRestoringToPool - 還原至彈性集區時不支援指定目標服務等級目標或版本。

  • 400 RestoreNotSupportedForGeoDrSecondary - 目前設定為異地次要資料庫的資料庫不支持時間點還原和資料庫復原作業。

  • 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - 用戶嘗試在具名復本上設定備份保留原則。

  • 400 GeoRedundantBackupsNotPermittedForSubscription - 訂用帳戶 '{0}' 下的所有資料庫已封鎖異地備援備份記憶體，方法是預覽功能 'Azure SQL Database 封鎖異地備援備份記憶體'。 請選取不同的備份記憶體備援。

  • 400 RestoreHyperscaleToNonHyperscaleElasticPool - 不支援將超大規模資料庫還原至非超大規模資料庫或還原非超大規模資料庫的資料庫至超大規模資料庫彈性集區。

  • 400 RestoreIneligibleDatabaseName - 指定的目標資料庫名稱 『{0}』，已保留，且無法在還原作業中使用。

  • 400 RestoreNotSupportedForSystemDb - 系統資料庫不支援還原和資料庫復原。

  • 400 RestoreIneligibleDroppedDatabaseShortLifespan - 源資料庫 '{0}'，在 '{1}' 上卸除，尚未存在足夠長的時間來支援還原。

  • 400 RestoreIneligibleLiveDatabaseShortLifespan - 源資料庫 '{0}'，尚未完成第一個備份以支援還原作業。 請等候至少指定的最早還原日期 『{1}』，然後重新提交要求。

  • 400 RestoreCrossServerDisabled - 針對時間點還原，目標邏輯伺服器必須與來源邏輯伺服器相同。 請考慮還原至源資料庫的伺服器，或使用資料庫複本或資料庫復原。

  • 400 RestoreSameServerRecoveryDisabled - 目前不支援相同伺服器復原。 請考慮使用時間點還原或復原至不同的伺服器。

  • 400 RestoreNotSupportedFromLtrBackupToEdition - 不支援從長期保留備份還原到 '{0}' 版本。

  • 400 RestoreNotSupportedFromExternalBackupToEdition - 不支援從外部備份還原到 '{0}' 版本。

  • 400 UpdateToServerlessIfLtrIsNotDisabled - 如果啟用長期備份保留，則不支援為無伺服器資料庫啟用自動暫停。

  • 400 DuplicateRestoreOperation - 伺服器 '{0}' 上具有相同目標資料庫名稱 '{1}' 的還原要求已經存在。

  • 400 ExternalBackupUriMalformed - 外部備份記憶體容器 URI 格式不正確。

  • 400 ExternalBackupUriHostNotAllowed - 不允許外部備份記憶體容器 URI 的主機名。

  • 400 ExternalBackupUriInvalidSchemeOrPort - 外部備份記憶體容器 URI 使用無效的配置或埠。 請使用 HTTPs 和埠 443。

  • 400 ExternalBackupVldbUnsupported - 超大規模資料庫不支援外部備份還原要求。

  • 400 CannotMoveOrDropSyncMetadatadatabase - 無法卸除用來作為同步元數據資料庫的資料庫。

  • 400 InvalidPitrPriorToVldbMigration - 針對資料庫 '{0}'，指定的時間點 '{1}' 是在超大規模資料庫移轉時間 '{2}'之前。 請指定目標版本或服務等級目標，在還原至超大規模資料庫移轉之前的某個點時不是超大規模資料庫。

  • 400 MissingKeyVaultUriForRestore - 必須有 Azure Key Vault 密鑰 URI '{0}'，才能在伺服器 '{1}' 下成功還原資料庫 '{2}'。

  • 400 BlockRestoreOnVldbGeoSecondary - 不允許還原源資料庫為異地輔助資料庫的超大規模資料庫。

  • 400 BackupSetNotFound - 找不到還原資料庫的備份。 請連絡支援人員以還原資料庫。

  • 400 不正確的AccessToAzureKeyVault - 目標伺服器無法存取備份期間建立的所有 AKV Uri。

  • 400 RestoreFailureSqlInstanceUnhealthy - 無法連線到實例以執行還原作業。

  • 400 BackupSetBroken - 備份集已中斷。

  • 400 TimeoutDuringRestore - 嘗試連線到還原目標時發生逾時。

  • 400 BrokenRestorePlanGapInLogBackups - 還原計劃已中斷，因為目前記錄備份的 firstLsn 不等於上一個記錄備份的 lastLsn。

  • 400 FullBackupMissingChecksum - 提供的完整備份遺漏總和檢查碼。

  • 400 RequiredBackupIsNotLastRestored - 無法完成移轉，因為提供的備份檔名不是還原的最後一個備份文件的名稱。

  • 400 不相容的PhysicalLayoutNonOnlineDataFilesExist - 資料庫備份包含不相容的實體配置。 非在線數據檔存在。

  • 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - 資料庫備份包含不相容的實體配置。 不支援多個記錄檔。

  • 400 BackupSetNotFoundRecentPit - 找不到將資料庫還原至指定時間點的備份。 請重試作業。 如果問題持續發生，請連絡支持人員以還原資料庫。

  • 400 InvalidPublicMaintenanceConfiguration - 使用者嘗試指定無法轉換成內部識別符的公用維護組態（格式不正確或錯誤區域）。

  • 400 MaintenanceWindowNotSupportedForNamedReplica - 用戶嘗試使用不支援的非預設維護時段建立或更新具名複本。

  • 400 InvalidStandbyGeoReadScale - 用戶嘗試在不支援它的待命異地資料庫上啟用讀取規模。

  • 400 PerDatabaseCMKKeyRotationAttemptedWhileOldThumbprintInUse - 資料庫層級 TDE 保護裝置的密鑰輪替會在使用中交易按住以舊密鑰加密的記錄檔時遭到封鎖。 如需解決此問題的可能策略，請參閱 aka.ms/azuresqldbkeyrotation。

  • 400 PerDBCMKNotSupportedWithLTR - 在資料庫上啟用長期備份保留時，不支援資料庫層級 CMK。

  • 400 VBSEnclaveNotSupportedForDW - 專用 SQL 集區不支援 preferredEnclaveType。

  • 400 VBSEnclaveNotSupportedForDCSeriesSLO - 不支援使用 DC 系列硬體設定來設定資料庫的 'VBS' preferredEnclaveType。 DC 系列資料庫已預先設定 Intel SGX 記憶體保護區。 不支援虛擬化型安全性 （VBS） 記憶體保護區。

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutDatabaseLevelEncryptionProtector - 資料庫層級加密保護裝置必須在目標資料庫上設定，同時嘗試複製或復寫以資料庫層級密鑰加密的資料庫。

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - 嘗試復寫以資料庫層級加密保護裝置設定的資料庫時，主資料庫所使用的目前密鑰必須傳遞至輔助資料庫。

  • 400 PerDatabaseCMKGeoPrimaryIsNotConfiguredWithDatabaseLevelEncryptionProtector - 異地主資料庫必須先設定資料庫層級加密保護裝置，才能在異地輔助資料庫上設定資料庫層級加密保護裝置。

  • 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - 不支援啟用自動暫停的無伺服器資料庫作為彈性作業資料庫，因為作業代理程式會防止該資料庫暫停。 您可以停用此無伺服器資料庫的自動暫停，或刪除使用此資料庫的作業代理程式。 如需詳細資訊，請參閱這裡：https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing

  • 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - 不支援使用 preferredEnclaveType 属性的不同值設定異地復寫的資料庫。 '{0}' 伺服器上的主要 '{1}' 資料庫會使用 '{2}' preferredEnclaveType，而 '{3}' 伺服器上次要 '{4}' 資料庫的指定 preferredEnclaveType 是 '{5}'。

  • 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - 虛擬式安全性 （VBS） 記憶體保護區不支援主要和輔助資料庫之間的計劃性故障轉移。

  • 400 PerDatabaseCMKGeoPrimaryIsConfiguredWithDatabaseLevelEncryptionProtector - 在故障轉移至沒有資料庫層級加密保護裝置的異地輔助資料庫時，地理主資料庫不得設定資料庫層級加密保護裝置。

  • 400 CreateDatabaseAttemptedWithRotationInProgress - 由於伺服器上的持續透明數據加密 （TDE） 密鑰輪替，因此目前無法執行建立資料庫作業。 請稍後再試一次作業。

  • 400 VBSEnclaveResourcePoolInvalidCombination - 不支援將具有 '{0}' preferredEnclaveType 的資料庫新增至彈性集區 '{1}' 與 '{2}' preferredEnclaveType。 將資料庫新增至彈性集區之前，請確定資料庫的 preferredEnclaveType 與彈性集區都相同。 如需詳細資訊，請參閱 https://aka.ms/AlwaysEncryptedEnableSecureEnclaves

  • 400 MissingAsymmetricKeyOnTargetServer - 目標伺服器無法存取非對稱密鑰。

  • 400 MismatchingSubscriptionWithUrl - 提供的訂用帳戶不符合 Url 中的訂用帳戶。

  • 400 MultipleDroppedDatabasesWithTheSameName - 在伺服器上找到多個具有相同名稱的已卸除資料庫。

  • 400 AzureKeyVaultClientError - Azure Key Vault 用戶端發生錯誤。

  • 400 AzureKeyVaultClientInfoError - 取得 Azure Key Vault 用戶端資訊時發生錯誤。

  • 400 AzureKeyVaultKeyThumbprintIsDifferent - 作業無法完成，因為 Azure Key Vault 密鑰數據與目前的加密保護裝置密鑰不同。

  • 400 不支援的BackupStorageRedundancy - 目標區域中不支援指定的備份記憶體備援。

  • 400 LTRSterlingToVldbMigrationNotSupported - 無法將資料庫的服務目標變更為超大規模資料庫，因為超大規模資料庫尚不支持長期保留。 請停用資料庫的長期保留，然後再試一次。

  • 400 超大規模資料庫ReverseMigrationNotSupported - 將超大規模資料庫反向移轉至斯特林時遇到不支持的情況。

  • 400 UpdateSloOperationIdDoesNotExist - 動作失敗，因為未偵測到伺服器的作用中 update-slo 作業：{0}，資料庫：{1};。 請指定有效的參數來重試作業。

  • 400 ManualCutoverUnsupported - 手動完全移轉選項的使用無效。 請藉由指定有效的參數，檢查目前和要求的服務目標，然後重試作業。

  • 400 VBSEnclaveResourcePoolInvalidCombination - 不支援將具有 '{0}' preferredEnclaveType 的資料庫新增至彈性集區 '{1}' 與 '{2}' preferredEnclaveType。 將資料庫新增至彈性集區之前，請確定資料庫的 preferredEnclaveType 與彈性集區都相同。 如需詳細資訊，請參閱 https://aka.ms/AlwaysEncryptedEnableSecureEnclaves

  • 400 VBSEnclaveNotSupportedForDW - 專用 SQL 集區不支援 preferredEnclaveType。

  • 400 VBSEnclaveNotSupportedForDCSeriesSLO - 不支援使用 DC 系列硬體設定來設定資料庫的 'VBS' preferredEnclaveType。 DC 系列資料庫已預先設定 Intel SGX 記憶體保護區。 不支援虛擬化型安全性 （VBS） 記憶體保護區。

  • 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - 不支援使用 preferredEnclaveType 属性的不同值設定異地復寫的資料庫。 '{0}' 伺服器上的主要 '{1}' 資料庫會使用 '{2}' preferredEnclaveType，而 '{3}' 伺服器上次要 '{4}' 資料庫的指定 preferredEnclaveType 是 '{5}'。

  • 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - 虛擬式安全性 （VBS） 記憶體保護區不支援主要和輔助資料庫之間的計劃性故障轉移。

  • 404 OperationIdNotFound - 標識符為 的作業不存在。

  • 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。

  • 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器

  • 404 LongTermRetentionMigrationBackupNotFound - 指定的 LTR 備份不存在。

  • 404 SubscriptionNotFound - 找不到要求的訂用帳戶。

  • 404 ServerNotInSubscription - 指定的伺服器不存在於指定的訂用帳戶上。

  • 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。

  • 404 DatabaseDoesNotExist - 使用者已指定此伺服器實例上不存在的資料庫名稱。

  • 404 CannotFindObject - 找不到對象，因為它不存在或您沒有許可權

  • 405 UnsupportedReplicationOperation - 資料庫上起始了不支持的復寫作業。

  • 409 CannotCancelOperation - 管理作業處於無法取消的狀態。

  • 409 OperationCancelled - 使用者已取消作業。

  • 409 OperationInterrupted - 無法完成資源上的作業，因為相同資源上的另一個作業中斷。

  • 409 LongTermRetentionMigrationRequestConflict - 此 LTR 備份上的衝突作業仍在進行中。

  • 409 LongTermRetentionMigrationBackupConflict - 目標資料庫有相同備份時間的另一個 LTR 備份存在。

  • 409 ServerDisabled - 伺服器已停用。

  • 409 ConflictingDatabaseOperation - 資料庫上已經有一些作業，目前的作業應該等到它完成為止。

  • 409 RemoteDatabaseExists - 目的地伺服器上已經存在目的地資料庫名稱。

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship - 在不在復寫關聯性的資料庫中執行複寫作業。

  • 409 InvalidOperationForDatabaseInReplicationRelationship - 已在復寫關聯性中的資料庫上執行複寫植入作業。

  • 409 FreeDbAlreadyExists - 每個區域的訂用帳戶只能有一個免費資料庫。

  • 409 DuplicateGeoDrRelation - 資料庫已經在復寫關聯中。 這是重複的要求。

  • 409 ConflictingServerOperation - 伺服器目前正在進行作業。

  • 409 SubscriptionDisabled - 已停用訂用帳戶。

  • 409 ConflictingSystemOperationInProgress - 資料庫上的系統維護作業正在進行中，而進一步的作業必須等到它完成為止。

  • 409 SkuAssignmentInProgress - 無法處理目前的指派要求，因為先前的要求尚未完成。

  • 409 CurrentMemoryUsageExceedsSkuQuota - 使用者嘗試了因為資源耗用量較高而無法完成的 SKU 更新作業。

  • 409 ServerKeyNameAlreadyExists - 伺服器密鑰已存在於伺服器上。

  • 409 ServerKeyUriAlreadyExists - 伺服器密鑰 URI 已存在於伺服器上。

  • 409 ServerKeyDoesNotExists - 伺服器密鑰不存在。

  • 409 UpdateSloInProgress - 用戶嘗試在 SLO 更新進行時起始不相容的作業。

  • 409 ServerDtuQuotaExceeded - 無法執行作業，因為伺服器會超過允許的資料庫輸送量單位配額。

  • 409 UpdateSloFailedDatabaseTooBusy - 更新 SLO 作業無法完成，因為資料庫太忙碌。

  • 409 UnableToAlterDatabaseInReplication - 複寫關聯性中資料庫上的用戶改變版本。

  • 409 AzureKeyVaultKeyNameNotFound - 作業無法完成，因為 Azure Key Vault 密鑰名稱不存在。

  • 409 AzureKeyVaultKeyInUse - 伺服器目前正在使用密鑰。

  • 409 ElasticPoolBusy - 在忙碌中的彈性集區上嘗試管理作業。

  • 409 SimultaneousSkuChangeNotAllowed - 服務目標變更作業無法同時在復寫關聯性的兩個資料庫上執行。

  • 409 TargetElasticPoolBeingUpdated - 無法啟動彈性集區的更新，因為此彈性集區中的其中一個資料庫正在進行複製作業

  • 409 DatabaseCopyLimitPerReplicaReached - 用戶達到並行資料庫複本的限制。

  • 409 ConflictRequestToUpdateBackupRedundancy - 變更備份記憶體備援的衝突要求仍在進行中。

  • 409 DatabaseElasticPoolMaintenanceConflict - 用戶嘗試使用與資料庫彈性集區衝突的指定維護組態來建立或更新資料庫。

  • 409 SubscriptionVcoreQuotaExceeded - 無法執行作業，因為訂用帳戶會超過允許的虛擬核心配額。

  • 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。

  • 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。

  • 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。

  • 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。

  • 500 OperationTimedOut - 作業逾時並自動回復。 請重試作業。

  • 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - 無法在目標區域中啟動 LTR 備份複製要求。

  • 500 LongTermRetentionMigrationRequestCopyFailed - LTR 備份 Blob 的複製作業失敗。

  • 500 LongTermRetentionMigrationRestoreVerExceeded - 達到最大嘗試之後還原驗證失敗。

  • 500 LongTermRetentionMigrationRestoreVerFailed - 還原驗證失敗。

  • 500 ActivateOrDeactivateWorkflowThrottling - 啟用或停用工作流程失敗，因為並行工作流程太多

  • 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

  • 503 AzureKeyVaultConnectionFailed - 無法完成伺服器上的作業，因為嘗試連線到 Azure Key Vault 失敗

  • 503 AzureKeyVaultGenericConnectionError - 作業無法完成，因為嘗試擷取 Key Vault 資訊時發生錯誤。

  • 503 DatabaseUnavailable - 作業失敗，因為資料庫無法使用。

  • 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

  • 504 RequestTimeout - 服務要求超過允許的逾時。

範例

Assigns maintenance window to a database.
Patch a database with database-level customer managed keys.
Resets maintenance window of a database to default.
Updates a database with Default enclave type.
Updates a database with VBS enclave type.
Updates a database.

Assigns maintenance window to a database.

範例要求

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

{
  "sku": {
    "name": "BC_Gen5_4"
  },
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1"
  }
}

範例回覆

狀態碼:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 4
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 4
    },
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}
狀態碼:
202 
Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/databaseOperationResults/11111111-1111-1111-1111-111111111111

Patch a database with database-level customer managed keys.

範例要求

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

{
  "identity": {
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/Default-SQL-SouthEastAsia/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi": {},
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/Default-SQL-SouthEastAsia/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umiToDelete": null
    },
    "type": "UserAssigned"
  },
  "sku": {
    "name": "S0",
    "tier": "Standard"
  },
  "properties": {
    "keys": {
      "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion": {},
      "https://your-key-vault-name.vault.azure.net/yourKey2/yourKey2VersionToDelete": null
    },
    "encryptionProtector": "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion"
  }
}

範例回覆

狀態碼:
200 
{
  "sku": {
    "name": "BC_Gen4",
    "tier": "BusinessCritical",
    "capacity": 4
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen4_2",
    "requestedServiceObjectiveName": "BC_Gen4_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "currentSku": {
      "name": "BC_Gen4",
      "tier": "BusinessCritical",
      "capacity": 4
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Local",
    "isLedgerOn": false
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}
狀態碼:
202 
Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/locations/southeastasia/databaseOperationResults/11111111-1111-1111-1111-111111111111

Resets maintenance window of a database to default.

範例要求

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

{
  "sku": {
    "name": "BC_Gen5_4"
  },
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"
  }
}

範例回覆

狀態碼:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 4
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_4",
    "requestedServiceObjectiveName": "BC_Gen5_4",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 4
    }
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}
狀態碼:
202 
Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/databaseOperationResults/11111111-1111-1111-1111-111111111111

Updates a database with Default enclave type.

範例要求

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

{
  "properties": {
    "preferredEnclaveType": "Default"
  }
}

範例回覆

狀態碼:
200 
{
  "sku": {
    "name": "Standard",
    "tier": "Standard",
    "capacity": 10
  },
  "kind": "v12.0,user",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "currentSku": {
      "name": "Standard",
      "tier": "Standard",
      "capacity": 10
    },
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "S0",
    "currentBackupStorageRedundancy": "Geo",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "readScale": "Disabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "S0",
    "zoneRedundant": false,
    "preferredEnclaveType": "Default"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}
狀態碼:
202 
Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/databaseOperationResults/11111111-1111-1111-1111-111111111111

Updates a database with VBS enclave type.

範例要求

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

{
  "properties": {
    "preferredEnclaveType": "VBS"
  }
}

範例回覆

狀態碼:
200 
{
  "sku": {
    "name": "Standard",
    "tier": "Standard",
    "capacity": 10
  },
  "kind": "v12.0,user",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "currentSku": {
      "name": "Standard",
      "tier": "Standard",
      "capacity": 10
    },
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "S0",
    "currentBackupStorageRedundancy": "Geo",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "readScale": "Disabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "S0",
    "zoneRedundant": false,
    "preferredEnclaveType": "VBS"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}
狀態碼:
202 
Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/databaseOperationResults/11111111-1111-1111-1111-111111111111

Updates a database.

範例要求

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2023-08-01

{
  "sku": {
    "name": "BC_Gen4_4"
  },
  "properties": {
    "maxSizeBytes": 1073741824,
    "licenseType": "LicenseIncluded"
  }
}

範例回覆

狀態碼:
200 
{
  "sku": {
    "name": "BC_Gen4",
    "tier": "BusinessCritical",
    "capacity": 4
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen4_2",
    "requestedServiceObjectiveName": "BC_Gen4_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "currentSku": {
      "name": "BC_Gen4",
      "tier": "BusinessCritical",
      "capacity": 4
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Local",
    "isLedgerOn": false
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}
狀態碼:
202 
Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/databaseOperationResults/11111111-1111-1111-1111-111111111111

定義

名稱 Description
AlwaysEncryptedEnclaveType

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

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

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

元資料目錄的定序。
CreateMode

指定資料庫建立模式。

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

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

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

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

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

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

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

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

資料庫資源。
DatabaseIdentity

資源的 Azure Active Directory 身分識別設定。
DatabaseIdentityType

識別類型
DatabaseKey

用於待用加密的資料庫層級金鑰。
DatabaseKeyType

資料庫金鑰類型。 只有支援的值為 『AzureKeyVault』。
DatabaseLicenseType

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

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

資料庫的狀態。
DatabaseUpdate

資料庫更新資源。
DatabaseUserIdentity

資源的 Azure Active Directory 身分識別設定。
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應
FreeLimitExhaustionBehavior

指定免費資料庫用完每月可用限制時的行為。

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

BillForUsage：資料庫會在免費限制用盡時繼續上線，並收取任何超額費用。
SampleName

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

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

ARM 資源 SKU。

AlwaysEncryptedEnclaveType

列舉型別

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

值 Description
Default
VBS

AvailabilityZoneType

列舉型別

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

值 Description
1
2
3
NoPreference

BackupStorageRedundancy

列舉型別

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

值 Description
Geo
GeoZone
Local
Zone

CatalogCollationType

列舉型別

元資料目錄的定序。

值 Description
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。

值 Description
Copy
Default
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
Secondary

Database

Object

資料庫資源。

名稱 類型 Description
id

string

資源標識碼。
identity

DatabaseIdentity

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

string

資料庫種類。 這是用於 Azure 入口網站體驗的元數據。
location

string

資源位置。
managedBy

string

管理資料庫的資源。
name

string

資源名稱。
properties.autoPauseDelay

integer (int32)

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

AvailabilityZoneType

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

CatalogCollationType

元資料目錄的定序。
properties.collation

string

資料庫的定序。
properties.createMode

CreateMode

指定資料庫建立模式。

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

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

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

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

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

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

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

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

string (date-time)

資料庫的建立日期（ISO8601格式）。
properties.currentBackupStorageRedundancy

BackupStorageRedundancy

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

string

資料庫目前的服務等級目標名稱。
properties.currentSku

Sku

SKU 的名稱和層。
properties.databaseId

string (uuid)

資料庫的標識碼。
properties.defaultSecondaryLocation

string

這個資料庫的預設次要區域。
properties.earliestRestoreDate

string (date-time)

這會記錄此資料庫最早的開始日期和時間（ISO8601格式）。
properties.elasticPoolId

string (arm-id)

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

string

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

boolean

啟用或停用資料庫加密保護裝置 AKV 金鑰自動輪替的旗標。
properties.failoverGroupId

string

此資料庫所屬的故障轉移群組資源標識碼。
properties.federatedClientId

string (uuid)

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

FreeLimitExhaustionBehavior

指定免費資料庫用完每月可用限制時的行為。

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

BillForUsage：資料庫會在免費限制用盡時繼續上線，並收取任何超額費用。
properties.highAvailabilityReplicaCount

integer (int32)

與用來提供高可用性的商業關鍵、進階或超大規模資料庫相關聯的次要複本數目。 不適用於彈性集區內的超大規模資料庫。
properties.isInfraEncryptionEnabled

boolean

此資料庫已啟用基礎結構加密。
properties.isLedgerOn

boolean

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

<string,  DatabaseKey>

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

DatabaseLicenseType

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

string (arm-id)

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

string

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

boolean

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

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

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

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

integer (int64)

這個資料庫的記錄大小上限。
properties.maxSizeBytes

integer (int64)

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

number (double)

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

string (date-time)

用戶設定或動作暫停資料庫的日期（ISO8601格式）。 如果資料庫已就緒，則為 Null。
properties.performCutover

boolean

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

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

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

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

AlwaysEncryptedEnclaveType

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

DatabaseReadScale

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

string (arm-id)

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

string (arm-id)

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

BackupStorageRedundancy

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

string

資料庫所要求的服務等級目標名稱。
properties.restorableDroppedDatabaseId

string (arm-id)

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

string (date-time)

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

string (date-time)

使用者動作或資料庫登入繼續資料庫的日期（ISO8601格式）。 如果資料庫暫停，則為 Null。
properties.sampleName

SampleName

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

SecondaryType

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

string (date-time)

指定刪除資料庫的時間。
properties.sourceDatabaseId

string (arm-id)

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

string (arm-id)

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

只有 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
properties.status

DatabaseStatus

資料庫的狀態。
properties.useFreeLimit

boolean

資料庫是否使用免費每月限制。 在訂用帳戶中的一個資料庫上允許。
properties.zoneRedundant

boolean

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

Sku

資料庫 SKU。

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

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

Get-AzSqlServerServiceObjective -Location <location>
tags

object

資源標籤。
type

string

資源類型。

DatabaseIdentity

Object

資源的 Azure Active Directory 身分識別設定。

名稱 類型 Description
tenantId

string (uuid)

Azure Active Directory 租用戶標識符。
type

DatabaseIdentityType

識別類型
userAssignedIdentities

<string,  DatabaseUserIdentity>

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

DatabaseIdentityType

列舉型別

識別類型

值 Description
None
UserAssigned

DatabaseKey

Object

用於待用加密的資料庫層級金鑰。

名稱 類型 Description
creationDate

string (date-time)

資料庫金鑰建立日期。
subregion

string

伺服器索引鍵的子區域。
thumbprint

string

資料庫金鑰的指紋。
type

DatabaseKeyType

資料庫金鑰類型。 只有支援的值為 『AzureKeyVault』。

DatabaseKeyType

列舉型別

資料庫金鑰類型。 只有支援的值為 『AzureKeyVault』。

值 Description
AzureKeyVault

DatabaseLicenseType

列舉型別

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

值 Description
BasePrice
LicenseIncluded

DatabaseReadScale

列舉型別

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

值 Description
Disabled
Enabled

DatabaseStatus

列舉型別

資料庫的狀態。

值 Description
AutoClosed
Copying
Creating
Disabled
EmergencyMode
Inaccessible
Offline
OfflineChangingDwPerformanceTiers
OfflineSecondary
Online
OnlineChangingDwPerformanceTiers
Paused
Pausing
Recovering
RecoveryPending
Restoring
Resuming
Scaling
Shutdown
Standby
Starting
Stopped
Stopping
Suspect

DatabaseUpdate

Object

資料庫更新資源。

名稱 類型 Description
identity

DatabaseIdentity

資料庫身分識別
properties.autoPauseDelay

integer (int32)

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

CatalogCollationType

元資料目錄的定序。
properties.collation

string

資料庫的定序。
properties.createMode

CreateMode

指定資料庫建立模式。

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

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

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

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

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

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

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

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

string (date-time)

資料庫的建立日期（ISO8601格式）。
properties.currentBackupStorageRedundancy

BackupStorageRedundancy

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

string

資料庫目前的服務等級目標名稱。
properties.currentSku

Sku

SKU 的名稱和層。
properties.databaseId

string (uuid)

資料庫的標識碼。
properties.defaultSecondaryLocation

string

這個資料庫的預設次要區域。
properties.earliestRestoreDate

string (date-time)

這會記錄此資料庫最早的開始日期和時間（ISO8601格式）。
properties.elasticPoolId

string (arm-id)

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

string

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

boolean

啟用或停用資料庫加密保護裝置 AKV 金鑰自動輪替的旗標。
properties.failoverGroupId

string

此資料庫所屬的故障轉移群組資源標識碼。
properties.federatedClientId

string (uuid)

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

FreeLimitExhaustionBehavior

指定免費資料庫用完每月可用限制時的行為。

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

BillForUsage：資料庫會在免費限制用盡時繼續上線，並收取任何超額費用。
properties.highAvailabilityReplicaCount

integer (int32)

與用來提供高可用性的商業關鍵、進階或超大規模資料庫相關聯的次要複本數目。 不適用於彈性集區內的超大規模資料庫。
properties.isInfraEncryptionEnabled

boolean

此資料庫已啟用基礎結構加密。
properties.isLedgerOn

boolean

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

<string,  DatabaseKey>

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

DatabaseLicenseType

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

string (arm-id)

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

string

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

boolean

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

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

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

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

integer (int64)

這個資料庫的記錄大小上限。
properties.maxSizeBytes

integer (int64)

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

number (double)

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

string (date-time)

用戶設定或動作暫停資料庫的日期（ISO8601格式）。 如果資料庫已就緒，則為 Null。
properties.performCutover

boolean

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

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

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

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

AlwaysEncryptedEnclaveType

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

DatabaseReadScale

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

string (arm-id)

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

string (arm-id)

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

BackupStorageRedundancy

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

string

資料庫所要求的服務等級目標名稱。
properties.restorableDroppedDatabaseId

string (arm-id)

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

string (date-time)

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

string (date-time)

使用者動作或資料庫登入繼續資料庫的日期（ISO8601格式）。 如果資料庫暫停，則為 Null。
properties.sampleName

SampleName

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

SecondaryType

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

string (date-time)

指定刪除資料庫的時間。
properties.sourceDatabaseId

string (arm-id)

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

DatabaseStatus

資料庫的狀態。
properties.useFreeLimit

boolean

資料庫是否使用免費每月限制。 在訂用帳戶中的一個資料庫上允許。
properties.zoneRedundant

boolean

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

Sku

SKU 的名稱和層。
tags

object

資源標籤。

DatabaseUserIdentity

Object

資源的 Azure Active Directory 身分識別設定。

名稱 類型 Description
clientId

string (uuid)

Azure Active Directory 用戶端標識符。
principalId

string (uuid)

Azure Active Directory 主體標識符。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細數據。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

Object

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

FreeLimitExhaustionBehavior

列舉型別

指定免費資料庫用完每月可用限制時的行為。

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

BillForUsage：資料庫會在免費限制用盡時繼續上線，並收取任何超額費用。

值 Description
AutoPause
BillOverUsage

SampleName

列舉型別

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

值 Description
AdventureWorksLT
WideWorldImportersFull
WideWorldImportersStd

SecondaryType

列舉型別

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

值 Description
Geo
Named
Standby

Sku

Object

ARM 資源 SKU。

名稱 類型 Description
capacity

integer (int32)

特定 SKU 的容量。
family

string

如果服務有不同世代的硬體，針對相同的 SKU，則可以在這裡擷取。
name

string

SKU 的名稱，通常是字母 + 數位碼，例如 P3。
size

string

特定 SKU 的大小
tier

string

特定 SKU 的階層或版本，例如基本、進階。