PoolUpdatePropertiesParameter クラス

プールに対して行う一連の変更。

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。

継承
PoolUpdatePropertiesParameter

コンストラクター

PoolUpdatePropertiesParameter(*, certificate_references, application_package_references, metadata, start_task=None, target_node_communication_mode=None, **kwargs)

パラメーター

start_task
StartTask
必須

プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。 この要素が存在する場合は、既存の StartTask が上書きされます。 省略すると、既存の StartTask がプールから削除されます。

certificate_references
list[CertificateReference]
必須

必須。 この一覧は、プールで構成されている既存の証明書参照を置き換えます。 空のコレクションを指定すると、既存の証明書参照はすべてプールから削除されます。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するために環境変数 AZ_BATCH_CERTIFICATES_DIRが Task に提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、証明書がそのディレクトリに配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。代わりに Azure KeyVault 拡張機能 を使用してください。

application_package_references
list[ApplicationPackageReference]
必須

必須。 この一覧は、プール上の既存のアプリケーション パッケージ参照を置き換えます。 アプリケーション パッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 任意のプールには、最大 10 個のアプリケーション パッケージ参照があります。 省略した場合、または空のコレクションを指定した場合、既存のアプリケーション パッケージ参照はすべてプールから削除されます。 指定されたプールでは、最大 10 個の参照を指定できます。

metadata
list[MetadataItem]
必須

必須。 この一覧は、プールで構成されている既存のメタデータを置き換えます。 省略した場合、または空のコレクションを指定した場合、既存のメタデータはすべて Pool から削除されます。

target_node_communication_mode
str または NodeCommunicationMode
必須

プールの目的のノード通信モード。 この設定は、プールの既存の targetNodeCommunication 設定を置き換えます。 省略した場合、既存の設定は既定です。 使用可能な値は、'default'、'classic'、'simplified' です。

メソッド

as_dict

json.dump を使用して JSONify できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。

このファイルの 3 つの例を参照してください。

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。

deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。

enable_additional_properties_sending
from_dict

指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。

既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください

is_xml_model
serialize

このモデルから Azure に送信される JSON を返します。

これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。

validate

このモデルを再帰的に検証し、ValidationError の一覧を返します。

as_dict

json.dump を使用して JSONify できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。

このファイルの 3 つの例を参照してください。

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

パラメーター

key_transformer
<xref:function>

キー トランスフォーマー関数。

keep_readonly
既定値: True

戻り値

dict JSON 互換オブジェクト

の戻り値の型 :

deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。

deserialize(data, content_type=None)

パラメーター

data
str
必須

RestAPI 構造体を使用する str。 既定では JSON。

content_type
str
既定値: None

既定では JSON、XML の場合は application/xml を設定します。

戻り値

このモデルのインスタンス

例外

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。

既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください

from_dict(data, key_extractors=None, content_type=None)

パラメーター

data
dict
必須

RestAPI 構造体を使用したディクテーション

content_type
str
既定値: None

既定では JSON、XML の場合は application/xml を設定します。

key_extractors
既定値: None

戻り値

このモデルのインスタンス

例外

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

このモデルから Azure に送信される JSON を返します。

これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。

serialize(keep_readonly=False, **kwargs)

パラメーター

keep_readonly
bool
既定値: False

読み取り専用属性をシリアル化する場合

戻り値

dict JSON 互換オブジェクト

の戻り値の型 :

validate

このモデルを再帰的に検証し、ValidationError の一覧を返します。

validate()

戻り値

検証エラーの一覧

の戻り値の型 :