CloudPool クラス

  • リファレンス

Azure Batch サービス内のプール。

変数はサーバーによってのみ設定され、要求の送信時には無視されます。

継承
Model
CloudPool

コンストラクター

CloudPool(*, id: str = None, display_name: str = None, url: str = None, e_tag: str = None, last_modified=None, creation_time=None, state=None, state_transition_time=None, allocation_state=None, allocation_state_transition_time=None, vm_size: str = None, cloud_service_configuration=None, virtual_machine_configuration=None, resize_timeout=None, resize_errors=None, current_dedicated_nodes: int = None, current_low_priority_nodes: int = 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, auto_scale_run=None, enable_inter_node_communication: bool = None, network_configuration=None, start_task=None, certificate_references=None, application_package_references=None, application_licenses=None, task_slots_per_node: int = None, task_scheduling_policy=None, user_accounts=None, metadata=None, stats=None, mount_configuration=None, identity=None, target_node_communication_mode=None, **kwargs)

パラメーター

id
str
必須

ID には、ハイフンやアンダースコアを含む英数字の任意の組み合わせを含めることができます。また、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID がない可能性があります)。

display_name
str
必須

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

url
str
必須
e_tag
str
必須

これは不透明な文字列です。 これを使用して、プールが要求間で変更されたかどうかを検出できます。 特に、プールを更新するときに ETag を渡して、その間に他のユーザーがプールを変更していない場合にのみ変更を有効にするように指定できます。

last_modified
datetime
必須

これは、targetDedicatedNodes や enableAutoscale 設定など、プール レベルのデータが変更された最後の時刻です。 コンピューティング ノードの状態の変更など、ノード レベルの変更は考慮されません。

creation_time
datetime
必須
state
str または PoolState
必須

使用可能な値は、'active'、'removeing' です。

state_transition_time
datetime
必須
allocation_state
str または AllocationState
必須

使用可能な値は、'steady'、'resizing'、'stopping' です。

allocation_state_transition_time
datetime
必須
vm_size
str
必須

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

cloud_service_configuration
CloudServiceConfiguration
必須

プールのクラウド サービス構成。 このプロパティと virtualMachineConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。

virtual_machine_configuration
VirtualMachineConfiguration
必須

プールの仮想マシンの構成。 このプロパティと cloudServiceConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。

resize_timeout
<xref:timedelta>
必須

これは、最新のサイズ変更操作のタイムアウトです。 (プールの作成時の初期サイズ変更は、サイズ変更としてカウントされます)。既定値は 15 分です。

resize_errors
list[ResizeError]
必須

このプロパティは、プールの最後のサイズ変更中に 1 つ以上のエラーが発生した場合、および Pool allocationState が安定している場合にのみ設定されます。

current_dedicated_nodes
int
必須

プールに現在存在する専用のコンピューティング ノードの数。

current_low_priority_nodes
int
必須

プールに現在存在するスポット/低優先度のコンピューティング ノードの数。 このカウントには、割り込まれたスポット/低優先度のコンピューティング ノードが含まれます。

target_dedicated_nodes
int
必須

プール内の専用コンピューティング ノードの必要な数。

target_low_priority_nodes
int
必須

プール内のスポット/低優先度コンピューティング ノードの必要な数。

enable_auto_scale
bool
必須

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

auto_scale_formula
str
必須

このプロパティは、プールが自動的にスケーリングされる場合 、つまり enableAutoScale が true の場合にのみ設定されます。

auto_scale_evaluation_interval
<xref:timedelta>
必須

このプロパティは、プールが自動的にスケーリングされる場合 、つまり enableAutoScale が true の場合にのみ設定されます。

auto_scale_run
AutoScaleRun
必須

自動スケーリング数式の最後の実行の結果とエラー。 このプロパティは、プールが自動的にスケーリングされる場合 、つまり enableAutoScale が true の場合にのみ設定されます。

enable_inter_node_communication
bool
必須

プールがコンピューティング ノード間の直接通信を許可するかどうか。 これにより、プールに割り当てることができるコンピューティング ノードに制限が課されます。 この値を指定すると、要求された数のコンピューティング ノードがプールに割り当てられる可能性が低くなります。

network_configuration
NetworkConfiguration
必須

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

start_task
StartTask
必須

プールに参加する各コンピューティング ノードで実行するように指定されたタスク。

certificate_references
list[CertificateReference]
必須

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

application_package_references
list[ApplicationPackageReference]
必須

パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。

application_licenses
list[str]
必須

アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。

task_slots_per_node
int
必須

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

task_scheduling_policy
TaskSchedulingPolicy
必須

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

user_accounts
list[UserAccount]
必須
metadata
list[MetadataItem]
必須
stats
PoolStatistics
必須

プールの有効期間全体の使用率とリソース使用量の統計。 このプロパティは、CloudPool が 'stats' 属性を含む expand 句で取得された場合にのみ設定されます。それ以外の場合は null です。 統計はすぐには使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。

mount_configuration
list[MountConfiguration]
必須

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

identity
BatchPoolIdentity
必須

Batch プールの ID (構成されている場合)。 Batch プールに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

target_node_communication_mode
str または NodeCommunicationMode
必須

プールの目的のノード通信モード。 省略した場合、既定値は Default です。 使用できる値は、'default'、'classic'、'simplified' です。

変数

current_node_communication_mode
str または NodeCommunicationMode

プール通信モードの現在の状態。 使用可能な値は、'default'、'classic'、'simplified' です。

メソッド

as_dict

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

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

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

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

このファイルの 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' が含まれています。 値は、このオブジェクトの現在の値です。

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

このファイルの 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 は既定で、application/xml if 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 は既定で、application/xml if 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

readonly 属性をシリアル化する場合

戻り値

dict JSON 互換オブジェクト

の戻り値の型 :

dict

validate

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

validate()

戻り値

検証エラーの一覧

の戻り値の型 :

list