VirtualMachinesOperations 類別
- 繼承
-
builtins.objectVirtualMachinesOperations
建構函式
VirtualMachinesOperations(*args, **kwargs)
方法
begin_assess_patches |
評估 VM 上的修補程式。 |
begin_capture |
藉由複製 VM 的虛擬硬碟來擷取 VM,並輸出可用來建立類似 VM 的範本。 |
begin_convert_to_managed_disks |
將虛擬機器磁片從 Blob 型轉換為受控磁片。 叫用此作業之前,必須先停止解除配置虛擬機器。 |
begin_create_or_update |
建立或更新虛擬機器的作業。 請注意,某些屬性只能在虛擬機器建立期間設定。 |
begin_deallocate |
關閉虛擬機器並釋放計算資源。 此虛擬機器所使用的計算資源不會向您收費。 |
begin_delete |
刪除虛擬機器的作業。 |
begin_perform_maintenance |
在虛擬機器上執行維護的作業。 |
begin_power_off |
關閉電源 (停止) 虛擬機器的作業。 虛擬機器可以使用相同的布建資源重新開機。 您仍需支付此虛擬機器的費用。 |
begin_reapply |
重新套用虛擬機器狀態的作業。 |
begin_redeploy |
關閉虛擬機器、將它移至新的節點,並重新開啟它。 |
begin_reimage |
將具有暫時 OS 磁片的虛擬機器重新映射回其初始狀態。 |
begin_restart |
重新開機虛擬機器的作業。 |
begin_run_command |
在 VM 上執行命令。 |
begin_start |
啟動虛擬機器的作業。 |
begin_update |
更新虛擬機器的作業。 |
generalize |
將虛擬機器的 OS 狀態設定為一般化。 建議您在執行這項作業之前先對虛擬機器進行 sysprep。 >>:code: |
get |
擷取虛擬機器模型檢視或執行個體檢視的相關資訊。 |
instance_view |
擷取虛擬機器執行時間狀態的相關資訊。 |
list |
列出指定資源群組中的所有虛擬機器。 在回應中使用 nextLink 屬性來取得虛擬機器的下一頁。 |
list_all |
列出指定訂用帳戶中的所有虛擬機器。 在回應中使用 nextLink 屬性來取得虛擬機器的下一頁。 |
list_available_sizes |
列出可調整指定虛擬機器大小的所有可用虛擬機器大小。 |
list_by_location |
取得指定位置之指定訂用帳戶下的所有虛擬機器。 |
retrieve_boot_diagnostics_data |
擷取虛擬機器開機診斷記錄的 SAS URI 作業。 |
simulate_eviction |
模擬現成虛擬機器收回的作業。 |
begin_assess_patches
評估 VM 上的修補程式。
begin_assess_patches(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[VirtualMachineAssessPatchesResult]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
傳回 VirtualMachineAssessPatchesResult 或 cls (回應結果的 LROPoller 實例)
傳回類型
例外狀況
begin_capture
藉由複製 VM 的虛擬硬碟來擷取 VM,並輸出可用來建立類似 VM 的範本。
begin_capture(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineCaptureParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachineCaptureResult]
參數
- parameters
- VirtualMachineCaptureParameters 或 IO
提供給擷取虛擬機器作業的參數。 這是 VirtualMachineCaptureParameters 類型或 IO 類型。 必要。
- content_type
- str
本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
會傳回 VirtualMachineCaptureResult 或 cls (回應結果的 LROPoller 實例)
傳回類型
例外狀況
begin_convert_to_managed_disks
將虛擬機器磁片從 Blob 型轉換為受控磁片。 叫用此作業之前,必須先停止解除配置虛擬機器。
begin_convert_to_managed_disks(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_create_or_update
建立或更新虛擬機器的作業。 請注意,某些屬性只能在虛擬機器建立期間設定。
begin_create_or_update(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachine, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachine]
參數
- content_type
- str
本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 VirtualMachine 或 cls (回應的結果)
傳回類型
例外狀況
begin_deallocate
關閉虛擬機器並釋放計算資源。 此虛擬機器所使用的計算資源不會向您收費。
begin_deallocate(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_delete
刪除虛擬機器的作業。
begin_delete(resource_group_name: str, vm_name: str, *, force_deletion: bool | None = None, **kwargs: Any) -> LROPoller[None]
參數
- force_deletion
- bool
選擇性參數以強制刪除虛擬機器。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_perform_maintenance
在虛擬機器上執行維護的作業。
begin_perform_maintenance(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_power_off
關閉電源 (停止) 虛擬機器的作業。 虛擬機器可以使用相同的布建資源重新開機。 您仍需支付此虛擬機器的費用。
begin_power_off(resource_group_name: str, vm_name: str, *, skip_shutdown: bool = False, **kwargs: Any) -> LROPoller[None]
參數
- skip_shutdown
- bool
要求非正常 VM 關機的參數。 這個旗標的 True 值表示非正常關機,false 則表示否則為 false。 如果未指定,這個旗標的預設值為 false。 預設值為 False。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_reapply
重新套用虛擬機器狀態的作業。
begin_reapply(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_redeploy
關閉虛擬機器、將它移至新的節點,並重新開啟它。
begin_redeploy(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_reimage
將具有暫時 OS 磁片的虛擬機器重新映射回其初始狀態。
begin_reimage(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineReimageParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
參數
- parameters
- VirtualMachineReimageParameters 或 IO
提供給重新映射虛擬機器作業的參數。 這是 VirtualMachineReimageParameters 類型或 IO 類型。 預設值為 [無]。
- content_type
- str
本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_restart
重新開機虛擬機器的作業。
begin_restart(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_run_command
在 VM 上執行命令。
begin_run_command(resource_group_name: str, vm_name: str, parameters: _models.RunCommandInput, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RunCommandResult]
參數
- content_type
- str
本文參數內容類型。 已知值為:'application/json'、'text/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
會傳回 RunCommandResult 或 cls (回應結果的 LROPoller 實例)
傳回類型
例外狀況
begin_start
啟動虛擬機器的作業。
begin_start(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_update
更新虛擬機器的作業。
begin_update(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachine]
參數
- content_type
- str
Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 PollingMethod
根據預設,您的輪詢方法會是 ARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有 Retry-After 標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。
傳回
LROPoller 的實例,會傳回 VirtualMachine 或 cls (回應的結果)
傳回類型
例外狀況
generalize
將虛擬機器的 OS 狀態設定為一般化。 建議您在執行這項作業之前先對虛擬機器進行 sysprep。 >>:code: <br>
For Windows,請參閱 Create a managed image of a generalized VM in Azure <https://docs.microsoft.com/en-us/azure/virtual-machines/windows/capture-image-resource>
_ << .:code:For Linux, please refer to
如何建立虛擬機器或 VHD 的映射。
generalize(resource_group_name: str, vm_name: str, **kwargs: Any) -> None
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
無或 cls (回應的結果)
傳回類型
例外狀況
get
擷取虛擬機器模型檢視或執行個體檢視的相關資訊。
get(resource_group_name: str, vm_name: str, *, expand: Literal['instanceView'] = 'instanceView', **kwargs: Any) -> VirtualMachine
參數
- expand
- str
要套用至作業的展開運算式。 已知值為 「instanceView」 和 None。 預設值為 「instanceView」。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
VirtualMachine 或 cls 的結果 (回應)
傳回類型
例外狀況
instance_view
擷取虛擬機器執行時間狀態的相關資訊。
instance_view(resource_group_name: str, vm_name: str, **kwargs: Any) -> VirtualMachineInstanceView
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
VirtualMachineInstanceView 或 cls (回應的結果)
傳回類型
例外狀況
list
列出指定資源群組中的所有虛擬機器。 在回應中使用 nextLink 屬性來取得虛擬機器的下一頁。
list(resource_group_name: str, **kwargs: Any) -> Iterable[VirtualMachine]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
Iterator,例如 VirtualMachine 的實例或 cls 的結果 (回應)
傳回類型
例外狀況
list_all
列出指定訂用帳戶中的所有虛擬機器。 在回應中使用 nextLink 屬性來取得虛擬機器的下一頁。
list_all(*, status_only: str | None = None, **kwargs: Any) -> Iterable[VirtualMachine]
參數
- status_only
- str
statusOnly=true 可擷取訂用帳戶中所有虛擬機器的執行時間狀態。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
Iterator,例如 VirtualMachine 的實例或 cls 的結果 (回應)
傳回類型
例外狀況
list_available_sizes
列出可調整指定虛擬機器大小的所有可用虛擬機器大小。
list_available_sizes(resource_group_name: str, vm_name: str, **kwargs: Any) -> Iterable[VirtualMachineSize]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
VirtualMachineSize 實例或 cls (回應結果的反覆運算器)
傳回類型
例外狀況
list_by_location
取得指定位置之指定訂用帳戶下的所有虛擬機器。
list_by_location(location: str, **kwargs: Any) -> Iterable[VirtualMachine]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
Iterator,例如 VirtualMachine 的實例或 cls 的結果 (回應)
傳回類型
例外狀況
retrieve_boot_diagnostics_data
擷取虛擬機器開機診斷記錄的 SAS URI 作業。
retrieve_boot_diagnostics_data(resource_group_name: str, vm_name: str, *, sas_uri_expiration_time_in_minutes: int | None = None, **kwargs: Any) -> RetrieveBootDiagnosticsDataResult
參數
- sas_uri_expiration_time_in_minutes
- int
SAS URI 的到期期間,其值介於 1 到 1440 分鐘之間。 <br>
:code: >><<<br>
注意:如果未指定,則會產生 SAS URI,預設到期期間為 120 分鐘。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
RetrieveBootDiagnosticsDataResult 或 cls 的結果 (回應)
傳回類型
例外狀況
simulate_eviction
模擬現成虛擬機器收回的作業。
simulate_eviction(resource_group_name: str, vm_name: str, **kwargs: Any) -> None
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
無或 cls (回應的結果)
傳回類型
例外狀況
屬性
models
models = <module 'azure.mgmt.compute.v2020_06_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2020_06_01\\models\\__init__.py'>