VirtualMachinesOperations クラス
警告
このクラスを直接インスタンス化しないでください。
代わりに、次の操作にアクセスする必要があります。
<xref:virtual_machines> 属性を使用する。
- 継承
-
builtins.objectVirtualMachinesOperations
コンストラクター
VirtualMachinesOperations(*args, **kwargs)
メソッド
begin_capture |
VM の仮想ハード ディスクをコピーして VM をキャプチャし、同様の VM を作成するために使用できるテンプレートを出力します。 |
begin_convert_to_managed_disks |
仮想マシン ディスクを BLOB ベースからマネージド ディスクに変換します。 この操作を呼び出す前に、仮想マシンを停止して割り当てを解除する必要があります。 >>:code: |
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 |
指定した場所の指定したサブスクリプションのすべての仮想マシンを取得します。 |
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
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
VirtualMachineCaptureResult または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
begin_convert_to_managed_disks
仮想マシン ディスクを BLOB ベースからマネージド ディスクに変換します。 この操作を呼び出す前に、仮想マシンを停止して割り当てを解除する必要があります。 >>:code:<br>
Windows の場合は、_<<.:code をConvert a virtual machine from unmanaged disks to managed disks. <https://docs.microsoft.com/en-us/azure/virtual-machines/windows/convert-unmanaged-to-managed-disks>
参照してください。For Linux, please refer to
仮想マシンをアンマネージド ディスクからマネージド ディスクに変換します。
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 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
VirtualMachine または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
begin_delete
仮想マシンを削除する操作。
begin_delete(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 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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 です。
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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
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_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 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
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
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
仮想マシンを起動する操作。
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 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
begin_update
仮想マシンを更新する操作。
begin_update(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachine]
パラメーター
- parameters
- VirtualMachineUpdate または IO
仮想マシンの更新操作に指定されたパラメーター。 VirtualMachineUpdate 型または 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 つのポーリング間の既定の待機時間。
戻り値
VirtualMachine または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
generalize
仮想マシンの OS 状態を一般化に設定します。 この操作を実行する前に、仮想マシンを sysprep することをお勧めします。 >>:code:<br>
Windows の場合は、_<<.:code をCreate a managed image of a generalized VM in Azure <https://docs.microsoft.com/en-us/azure/virtual-machines/windows/capture-image-resource>
参照してください。For Linux, please refer to
仮想マシンまたは VHD のイメージを作成する方法。
generalize(resource_group_name: str, vm_name: str, **kwargs: Any) -> None
パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
なし、または cls(response) の結果
の戻り値の型 :
例外
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(response) の結果
の戻り値の型 :
例外
instance_view
仮想マシンの実行時の状態に関する情報を取得します。
instance_view(resource_group_name: str, vm_name: str, **kwargs: Any) -> VirtualMachineInstanceView
パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
VirtualMachineInstanceView または cls(response) の結果
の戻り値の型 :
例外
list
指定したリソース グループ内のすべての仮想マシンを一覧表示します。 応答で nextLink プロパティを使用して、仮想マシンの次のページを取得します。
list(resource_group_name: str, **kwargs: Any) -> Iterable[VirtualMachine]
パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
VirtualMachine のインスタンスや cls(response) の結果のような反復子
の戻り値の型 :
例外
list_all
指定したサブスクリプション内のすべての仮想マシンを一覧表示します。 応答で nextLink プロパティを使用して、仮想マシンの次のページを取得します。
list_all(*, status_only: str | None = None, **kwargs: Any) -> Iterable[VirtualMachine]
パラメーター
- status_only
- str
statusOnly=true を指定すると、サブスクリプション内のすべてのVirtual Machinesの実行時の状態をフェッチできます。 既定値は [なし] です。
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
VirtualMachine のインスタンスや cls(response) の結果のような反復子
の戻り値の型 :
例外
list_available_sizes
指定した仮想マシンのサイズを変更できる使用可能なすべての仮想マシン サイズを一覧表示します。
list_available_sizes(resource_group_name: str, vm_name: str, **kwargs: Any) -> Iterable[VirtualMachineSize]
パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
VirtualMachineSize のインスタンスや cls(response) の結果のような反復子
の戻り値の型 :
例外
list_by_location
指定した場所の指定したサブスクリプションのすべての仮想マシンを取得します。
list_by_location(location: str, **kwargs: Any) -> Iterable[VirtualMachine]
パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
VirtualMachine のインスタンスや cls(response) の結果のような反復子
の戻り値の型 :
例外
属性
models
models = <module 'azure.mgmt.compute.v2019_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2019_07_01\\models\\__init__.py'>
Azure SDK for Python