ComputeNodeOperations クラス

ComputeNodeOperations 操作。

このクラスを直接インスタンス化するのではなく、それを作成して属性としてアタッチするクライアント インスタンスを作成する必要があります。

継承

builtins.object

ComputeNodeOperations

コンストラクター

ComputeNodeOperations(client, config, serializer, deserializer)

パラメーター

client

必須

サービス要求のクライアント。

config

必須

サービス クライアントの構成。

serializer

必須

オブジェクト モデル シリアライザー。

deserializer

必須

オブジェクト モデル逆シリアライザー。

変数

api_version

要求で使用する API のバージョン。 定数値: "2023-05-01.17.0"

メソッド

add_user	指定したコンピューティング ノードにユーザー アカウントを追加します。 ユーザー アカウントをコンピューティング ノードに追加できるのは、アイドル状態または実行中の状態の場合のみです。
delete_user	指定したコンピューティング ノードからユーザー アカウントを削除します。 コンピューティング ノードに対するユーザー アカウントは、アイドル状態または実行中状態の場合にのみ削除できます。
disable_scheduling	指定したコンピューティング ノードのタスク スケジューリングを無効にします。 コンピューティング ノードでタスク スケジューリングを無効にできるのは、現在のスケジュール状態が有効になっている場合のみです。
enable_scheduling	指定したコンピューティング ノードでタスク スケジュールを有効にします。 コンピューティング ノードでタスク スケジューリングを有効にできるのは、現在のスケジュール状態が無効になっている場合のみです。
get	指定したコンピューティング ノードに関する情報を取得します。
get_remote_desktop	指定したコンピューティング ノードのリモート デスクトップ プロトコル ファイルを取得します。 RDP ファイルを使用してコンピューティング ノードにアクセスするには、コンピューティング ノードにユーザー アカウントを作成する必要があります。 この API は、クラウド サービス構成で作成されたプールでのみ呼び出すことができます。 仮想マシン構成で作成されたプールについては、GetRemoteLoginSettings API を参照してください。
get_remote_login_settings	コンピューティング ノードへのリモート ログインに必要な設定を取得します。 リモート ログイン設定を使用してコンピューティング ノードにリモートでログインする前に、コンピューティング ノードにユーザー アカウントを作成する必要があります。 この API は、仮想マシン構成プロパティを使用して作成されたプールでのみ呼び出すことができます。 クラウド サービス構成で作成されたプールについては、GetRemoteDesktop API を参照してください。
list	指定したプール内のコンピューティング ノードを一覧表示します。
reboot	指定したコンピューティング ノードを再起動します。 コンピューティング ノードは、アイドル状態または実行中の状態の場合にのみ再起動できます。
reimage	指定したコンピューティング ノードにオペレーティング システムを再インストールします。 オペレーティング システムは、アイドル状態または実行中の状態の場合にのみ、コンピューティング ノードに再インストールできます。 この API は、クラウド サービス構成プロパティを使用して作成されたプールでのみ呼び出すことができます。
update_user	指定したコンピューティング ノードのユーザー アカウントのパスワードと有効期限を更新します。 この操作により、Account のすべての更新可能なプロパティが置き換えられます。 たとえば、expiryTime 要素が指定されていない場合、現在の値は変更されずに既定値に置き換えられます。 コンピューティング ノードのユーザー アカウントは、アイドル状態または実行中の状態の場合にのみ更新できます。
upload_batch_service_logs	指定したコンピューティング ノードAzure Batchサービス ログ ファイルをAzure Blob Storageにアップロードします。 これは、エラーが発生し、Azure サポートにエスカレートする場合に、Azure Batchサービス ログ ファイルをコンピューティング ノードから自動化された方法で収集するためのものです。 Azure Batch サービスのログ ファイルは、Batch サービスの問題のデバッグに役立つAzure サポートと共有する必要があります。

add_user

指定したコンピューティング ノードにユーザー アカウントを追加します。

ユーザー アカウントをコンピューティング ノードに追加できるのは、アイドル状態または実行中の状態の場合のみです。

add_user(pool_id, node_id, user, compute_node_add_user_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

ユーザー アカウントを作成するコンピューターの ID。

user

ComputeNodeUser

必須

作成するユーザー アカウント。

compute_node_add_user_options

ComputeNodeAddUserOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

ClientRawResponse

例外

BatchErrorException

delete_user

指定したコンピューティング ノードからユーザー アカウントを削除します。

コンピューティング ノードに対するユーザー アカウントは、アイドル状態または実行中状態の場合にのみ削除できます。

delete_user(pool_id, node_id, user_name, compute_node_delete_user_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

ユーザー アカウントを削除するマシンの ID。

user_name

str

必須

削除するユーザー アカウントの名前。

compute_node_delete_user_options

ComputeNodeDeleteUserOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

ClientRawResponse

例外

BatchErrorException

disable_scheduling

指定したコンピューティング ノードのタスク スケジューリングを無効にします。

コンピューティング ノードでタスク スケジューリングを無効にできるのは、現在のスケジュール状態が有効になっている場合のみです。

disable_scheduling(pool_id, node_id, node_disable_scheduling_option=None, compute_node_disable_scheduling_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

タスク スケジュールを無効にするコンピューティング ノードの ID。

node_disable_scheduling_option

str または DisableComputeNodeSchedulingOption

既定値: None

既定値は requeue です。 指定できる値は、'requeue'、'terminate'、'taskCompletion' です。

compute_node_disable_scheduling_options

ComputeNodeDisableSchedulingOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

ClientRawResponse

例外

BatchErrorException

enable_scheduling

指定したコンピューティング ノードでタスク スケジュールを有効にします。

コンピューティング ノードでタスク スケジューリングを有効にできるのは、現在のスケジュール状態が無効になっている場合のみです。

enable_scheduling(pool_id, node_id, compute_node_enable_scheduling_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

タスクのスケジュール設定を有効にするコンピューティング ノードの ID。

compute_node_enable_scheduling_options

ComputeNodeEnableSchedulingOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

ClientRawResponse

例外

BatchErrorException

get

指定したコンピューティング ノードに関する情報を取得します。

get(pool_id, node_id, compute_node_get_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

情報を取得するコンピューティング ノードの ID。

compute_node_get_options

ComputeNodeGetOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

computeNode または ClientRawResponse (raw=true の場合)

の戻り値の型 :

ComputeNode,

ClientRawResponse

例外

BatchErrorException

get_remote_desktop

指定したコンピューティング ノードのリモート デスクトップ プロトコル ファイルを取得します。

RDP ファイルを使用してコンピューティング ノードにアクセスするには、コンピューティング ノードにユーザー アカウントを作成する必要があります。 この API は、クラウド サービス構成で作成されたプールでのみ呼び出すことができます。 仮想マシン構成で作成されたプールについては、GetRemoteLoginSettings API を参照してください。

get_remote_desktop(pool_id, node_id, compute_node_get_remote_desktop_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

リモート デスクトップ プロトコル ファイルを取得するコンピューティング ノードの ID。

compute_node_get_remote_desktop_options

ComputeNodeGetRemoteDesktopOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

callback

Callable[<xref:Bytes>, <xref:response=None>]

既定値: None

を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、データの現在のチャンクのバイトと応答オブジェクトの 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。

operation_config

必須

操作構成のオーバーライド。

戻り値

object または ClientRawResponse (raw=true の場合)

の戻り値の型 :

Generator,

ClientRawResponse

例外

BatchErrorException

get_remote_login_settings

コンピューティング ノードへのリモート ログインに必要な設定を取得します。

リモート ログイン設定を使用してコンピューティング ノードにリモートでログインする前に、コンピューティング ノードにユーザー アカウントを作成する必要があります。 この API は、仮想マシン構成プロパティを使用して作成されたプールでのみ呼び出すことができます。 クラウド サービス構成で作成されたプールについては、GetRemoteDesktop API を参照してください。

get_remote_login_settings(pool_id, node_id, compute_node_get_remote_login_settings_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

リモート ログイン設定を取得するコンピューティング ノードの ID。

compute_node_get_remote_login_settings_options

ComputeNodeGetRemoteLoginSettingsOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

computeNodeGetRemoteLoginSettingsResult または ClientRawResponse (raw=true の場合)

の戻り値の型 :

ComputeNodeGetRemoteLoginSettingsResult,

ClientRawResponse

例外

BatchErrorException

list

指定したプール内のコンピューティング ノードを一覧表示します。

list(pool_id, compute_node_list_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを一覧表示するプールの ID。

compute_node_list_options

ComputeNodeListOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

ComputeNode のインスタンスのような反復子

の戻り値の型 :

ComputeNodePaged[ComputeNode]

例外

BatchErrorException

reboot

指定したコンピューティング ノードを再起動します。

コンピューティング ノードは、アイドル状態または実行中の状態の場合にのみ再起動できます。

reboot(pool_id, node_id, node_reboot_option=None, compute_node_reboot_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

再起動するコンピューティング ノードの ID。

node_reboot_option

str または ComputeNodeRebootOption

既定値: None

既定値は requeue です。 指定できる値は、'requeue'、'terminate'、'taskCompletion'、'retainedData' です。

compute_node_reboot_options

ComputeNodeRebootOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

ClientRawResponse

例外

BatchErrorException

reimage

指定したコンピューティング ノードにオペレーティング システムを再インストールします。

オペレーティング システムは、アイドル状態または実行中の状態の場合にのみ、コンピューティング ノードに再インストールできます。 この API は、クラウド サービス構成プロパティを使用して作成されたプールでのみ呼び出すことができます。

reimage(pool_id, node_id, node_reimage_option=None, compute_node_reimage_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

再起動するコンピューティング ノードの ID。

node_reimage_option

str または ComputeNodeReimageOption

既定値: None

既定値は requeue です。 指定できる値は、'requeue'、'terminate'、'taskCompletion'、'retainedData' です。

compute_node_reimage_options

ComputeNodeReimageOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

ClientRawResponse

例外

BatchErrorException

update_user

指定したコンピューティング ノードのユーザー アカウントのパスワードと有効期限を更新します。

この操作により、Account のすべての更新可能なプロパティが置き換えられます。 たとえば、expiryTime 要素が指定されていない場合、現在の値は変更されずに既定値に置き換えられます。 コンピューティング ノードのユーザー アカウントは、アイドル状態または実行中の状態の場合にのみ更新できます。

update_user(pool_id, node_id, user_name, node_update_user_parameter, compute_node_update_user_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

ユーザー アカウントを更新するコンピューターの ID。

user_name

str

必須

更新するユーザー アカウントの名前。

node_update_user_parameter

NodeUpdateUserParameter

必須

要求のパラメーター。

compute_node_update_user_options

ComputeNodeUpdateUserOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

ClientRawResponse

例外

BatchErrorException

upload_batch_service_logs

指定したコンピューティング ノードAzure Batchサービス ログ ファイルをAzure Blob Storageにアップロードします。

これは、エラーが発生し、Azure サポートにエスカレートする場合に、Azure Batchサービス ログ ファイルをコンピューティング ノードから自動化された方法で収集するためのものです。 Azure Batch サービスのログ ファイルは、Batch サービスの問題のデバッグに役立つAzure サポートと共有する必要があります。

upload_batch_service_logs(pool_id, node_id, upload_batch_service_logs_configuration, compute_node_upload_batch_service_logs_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

pool_id

str

必須

コンピューティング ノードを含むプールの ID。

node_id

str

必須

Azure Batch サービス ログ ファイルのアップロード元となるコンピューティング ノードの ID。

upload_batch_service_logs_configuration

UploadBatchServiceLogsConfiguration

必須

Azure Batch サービス ログ ファイルのアップロード構成。

compute_node_upload_batch_service_logs_options

ComputeNodeUploadBatchServiceLogsOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

raw=true の場合、UploadBatchServiceLogsResult または ClientRawResponse

の戻り値の型 :

UploadBatchServiceLogsResult,

ClientRawResponse

例外

BatchErrorException

属性

models

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