Pool interface

套件:

@azure/arm-batch

包含集區的相關信息。

Extends

AzureProxyResource

屬性

allocationState	集區是否重設大小。 注意：這個屬性不會串行化。 它只能由伺服器填入。
allocationStateTransitionTime	集區進入其目前配置狀態的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。
applicationLicenses	應用程式授權清單必須是可用 Batch 服務應用程式授權的子集。 如果要求不支持的授權，集區建立將會失敗。
applicationPackages	應用程式套件參考的變更會影響聯結集區的所有新計算節點，但在重新啟動或重新映像之前，不會影響已在集區中的計算節點。 在任何指定的集區上，最多有10個應用程式套件參考。
autoScaleRun	只有當集區自動調整時，才會設定這個屬性，也就是使用 autoScaleSettings。 注意：這個屬性不會串行化。 它只能由伺服器填入。
certificates	針對 Windows 計算節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs），並將憑證放在該目錄中。 警告：這個屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能。
creationTime	集區的建立時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。
currentDedicatedNodes	集區中目前專用計算節點的數目。 注意：這個屬性不會串行化。 它只能由伺服器填入。
currentLowPriorityNodes	目前在集區中的Spot/低優先順序計算節點數目。 注意：這個屬性不會串行化。 它只能由伺服器填入。
currentNodeCommunicationMode	決定集區如何與 Batch 服務通訊。 注意：這個屬性不會串行化。 它只能由伺服器填入。
deploymentConfiguration	部署組態屬性。
displayName	顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。
identity	用於 Batch 集區的身分識別類型。
interNodeCommunication	這會限制哪些節點可以指派給集區。 啟用此值可減少集區中配置要求節點數目的機會。 如果未指定，這個值會預設為 『Disabled』。
lastModified	這是集區層級數據上次變更的時間，例如 targetDedicatedNodes 或 autoScaleSettings。 它不會考慮節點層級變更，例如計算節點變更狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
metadata	Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。
mountConfiguration	這支援 Azure 檔案服務、NFS、CIFS/SMB 和 Blobfuse。
networkConfiguration	集區的網路組態。
provisioningState	集區的目前狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
provisioningStateTransitionTime	集區進入其目前狀態的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。
resizeOperationStatus	描述目前的作業（如果集區 AllocationState 為重設大小），或先前完成的作業（如果 AllocationState 為穩定）。 注意：這個屬性不會串行化。 它只能由伺服器填入。
resourceTags	要與 Azure Batch 集區相關聯的使用者定義標籤。 指定時，這些標籤會傳播至與集區相關聯的備份 Azure 資源。 只有在使用 poolAllocationMode 屬性設定為 'UserSubscription' 建立 Batch 帳戶時，才能指定這個屬性。
scaleSettings	定義集區所需的大小。 這可以是 'fixedScale'，其中指定要求的目標DedicatedNodes，或 'autoScale'，其會定義定期重新評估的公式。 如果未指定此屬性，集區將會有固定小數字數，且具有 0 個 targetDedicatedNodes。
startTask	在 PATCH （update） 作業中，這個屬性可以設定為空白物件，以從集區中移除開始工作。
targetNodeCommunicationMode	如果省略，預設值為 Default。
taskSchedulingPolicy	如果未指定，則會散佈預設值。
taskSlotsPerNode	預設值為 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。
upgradePolicy	描述升級原則 - 自動、手動或滾動。
userAccounts	要建立於集區中每個節點上的用戶帳戶清單。
vmSize	如需可用 VM 大小的詳細資訊，請參閱虛擬機的大小 （Linux） （https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/） 或虛擬機的大小 （Windows） （https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/）。 Batch 支援除了STANDARD_A0和具有進階記憶體以外的所有 Azure VM 大小（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）。

繼承的屬性

etag	資源的 ETag，用於並行語句。 注意：這個屬性不會串行化。 它只能由伺服器填入。
id	資源的標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。
name	資源的名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
tags	資源的標記。
type	資源的型別。 注意：這個屬性不會串行化。 它只能由伺服器填入。

屬性詳細資料

allocationState

集區是否重設大小。 注意：這個屬性不會串行化。 它只能由伺服器填入。

allocationState?: AllocationState

屬性值

AllocationState

allocationStateTransitionTime

集區進入其目前配置狀態的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。

allocationStateTransitionTime?: Date

屬性值

Date

applicationLicenses

應用程式授權清單必須是可用 Batch 服務應用程式授權的子集。 如果要求不支持的授權，集區建立將會失敗。

applicationLicenses?: string[]

屬性值

string[]

applicationPackages

應用程式套件參考的變更會影響聯結集區的所有新計算節點，但在重新啟動或重新映像之前，不會影響已在集區中的計算節點。 在任何指定的集區上，最多有10個應用程式套件參考。

applicationPackages?: ApplicationPackageReference[]

屬性值

ApplicationPackageReference[]

autoScaleRun

只有當集區自動調整時，才會設定這個屬性，也就是使用 autoScaleSettings。 注意：這個屬性不會串行化。 它只能由伺服器填入。

autoScaleRun?: AutoScaleRun

屬性值

AutoScaleRun

certificates

針對 Windows 計算節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs），並將憑證放在該目錄中。

警告：這個屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能。

certificates?: CertificateReference[]

屬性值

CertificateReference[]

creationTime

集區的建立時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。

creationTime?: Date

屬性值

Date

currentDedicatedNodes

集區中目前專用計算節點的數目。 注意：這個屬性不會串行化。 它只能由伺服器填入。

currentDedicatedNodes?: number

屬性值

number

currentLowPriorityNodes

目前在集區中的Spot/低優先順序計算節點數目。 注意：這個屬性不會串行化。 它只能由伺服器填入。

currentLowPriorityNodes?: number

屬性值

number

currentNodeCommunicationMode

決定集區如何與 Batch 服務通訊。 注意：這個屬性不會串行化。 它只能由伺服器填入。

currentNodeCommunicationMode?: NodeCommunicationMode

屬性值

NodeCommunicationMode

deploymentConfiguration

部署組態屬性。

deploymentConfiguration?: DeploymentConfiguration

屬性值

DeploymentConfiguration

displayName

顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。

displayName?: string

屬性值

string

identity

用於 Batch 集區的身分識別類型。

identity?: BatchPoolIdentity

屬性值

BatchPoolIdentity

interNodeCommunication

這會限制哪些節點可以指派給集區。 啟用此值可減少集區中配置要求節點數目的機會。 如果未指定，這個值會預設為 『Disabled』。

interNodeCommunication?: InterNodeCommunicationState

屬性值

InterNodeCommunicationState

lastModified

這是集區層級數據上次變更的時間，例如 targetDedicatedNodes 或 autoScaleSettings。 它不會考慮節點層級變更，例如計算節點變更狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

lastModified?: Date

屬性值

Date

metadata

Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。

metadata?: MetadataItem[]

屬性值

MetadataItem[]

mountConfiguration

這支援 Azure 檔案服務、NFS、CIFS/SMB 和 Blobfuse。

mountConfiguration?: MountConfiguration[]

屬性值

MountConfiguration[]

networkConfiguration

集區的網路組態。

networkConfiguration?: NetworkConfiguration

屬性值

NetworkConfiguration

provisioningState

集區的目前狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

provisioningState?: PoolProvisioningState

屬性值

PoolProvisioningState

provisioningStateTransitionTime

集區進入其目前狀態的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。

provisioningStateTransitionTime?: Date

屬性值

Date

resizeOperationStatus

描述目前的作業（如果集區 AllocationState 為重設大小），或先前完成的作業（如果 AllocationState 為穩定）。 注意：這個屬性不會串行化。 它只能由伺服器填入。

resizeOperationStatus?: ResizeOperationStatus

屬性值

ResizeOperationStatus

resourceTags

要與 Azure Batch 集區相關聯的使用者定義標籤。 指定時，這些標籤會傳播至與集區相關聯的備份 Azure 資源。 只有在使用 poolAllocationMode 屬性設定為 'UserSubscription' 建立 Batch 帳戶時，才能指定這個屬性。

resourceTags?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

scaleSettings

定義集區所需的大小。 這可以是 'fixedScale'，其中指定要求的目標DedicatedNodes，或 'autoScale'，其會定義定期重新評估的公式。 如果未指定此屬性，集區將會有固定小數字數，且具有 0 個 targetDedicatedNodes。

scaleSettings?: ScaleSettings

屬性值

ScaleSettings

startTask

在 PATCH （update） 作業中，這個屬性可以設定為空白物件，以從集區中移除開始工作。

startTask?: StartTask

屬性值

StartTask

targetNodeCommunicationMode

如果省略，預設值為 Default。

targetNodeCommunicationMode?: NodeCommunicationMode

屬性值

NodeCommunicationMode

taskSchedulingPolicy

如果未指定，則會散佈預設值。

taskSchedulingPolicy?: TaskSchedulingPolicy

屬性值

TaskSchedulingPolicy

taskSlotsPerNode

預設值為 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。

taskSlotsPerNode?: number

屬性值

number

upgradePolicy

描述升級原則 - 自動、手動或滾動。

upgradePolicy?: UpgradePolicy

屬性值

UpgradePolicy

userAccounts

要建立於集區中每個節點上的用戶帳戶清單。

userAccounts?: UserAccount[]

屬性值

UserAccount[]

vmSize

如需可用 VM 大小的詳細資訊，請參閱虛擬機的大小 （Linux） （https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/） 或虛擬機的大小 （Windows） （https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/）。 Batch 支援除了STANDARD_A0和具有進階記憶體以外的所有 Azure VM 大小（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）。

vmSize?: string

屬性值

string

繼承的屬性詳細資料

etag

資源的 ETag，用於並行語句。 注意：這個屬性不會串行化。 它只能由伺服器填入。

etag?: string

屬性值

string

繼承自AzureProxyResource.etag

id

資源的標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自AzureProxyResource.id

name

資源的名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自 AzureProxyResource.name 的

tags

資源的標記。

tags?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承自AzureProxyResource.tags

type

資源的型別。 注意：這個屬性不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自AzureProxyResource.type