PoolSpecification クラス

新しいプールを作成するための仕様。

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

継承

Model

PoolSpecification

コンストラクター

PoolSpecification(*, vm_size: str, display_name: str = None, cloud_service_configuration=None, virtual_machine_configuration=None, task_slots_per_node: int = None, task_scheduling_policy=None, resize_timeout=None, target_dedicated_nodes: int = None, target_low_priority_nodes: int = None, enable_auto_scale: bool = None, auto_scale_formula: str = None, auto_scale_evaluation_interval=None, enable_inter_node_communication: bool = None, network_configuration=None, start_task=None, certificate_references=None, application_package_references=None, application_licenses=None, user_accounts=None, metadata=None, mount_configuration=None, target_node_communication_mode=None, **kwargs)

パラメーター

display_name

str

必須

表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。

vm_size

str

必須

必須。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プール内のコンピューティング ノードの VM サイズの選択 (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。

cloud_service_configuration

CloudServiceConfiguration

必須

プールのクラウド サービス構成。 プールを Azure PaaS VM で作成する必要がある場合は、このプロパティを指定する必要があります。 このプロパティと virtualMachineConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。 どちらも指定されていない場合、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。

virtual_machine_configuration

VirtualMachineConfiguration

必須

プールの仮想マシンの構成。 プールを Azure IaaS VM で作成する必要がある場合は、このプロパティを指定する必要があります。 このプロパティと cloudServiceConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。 どちらも指定されていない場合、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

task_slots_per_node

int

必須

プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。

task_scheduling_policy

TaskSchedulingPolicy

必須

プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドになります。

resize_timeout

<xref:timedelta>

必須

このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

target_dedicated_nodes

int

必須

プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

target_low_priority_nodes

int

必須

プール内のスポット/低優先度コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

enable_auto_scale

bool

必須

プール のサイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula 要素が必要です。 Pool は、数式に従って自動的にサイズ変更されます。 既定値は false です。

auto_scale_formula

str

必須

enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 Pool が作成される前に、数式の有効性が確認されます。 式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。

auto_scale_evaluation_interval

<xref:timedelta>

必須

既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

enable_inter_node_communication

bool

必須

プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。

network_configuration

NetworkConfiguration

必須

プールのネットワーク構成。

start_task

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]

必須

プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照に対する変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。

application_licenses

list[str]

必須

アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。 プールで使用できるライセンスは、'maya'、'vray'、'3dsmax'、'arnold' です。 プールに追加されたアプリケーション ライセンスごとに追加料金が適用されます。

user_accounts

list[UserAccount]

必須

metadata

list[MetadataItem]

必須

Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。

mount_configuration

list[MountConfiguration]

必須

これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。

target_node_communication_mode

str または NodeCommunicationMode

必須

プールの目的のノード通信モード。 省略した場合、既定値は Default です。 使用可能な値は、'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 互換オブジェクト

の戻り値の型 :

dict

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 互換オブジェクト

の戻り値の型 :

dict

validate

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

validate()

戻り値

検証エラーの一覧

の戻り値の型 :

list