共用方式為


Managed Instances - Stop

停止受控實例。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/stop?api-version=2023-08-01-preview

URI 參數

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

string

受管理的執行個體名稱。

resourceGroupName
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

要用於要求的 API 版本。

回應

名稱 類型 Description
200 OK

ManagedInstance

已成功停止受控實例。

202 Accepted

正在停止受控實例。

Other Status Codes

ErrorResponse

錯誤回應: ≦

  • 400 ManagementServiceStopManagedInstanceZoneRedundant - 停止在已啟用區域備援的實例上執行。

  • 400 ManagementServiceStopManagedInstancePartOfFailoverGroup - 停止在故障轉移群組的實例上執行。

  • 400 NameAlreadyExists - 所提供的名稱已經存在。

  • 400 ManagementServiceStartStopManagedInstanceSubscriptionNotEnabledForFeature - 用戶嘗試使用 Start/Stop 功能,而不需為適當的訂用帳戶功能列入允許清單。

  • 400 ManagementServiceStopManagedInstanceNotSupportedOnSKU - 指定的 SKU 不支援停止作業。

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

  • 400 StartStopOfManagedInstanceIsDisabled - 未啟用受控實例上的啟動和停止作業。

  • 400 InvalidIdentifier - 識別碼包含 NULL 或無效的 Unicode 字元。

  • 400 ManagementServiceStopManagedInstanceUsingMILink - 停止在已設定 受控執行個體 鏈接的實例上執行。

  • 400 ManagementServiceStopManagedInstanceFeatureDisabled - 用戶嘗試使用停用的 Stop Azure SQL 受控執行個體 功能。

  • 400 ManagementServiceStopManagedInstanceHostedOnRdfePlatform - 停止在未使用 Feature Wave 2022 年 11 月執行的實例上執行

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

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

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

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

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

  • 409 ManagementServiceStopManagedInstanceAlreadyInProgress - 針對處於停止/停止狀態之作業提交的作業停止作業。

  • 409 ManagementServiceStopManagedInstanceConflictingOperation - 停止 Azure SQL 受控執行個體 衝突的作業訊息。

  • 409 ManagementServiceStopManagedInstanceDroppedDuringStop - 停止在同時處於刪除狀態或移除的實例上執行。

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

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

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

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

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

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

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

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

範例

Stops the managed instance.

Sample Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/managedInstances/mitostop/stop?api-version=2023-08-01-preview

Sample Response

{
  "sku": {
    "name": "GP_Gen5",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen5"
  },
  "properties": {
    "fullyQualifiedDomainName": "mitostop.1234567891234.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "state": "Stopped",
    "provisioningState": "Succeeded",
    "vCores": 8,
    "storageSizeInGB": 1024,
    "licenseType": "LicenseIncluded",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Default",
    "minimalTlsVersion": "1.2",
    "dnsZone": "1234567891234",
    "instancePoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "servicePrincipal": {
      "principalId": "00000011-1111-2222-2222-123456789111",
      "clientId": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "type": "SystemAssigned"
    },
    "externalGovernanceStatus": "Enabled",
    "hybridSecondaryUsage": "Passive",
    "authenticationMetadata": "Windows",
    "databaseFormat": "SQLServer2022"
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/managedInstances/mitostop",
  "name": "mitostop",
  "type": "Microsoft.Sql/managedInstances"
}
Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/locations/westeurope/stopManagedInstanceOperationResults/11111111-1111-1111-1111-111111111111
Azure-AsyncOperation: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/locations/westeurope/stopManagedInstanceAzureAsyncOperation/11111111-1111-1111-1111-111111111111

定義

名稱 Description
AdministratorType

伺服器管理員的類型。

AuthMetadataLookupModes

受控實例的驗證元數據查閱模式。

BackupStorageRedundancy

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

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

ExternalGovernanceStatus

外部治理的狀態。

FreemiumType

天氣或未 受控執行個體 為免費空間。

HybridSecondaryUsage

混合式次要使用量。 可能的值為 「主動」 (預設值) ,而「被動」 (客戶會使用次要作為被動DR) 。

HybridSecondaryUsageDetected

偵測到混合式次要使用量。 可能的值為「主動」 (客戶不符合使用次要作為被動DR) 和「被動」 (客戶符合使用次要作為被動DR) 的需求。

IdentityType

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

ManagedInstance

Azure SQL 受控實例。

ManagedInstanceDatabaseFormat

指定 SQL 引擎版本專屬實例資料庫的內部格式。

ManagedInstanceExternalAdministrator

Active Directory 系統管理員的屬性。

ManagedInstanceLicenseType

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

ManagedInstancePecProperty

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

ManagedInstancePrivateEndpointConnectionProperties

私人端點連線的屬性。

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

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

ManagedServerCreateMode

指定資料庫建立模式。

默認值:建立一般實例。

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

PrincipalType

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

ProvisioningState

受控實例的布建狀態。

ResourceIdentity

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

ServicePrincipal

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

ServicePrincipalType

服務主體類型。

Sku

ARM 資源 SKU。

UserIdentity

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

AdministratorType

伺服器管理員的類型。

名稱 類型 Description
ActiveDirectory

string

AuthMetadataLookupModes

受控實例的驗證元數據查閱模式。

名稱 類型 Description
AzureAD

string

Paired

string

Windows

string

BackupStorageRedundancy

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

名稱 類型 Description
Geo

string

GeoZone

string

Local

string

Zone

string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。

ExternalGovernanceStatus

外部治理的狀態。

名稱 類型 Description
Disabled

string

Enabled

string

FreemiumType

天氣或未 受控執行個體 為免費空間。

名稱 類型 Description
Freemium

string

Regular

string

HybridSecondaryUsage

混合式次要使用量。 可能的值為 「主動」 (預設值) ,而「被動」 (客戶會使用次要作為被動DR) 。

名稱 類型 Description
Active

string

Passive

string

HybridSecondaryUsageDetected

偵測到混合式次要使用量。 可能的值為「主動」 (客戶不符合使用次要作為被動DR) 和「被動」 (客戶符合使用次要作為被動DR) 的需求。

名稱 類型 Description
Active

string

Passive

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 系統管理員。 這隻能在實例建立時使用。 如果用於實例更新,則會忽略它,否則會導致錯誤。 如需更新,則必須使用個別 API。

properties.authenticationMetadata

AuthMetadataLookupModes

受控實例的驗證元數據查閱模式。

properties.collation

string

受控實例的定序。

properties.createTime

string

指定 受控執行個體 建立) 的時間點 (ISO8601 格式。

properties.currentBackupStorageRedundancy

BackupStorageRedundancy

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

properties.databaseFormat

ManagedInstanceDatabaseFormat

指定 SQL 引擎版本專屬實例資料庫的內部格式。

properties.dnsZone

string

受控實例所在的 Dns 區域。

properties.dnsZonePartner

string

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

properties.externalGovernanceStatus

ExternalGovernanceStatus

外部治理的狀態。

properties.fullyQualifiedDomainName

string

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

properties.hybridSecondaryUsage

HybridSecondaryUsage

混合式次要使用量。 可能的值為 「主動」 (預設值) ,而「被動」 (客戶會使用次要作為被動DR) 。

properties.hybridSecondaryUsageDetected

HybridSecondaryUsageDetected

偵測到混合式次要使用量。 可能的值為「主動」 (客戶不符合使用次要作為被動DR) 和「被動」 (客戶符合使用次要作為被動DR) 的需求。

properties.instancePoolId

string

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

properties.isGeneralPurposeV2

boolean

這是否為 常規用途 版本的 GPv2 變體。

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.pricingModel

FreemiumType

天氣或未 受控執行個體 為免費空間。

properties.primaryUserAssignedIdentityId

string

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

properties.privateEndpointConnections

ManagedInstancePecProperty[]

受控實例上的私人端點連線清單。

properties.provisioningState

ProvisioningState

受控實例的布建狀態。

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.storageIOps

integer

記憶體 IOps。 最小值:300。 最大值:80000。 僅允許 1 個 IOps 的增量。 最大值取決於選取的硬體系列和虛擬核心數目。

properties.storageSizeInGB

integer

以 GB 為單位的記憶體大小。 最小值:32。 最大值:16384。 只允許 32 GB 的增量。 最大值取決於選取的硬體系列和虛擬核心數目。

properties.storageThroughputMBps

integer

實例建立/更新作業不支持記憶體輸送量 MBps 參數。

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.totalMemoryMB

integer

以 MB 為單位的總記憶體。 最小值:7168。 最大值:891328。 只允許 1 MB 的增量。 最大值取決於選取的硬體系列和虛擬核心數目。

properties.vCores

integer

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

properties.virtualClusterId

string

受控執行個體的虛擬叢集資源標識碼。

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

資源類型。

ManagedInstanceDatabaseFormat

指定 SQL 引擎版本專屬實例資料庫的內部格式。

名稱 類型 Description
AlwaysUpToDate

string

SQLServer2022

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

ManagedServerCreateMode

指定資料庫建立模式。

默認值:建立一般實例。

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

名稱 類型 Description
Default

string

PointInTimeRestore

string

PrincipalType

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

名稱 類型 Description
Application

string

Group

string

User

string

ProvisioningState

受控實例的布建狀態。

名稱 類型 Description
Canceled

string

Created

string

Failed

string

InProgress

string

Succeeded

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 主體標識符。