CloudPool 類別
Azure Batch服務中的集區。
變數只會由伺服器填入，而且會在傳送要求時予以忽略。
- 繼承
-
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
識別碼可以包含英數位元的任何組合，包括連字號和底線，而且不能包含超過 64 個字元。 識別碼會保留大小寫且不區分大小寫 (，也就是說，您可能在帳戶中沒有兩個識別碼，而該識別碼只依大小寫) 而有所不同。
- url
- str
- last_modified
- datetime
這是集區層級資料上次變更的時間，例如 targetDedicatedNodes 或 enableAutoscale 設定。 它不會考慮節點層級變更，例如計算節點變更狀態。
- creation_time
- datetime
- state_transition_time
- datetime
- 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>
這是最近調整大小作業的逾時。 (建立集區時的初始調整大小會計算為 resize.) 預設值為 15 分鐘。
- enable_auto_scale
- bool
集區大小是否應該隨著時間自動調整。 如果為 false，則必須指定至少一個 targetDedicatedNodes 和 targetLowPriorityNodes。 如果為 true，則需要 autoScaleFormula 屬性，而且集區會根據公式自動調整大小。 預設值為 false。
- auto_scale_evaluation_interval
- <xref:timedelta>
只有在集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。
- enable_inter_node_communication
- bool
集區是否允許計算節點之間的直接通訊。 這會限制可將計算節點指派給集區。 指定此值可減少在集區中配置所要求計算節點數目的機會。
- certificate_references
- list[CertificateReference]
針對 Windows 節點，Batch 服務會將憑證安裝到指定的憑證存放區和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，並將環境變數AZ_BATCH_CERTIFICATES_DIR提供給工作來查詢此位置。 對於可見度為 'remoteUser' 的憑證，會在使用者的主目錄中建立 'certs' 目錄 (，例如 /home/{user-name}/certs) ，而 Certificates 會放在該目錄中。 警告：此屬性已被取代，將在 2024 年 2 月之後移除。請改用 Azure KeyVault 擴充功能 。
- application_package_references
- list[ApplicationPackageReference]
套件參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新開機或重新製作映射為止。 任何指定的集區上最多有 10 個套件參考。
- user_accounts
- list[UserAccount]
- metadata
- list[MetadataItem]
- stats
- PoolStatistics
集區整個存留期的使用率和資源使用量統計資料。 只有在使用包含 'stats' 屬性的 expand 子句擷取 CloudPool 時，才會填入此屬性;否則為 null。 統計資料可能無法立即使用。 Batch 服務會定期匯總統計資料。 典型的延遲大約是 30 分鐘。
- identity
- BatchPoolIdentity
如果已設定，Batch 集區的身分識別。 與 Batch 集區相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源識別碼：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
- target_node_communication_mode
- str 或 NodeCommunicationMode
集區所需的節點通訊模式。 如果省略，預設值為 Default。 可能的值包括：'default'、'classic'、'simplified'
變數
- current_node_communication_mode
- str 或 NodeCommunicationMode
集區通訊模式的目前狀態。 可能的值包括：'default'、'classic'、'simplified'
方法
| as_dict |
使用 json.dump 傳回可以是 JSONify 的聽寫。 進階用法可以選擇性地使用回呼作為參數： 索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。 傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。 請參閱此檔案中的三個範例：
如果您想要 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 的聽寫。
進階用法可以選擇性地使用回呼作為參數：
索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。
傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。
請參閱此檔案中的三個範例：
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
傳回
聽寫 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)參數
傳回
聽寫 JSON 相容物件
