Virtual Machine Instances - Stop

服務:

Azure Arc enabled SCVMM

API 版本:

2024-06-01

實作作業以停止虛擬機。
關閉虛擬機實例電源（停止）的作業。

POST https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

URI 參數

名稱	位於	必要	類型	Description
resourceUri	path	True	string	資源的完整 Azure Resource Manager 標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
skipShutdown	SkipShutdown	取得或設定值，指出是否要求非正常關閉的 VM。 這個旗標的 True 值表示非正常關機，而 false 則表示否則為 false。 默認值為 false。

回應

名稱	類型	Description
202 Accepted		已接受資源作業。 標題 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

VirtualMachineInstances_Stop_MaximumSet

VirtualMachineInstances_Stop_MinimumSet

VirtualMachineInstances_Stop_MaximumSet

範例要求

HTTP

POST https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

{
  "skipShutdown": "true"
}

範例回覆

狀態碼:

202

location: https://contoso.com/operationstatus

VirtualMachineInstances_Stop_MinimumSet

範例要求

HTTP

POST https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

{}

範例回覆

狀態碼:

202

location: https://contoso.com/operationstatus

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
SkipShutdown	取得或設定值，指出是否要求非正常關閉的 VM。 這個旗標的 True 值表示非正常關機，而 false 則表示否則為 false。 默認值為 false。
StopVirtualMachineOptions	定義停止動作屬性。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

SkipShutdown

取得或設定值，指出是否要求非正常關閉的 VM。 這個旗標的 True 值表示非正常關機，而 false 則表示否則為 false。 默認值為 false。

名稱	類型	Description
false	string	停用略過關機。
true	string	啟用略過關機。

StopVirtualMachineOptions

定義停止動作屬性。

名稱	類型	預設值	Description
skipShutdown	SkipShutdown	false	取得或設定值，指出是否要求非正常關閉的 VM。 這個旗標的 True 值表示非正常關機，而 false 則表示否則為 false。 默認值為 false。