VirtualMachineScaleSetVMsOperations 類別

警告

請勿直接具現化此類別。

相反地,您應該透過 存取下列作業

ComputeManagementClient's

<xref:virtual_machine_scale_set_vms> 屬性。

繼承
builtins.object
VirtualMachineScaleSetVMsOperations

建構函式

VirtualMachineScaleSetVMsOperations(*args, **kwargs)

方法

begin_deallocate

解除配置 VM 擴展集中的特定虛擬機器。 關閉虛擬機器,並釋放它所使用的計算資源。 一旦解除配置,您就不需支付此虛擬機器的計算資源費用。

begin_delete

從 VM 擴展集刪除虛擬機器。

begin_perform_maintenance

在 VM 擴展集中的虛擬機器上執行維護。

begin_power_off

關閉電源 (停止) VM 擴展集中的虛擬機器。 請注意,資源仍會附加,而您需支付資源的費用。 請改用解除配置來釋放資源並避免產生費用。

begin_redeploy

關閉虛擬機器擴展集中的虛擬機器、將其移至新的節點,並將它重新開啟。

begin_reimage

重新映射 (升級作業系統,) VM 擴展集中的特定虛擬機器。

begin_reimage_all

可讓您重新映射所有磁片, ( 包括 VM 擴展集實例中的資料磁片 ) 。 只有受控磁片才支援這項作業。

begin_restart

重新開機 VM 擴展集中的虛擬機器。

begin_run_command

在 VM 擴展集中的虛擬機器上執行命令。

begin_start

啟動 VM 擴展集中的虛擬機器。

begin_update

更新 VM 擴展集的虛擬機器。

get

從 VM 擴展集取得虛擬機器。

get_instance_view

從 VM 擴展集取得虛擬機器的狀態。

list

取得 VM 擴展集中所有虛擬機器的清單。

retrieve_boot_diagnostics_data

擷取 VM 擴展集中虛擬機器開機診斷記錄的 SAS URI 作業。

simulate_eviction

模擬 VM 擴展集中現成虛擬機器收回的作業。

begin_deallocate

解除配置 VM 擴展集中的特定虛擬機器。 關閉虛擬機器,並釋放它所使用的計算資源。 一旦解除配置,您就不需支付此虛擬機器的計算資源費用。

begin_deallocate(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_delete

從 VM 擴展集刪除虛擬機器。

begin_delete(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, force_deletion: bool | None = None, **kwargs: Any) -> LROPoller[None]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

force_deletion
bool

選擇性參數,以強制從 VM 擴展集刪除虛擬機器。 預覽) 中的 (功能。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_perform_maintenance

在 VM 擴展集中的虛擬機器上執行維護。

begin_perform_maintenance(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_power_off

關閉電源 (停止) VM 擴展集中的虛擬機器。 請注意,資源仍會附加,而您需支付資源的費用。 請改用解除配置來釋放資源並避免產生費用。

begin_power_off(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, skip_shutdown: bool = False, **kwargs: Any) -> LROPoller[None]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

skip_shutdown
bool

要求非正常 VM 關機的參數。 這個旗標的 True 值表示非正常關機,false 則表示否則為 false。 如果未指定,這個旗標的預設值為 false。 預設值為 False。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_redeploy

關閉虛擬機器擴展集中的虛擬機器、將其移至新的節點,並將它重新開啟。

begin_redeploy(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_reimage

重新映射 (升級作業系統,) VM 擴展集中的特定虛擬機器。

begin_reimage(resource_group_name: str, vm_scale_set_name: str, instance_id: str, vm_scale_set_vm_reimage_input: _models.VirtualMachineScaleSetVMReimageParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

vm_scale_set_vm_reimage_input
VirtualMachineScaleSetVMReimageParametersIO
必要

ScaleSet 中重新製作虛擬機器映射的參數。 這是 VirtualMachineScaleSetVMReimageParameters 類型或 IO 類型。 預設值為 [無]。

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_reimage_all

可讓您重新映射所有磁片, ( 包括 VM 擴展集實例中的資料磁片 ) 。 只有受控磁片才支援這項作業。

begin_reimage_all(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_restart

重新開機 VM 擴展集中的虛擬機器。

begin_restart(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_run_command

在 VM 擴展集中的虛擬機器上執行命令。

begin_run_command(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: _models.RunCommandInput, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RunCommandResult]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

parameters
RunCommandInputIO
必要

提供給執行命令作業的參數。 這是 RunCommandInput 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為:'application/json'、'text/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

會傳回 RunCommandResult 或 cls (回應結果的 LROPoller 實例)

傳回類型

例外狀況

begin_start

啟動 VM 擴展集中的虛擬機器。

begin_start(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_update

更新 VM 擴展集的虛擬機器。

begin_update(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: _models.VirtualMachineScaleSetVM, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachineScaleSetVM]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

應建立或更新擴充功能的 VM 擴展集名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

parameters
VirtualMachineScaleSetVMIO
必要

提供給更新虛擬機器擴展集 VM 作業的參數。 這是 VirtualMachineScaleSetVM 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

傳回 VirtualMachineScaleSetVM 或 cls (回應結果的 LROPoller 實例)

傳回類型

例外狀況

get

從 VM 擴展集取得虛擬機器。

get(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, expand: Literal['instanceView'] = 'instanceView', **kwargs: Any) -> VirtualMachineScaleSetVM

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

expand
str

要套用至作業的展開運算式。 已知值為 「instanceView」 和 None。 預設值為 「instanceView」。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

VirtualMachineScaleSetVM 或 cls 的結果 (回應)

傳回類型

例外狀況

get_instance_view

從 VM 擴展集取得虛擬機器的狀態。

get_instance_view(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> VirtualMachineScaleSetVMInstanceView

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

VirtualMachineScaleSetVMInstanceView 或 cls 的結果 (回應)

傳回類型

例外狀況

list

取得 VM 擴展集中所有虛擬機器的清單。

list(resource_group_name: str, virtual_machine_scale_set_name: str, *, filter: str | None = None, select: str | None = None, expand: str | None = None, **kwargs: Any) -> Iterable[VirtualMachineScaleSetVM]

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

virtual_machine_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

filter
str

要套用至作業的篩選。 允許的值是 'startwith (instanceView/statuses/code、'PowerState') eq true'、'properties/latestModelApplied eq true'、'properties/latestModelApplied eq false'。 預設值為 [無]。

select
str

清單參數。 允許的值是 'instanceView'、'instanceView/statuses'。 預設值為 [無]。

expand
str

要套用至作業的展開運算式。 允許的值是 'instanceView'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

Iterator,例如 VirtualMachineScaleSetVM 的實例或 cls (回應的結果)

傳回類型

例外狀況

retrieve_boot_diagnostics_data

擷取 VM 擴展集中虛擬機器開機診斷記錄的 SAS URI 作業。

retrieve_boot_diagnostics_data(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, sas_uri_expiration_time_in_minutes: int | None = None, **kwargs: Any) -> RetrieveBootDiagnosticsDataResult

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

sas_uri_expiration_time_in_minutes
int

SAS URI 的到期期間,其值介於 1 到 1440 分鐘之間。 <br>:code: >><<<br> 注意:如果未指定,則會產生 SAS URI,預設到期期間為 120 分鐘。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

RetrieveBootDiagnosticsDataResult 或 cls 的結果 (回應)

傳回類型

例外狀況

simulate_eviction

模擬 VM 擴展集中現成虛擬機器收回的作業。

simulate_eviction(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> None

參數

resource_group_name
str
必要

資源群組的名稱。 必要。

vm_scale_set_name
str
必要

VM 擴展集的名稱。 必要。

instance_id
str
必要

虛擬機器的實例識別碼。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

無或 cls (回應的結果)

傳回類型

例外狀況

屬性

models

models = <module 'azure.mgmt.compute.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2020_12_01\\models\\__init__.py'>