Managed Instances - Update

更新受控執行個體。

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

URI 參數

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

string

受管理的執行個體名稱。

resourceGroupName
path True

string

包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。

subscriptionId
path True

string

可識別 Azure 訂用帳戶的訂用帳戶識別碼。

api-version
query True

string

要用於要求的 API 版本。

要求本文

名稱 類型 Description
identity

ResourceIdentity

受控實例識別

properties.administratorLogin

string

受控實例的系統管理員用戶名稱。 只有在建立受控實例 (且建立) 時,才能指定。

properties.administratorLoginPassword

string

建立受控實例) 所需的系統管理員登入密碼 (。

properties.administrators

ManagedInstanceExternalAdministrator

伺服器的 Azure Active Directory 系統管理員。

properties.collation

string

受控實例的定序。

properties.dnsZonePartner

string

建立之後,此受控實例將會共用其 DNS 區域的另一個受控實例的資源識別碼。

properties.instancePoolId

string

這個受控伺服器所屬之實例集區的標識碼。

properties.keyId

string

要用於加密之金鑰的 CMK URI。

properties.licenseType

ManagedInstanceLicenseType

授權類型。 可能的值為 『LicenseIncluded』 (一般價格,其中包含新的 SQL 授權) 和 『BasePrice』 (折扣的 AHB 價格,以攜帶您自己的 SQL 授權) 。

properties.maintenanceConfigurationId

string

指定要套用至此受控實例的維護組態標識碼。

properties.managedInstanceCreateMode

ManagedServerCreateMode

指定資料庫建立模式。

默認值:建立一般實例。

還原:將一組備份還原至特定時間點,以建立實例。 必須指定 RestorePointInTime 和 SourceManagedInstanceId。

properties.minimalTlsVersion

string

最低 TLS 版本。 允許的值:'None'、'1.0'、'1.1'、'1.2'

properties.primaryUserAssignedIdentityId

string

預設會使用之使用者指派身分識別的資源標識碼。

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 的增量。 最大值取決於選取的硬體系列和虛擬核心數目。

properties.subnetId

string

受控實例的子網資源標識碼。

properties.timezoneId

string

時區的標識碼。 允許的值是 Windows 支援的時區。 Windows 會保留支援時區的詳細數據,包括登錄中的標識符,位於 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 底下。 您可以藉由查詢 SELECT 名稱 AS timezone_id FROM sys.time_zone_info,透過 SQL Server 取得這些登錄值。 您也可以在 PowerShell 中執行 [System.TimeZoneInfo]::GetSystemTimeZones () 來取得標識符列表。 有效時區標識碼的範例是 「Pacific Standard Time」 或 「W」。 歐洲標準時間」。

properties.vCores

integer

虛擬核心的數目。 允許的值:8、16、24、32、40、64、80。

properties.zoneRedundant

boolean

是否啟用 multi-az。

sku

Sku

受控實例 SKU

tags

object

資源標籤。

回應

名稱 類型 Description
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 - 受控實例建立或更新所提供的子網資源標識符無效。

  • 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) 小於目前使用的記憶體 (GB) {1} 。 請指定較高的記憶體大小限制。

  • 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 - '{0}' 在此版本的 SQL Server 中不是有效的資料庫版本。

  • 400 InvalidLocation - 指定了無效的位置。

  • 400 InvalidParameterValue - 已將無效的值提供給參數。

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

  • 400 MiGeoRestoreWithWrongBackupStorageRedundancy - 使用 LRS/ZRS 備份記憶體備援的受控實例不允許 Geo-Restore。

  • 400 UpdateingInstanceAndBackupRedundancy - 實例區域備援和備份記憶體備援無法在相同的要求中更新。

  • 400 ProvisioningDisabled - 依原樣顯示資源作業授權者的錯誤訊息,而不需變更

  • 400 AadOnlyAuthenticationIsEnabled - 已啟用 Azure Active Directory 僅限驗證。 請連絡您的系統管理員。

  • 400 ManagementServiceFeatureDisabled - 用戶嘗試使用已停用的功能。

  • 400 MatchingResourceGroupNameWithUrl - 提供的資源組名與 URL 中的名稱不符。

  • 400 MatchingSubscriptionWithUrl - 提供的訂用帳戶不符合 URL 中的訂用帳戶。

  • 400 InvalidMinimalTlsVersion - 無效的最低 TLS 版本。

  • 400 InvalidResourceId - 資源標識符無效。

  • 400 InvalidParameterValue - 已將無效的值提供給參數。

  • 400 AadOnlyAuthenticationIsEnabled - 已啟用 Azure Active Directory 僅限驗證。 請連絡您的系統管理員。

  • 400 InvalidExternalAdministratorLogin - 無效或遺漏外部系統管理員登入名稱。

  • 400 InvalidExternalAdministratorSid - 無效或遺漏外部系統管理員對象標識碼。

  • 400 InvalidExternalAdministratorTenantId - 無效或遺失外部系統管理員租用戶標識符。

  • 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 - 標識符為 的作業不存在。

  • 404 ResourceDoesNotExist - 名稱為 '{0}' 的資源不存在。 若要繼續,請指定有效的資源名稱。

  • 404 InstancePoolNotFound - 找不到實例集區

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

  • 404 ResourceNotFound - 找不到所要求的資源。

  • 405 InvalidVcoreValue - 虛擬核心值 {0} 無效。 請指定有效的虛擬核心值。

  • 405 InvalidHardwareGenerationValue - HardwareGeneration {0} 無效。 請指定有效的 HardwareGeneration 值。

  • 405 InvalidStorageSizeValue - 「記憶體大小無效: {0} GB。 記憶體大小必須在 和 {2} GB 之間{1}指定,以 GB 為單位{3}。

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

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

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

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

  • 409 ServerOverridePreconditionFailed - 無法在類別 '{0}' 上套用伺服器覆寫,因為伺服器 '{2}' 中的實體資料庫或實例 '{1}' 目前不是處於 'Ready' 或 'Deactivated' 狀態。

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

定義

名稱 Description
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』 (折扣的 AHB 價格,以攜帶您自己的 SQL 授權) 。

ManagedInstancePecProperty

受控實例下的私人端點連線

ManagedInstancePrivateEndpointConnectionProperties

私人端點連線的屬性。

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

用於連接到 實例的連接類型。

ManagedInstanceUpdate

Azure SQL Database 受控實例的更新要求。

ManagedServerCreateMode

指定資料庫建立模式。

默認值:建立一般實例。

還原:將一組備份還原至特定時間點,以建立實例。 必須指定 RestorePointInTime 和 SourceManagedInstanceId。

PrincipalType

伺服器管理員的主體類型。

ResourceIdentity

資源的 Azure Active Directory 身分識別組態。

ServicePrincipal

受控實例的資源服務主體組態。

ServicePrincipalType

服務主體類型。

Sku

ARM 資源 SKU。

UserIdentity

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

AdministratorType

伺服器管理員的類型。

名稱 類型 Description
ActiveDirectory

string

BackupStorageRedundancy

用來儲存此實例備份的記憶體帳戶類型。 選項包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)

名稱 類型 Description
Geo

string

GeoZone

string

Local

string

Zone

string

IdentityType

識別類型。 將此設定為 『SystemAssigned』,以便自動建立並指派資源的 Azure Active Directory 主體。

名稱 類型 Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManagedInstance

Azure SQL 受控實例。

名稱 類型 Description
id

string

資源識別碼。

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

另一個受控實例的資源標識符,此受控實例會在建立之後共用其 DNS 區域。

properties.fullyQualifiedDomainName

string

受控實例的完整功能變數名稱。

properties.instancePoolId

string

這個受管理伺服器所屬之實例集區的標識碼。

properties.keyId

string

要用於加密之金鑰的 CMK URI。

properties.licenseType

ManagedInstanceLicenseType

授權類型。 可能的值為 『LicenseIncluded』 (一般價格,包括新的 SQL 授權) 和 『BasePrice』 (折扣的 AHB 價格,以攜帶您自己的 SQL 授權) 。

properties.maintenanceConfigurationId

string

指定要套用至此受控實例的維護組態標識碼。

properties.managedInstanceCreateMode

ManagedServerCreateMode

指定資料庫建立模式。

默認值:建立一般實例。

還原:將一組備份還原至特定時間點,以建立實例。 必須指定 RestorePointInTime 和 SourceManagedInstanceId。

properties.minimalTlsVersion

string

最低 TLS 版本。 允許的值:'None'、'1.0'、'1.1'、'1.2'

properties.primaryUserAssignedIdentityId

string

預設使用之使用者指派身分識別的資源標識碼。

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 的增量。 最大值取決於選取的硬體系列和虛擬核心數目。

properties.subnetId

string

受控實例的子網資源標識碼。

properties.timezoneId

string

時區的標識碼。 允許的值是 Windows 支援的時區。 Windows 會在 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 下的登錄中保留支援時區的詳細數據,包括標識符。 您可以藉由查詢 SELECT 名稱 AS timezone_id FROM sys.time_zone_info,透過 SQL Server 取得這些登錄值。 您也可以在 PowerShell 中執行 [System.TimeZoneInfo]::GetSystemTimeZones () 來取得標識符列表。 有效時區標識碼的範例是 「Pacific Standard Time」 或 「W」。 歐洲標準時間」。

properties.vCores

integer

虛擬核心數目。 允許的值: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 系統管理員的屬性。

名稱 類型 Description
administratorType

AdministratorType

伺服器管理員的類型。

azureADOnlyAuthentication

boolean

僅啟用 Azure Active Directory 驗證。

login

string

伺服器管理員的登入名稱。

principalType

PrincipalType

伺服器管理員的主體類型。

sid

string

伺服器管理員) SID (物件識別碼。

tenantId

string

系統管理員的租用戶標識碼。

ManagedInstanceLicenseType

授權類型。 可能的值為 『LicenseIncluded』 (一般價格,其中包含新的 SQL 授權) 和 『BasePrice』 (折扣的 AHB 價格,以攜帶您自己的 SQL 授權) 。

名稱 類型 Description
BasePrice

string

LicenseIncluded

string

ManagedInstancePecProperty

受控實例下的私人端點連線

名稱 類型 Description
id

string

資源識別碼。

properties

ManagedInstancePrivateEndpointConnectionProperties

私人端點連線屬性

ManagedInstancePrivateEndpointConnectionProperties

私人端點連線的屬性。

名稱 類型 Description
privateEndpoint

ManagedInstancePrivateEndpointProperty

線上所屬的私人端點。

privateLinkServiceConnectionState

ManagedInstancePrivateLinkServiceConnectionStateProperty

私人端點連線的連線狀態。

provisioningState

string

私人端點連線的狀態。

ManagedInstancePrivateEndpointProperty

名稱 類型 Description
id

string

私人端點的資源標識碼。

ManagedInstancePrivateLinkServiceConnectionStateProperty

名稱 類型 Description
actionsRequired

string

私人鏈接服務連線描述。

description

string

私人鏈接服務連線描述。

status

string

私人鏈接服務連線狀態。

ManagedInstanceProxyOverride

用於連接到 實例的連接類型。

名稱 類型 Description
Default

string

Proxy

string

Redirect

string

ManagedInstanceUpdate

Azure SQL Database 受控實例的更新要求。

名稱 類型 Description
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

建立之後,此受控實例將會共用其 DNS 區域的另一個受控實例的資源識別碼。

properties.fullyQualifiedDomainName

string

受控實例的完整功能變數名稱。

properties.instancePoolId

string

這個受控伺服器所屬之實例集區的標識碼。

properties.keyId

string

要用於加密之金鑰的 CMK URI。

properties.licenseType

ManagedInstanceLicenseType

授權類型。 可能的值為 『LicenseIncluded』 (一般價格,包括新的 SQL 授權) 和 『BasePrice』 (折扣的 AHB 價格,以攜帶您自己的 SQL 授權) 。

properties.maintenanceConfigurationId

string

指定要套用至此受控實例的維護組態標識碼。

properties.managedInstanceCreateMode

ManagedServerCreateMode

指定資料庫建立模式。

默認值:建立一般實例。

還原:將一組備份還原至特定時間點,以建立實例。 必須指定 RestorePointInTime 和 SourceManagedInstanceId。

properties.minimalTlsVersion

string

最低 TLS 版本。 允許的值:'None'、'1.0'、'1.1'、'1.2'

properties.primaryUserAssignedIdentityId

string

預設會使用之使用者指派身分識別的資源標識碼。

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 的增量。 最大值取決於選取的硬體系列和虛擬核心數目。

properties.subnetId

string

受控實例的子網資源標識碼。

properties.timezoneId

string

時區的標識碼。 允許的值是 Windows 支援的時區。 Windows 會保留支援時區的詳細數據,包括登錄中的標識符,位於 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 底下。 您可以藉由查詢 SELECT 名稱 AS timezone_id FROM sys.time_zone_info,透過 SQL Server 取得這些登錄值。 您也可以在 PowerShell 中執行 [System.TimeZoneInfo]::GetSystemTimeZones () 來取得標識符列表。 有效時區標識碼的範例是 「Pacific Standard Time」 或 「W」。 歐洲標準時間」。

properties.vCores

integer

虛擬核心的數目。 允許的值:8、16、24、32、40、64、80。

properties.zoneRedundant

boolean

是否啟用 multi-az。

sku

Sku

受控實例 SKU

tags

object

資源標籤。

ManagedServerCreateMode

指定資料庫建立模式。

默認值:建立一般實例。

還原:將一組備份還原至特定時間點,以建立實例。 必須指定 RestorePointInTime 和 SourceManagedInstanceId。

名稱 類型 Description
Default

string

PointInTimeRestore

string

PrincipalType

伺服器管理員的主體類型。

名稱 類型 Description
Application

string

Group

string

User

string

ResourceIdentity

資源的 Azure Active Directory 身分識別組態。

名稱 類型 Description
principalId

string

Azure Active Directory 主體標識符。

tenantId

string

Azure Active Directory 租用戶標識符。

type

IdentityType

識別類型。 將此設定為 『SystemAssigned』,以便自動建立並指派資源的 Azure Active Directory 主體。

userAssignedIdentities

<string,  UserIdentity>

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

ServicePrincipal

受控實例的資源服務主體組態。

名稱 類型 Description
clientId

string

Azure Active Directory 應用程式用戶端標識碼。

principalId

string

Azure Active Directory 應用程式對象識別碼。

tenantId

string

Azure Active Directory 租用戶標識符。

type

ServicePrincipalType

服務主體類型。

ServicePrincipalType

服務主體類型。

名稱 類型 Description
None

string

SystemAssigned

string

Sku

ARM 資源 SKU。

名稱 類型 Description
capacity

integer

特定 SKU 的容量。

family

string

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

name

string

SKU 的名稱,通常是字母 + 編號代碼,例如 P3。

size

string

特定 SKU 的大小

tier

string

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

UserIdentity

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

名稱 類型 Description
clientId

string

Azure Active Directory 用戶端標識符。

principalId

string

Azure Active Directory 主體標識符。