Pool クラス
プールに関する情報が含まれます。
変数はサーバーによってのみ設定され、要求の送信時には無視されます。
- 継承
-
azure.mgmt.batch.models._models_py3.ProxyResourcePool
コンストラクター
Pool(*, identity: _models.BatchPoolIdentity | None = None, display_name: str | None = None, vm_size: str | None = None, deployment_configuration: _models.DeploymentConfiguration | None = None, scale_settings: _models.ScaleSettings | None = None, inter_node_communication: str | _models.InterNodeCommunicationState | None = None, network_configuration: _models.NetworkConfiguration | None = None, task_slots_per_node: int = 1, task_scheduling_policy: _models.TaskSchedulingPolicy | None = None, user_accounts: List[_models.UserAccount] | None = None, metadata: List[_models.MetadataItem] | None = None, start_task: _models.StartTask | None = None, certificates: List[_models.CertificateReference] | None = None, application_packages: List[_models.ApplicationPackageReference] | None = None, application_licenses: List[str] | None = None, mount_configuration: List[_models.MountConfiguration] | None = None, target_node_communication_mode: str | _models.NodeCommunicationMode | None = None, resource_tags: Dict[str, str] | None = None, **kwargs: Any)
Keyword-Only Parameters
- identity
- BatchPoolIdentity
Batch プールに使用される ID の種類。
- display_name
- str
表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
- vm_size
- str
Cloud Services プール (cloudServiceConfiguration を使用して作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Servicesのサイズ (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)」を参照してください。 Batch では、ExtraSmall を除くすべてのCloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用するプールで使用可能な VM サイズ (virtualMachineConfiguration で作成されたプール) の詳細については、「Virtual Machinesのサイズ (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)」または「Virtual Machinesのサイズ (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
- deployment_configuration
- DeploymentConfiguration
CloudServiceConfiguration を使用すると、ノードは Azure Cloud Services (PaaS) を使用して作成する必要があり、VirtualMachineConfiguration では Azure Virtual Machines (IaaS) が使用されます。
- scale_settings
- ScaleSettings
プールの目的のサイズを定義します。 これは、要求された targetDedicatedNodes が指定されている 'fixedScale' か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。 このプロパティを指定しない場合、プールには 0 targetDedicatedNodes の固定スケールが設定されます。
- inter_node_communication
- str または InterNodeCommunicationState
これにより、プールに割り当てることができるノードに制限が課されます。 この値を有効にすると、要求された数のノードがプールに割り当てられる可能性が低くなります。 指定しない場合、この値の既定値は 'Disabled' になります。 既知の値は、"Enabled" と "Disabled" です。
- network_configuration
- NetworkConfiguration
プールのネットワーク構成。
- task_scheduling_policy
- TaskSchedulingPolicy
指定しない場合、既定値はスプレッドになります。
- user_accounts
- list[UserAccount]
プール内の各ノードに作成されるユーザー アカウントの一覧。
- metadata
- list[MetadataItem]
Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
- start_task
- StartTask
PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。
- certificates
- list[CertificateReference]
Windows コンピューティング ノードの場合、Batch サービスは、指定した証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、証明書がそのディレクトリに配置されます。
警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。
- application_packages
- list[ApplicationPackageReference]
アプリケーション パッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 任意のプールには、最大 10 個のアプリケーション パッケージ参照があります。
アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。
- mount_configuration
- list[MountConfiguration]
これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
- target_node_communication_mode
- str または NodeCommunicationMode
省略した場合、既定値は Default です。 既知の値は、"Default"、"Classic"、および "Simplified" です。
Azure Batch プールに関連付けるユーザー定義タグ。 これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが反映されます。 このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。
変数
- id
- str
リソースの ID。
- name
- str
リソースの名前。
- type
- str
リソースの型。
- etag
- str
コンカレンシー ステートメントに使用されるリソースの ETag。
- identity
- BatchPoolIdentity
Batch プールに使用される ID の種類。
- display_name
- str
表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
- last_modified
- datetime
これは、targetDedicatedNodes や autoScaleSettings などのプール レベルのデータが最後に変更された時刻です。 コンピューティング ノードの状態の変更など、ノード レベルの変更は考慮されません。
- creation_time
- datetime
プールの作成時間。
- provisioning_state
- str または PoolProvisioningState
プールの現在の状態。 既知の値は、"Succeeded" と "Removeing" です。
- provisioning_state_transition_time
- datetime
プールが現在の状態になった時刻。
- allocation_state
- str または AllocationState
プールのサイズを変更するかどうか。 既知の値は、"Steady"、"Resizing"、および "Stopping" です。
- allocation_state_transition_time
- datetime
プールが現在の割り当て状態になった時刻。
- vm_size
- str
Cloud Services プール (cloudServiceConfiguration を使用して作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Servicesのサイズ (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)」を参照してください。 Batch では、ExtraSmall を除くすべてのCloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用するプールで使用可能な VM サイズ (virtualMachineConfiguration で作成されたプール) の詳細については、「Virtual Machinesのサイズ (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)」または「Virtual Machinesのサイズ (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
- deployment_configuration
- DeploymentConfiguration
CloudServiceConfiguration を使用すると、ノードは Azure Cloud Services (PaaS) を使用して作成する必要があり、VirtualMachineConfiguration では Azure Virtual Machines (IaaS) が使用されます。
- current_dedicated_nodes
- int
プール内の現在の専用コンピューティング ノードの数。
- current_low_priority_nodes
- int
プール内の現在のスポット/低優先度コンピューティング ノードの数。
- scale_settings
- ScaleSettings
プールの目的のサイズを定義します。 これは、要求された targetDedicatedNodes が指定されている 'fixedScale' か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。 このプロパティを指定しない場合、プールには 0 targetDedicatedNodes の固定スケールが設定されます。
- auto_scale_run
- AutoScaleRun
このプロパティは、プールが自動的にスケーリングされる場合 、つまり autoScaleSettings が使用される場合にのみ設定されます。
- inter_node_communication
- str または InterNodeCommunicationState
これにより、プールに割り当てることができるノードに制限が課されます。 この値を有効にすると、要求された数のノードがプールに割り当てられる可能性が低くなります。 指定しない場合、この値の既定値は 'Disabled' になります。 既知の値は、"Enabled" と "Disabled" です。
- network_configuration
- NetworkConfiguration
プールのネットワーク構成。
- task_slots_per_node
- int
既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
- task_scheduling_policy
- TaskSchedulingPolicy
指定しない場合、既定値はスプレッドになります。
- user_accounts
- list[UserAccount]
プール内の各ノードに作成されるユーザー アカウントの一覧。
- metadata
- list[MetadataItem]
Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
- start_task
- StartTask
PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。
- certificates
- list[CertificateReference]
Windows コンピューティング ノードの場合、Batch サービスは、指定した証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、証明書がそのディレクトリに配置されます。
警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。
- application_packages
- list[ApplicationPackageReference]
アプリケーション パッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 任意のプールには、最大 10 個のアプリケーション パッケージ参照があります。
アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。
- resize_operation_status
- ResizeOperationStatus
現在の操作 (プールの AllocationState がサイズ変更の場合) または以前に完了した操作 (AllocationState が安定している場合) について説明します。
- mount_configuration
- list[MountConfiguration]
これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
- target_node_communication_mode
- str または NodeCommunicationMode
省略した場合、既定値は Default です。 既知の値は、"Default"、"Classic"、および "Simplified" です。
- current_node_communication_mode
- str または NodeCommunicationMode
プールが Batch サービスと通信する方法を決定します。 既知の値は、"Default"、"Classic"、および "Simplified" です。
Azure SDK for Python
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示