你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Databases - Update

更新现有的数据库。

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

URI 参数

Name In Required Type Description
databaseName
path True
  • string

数据库的名称。

resourceGroupName
path True
  • string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

serverName
path True
  • string

服务器的名称。

subscriptionId
path True
  • string

用于标识 Azure 订阅的订阅 ID。

api-version
query True
  • string

要用于请求的 API 版本。

请求正文

Name Type Description
properties.autoPauseDelay
  • integer

数据库自动暂停的时间(以分钟为单位)。 值为 -1 表示禁用自动暂停

properties.catalogCollation

元数据目录的排序规则。

properties.collation
  • string

数据库的排序规则。

properties.createMode

指定数据库创建模式。

默认值:常规数据库创建。

复制:将数据库创建为现有数据库的副本。 必须将 sourceDatabaseId 指定为源数据库的资源 ID。

辅助数据库:将数据库创建为现有数据库的次要副本。 必须将 sourceDatabaseId 指定为现有主数据库的资源 ID。

PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。

恢复:通过还原异地复制的备份来创建数据库。 必须将 sourceDatabaseId 指定为可恢复的数据库资源 ID 才能还原。

还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原的已删除数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从以前的时间点还原。

RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

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

properties.elasticPoolId
  • string

包含此数据库的弹性池的资源标识符。

properties.highAvailabilityReplicaCount
  • integer

与用于提供高可用性的数据库关联的辅助副本数。

properties.isLedgerOn
  • boolean

此数据库是否为账本数据库,这意味着数据库中的所有表都是账本表。 注意:创建数据库后,无法更改此属性的值。

properties.licenseType

要申请此数据库的许可证类型。 LicenseIncluded如果需要许可证,或者BasePrice拥有许可证并且有资格获得Azure 混合权益。

properties.longTermRetentionBackupResourceId
  • string

与此数据库的创建操作关联的长期保留备份的资源标识符。

properties.maintenanceConfigurationId
  • string

分配给数据库的维护配置 ID。 此配置定义维护更新发生时的时间段。

properties.maxSizeBytes
  • integer

以字节表示的数据库的最大大小。

properties.minCapacity
  • number

数据库始终分配的最小容量(如果未暂停)

properties.readScale

只读路由的状态。 如果启用,将应用程序意向设置为在其连接字符串中以只读方式设置的连接可能会路由到同一区域中的只读次要副本。

properties.recoverableDatabaseId
  • string

与此数据库的创建操作关联的可恢复数据库的资源标识符。

properties.recoveryServicesRecoveryPointId
  • string

与此数据库的创建操作关联的恢复点的资源标识符。

properties.requestedBackupStorageRedundancy

用于存储此数据库的备份的存储帐户类型。

properties.restorableDroppedDatabaseId
  • string

与此数据库的创建操作关联的可还原已删除数据库的资源标识符。

properties.restorePointInTime
  • string

指定将还原以创建新数据库的源数据库的 ISO8601 格式) 时间点 (。

properties.sampleName

创建此数据库时要应用的示例架构的名称。

properties.secondaryType

数据库的辅助类型(如果是辅助数据库)。 有效值为 Geo 和 Named。

properties.sourceDatabaseDeletionDate
  • string

指定删除数据库的时间。

properties.sourceDatabaseId
  • string

与此数据库的创建操作关联的源数据库的资源标识符。

properties.zoneRedundant
  • boolean

此数据库是否为区域冗余,这意味着此数据库的副本将分散到多个可用性区域。

sku

SKU 的名称和层。

tags
  • object

资源标记。

响应

Name Type Description
200 OK

已成功更新数据库。

202 Accepted

正在更新数据库。

Other Status Codes

错误响应: ***

  • 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 DatabaseNameDoesNotMatchSourceDatabaseId - 指定的数据库名称与 sourceDatabaseId 中的数据库名称不匹配。

  • 400 ElasticPoolNotSupportedForExternalBackupRestore - 外部备份还原不支持弹性池

  • 400 InvalidRecoverableDatabaseId - 可恢复的数据库标识符无效。

  • 400 InvalidRecoveryServicesRecoveryPointId - 恢复服务恢复点标识符无效。

  • 400 InvalidRestorableDroppedDatabaseDeletionDate - 给定的可还原删除的数据库删除日期无效

  • 400 InvalidRestorableDroppedDatabaseId - 可还原的已删除数据库标识符无效

  • 400 MissingRecoverableDatabaseId - 缺少可恢复的数据库标识符。

  • 400 MissingRecoveryServicesRecoveryPointId - 缺少恢复服务恢复点 ID。

  • 400 MissingRestorableDroppedDatabaseId - 缺少 restorableDroppedDatabaseId

  • 400 MissingRestorePointInTime - 缺少还原时间点

  • 400 MissingSourceDatabaseDeletionDate - 缺少源数据库删除日期

  • 400 MissingStorageContainerSasToken - 缺少存储容器 SAS 令牌

  • 400 MissingStorageContainerUri - 缺少存储容器 URI

  • 400 RestoreableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - 无法在还原创建模式下指定 sourceDatabaseId 时指定 restoreableDroppedDatabaseId

  • 400 TierChangeUnsupportedDueToMemoryOptimizedObject - 数据库无法更新其 SKU,因为它具有内存优化的对象。

  • 400 SourceServerNotFound - CreateDatabaseAsCopy API 调用中提供的源数据库 ID 的服务器部分不会映射到现有服务器。

  • 400 ElasticPoolOverStorageUsage - 尝试在达到弹性池的存储限制时将数据写入数据库。

  • 400 InvalidDatabaseCreateMode - 创建数据库的请求无效。

  • 400 InvalidAddSecondaryPermission - 用户没有足够的权限在指定服务器上添加辅助数据库。

  • 400 UnsupportedServiceName - 指定的名称是无效名称,因为它包含一个或多个不支持的 unicode 字符。

  • 400 CurrentDatabaseLogSizeExceedsMaxSize - 用户尝试将数据库更改为最大日志大小低于当前使用情况的 SKU。

  • 400 InvalidBackupStorageAccountType - 用户在数据库创建/更新期间传递了 zrs/lrs,但由于客户未列入允许列表或 zrs 在指定区域中不可用,因此失败。

  • 400 CannotUpdateToFreeDatabase - 不支持将数据库更新到免费 SKU。

  • 400 DatabaseInvalidSkuPropertyCombination - 请求的 SKU 的属性不一致。 请检查是否指定了有效的组合。 有关详细信息,请参阅 https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability

  • 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - 用户尝试创建一个命名副本,该副本将超过每个主数据库允许的数字

  • 400 DatabaseIsCurrentlyPinned - Microsoft 已将数据库固定到SQL Server引擎版本。 为了确保数据库未遇到生产问题,在数据库未固定之前,将阻止数据库的任何将来缩放操作。 请联系 Microsoft 支持部门获取有关缩放的帮助。

  • 400 RestoreTargetEditionSizeInsufficient - 用户尝试将数据库还原到小于源当前分配大小的版本。

  • 400 InvalidSku - 用户指定了无效 SKU。

  • 400 InvalidTierSkuCombination - 指定的层不支持指定的 SKU。

  • 400 ServerNotFound - 找不到请求的服务器。

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

  • 400 FeatureDisabledOnSelectedEdition - 用户尝试使用当前数据库版本上禁用的功能。

  • 400 OfferDisabledOnSubscription - 订阅套餐类型受到限制,无法预配请求的资源。

  • 400 InvalidTargetSubregion - 不可读辅助数据库的目标服务器不在 DR 配对的 Azure 区域中。

  • 400 DatabaseCreationBlockedForNonActivatedCMKServer - 在激活工作区之前,SQL启用了 CMK 的工作区阻止池创建。 首先,启用清除保护,并在工作区密钥的 Azure 密钥保管库上向工作区托管标识授予获取、包装密钥、解包密钥) 所需的 (权限。 接下来,在授予访问权限后激活工作区。

  • 400 PartnerServerNotCompatible - 用户尝试将数据库从 SAWA V1 服务器复制到斯特林服务器,反之亦然。

  • 400 错误ReplicationLinkState - 该操作要求数据库在复制链接上处于预期状态。

  • 400 TargetElasticPoolDoesNotExist - 服务器上不存在弹性池。

  • 400 ElasticPoolSkuCombinationInvalid - 仅当 SKU 指定为“ElasticPool”时,才能一起指定弹性池和 sku。

  • 400 ElasticPoolTierCombinationInvalid - 数据库层不同于弹性池服务层。

  • 400 ElasticPoolNameRequired - 用户尝试创建或更新数据库到弹性池服务目标,而无需指定弹性池的名称。

  • 400 ElasticPoolInconsistentDtuGuaranteeSettings - 尝试为超过弹性池请求的 DTU 的数据库提供 DTU 最小值。

  • 400 TierChangeUnsupportedDueToCDCEnabledDatabase - 数据库无法更新其 SKU,因为它已启用 CDC。

  • 400 ElasticPoolDatabaseCountOverLimit - 尝试在达到弹性池的数据库计数限制时创建或添加弹性池。

  • 400 CannotChangeToOrFromDataWarehouseTier - 用户尝试将数据库的 SKU 从 DataWarehouse 层更改为非 DataWarehouse 层,反之亦然。

  • 400 CurrentDatabaseSizeExceedsMaxSize - 用户尝试将数据库的最大大小减小为小于当前使用情况的大小。

  • 400 AzureKeyVaultKeyDisabled - 无法在服务器上完成该操作,因为 Azure 密钥保管库 密钥已禁用。

  • 400 ElasticPoolDecreaseStorageLimitBelowUsage - 尝试降低弹性池的存储限制低于其存储使用量。

  • 400 AzureKeyVaultInvalidExpirationDate - 操作无法完成,因为 Azure 密钥保管库密钥过期日期无效。

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty - 操作无法完成,因为 Azure 密钥保管库 Uri 为 null 或空。

  • 400 ElasticPoolInconsistentVcoreGuaranteeSettings - 每个数据库的数据库数和 VCore 最小值不能超过弹性池请求的 VCore 数。

  • 400 UpdateNotAllowedOnPausedDatabase - 用户尝试对暂停的数据库执行更新。

  • 400 AzureKeyVaultNoServerIdentity - 服务器标识未正确配置。

  • 400 InvalidMaxSizeTierCombination - 指定的层不支持指定的数据库最大大小。

  • 400 AzureKeyVaultInvalidUri - 来自 Azure 密钥保管库的无效响应。 请使用有效的 Azure 密钥保管库 URI。

  • 400 AzureKeyVaultMissingPermissions - 服务器缺少对 Azure 密钥保管库所需的权限。

  • 400 InvalidReadScaleEdition - 用户尝试对不支持它的数据库类型启用读取缩放。

  • 400 InvalidReadScaleUnits - 用户尝试提供不支持的读取缩放值。

  • 400 SecurityAzureKeyVaultInvalidKeyName - 由于服务器密钥名称无效,无法完成该操作。

  • 400 RegionDoesNotSupportVersion - 用户尝试在不支持该服务器版本的位置创建指定版本的服务器。

  • 400 GeoSecondaryMaxSizeUpdateFailed - 异地辅助数据库是不支持所请求的最大值或异地辅助数据库位于不受支持的区域中的 SLO,或者异地辅助数据库上的更新操作已在进行中。

  • 400 AdalGenericError - 操作无法完成,因为遇到Azure Active Directory错误。

  • 400 AdalServicePrincipalNotFound - 操作无法完成,因为遇到Azure Active Directory库服务主体找不到错误。

  • 400 InvalidTier - 用户指定了无效层。

  • 400 AzureKeyVaultMalformedVaultUri - 提供的密钥保管库 uri 无效。

  • 400 CannotUseReservedDatabaseName - 不能在此操作中使用保留的数据库名称。

  • 400 SubscriptionNotFound - 找不到请求的订阅。

  • 400 RequestedDatabaseSizeRequiresShrink - 用户尝试 ALTER DATABASE MODIFY MAXSIZE 以将数据库的 MAXSIZE 修改为较小的大小,然后修改当前大小。

  • 400 CurrentDatabaseSizeExceedsDbMaxSize - 用户尝试将数据库的最大大小减小到小于当前使用情况的大小。

  • 400 InvalidServerName - 指定的服务器名称无效。

  • 400 CannotUseTrailingWhitespacesInDatabaseName - 数据库名称验证失败。

  • 400 SourceDatabaseEditionCouldNotBeUpgraded - 源数据库的版本不能高于目标数据库。

  • 400 SecurityAdalPrincipalCertExpiredError - 操作无法完成,因为 Azure 密钥保管库主体证书已过期。

  • 400 TargetDatabaseEditionCouldNotBeDowngraded - 目标数据库的版本不能低于源数据库。

  • 400 UpdateNotAllowedIfGeoDrOperationInProgress - 由于服务器“上数据库”{0}{1}“的副本或故障转移操作当前正在进行中,因此不允许该操作。

  • 400 InvalidCollation - 服务器无法识别排序规则。

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的密钥保管库 uri 无效。

  • 400 KeyMaterialNotFoundOnRemoteServer - 远程服务器无权访问用作 TDE 保护程序的密钥材料。

  • 400 AzureKeyVaultMismatchError - http 响应中找到的意外密钥保管库区域。

  • 400 AzureKeyVaultRsaKeyNotSupported - 提供的密钥保管库使用不支持的 RSA 密钥大小或密钥类型。 支持的 RSA 密钥大小为 2048 或 3072,密钥类型为 RSA 或 RSA-HSM。

  • 400 ElasticPoolOverFileSpace - 弹性池中的文件空间不足。

  • 400 PartnerDBNotCompatibleForSGXEnclave - 仅当两个数据库都在 DC 系列硬件上运行时,才支持为已启用 enclave 的数据库设置 GeoDR 链接或更新 SLO。

  • 400 UpdateNotAllowedInCurrentReplicationState - 该操作在其当前复制状态下不允许对数据库执行操作。

  • 400 InvalidLicenseType - 用户尝试使用不支持的许可证类型创建或更新数据库或弹性池。

  • 400 GeoReplicaLimitReached - 达到每个副本复制限制。

  • 400 UnsupportedCapacity - 用户尝试使用不支持的容量创建或更新数据库。

  • 400 ReplicationSourceAndTargetMustHaveSameName - 复制源和目标数据库必须具有相同的名称。

  • 400 ProvisioningDisabled - 按原样显示资源操作授权者的错误消息,无需更改

  • 400 ReplicationSourceAndTargetMustBeInDifferentServers - 复制源和目标数据库必须位于不同的逻辑服务器中。

  • 400 CannotUpdateIsLedgerDatabase - 无法更新现有数据库的账本属性。

  • 400 UnableToResolveRemoteServer - 由于服务器名称或 DNS 连接问题无效,无法解决远程合作伙伴服务器名称。

  • 400 RemoteDatabaseCopyPermission - 用户没有足够的权限在指定服务器上创建数据库副本。

  • 400 CannotMoveOrDropSyncMetadataDatabase - 无法删除用作同步元数据数据库的数据库。

  • 400 SecurityAzureKeyVaultGeoChainError - 使用 Azure 密钥保管库 (BYOK) 启用透明数据加密时,不支持创建辅助 (称为链接) 的进程。

  • 400 RestoreToFreeEditionNotSupported - 还原和 GeoRestore 目标不能为免费数据库。

  • 400 CannotMoveOrDropJobAccountDatabase - 无法删除与作业帐户关联的数据库。

  • 免费数据库不支持 400 RestoreNotSupportedForFreeEdition - 还原和 GeoRestore。

  • 400 JobAgentDatabaseEditionUnsupported - 不支持指定数据库的服务级别目标用作作业代理数据库。

  • 400 InvalidDroppedDatabase - 源数据库在受支持的恢复期内不存在于服务器上。

  • 400 InvalidLiveDatabase - 源数据库在受支持的恢复期内不存在于服务器上。 如果还原已删除的数据库,请指定其删除日期。

  • 400 InvalidVldbRecoverySlo - 超大规模版本恢复要求源数据库和目标数据库都使用超大规模服务级别目标。

  • 400 SourceDatabaseNotFound - 源数据库不存在。

  • 400 InvalidVldbRestoreSlo - 超大规模版本时间点还原要求源数据库和目标数据库都使用超大规模服务级别目标。

  • 400 CannotSpecifyPoolOrSlo - 不支持指定弹性池和/或更改服务级别目标或版本。

  • 400 InvalidPublicMaintenanceConfiguration - 用户尝试指定无法转换为内部 ID 的公共维护配置, (格式不正确或错误的区域) 。

  • 400 ChangeUnsupportedOnEntity - 用户尝试对给定实体执行不受支持的创建/更新/删除操作。

  • 404 OperationIdNotFound - ID 操作不存在。

  • 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

  • 404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。

  • 404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。

  • 404 ServerNotInSubscription - 指定的服务器在指定的订阅上不存在。

  • 404 CannotFindObject - 找不到对象,因为它不存在或您没有权限

  • 405 UnsupportedReplicationOperation - 数据库上启动了不受支持的复制操作。

  • 409 OperationCancelled - 操作已被用户取消。

  • 409 OperationInterrupted - 无法完成资源上的操作,因为它被同一资源上的另一个操作中断。

  • 409 FreeDbAlreadyExists - 每个区域的订阅只能存在一个免费数据库。

  • 409 SubscriptionDisabled - 已禁用订阅。

  • 409 ConflictingSystemOperationInProgress - 数据库上正在进行系统维护操作,后续操作需要等待,直到完成。

  • 409 ConflictRequestToUpdateBackupRedundancy - 更改备份存储冗余的冲突请求仍在进行中。

  • 409 SkuAssignmentInProgress - 无法处理当前分配请求,因为以前的请求尚未完成。

  • 409 DatabaseElasticPoolMaintenanceConflict - 用户尝试使用与数据库的弹性池冲突的指定维护配置创建或更新数据库。

  • 409 ServerDtuQuotaExceeded - 无法执行该操作,因为服务器将超过允许的数据库吞吐量单位配额。

  • 409 UnableToAlterDatabaseInReplication - 复制关系中数据库上的用户更改版本。

  • 409 CurrentMemoryUsageExceedsSkuQuota - 用户尝试了由于资源消耗较高而无法完成的 SKU 更新操作。

  • 409 ServerKeyNameAlreadyExists - 服务器上已存在服务器密钥。

  • 409 ServerKeyUriAlreadyExists - 服务器上已存在服务器密钥 URI。

  • 409 ServerKeyDoesNotExists - 服务器密钥不存在。

  • 409 UpdateSloInProgress - 用户在进行 SLO 更新时尝试启动不兼容的操作。

  • 409 UpdateSloFailedDatabaseTooBusy - 更新 SLO 操作无法完成,因为数据库太忙。

  • 409 AzureKeyVaultKeyNameNotFound - 操作无法完成,因为 Azure 密钥保管库密钥名称不存在。

  • 409 AzureKeyVaultKeyInUse - 服务器当前正在使用密钥。

  • 409 ServerDisabled - 服务器已禁用。

  • 409 ConflictingDatabaseOperation - 数据库上已有一些操作,当前操作应等到操作完成。

  • 409 SimultaneousSkuChangeNotAllowed - 服务目标更改操作不能同时在复制关系的两个数据库上运行。

  • 409 TargetElasticPoolBeingUpdated - 无法启动弹性池的更新,因为此弹性池中的某个数据库正在进行复制操作

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship - 对已在复制关系中的数据库执行复制种子设定操作。

  • 409 InvalidOperationForDatabaseInReplicationRelationship - 对已在复制关系中的数据库执行复制种子设定操作。

  • 409 DuplicateGeoDrRelation - 数据库已处于复制关系中。 这是重复的请求。

  • 409 DatabaseCopyLimitPerReplicaReached - 用户达到了并发数据库副本的限制。

  • 409 RemoteDatabaseExists - 目标服务器上已存在目标数据库名称。

  • 429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。

  • 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。

  • 500 OperationTimedOut - 操作超时并自动回滚。 请重试该操作。

  • 500 ActivateOrDeactivateWorkflowThrottling - 激活或停用工作流失败,因为并发工作流过多

  • 503 TooManyRequests - 请求超出可用资源可处理的最大请求数。

  • 503 AzureKeyVaultConnectionFailed - 无法完成该操作,因为尝试连接到 Azure 密钥保管库失败

  • 503 AzureKeyVaultGenericConnectionError - 操作无法完成,因为尝试检索密钥保管库信息时遇到错误。

  • 503 DatabaseUnavailable - 操作失败,因为数据库不可用。

  • 504 RequestTimeout - 服务请求超过了允许的超时。

示例

Assigns maintenance window to a database.
Resets maintenance window of a database to default.
Updates a database.

Assigns maintenance window to a database.

Sample Request

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

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

Sample Response

{
  "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"
}

Resets maintenance window of a database to default.

Sample Request

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

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

Sample Response

{
  "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"
}

Updates a database.

Sample Request

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

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

Sample Response

{
  "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"
}

定义

CatalogCollationType

元数据目录的排序规则。

CreateMode

指定数据库创建模式。

默认值:常规数据库创建。

复制:将数据库创建为现有数据库的副本。 必须将 sourceDatabaseId 指定为源数据库的资源 ID。

辅助数据库:将数据库创建为现有数据库的次要副本。 必须将 sourceDatabaseId 指定为现有主数据库的资源 ID。

PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。

恢复:通过还原异地复制的备份来创建数据库。 必须将 sourceDatabaseId 指定为可恢复的数据库资源 ID 才能还原。

还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原的已删除数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从以前的时间点还原。

RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

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

CurrentBackupStorageRedundancy

用于存储此数据库的备份的存储帐户类型。

Database

数据库资源。

DatabaseLicenseType

要申请此数据库的许可证类型。 LicenseIncluded如果需要许可证,或者BasePrice拥有许可证并且有资格获得Azure 混合权益。

DatabaseReadScale

只读路由的状态。 如果启用,将应用程序意向设置为在其连接字符串中以只读方式设置的连接可能会路由到同一区域中的只读次要副本。

DatabaseStatus

数据库的状态。

DatabaseUpdate

数据库资源。

RequestedBackupStorageRedundancy

用于存储此数据库的备份的存储帐户类型。

SampleName

创建此数据库时要应用的示例架构的名称。

SecondaryType

数据库的辅助类型(如果是辅助数据库)。 有效值为 Geo 和 Named。

Sku

ARM 资源 SKU。

CatalogCollationType

元数据目录的排序规则。

Name Type Description
DATABASE_DEFAULT
  • string
SQL_Latin1_General_CP1_CI_AS
  • string

CreateMode

指定数据库创建模式。

默认值:常规数据库创建。

复制:将数据库创建为现有数据库的副本。 必须将 sourceDatabaseId 指定为源数据库的资源 ID。

辅助数据库:将数据库创建为现有数据库的次要副本。 必须将 sourceDatabaseId 指定为现有主数据库的资源 ID。

PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。

恢复:通过还原异地复制的备份来创建数据库。 必须将 sourceDatabaseId 指定为可恢复的数据库资源 ID 才能还原。

还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原的已删除数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从以前的时间点还原。

RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

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

Name Type Description
Copy
  • string
Default
  • string
OnlineSecondary
  • string
PointInTimeRestore
  • string
Recovery
  • string
Restore
  • string
RestoreExternalBackup
  • string
RestoreExternalBackupSecondary
  • string
RestoreLongTermRetentionBackup
  • string
Secondary
  • string

CurrentBackupStorageRedundancy

用于存储此数据库的备份的存储帐户类型。

Name Type Description
Geo
  • string
Local
  • string
Zone
  • string

Database

数据库资源。

Name Type Description
id
  • string

资源 ID。

kind
  • string

数据库类型。 这是用于Azure 门户体验的元数据。

location
  • string

资源位置。

managedBy
  • string

管理数据库的资源。

name
  • string

资源名称。

properties.autoPauseDelay
  • integer

自动暂停数据库的时间(以分钟为单位)。 值 -1 表示禁用自动暂停

properties.catalogCollation

元数据目录的排序规则。

properties.collation
  • string

数据库的排序规则。

properties.createMode

指定数据库创建模式。

默认值:常规数据库创建。

复制:创建数据库作为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。

辅助数据库:创建数据库作为现有数据库的次要副本。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。

PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。

恢复:通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为可恢复的数据库资源 ID 才能还原。

还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原的数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从较早的时间点还原。

RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

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

properties.creationDate
  • string

数据库的创建日期 (ISO8601 格式) 。

properties.currentBackupStorageRedundancy

用于存储此数据库的备份的存储帐户类型。

properties.currentServiceObjectiveName
  • string

数据库的当前服务级别目标名称。

properties.currentSku

SKU 的名称和层。

properties.databaseId
  • string

数据库的 ID。

properties.defaultSecondaryLocation
  • string

此数据库的默认次要区域。

properties.earliestRestoreDate
  • string

这会记录还原的最早开始日期和时间,该数据库 (ISO8601 格式) 。

properties.elasticPoolId
  • string

包含此数据库的弹性池的资源标识符。

properties.failoverGroupId
  • string

此数据库所属的故障转移组资源标识符。

properties.highAvailabilityReplicaCount
  • integer

与用于提供高可用性的数据库关联的次要副本数。

properties.isInfraEncryptionEnabled
  • boolean

为此数据库启用了基础结构加密。

properties.isLedgerOn
  • boolean

此数据库是否是账本数据库,这意味着数据库中的所有表都是账本表。 注意:创建数据库后,无法更改此属性的值。

properties.licenseType

要申请此数据库的许可证类型。 LicenseIncluded如果需要许可证,或者BasePrice拥有许可证并且有资格获得Azure 混合权益。

properties.longTermRetentionBackupResourceId
  • string

与此数据库的创建操作关联的长期保留备份的资源标识符。

properties.maintenanceConfigurationId
  • string

分配给数据库的维护配置 ID。 此配置定义维护更新发生时的时间段。

properties.maxLogSizeBytes
  • integer

此数据库的最大日志大小。

properties.maxSizeBytes
  • integer

以字节表示的数据库的最大大小。

properties.minCapacity
  • number

数据库始终分配的最小容量(如果未暂停)

properties.pausedDate
  • string

用户配置或操作 (ISO8601 格式) 暂停数据库的日期。 如果数据库准备就绪,则为 Null。

properties.readScale

只读路由的状态。 如果启用,将应用程序意向设置为只读的连接在其连接字符串可能会路由到同一区域中的只读次要副本。

properties.recoverableDatabaseId
  • string

与此数据库的创建操作关联的可恢复数据库的资源标识符。

properties.recoveryServicesRecoveryPointId
  • string

与此数据库的创建操作关联的恢复点的资源标识符。

properties.requestedBackupStorageRedundancy

用于存储此数据库的备份的存储帐户类型。

properties.requestedServiceObjectiveName
  • string

请求的数据库服务级别目标名称。

properties.restorableDroppedDatabaseId
  • string

与此数据库的创建操作关联的可还原已删除数据库的资源标识符。

properties.restorePointInTime
  • string

指定要还原以创建新数据库的源数据库的 ISO8601 格式) (的时间点。

properties.resumedDate
  • string

用户操作或数据库登录 (ISO8601 格式) 恢复数据库的日期。 如果数据库暂停,则为 Null。

properties.sampleName

创建此数据库时要应用的示例架构的名称。

properties.secondaryType

数据库的辅助类型(如果是辅助数据库)。 有效值为 Geo 和 Named。

properties.sourceDatabaseDeletionDate
  • string

指定删除数据库的时间。

properties.sourceDatabaseId
  • string

与此数据库的创建操作关联的源数据库的资源标识符。

properties.status

数据库的状态。

properties.zoneRedundant
  • boolean

此数据库是否为区域冗余,这意味着此数据库的副本将分布在多个可用性区域。

sku

数据库 SKU。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 SKU (,包括可用于 Azure 区域中订阅的 SKU 名称、层/版本、系列和容量) ,请使用 Capabilities_ListByLocation REST API 或以下命令之一:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
tags
  • object

资源标记。

type
  • string

资源类型。

DatabaseLicenseType

要申请此数据库的许可证类型。 LicenseIncluded如果需要许可证,或者BasePrice拥有许可证并且有资格获得Azure 混合权益。

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseReadScale

只读路由的状态。 如果启用,将应用程序意向设置为在其连接字符串中以只读方式设置的连接可能会路由到同一区域中的只读次要副本。

Name Type Description
Disabled
  • string
Enabled
  • string

DatabaseStatus

数据库的状态。

Name Type Description
AutoClosed
  • string
Copying
  • string
Creating
  • string
Disabled
  • string
EmergencyMode
  • string
Inaccessible
  • string
Offline
  • string
OfflineChangingDwPerformanceTiers
  • string
OfflineSecondary
  • string
Online
  • string
OnlineChangingDwPerformanceTiers
  • string
Paused
  • string
Pausing
  • string
Recovering
  • string
RecoveryPending
  • string
Restoring
  • string
Resuming
  • string
Scaling
  • string
Shutdown
  • string
Standby
  • string
Suspect
  • string

DatabaseUpdate

数据库资源。

Name Type Description
properties.autoPauseDelay
  • integer

数据库自动暂停的时间(以分钟为单位)。 值为 -1 表示禁用自动暂停

properties.catalogCollation

元数据目录的排序规则。

properties.collation
  • string

数据库的排序规则。

properties.createMode

指定数据库创建模式。

默认值:常规数据库创建。

复制:创建数据库作为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。

辅助数据库:创建数据库作为现有数据库的次要副本。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。

PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。

恢复:通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为可恢复的数据库资源 ID 才能还原。

还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原的数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从较早的时间点还原。

RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

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

properties.creationDate
  • string

数据库的创建日期 (ISO8601 格式) 。

properties.currentBackupStorageRedundancy

用于存储此数据库的备份的存储帐户类型。

properties.currentServiceObjectiveName
  • string

数据库的当前服务级别目标名称。

properties.currentSku

SKU 的名称和层。

properties.databaseId
  • string

数据库的 ID。

properties.defaultSecondaryLocation
  • string

此数据库的默认次要区域。

properties.earliestRestoreDate
  • string

这会记录此数据库的最早开始日期和时间, (ISO8601 格式) 。

properties.elasticPoolId
  • string

包含此数据库的弹性池的资源标识符。

properties.failoverGroupId
  • string

此数据库所属的故障转移组资源标识符。

properties.highAvailabilityReplicaCount
  • integer

与用于提供高可用性的数据库关联的辅助副本数。

properties.isInfraEncryptionEnabled
  • boolean

为此数据库启用基础结构加密。

properties.isLedgerOn
  • boolean

此数据库是否为账本数据库,这意味着数据库中的所有表都是账本表。 注意:创建数据库后,无法更改此属性的值。

properties.licenseType

要申请此数据库的许可证类型。 LicenseIncluded如果需要许可证,或者BasePrice拥有许可证并且有资格获得Azure 混合权益。

properties.longTermRetentionBackupResourceId
  • string

与此数据库的创建操作关联的长期保留备份的资源标识符。

properties.maintenanceConfigurationId
  • string

分配给数据库的维护配置 ID。 此配置定义维护更新发生时的时间段。

properties.maxLogSizeBytes
  • integer

此数据库的最大日志大小。

properties.maxSizeBytes
  • integer

以字节表示的数据库的最大大小。

properties.minCapacity
  • number

数据库始终分配的最小容量(如果未暂停)

properties.pausedDate
  • string

用户配置或操作暂停数据库的日期 (ISO8601 格式) 。 如果数据库准备就绪,则为 Null。

properties.readScale

只读路由的状态。 如果启用,将应用程序意向设置为在其连接字符串中以只读方式设置的连接可能会路由到同一区域中的只读次要副本。

properties.recoverableDatabaseId
  • string

与此数据库的创建操作关联的可恢复数据库的资源标识符。

properties.recoveryServicesRecoveryPointId
  • string

与此数据库的创建操作关联的恢复点的资源标识符。

properties.requestedBackupStorageRedundancy

用于存储此数据库的备份的存储帐户类型。

properties.requestedServiceObjectiveName
  • string

请求的数据库服务级别目标名称。

properties.restorableDroppedDatabaseId
  • string

与此数据库的创建操作关联的可还原已删除数据库的资源标识符。

properties.restorePointInTime
  • string

指定将还原以创建新数据库的源数据库的 ISO8601 格式) 时间点 (。

properties.resumedDate
  • string

用户操作或数据库登录 (ISO8601 格式) 恢复数据库的日期。 如果数据库暂停,则为 Null。

properties.sampleName

创建此数据库时要应用的示例架构的名称。

properties.secondaryType

数据库的辅助类型(如果是辅助数据库)。 有效值为 Geo 和 Named。

properties.sourceDatabaseDeletionDate
  • string

指定删除数据库的时间。

properties.sourceDatabaseId
  • string

与此数据库的创建操作关联的源数据库的资源标识符。

properties.status

数据库的状态。

properties.zoneRedundant
  • boolean

此数据库是否为区域冗余,这意味着此数据库的副本将分散到多个可用性区域。

sku

SKU 的名称和层。

tags
  • object

资源标记。

RequestedBackupStorageRedundancy

用于存储此数据库的备份的存储帐户类型。

Name Type Description
Geo
  • string
Local
  • string
Zone
  • string

SampleName

创建此数据库时要应用的示例架构的名称。

Name Type Description
AdventureWorksLT
  • string
WideWorldImportersFull
  • string
WideWorldImportersStd
  • string

SecondaryType

数据库的辅助类型(如果是辅助数据库)。 有效值为 Geo 和 Named。

Name Type Description
Geo
  • string
Named
  • string

Sku

ARM 资源 SKU。

Name Type Description
capacity
  • integer

特定 SKU 的容量。

family
  • string

如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。

name
  • string

SKU 的名称,通常为字母 + 数字代码,例如 P3。

size
  • string

特定 SKU 的大小

tier
  • string

特定 SKU 的层或版本,例如基本 SKU 高级版。