VirtualMachineScaleSetVMsOperations クラス
警告
このクラスを直接インスタンス化しないでください。
代わりに、次の操作にアクセスする必要があります。
<xref:virtual_machine_scale_set_vms> 属性を使用する。
- 継承
-
builtins.objectVirtualMachineScaleSetVMsOperations
コンストラクター
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]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングを行わない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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]パラメーター
- force_deletion
- bool
VM スケール セットから仮想マシンを強制的に削除する省略可能なパラメーター。 (プレビューの機能)。 既定値は [なし] です。
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングを行わない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
begin_perform_maintenance
VM スケール セット内の仮想マシンに対してメンテナンスを実行します。
begin_perform_maintenance(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングを行わない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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]パラメーター
- skip_shutdown
- bool
正常でない VM シャットダウンを要求するパラメーター。 このフラグの True 値は正常でないシャットダウンを示し、false はそれ以外の場合を示します。 指定しない場合、このフラグの既定値は false です。 既定値は False です。
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングを行わない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
begin_redeploy
仮想マシン スケール セット内の仮想マシンをシャットダウンし、新しいノードに移動して電源を入れ直します。
begin_redeploy(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングを行わない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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]パラメーター
- vm_scale_set_vm_reimage_input
- VirtualMachineScaleSetVMReimageParameters または IO
ScaleSet での仮想マシンの再イメージ化のパラメーター。 VirtualMachineScaleSetVMReimageParameters 型または IO 型です。 既定値は [なし] です。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
begin_reimage_all
VM スケール セット インスタンス内のすべてのディスク (データ ディスクを含む) を再イメージ化できます。 この操作は、マネージド ディスクでのみサポートされます。
begin_reimage_all(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]パラメーター
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
begin_restart
VM スケール セット内の仮想マシンを再起動します。
begin_restart(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]パラメーター
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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]パラメーター
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json'、'text/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
RunCommandResult または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
begin_start
VM スケール セット内の仮想マシンを起動します。
begin_start(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]パラメーター
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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]パラメーター
- parameters
- VirtualMachineScaleSetVM または IO
UPDATE Virtual Machine Scale Sets VM 操作に指定されたパラメーター。 VirtualMachineScaleSetVM 型または IO 型のいずれかです。 必須。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
VirtualMachineScaleSetVM または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
get
VM スケール セットから仮想マシンを取得します。
get(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, expand: str | InstanceViewTypes | None = None, **kwargs: Any) -> VirtualMachineScaleSetVMパラメーター
- expand
- str または InstanceViewTypes
操作に適用する展開式。 'InstanceView' は、仮想マシンのインスタンス ビューを取得します。 'UserData' は、仮想マシンの UserData を取得します。 既知の値は、"instanceView" と "userData" です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
VirtualMachineScaleSetVM または cls(response) の結果
の戻り値の型 :
例外
get_instance_view
VM スケール セットから仮想マシンの状態を取得します。
get_instance_view(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> VirtualMachineScaleSetVMInstanceViewパラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
VirtualMachineScaleSetVMInstanceView または cls(response) の結果
の戻り値の型 :
例外
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]パラメーター
- filter
- str
操作に適用するフィルター。 使用できる値は、'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false' です。 既定値は [なし] です。
- select
- str
リスト パラメーター。 使用できる値は、'instanceView'、'instanceView/statuses' です。 既定値は [なし] です。
- expand
- str
操作に適用する展開式。 使用できる値は 'instanceView' です。 既定値は [なし] です。
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
VirtualMachineScaleSetVM のインスタンスや cls(response) の結果のような反復子
の戻り値の型 :
例外
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パラメーター
- sas_uri_expiration_time_in_minutes
- int
1 ~ 1440 分の値を持つ SAS URI の有効期限 (分単位)。 メモ： 指定しない場合、SAS URI は既定の有効期限 120 分で生成されます。 既定値は [なし] です。
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
RetrieveBootDiagnosticsDataResult または cls(response) の結果
の戻り値の型 :
例外
simulate_eviction
VM スケール セット内のスポット仮想マシンの削除をシミュレートする操作。
simulate_eviction(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> Noneパラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
なし、または cls(response) の結果
の戻り値の型 :
例外
属性
models
models = <module 'azure.mgmt.compute.v2023_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2023_03_01\\models\\__init__.py'>
Azure SDK for Python