PoolAddParameter クラス
追加するAzure Batch サービスのプール。
Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
- 継承
-
PoolAddParameter
コンストラクター
PoolAddParameter(*, id: str, vm_size: str, display_name: str = None, cloud_service_configuration=None, virtual_machine_configuration=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, task_slots_per_node: int = None, task_scheduling_policy=None, user_accounts=None, metadata=None, mount_configuration=None, target_node_communication_mode=None, **kwargs)
パラメーター
- id
- str
必須。 ID には、ハイフンやアンダースコアを含む英数字の任意の組み合わせを含めることができます。また、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つのプール ID がない可能性があります)。
- vm_size
- str
必須。 Cloud Services プール (cloudServiceConfiguration を使用して作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Services のサイズ (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)」を参照してください。 Batch では、ExtraSmall、A1V2、A2V2 を除くすべてのCloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用するプール (virtualMachineConfiguration で作成されたプール) で使用可能な VM サイズの詳細については、「Virtual Machinesのサイズ (Linux) ()」または「Virtual Machinesのサイズ (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
- cloud_service_configuration
- CloudServiceConfiguration
プールのクラウド サービス構成。 このプロパティと virtualMachineConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。
- virtual_machine_configuration
- VirtualMachineConfiguration
プールの仮想マシンの構成。 このプロパティと cloudServiceConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。
- 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 サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする」(https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) を参照してください。
- auto_scale_evaluation_interval
- <xref:timedelta>
既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
- enable_inter_node_communication
- bool
プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。
- 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]
プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。
- task_slots_per_node
- int
プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
- task_scheduling_policy
- TaskSchedulingPolicy
プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドになります。
- user_accounts
- list[UserAccount]
- mount_configuration
- list[MountConfiguration]
Azure fileshare、NFS、CIFS、または Blobfuse ベースのファイル システムを使用してストレージをマウントします。
- target_node_communication_mode
- str または NodeCommunicationMode
プールの目的のノード通信モード。 省略した場合、既定値は Default です。 使用できる値は、'default'、'classic'、'simplified' です。
メソッド
as_dict |
json.dump を使用して JSONify できる dict を返します。 高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。 キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。 返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。 このファイルの 3 つの例を参照してください。
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
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
deserialize
RestAPI 構文を使用して str を解析し、モデルを返します。
deserialize(data, content_type=None)
パラメーター
戻り値
このモデルのインスタンス
例外
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)
パラメーター
- key_extractors
戻り値
このモデルのインスタンス
例外
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)
パラメーター
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
validate
Azure SDK for Python