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

Managed Instances - Update

更新托管实例。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}?api-version=2021-11-01

URI 参数

名称 必需 类型 说明
managedInstanceName
path True

string

托管实例的名称。

resourceGroupName
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

要用于请求的 API 版本。

请求正文

名称 类型 说明
identity

ResourceIdentity

托管实例标识

properties.administratorLogin

string

托管实例的管理员用户名。 仅当 (创建托管实例并且需要创建) 时指定。

properties.administratorLoginPassword

string

创建托管实例) (管理员登录密码。

properties.administrators

ManagedInstanceExternalAdministrator

服务器的 Azure Active Directory 管理员。

properties.collation

string

托管实例的排序规则。

properties.dnsZonePartner

string

另一个托管实例的资源 ID,该托管实例在创建后将共享其 DNS 区域。

properties.instancePoolId

string

此托管服务器所属的实例池的 ID。

properties.keyId

string

要用于加密的密钥的 CMK URI。

properties.licenseType

ManagedInstanceLicenseType

许可证类型。 可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格,“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。

properties.maintenanceConfigurationId

string

指定要应用于此托管实例的维护配置 ID。

properties.managedInstanceCreateMode

ManagedServerCreateMode

指定数据库创建模式。

默认值:定期创建实例。

还原:通过将一组备份还原到特定时间点来创建实例。 必须指定 RestorePointInTime 和 SourceManagedInstanceId。

properties.minimalTlsVersion

string

最低 TLS 版本。 允许的值:“None”、“1.0”、“1.1”、“1.2”

properties.primaryUserAssignedIdentityId

string

默认要使用的用户分配标识的资源 ID。

properties.proxyOverride

ManagedInstanceProxyOverride

用于连接到实例的连接类型。

properties.publicDataEndpointEnabled

boolean

是否启用公共数据终结点。

properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

用于存储此实例的备份的存储帐户类型。 选项包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)

properties.restorePointInTime

string

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

properties.servicePrincipal

ServicePrincipal

托管实例的服务主体。

properties.sourceManagedInstanceId

string

与此实例的创建操作关联的源托管实例的资源标识符。

properties.storageSizeInGB

integer

存储大小(以 GB 为单位)。 最小值:32。 最大值:16384。 仅允许 32 GB 的增量。 最大值取决于所选的硬件系列和 vCore 数。

properties.subnetId

string

托管实例的子网资源 ID。

properties.timezoneId

string

时区的 ID。 允许的值是 Windows 支持的时区。 Windows 在 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 下的注册表中保留有关受支持时区(包括 ID)的详细信息。 可以通过SQL Server查询 SELECT name AS timezone_id FROM sys.time_zone_info 来获取这些注册表值。 还可以通过在 PowerShell 中执行 [System.TimeZoneInfo]::GetSystemTimeZones () 来获取 ID 列表。 有效时区 ID 的示例是“太平洋标准时间”或“W”。 欧洲标准时间”。

properties.vCores

integer

vCore 数。 允许的值:8、16、24、32、40、64、80。

properties.zoneRedundant

boolean

是否启用了 multi-az。

sku

Sku

托管实例 SKU

tags

object

资源标记。

响应

名称 类型 说明
200 OK

ManagedInstance

已成功更新托管实例。

202 Accepted

已接受

Other Status Codes

错误响应:***

  • 400 NameAlreadyExists - 提供的名称已存在。

  • 400 InvalidCollation - 排序规则无效。

  • 400 ProvisioningDisabled - 按原样显示来自资源操作授权者的错误消息,而不进行任何更改

  • 400 RegionDoesNotAllowProvisioning - 所选位置不接受新的 Windows Azure SQL 数据库服务器。 这可能会在以后更改。

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

  • 400 HkCannotSwitchToInactive - 数据库无法继续进行定价层更新,因为它具有内存优化对象。 请删除此类对象,然后重试。

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

  • 400 CloudLifterUnsupportedFeature - 此功能目前在托管实例上不可用。

  • 400 ManagedInstanceSloUpdateFailed - SLO“”{0}操作无法成功,因为“”{1}的内存使用量超过配额。

  • 400 OperationCanNotStartDueToMiLink - 无法完成“”{0}操作,因为通过托管实例链接创建过程中存在数据库。 请等待链接创建完成或删除链接,然后再次重试该操作。

  • 400 ManagedInstanceLocalStorageUpdateSloDisabled - 尚不支持使用本地存储更新托管实例的 SLO。

  • 400 InvalidSubnetResourceId - 为托管实例创建或更新提供的子网资源 ID 无效。

  • 400 VnetInWrongRegion - 虚拟网络位于错误区域。

  • 400 AlterDbDeactivatedNotSupported - 服务器“”、“数据库”{0}“{1}的数据库操作由于意外延迟而失败。 请重试。

  • 400 VnetAddressRangeError - 虚拟网络地址范围无效。

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

  • 400 VnetConfigIsNotAllowed - 不允许进行虚拟网络配置。

  • 400 InstanceFailoverGroupDoesNotExist - 服务器上不存在故障转移组。

  • 400 ManagedInstanceClassicVnetNotSupported - 托管实例无法加入经典虚拟网络。

  • 400 VnetConfigHasNsg - 用户尝试使用网络安全组注入托管服务器子网。

  • 400 VnetConfigHasNoUdr - 用户尝试注入没有默认用户定义的路由表的托管服务器子网。

  • 400 VnetConfigHasInvalidUdr - 用户尝试注入具有无效用户定义路由表的托管服务器子网。

  • 400 VnetConfigHasInvalidDns - 用户尝试使用无效的自定义 DNS 注入托管服务器子网。

  • 400 VnetConfigHasServiceEndpoints - 用户尝试使用服务终结点注入托管服务器子网。

  • 400 VnetSubnetIsInUse - 用户尝试注入不为空的托管服务器子网。

  • 400 VnetSubnetIsLocked - 用户尝试注入锁定范围内的托管服务器子网。

  • 400 VnetSubnetIsGateway - 用户尝试注入网关子网的托管服务器子网。

  • 400 VnetSubnetIsUnknown - 用户尝试注入不存在的托管服务器子网。

  • 400 VnetSubnetConflictWithIntendedPolicy - 用户尝试注入与 IntendedPolicy 冲突的托管服务器子网。

  • 400 ManagedInstanceInvalidEditionForSku - 指定的版本 {0} 与指定的 SKU {1}不一致。

  • 400 ManagedInstanceInvalidLicenseType - 指定的许可证类型 {0} 无效。

  • 400 ManagedInstanceUpdateSloInProgress - “无法完成操作,因为正在对托管实例'{0}'进行服务层级更改。' 请等待正常执行的操作完成,然后重试。”

  • 400 VnetResourceNotFound - 找不到资源:“{0}”。

  • 400 InstanceCollationUpdateNotSupported - 用户无法更改托管实例上的实例排序规则。

  • 400 CreateManagedInstanceWithNonDefaultCollationNotSupported - 用户只能使用排序规则“SQL_Latin1_General_CP1_CI_AS”创建托管实例。

  • 400 ManagedInstanceOperationInProgress - 操作无法完成,因为 {0} 操作正在进行。 请等待正在进行的操作完成,然后重试。

  • 400 ManagedInstanceExceedMaxAzureStorage - 无法完成操作,因为常规用途实例的总分配存储大小将超过 {0}。 请减少数据库文件数并重试操作。

  • 400 ManagedInstanceHasGeoReplica - 无法完成操作,因为实例已配置异地复制的辅助实例。

  • 400 InvalidDnsZone - 操作失败,因为尝试将托管实例作为异地复制辅助实例部署到已存在托管实例的子网 {0} 。 仅当托管实例是子网中部署的第一个实例时,才支持将托管实例部署为异地复制辅助实例。 请考虑将托管实例作为异地复制辅助实例部署到没有现有托管实例的其他子网,或者如果部署到具有现有托管实例的子网,请禁用异地复制选项。

  • 400 ManagedInstanceInvalidStorageSizeLessThenCurrentSizeUsed - 无效存储大小:存储大小限制 ({0} GB) 小于当前使用的存储 ({1} GB) 。 请指定更高的存储大小限制。

  • 400 InvalidTimezone - 无效时区。

  • 400 InstanceTimezoneUpdateNotSupported - 不支持实例时区更新。

  • 400 CreateManagedInstanceWithNonDefaultTimezoneNotSupported - 不支持使用非默认时区创建托管实例。

  • 400 ManagedInstanceIpAddressRangeLimit - 无法执行托管实例的创建/缩放,因为子网中没有足够的可用 IP 地址来执行操作。

  • 400 VnetDelegationNotAllowed - 用户尝试将托管服务器注入到委托的子网。

  • 400 SubnetHasResourcesOfDifferentType - 用户尝试在子网中创建具有不同类型的资源的 MI。

  • 400 UpdateManagedServerWithMaintenanceWindowNotAllowed - 不允许使用维护时段设置更新托管实例。

  • 400 VnetPrepareNIPFailed - 用户尝试准备与 NetworkIntentPolicy 冲突的子网。

  • 400 ManagedInstanceDeprecatedHardwareFamily - 无法将硬件代系更改为已弃用 {0} 的代系。

  • 400 ManagedInstanceBackupStorageTypeNotSupported - 实例更新操作中不允许使用备份存储类型参数。

  • 400 EmptyPDCInvalidDnsZone - 无法部署此托管实例,因为其 DNS 区域与子网 {0}的预期虚拟群集的 DNS 前缀不匹配。 尽管此虚拟群集为空,但无法更改其 DNS 前缀。 几个小时后,空的虚拟群集将自动删除。 请考虑等待此虚拟群集过期,或者手动删除此虚拟群集,然后创建托管实例。

  • 400 MissingIdentityId - 当标识类型设置为 UserAssigned 时,不会提供用户分配的标识

  • 400 InvalidPrimaryIdentityId - 用户为 PrimaryUserIdentityId 提供值,但 IdentityId 参数中未列出相同值

  • 400 ManagedInstanceZoneRedudantFeatureNotSupported - 所选服务层级不支持 ZoneRedundant 功能。 有关详细信息,请访问 aka.ms/sqlmi-service-tier-characteristics。

  • 400 ManagedInstanceZoneRedudantFeatureCantBeEnabled - 创建托管实例后,无法启用 zoneRedundant 功能。 有关详细信息,请访问 aka.ms/sqlmi-high-availability。

  • 400 ManagedInstanceZoneRedudantFeatureCantBeDisabled - 创建托管实例后,无法禁用 zoneRedundant 功能。 有关详细信息,请访问 aka.ms/sqlmi-high-availability。

  • 400 UmiMissingAkvPermissions - 用户提供的 PrimaryUserAssignedIdentityId 无权访问提供的 KeyId

  • 400 MissingPrimaryIdentity - 用户提供的 PrimaryUserAssignedIdentityId 无权访问提供的 KeyId

  • 400 SubnetIdCantBeUpdated - 不支持更改托管实例子网的操作。 请从请求中删除此参数。

  • 400 MigrationToAnotherVNetNotSupported - 所选子网位于另一个虚拟网络。 无法将托管实例移到另一个虚拟网络。 请提供 虚拟网络 {0}中的子网。

  • 400 MigrationToSubnetWithDifferentDnsZoneNotSupported - 提供的子网具有与当前不同的 DNS 区域。 不支持更改实例 DNS 区域。 请为子网提供同一 DNS 区域,创建新子网或提供空子网。

  • 400 MigrationToGen4SubnetNotSupported - 无法在 Gen4 硬件上运行时更新子网,因为它已被弃用。 请在更改托管实例子网操作过程中通过同时指定这两个参数(目标子网和硬件生成)将硬件从 Gen4 升级到 Gen5。

  • 400 PrimaryIdentityMissingPermissionForKeyId - KeyId 在创建过程中由用户提供,但在 API 调用中未提供 PrimaryUserAssignedIdentityId

  • 400 InvalidIdentityTypeForKeyId - KeyId 在创建过程中由用户提供,但标识类型未设置为“UserAssigned”

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

  • 400 ManagedInstanceFileExceededMaxAzureStorageFileSizeLimit - 无法完成操作,因为某些数据库文件超出最大常规用途文件大小限制 GB{0}。

  • 400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突操作

  • 400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突操作

  • 400 InstancePoolNotEnoughCapacity - 实例池没有足够的容量

  • 400 SourceAndTargetSubnetsMustBeVnetPeered - 托管实例当前使用的子网和提供的目标子网是未与虚拟网络对等互连连接的虚拟网络的一部分,或者已建立对等互连但不允许的流量。 若要将托管实例从一个子网移到另一个子网,需要从源虚拟网络和目标虚拟网络建立虚拟网络对等互连。 请配置虚拟网络要求,然后重试该操作。 了解详细信息 https://docs.microsoft.com/en-us/azure/virtual-network/tutorial-connect-virtual-networks-portal#peer-virtual-networks

  • 400 ManagedInstanceAndSubnetAreNotOnTheSameSubscription - 为托管实例部署提供的子网位于与为托管实例提交的订阅不同。 用于部署实例的托管实例和子网必须位于同一订阅上。 请提供另一个子网或切换到子网订阅,然后重试该操作。

  • 400 CreateManagedInstanceInvalidSubnetSize - 用户尝试在小于允许的最小子网大小的子网中创建托管实例。

  • 400 AddressRangeOfTargetSubnetAndSubnetOfGeoDRReplicaCantOverlap - 为托管实例迁移选择的子网的地址范围与保存异地复制辅助实例的子网的地址范围重叠。 请验证是否已根据 中的 https://aka.ms/move-managed-instance准则配置子网。

  • 400 TargetSubnetMustBeConfiguredToAllowGeoDRReplication - 为托管实例迁移选择的子网未配置为启用与异地复制辅助实例的通信。 如果所有必需的端口都已打开,请检查。 若要正确配置子网,请阅读 中的 https://aka.ms/move-managed-instance准则。

  • 400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。

  • 400 InvalidLoginName - 提供的登录名无效。

  • 400 InvalidUsername - 提供的用户名包含无效字符。

  • 400 PasswordTooShort - 提供的密码太短

  • 400 PasswordTooLong - 提供的密码太长。

  • 400 PasswordNotComplex - 提供的密码不够复杂。

  • 400 GatewayInvalidEdition - 在此版本的 SQL Server 中,“”{0}不是有效的数据库版本。

  • 400 InvalidLocation - 指定了无效位置。

  • 400 InvalidParameterValue - 为参数提供了无效值。

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

  • 400 MiGeoRestoreWithWrongBackupStorageRedundancy - 对于具有 LRS/ZRS 备份存储冗余的托管实例,不允许使用 Geo-Restore。

  • 400 UpdateInstanceAndBackupRedundancy - 无法在同一请求中更新实例区域冗余和备份存储冗余。

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

  • 400 AadOnlyAuthenticationIsEnabled - 已启用“仅限 Azure Active Directory 身份验证”。 请联系你的系统管理员。

  • 400 ManagementServiceFeatureDisabled - 用户尝试使用禁用的功能。

  • 400 MismatchingResourceGroupNameWithUrl - 提供的资源组名称与 URL 中的名称不匹配。

  • 400 MismatchingSubscriptionWithUrl - 提供的订阅与 URL 中的订阅不匹配。

  • 400 InvalidMinimalTlsVersion - 最低 TLS 版本无效。

  • 400 InvalidResourceId - 资源标识符无效。

  • 400 InvalidParameterValue - 为参数提供了无效值。

  • 400 AadOnlyAuthenticationIsEnabled - 已启用“仅限 Azure Active Directory 身份验证”。 请联系你的系统管理员。

  • 400 InvalidExternalAdministratorLogin - 无效或缺少外部管理员登录名。

  • 400 InvalidExternalAdministratorSid - 无效或缺少外部管理员对象 ID。

  • 400 InvalidExternalAdministratorTenantId - 无效或缺少外部管理员租户 ID。

  • 400 ExternalAdministratorPrincipalType - 无效或缺少外部管理员主体类型。 请从“用户”、“应用程序”或“组”中进行选择。

  • 400 MissingExternalAdministratorWithAadOnlyAuth - 若要使用仅限 Azure AD 的身份验证,请提供外部管理员的详细信息。

  • 400 ExternalAdministratorLoginSameAsSqlAdmin - Azure Active Directory 管理员和服务器管理员帐户的名称必须不同。 请提供不同的值。

  • 400 InvalidMaintenanceWindowSettings - 无效的维护时段设置。

  • 400 InvalidMaintenanceWindowProperty - 指定的维护时段属性无效。

  • 400 InvalidMaintenanceWindowPropertyNull - 所需属性为 null 的无效维护时段。

  • 400 InvalidMaintenanceWindowTypeWithPropertySpecified - 维护窗口类型不得指定某些属性。

  • 400 UpdateOfParameterNotSupported - 不支持更新“{0}”。

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

  • 404 ManagedInstanceNotInSubscriptionResourceGroup - 指定的托管实例不存在于指定的资源组和订阅中。

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

  • 404 OperationIdNotFound - ID 为 的操作不存在。

  • 404 ResourceDoesNotExist - 名称为“”{0}的资源不存在。 若要继续,请指定有效的资源名称。

  • 404 InstancePoolNotFound - 找不到实例池

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

  • 404 ResourceNotFound - 找不到请求的资源。

  • 405 InvalidVcoreValue - vCore 值 {0} 无效。 请指定有效的 vCore 值。

  • 405 InvalidHardwareGenerationValue - HardwareGeneration {0} 无效。 请指定有效的 HardwareGeneration 值。

  • 405 InvalidStorageSizeValue - “无效的存储大小: {0} GB。 存储大小必须在 和 {2} GB 之间{1}指定,以 GB 为{3}增量。

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

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

  • 409 冲突ServerOperation - 服务器当前正在进行操作。

  • 409 SubscriptionDisabled - 订阅已禁用。

  • 409 ServerOverridePreconditionFailed - 无法对类别“”{0}应用服务器替代,因为服务器“”{1}中的物理数据库或实例“”{2}当前未处于“就绪”或“已停用”状态。

  • 409 ManagedInstanceIsBusy - 服务器“”{0}当前正忙。 请等待几分钟,并重试。

  • 409 ServerAlreadyExists - 重复的服务器名称。

  • 409 ServerDisabled - 服务器已禁用。

  • 409 ServerQuotaExceeded - 服务器无法添加到订阅,因为它将超过配额。

  • 409 ConflictingManagedInstanceOperation - 托管实例的操作当前正在进行中。

  • 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - 实例为 multi-az,但备份存储正在从区域冗余更新为非区域冗余。

  • 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - 无法更新实例冗余,因为备份存储冗余更新正在进行中。

  • 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - 备份存储是非区域冗余的,但实例冗余正在更新为区域冗余。

  • 409 BackupRedundancyUpdateConflict - 无法更新备份存储冗余,因为备份存储冗余更新已在进行中。

  • 409 MiDropFailedOnAuthLocks - 用户尝试删除子网中对资源应用了锁定 () 的最后一个托管实例。

  • 409 MiCreateFailedNonDelegatedSubnet - 用户尝试在未委托给 Microsoft.Sql/managedInstances 的子网中部署托管实例或托管实例池。

  • 412 InstanceNotReadyForBackupRedundancyUpdate - 无法更新备份存储冗余,因为实例尚未就绪。

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

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

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

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

  • 429 ConflictingSubscriptionOperation - 订阅的操作当前正在进行中。

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

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

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

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

  • 429 ConflictingSubscriptionOperation - 订阅的操作当前正在进行中。

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

  • 500 GatewayInternalServerError - 服务器遇到意外异常。

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

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

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

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

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

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

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

示例

Remove maintenance policy from managed instance (select default maintenance policy)
Update managed instance with all properties
Update managed instance with minimal properties

Remove maintenance policy from managed instance (select default maintenance policy)

Sample Request

PATCH https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2021-11-01

{
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"
  }
}

Sample Response

{
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "state": "Ready",
    "vCores": 8,
    "storageSizeInGB": 1024,
    "licenseType": "LicenseIncluded",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Default",
    "dnsZone": "1b4e2caff2530",
    "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"
  },
  "location": "japaneast",
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Update managed instance with all properties

Sample Request

PATCH https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2021-11-01

{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8
  },
  "properties": {
    "administratorLogin": "dummylogin",
    "administratorLoginPassword": "PLACEHOLDER",
    "proxyOverride": "Redirect",
    "publicDataEndpointEnabled": false,
    "minimalTlsVersion": "1.2",
    "licenseType": "BasePrice",
    "vCores": 8,
    "storageSizeInGB": 448,
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "requestedBackupStorageRedundancy": "Geo",
    "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1"
  }
}

Sample Response

{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "id": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances",
  "location": "japaneast",
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "state": "Ready",
    "vCores": 8,
    "storageSizeInGB": 448,
    "licenseType": "BasePrice",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Redirect",
    "minimalTlsVersion": "1.2",
    "dnsZone": "1b4e2caff2530",
    "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo"
  }
}

Update managed instance with minimal properties

Sample Request

PATCH https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2021-11-01

{
  "tags": {
    "tagKey1": "TagValue1"
  }
}

Sample Response

{
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "administratorLogin": "PLACEHOLDER",
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "state": "Ready",
    "vCores": 8,
    "storageSizeInGB": 1024,
    "licenseType": "LicenseIncluded",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Default",
    "dnsZone": "1b4e2caff2530",
    "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default",
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo"
  },
  "location": "japaneast",
  "tags": {
    "tagKey1": "TagValue1"
  },
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

定义

名称 说明
AdministratorType

服务器管理员的类型。

BackupStorageRedundancy

用于存储此实例的备份的存储帐户类型。 选项包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)

IdentityType

标识类型。 将其设置为“SystemAssigned”,以便自动为资源创建和分配 Azure Active Directory 主体。

ManagedInstance

Azure SQL托管实例。

ManagedInstanceExternalAdministrator

Active Directory 管理员的属性。

ManagedInstanceLicenseType

许可证类型。 可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格,“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。

ManagedInstancePecProperty

托管实例下的专用终结点连接

ManagedInstancePrivateEndpointConnectionProperties

专用终结点连接的属性。

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

用于连接到实例的连接类型。

ManagedInstanceUpdate

Azure SQL数据库托管实例的更新请求。

ManagedServerCreateMode

指定数据库创建模式。

默认值:定期创建实例。

还原:通过将一组备份还原到特定时间点来创建实例。 必须指定 RestorePointInTime 和 SourceManagedInstanceId。

PrincipalType

服务器管理员的主体类型。

ResourceIdentity

资源的 Azure Active Directory 标识配置。

ServicePrincipal

资源托管实例的服务主体配置。

ServicePrincipalType

服务主体类型。

Sku

ARM 资源 SKU。

UserIdentity

资源的 Azure Active Directory 标识配置。

AdministratorType

服务器管理员的类型。

名称 类型 说明
ActiveDirectory

string

BackupStorageRedundancy

用于存储此实例的备份的存储帐户类型。 选项包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)

名称 类型 说明
Geo

string

GeoZone

string

Local

string

Zone

string

IdentityType

标识类型。 将其设置为“SystemAssigned”,以便自动为资源创建和分配 Azure Active Directory 主体。

名称 类型 说明
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManagedInstance

Azure SQL托管实例。

名称 类型 说明
id

string

资源 ID。

identity

ResourceIdentity

托管实例的 Azure Active Directory 标识。

location

string

资源位置。

name

string

资源名称。

properties.administratorLogin

string

托管实例的管理员用户名。 仅当 (创建托管实例并且需要创建) 时,才能指定。

properties.administratorLoginPassword

string

创建托管实例 () 所需的管理员登录密码。

properties.administrators

ManagedInstanceExternalAdministrator

服务器的 Azure Active Directory 管理员。

properties.collation

string

托管实例的排序规则。

properties.currentBackupStorageRedundancy

BackupStorageRedundancy

用于存储此实例备份的存储帐户类型。 选项包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)

properties.dnsZone

string

托管实例位于的 Dns 区域。

properties.dnsZonePartner

string

另一个托管实例的资源 ID,该托管实例在创建后将共享其 DNS 区域。

properties.fullyQualifiedDomainName

string

托管实例的完全限定域名。

properties.instancePoolId

string

此托管服务器所属的实例池的 ID。

properties.keyId

string

用于加密的密钥的 CMK URI。

properties.licenseType

ManagedInstanceLicenseType

许可证类型。 可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格,“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。

properties.maintenanceConfigurationId

string

指定要应用于此托管实例的维护配置 ID。

properties.managedInstanceCreateMode

ManagedServerCreateMode

指定数据库创建模式。

默认值:定期创建实例。

还原:通过将一组备份还原到特定时间点来创建实例。 必须指定 RestorePointInTime 和 SourceManagedInstanceId。

properties.minimalTlsVersion

string

最低 TLS 版本。 允许的值:“None”、“1.0”、“1.1”、“1.2”

properties.primaryUserAssignedIdentityId

string

默认要使用的用户分配标识的资源 ID。

properties.privateEndpointConnections

ManagedInstancePecProperty[]

托管实例上的专用终结点连接列表。

properties.provisioningState enum:
  • Accepted
  • Canceled
  • Created
  • Creating
  • Deleted
  • Deleting
  • Failed
  • NotSpecified
  • Registering
  • Running
  • Succeeded
  • TimedOut
  • Unknown
  • Unrecognized
  • Updating
properties.proxyOverride

ManagedInstanceProxyOverride

用于连接到实例的连接类型。

properties.publicDataEndpointEnabled

boolean

是否启用公共数据终结点。

properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

用于存储此实例备份的存储帐户类型。 选项包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)

properties.restorePointInTime

string

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

properties.servicePrincipal

ServicePrincipal

托管实例的服务主体。

properties.sourceManagedInstanceId

string

与此实例的创建操作关联的源托管实例的资源标识符。

properties.state

string

托管实例的状态。

properties.storageSizeInGB

integer

存储大小(以 GB 为单位)。 最小值:32。 最大值:16384。 仅允许 32 GB 的增量。 最大值取决于所选硬件系列和 vCore 数。

properties.subnetId

string

托管实例的子网资源 ID。

properties.timezoneId

string

时区的 ID。 允许的值是 Windows 支持的时区。 Windows 会在注册表中的 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zone 下保留有关支持时区(包括 ID)的详细信息。 可以通过查询 SELECT name AS timezone_id FROM sys.time_zone_info,通过 SQL Server 获取这些注册表值。 还可以通过在 PowerShell 中执行 [System.TimeZoneInfo]::GetSystemTimeZones () 来获取 ID 列表。 有效时区 ID 的示例是“太平洋标准时间”或“W”。 欧洲标准时间”。

properties.vCores

integer

vCore 数。 允许的值:8、16、24、32、40、64、80。

properties.zoneRedundant

boolean

是否启用 multi-az。

sku

Sku

托管实例 SKU。 sku.name 允许的值:GP_Gen5、GP_G8IM、GP_G8IH、BC_Gen5、BC_G8IM、BC_G8IH

tags

object

资源标记。

type

string

资源类型。

ManagedInstanceExternalAdministrator

Active Directory 管理员的属性。

名称 类型 说明
administratorType

AdministratorType

服务器管理员的类型。

azureADOnlyAuthentication

boolean

已启用仅限 Azure Active Directory 身份验证。

login

string

服务器管理员的登录名。

principalType

PrincipalType

服务器管理员的主体类型。

sid

string

SID (服务器管理员的对象 ID) 。

tenantId

string

管理员的租户 ID。

ManagedInstanceLicenseType

许可证类型。 可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格,“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。

名称 类型 说明
BasePrice

string

LicenseIncluded

string

ManagedInstancePecProperty

托管实例下的专用终结点连接

名称 类型 说明
id

string

资源 ID。

properties

ManagedInstancePrivateEndpointConnectionProperties

专用终结点连接属性

ManagedInstancePrivateEndpointConnectionProperties

专用终结点连接的属性。

名称 类型 说明
privateEndpoint

ManagedInstancePrivateEndpointProperty

连接所属的专用终结点。

privateLinkServiceConnectionState

ManagedInstancePrivateLinkServiceConnectionStateProperty

专用终结点连接的连接状态。

provisioningState

string

专用终结点连接的状态。

ManagedInstancePrivateEndpointProperty

名称 类型 说明
id

string

专用终结点的资源 ID。

ManagedInstancePrivateLinkServiceConnectionStateProperty

名称 类型 说明
actionsRequired

string

专用链接服务连接说明。

description

string

专用链接服务连接说明。

status

string

专用链接服务连接状态。

ManagedInstanceProxyOverride

用于连接到实例的连接类型。

名称 类型 说明
Default

string

Proxy

string

Redirect

string

ManagedInstanceUpdate

Azure SQL数据库托管实例的更新请求。

名称 类型 说明
identity

ResourceIdentity

托管实例标识

properties.administratorLogin

string

托管实例的管理员用户名。 仅当 (创建托管实例并且需要创建) 时,才能指定。

properties.administratorLoginPassword

string

创建托管实例 () 所需的管理员登录密码。

properties.administrators

ManagedInstanceExternalAdministrator

服务器的 Azure Active Directory 管理员。

properties.collation

string

托管实例的排序规则。

properties.currentBackupStorageRedundancy

BackupStorageRedundancy

用于存储此实例的备份的存储帐户类型。 选项包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)

properties.dnsZone

string

托管实例位于的 Dns 区域。

properties.dnsZonePartner

string

另一个托管实例的资源 ID,该托管实例在创建后将共享其 DNS 区域。

properties.fullyQualifiedDomainName

string

托管实例的完全限定域名。

properties.instancePoolId

string

此托管服务器所属的实例池的 ID。

properties.keyId

string

要用于加密的密钥的 CMK URI。

properties.licenseType

ManagedInstanceLicenseType

许可证类型。 可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格,“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。

properties.maintenanceConfigurationId

string

指定要应用于此托管实例的维护配置 ID。

properties.managedInstanceCreateMode

ManagedServerCreateMode

指定数据库创建模式。

默认值:定期创建实例。

还原:通过将一组备份还原到特定时间点来创建实例。 必须指定 RestorePointInTime 和 SourceManagedInstanceId。

properties.minimalTlsVersion

string

最低 TLS 版本。 允许的值:“None”、“1.0”、“1.1”、“1.2”

properties.primaryUserAssignedIdentityId

string

默认要使用的用户分配标识的资源 ID。

properties.privateEndpointConnections

ManagedInstancePecProperty[]

托管实例上的专用终结点连接列表。

properties.provisioningState enum:
  • Accepted
  • Canceled
  • Created
  • Creating
  • Deleted
  • Deleting
  • Failed
  • NotSpecified
  • Registering
  • Running
  • Succeeded
  • TimedOut
  • Unknown
  • Unrecognized
  • Updating
properties.proxyOverride

ManagedInstanceProxyOverride

用于连接到实例的连接类型。

properties.publicDataEndpointEnabled

boolean

是否启用公共数据终结点。

properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

用于存储此实例的备份的存储帐户类型。 选项包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)

properties.restorePointInTime

string

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

properties.servicePrincipal

ServicePrincipal

托管实例的服务主体。

properties.sourceManagedInstanceId

string

与此实例的创建操作关联的源托管实例的资源标识符。

properties.state

string

托管实例的状态。

properties.storageSizeInGB

integer

存储大小(以 GB 为单位)。 最小值:32。 最大值:16384。 仅允许 32 GB 的增量。 最大值取决于所选的硬件系列和 vCore 数。

properties.subnetId

string

托管实例的子网资源 ID。

properties.timezoneId

string

时区的 ID。 允许的值是 Windows 支持的时区。 Windows 在 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 下的注册表中保留有关受支持时区(包括 ID)的详细信息。 可以通过SQL Server查询 SELECT name AS timezone_id FROM sys.time_zone_info 来获取这些注册表值。 还可以通过在 PowerShell 中执行 [System.TimeZoneInfo]::GetSystemTimeZones () 来获取 ID 列表。 有效时区 ID 的示例是“太平洋标准时间”或“W”。 欧洲标准时间”。

properties.vCores

integer

vCore 数。 允许的值:8、16、24、32、40、64、80。

properties.zoneRedundant

boolean

是否启用了 multi-az。

sku

Sku

托管实例 SKU

tags

object

资源标记。

ManagedServerCreateMode

指定数据库创建模式。

默认值:定期创建实例。

还原:通过将一组备份还原到特定时间点来创建实例。 必须指定 RestorePointInTime 和 SourceManagedInstanceId。

名称 类型 说明
Default

string

PointInTimeRestore

string

PrincipalType

服务器管理员的主体类型。

名称 类型 说明
Application

string

Group

string

User

string

ResourceIdentity

资源的 Azure Active Directory 标识配置。

名称 类型 说明
principalId

string

Azure Active Directory 主体 ID。

tenantId

string

Azure Active Directory 租户 ID。

type

IdentityType

标识类型。 将此设置为“SystemAssigned”,以便自动为资源创建和分配 Azure Active Directory 主体。

userAssignedIdentities

<string,  UserIdentity>

要使用的用户分配标识的资源 ID

ServicePrincipal

资源托管实例的服务主体配置。

名称 类型 说明
clientId

string

Azure Active Directory 应用程序客户端 ID。

principalId

string

Azure Active Directory 应用程序对象 ID。

tenantId

string

Azure Active Directory 租户 ID。

type

ServicePrincipalType

服务主体类型。

ServicePrincipalType

服务主体类型。

名称 类型 说明
None

string

SystemAssigned

string

Sku

ARM 资源 SKU。

名称 类型 说明
capacity

integer

特定 SKU 的容量。

family

string

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

name

string

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

size

string

特定 SKU 的大小

tier

string

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

UserIdentity

资源的 Azure Active Directory 标识配置。

名称 类型 说明
clientId

string

Azure Active Directory 客户端 ID。

principalId

string

Azure Active Directory 主体 ID。