Pool interface

Pakiet:

@azure/arm-batch

Zawiera informacje o puli.

Rozszerzenie

ProxyResource

Właściwości

allocationState	Określa, czy pula zmienia rozmiar. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
allocationStateTransitionTime	Czas, w którym pula weszła w bieżący stan alokacji. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
applicationLicenses	Lista licencji aplikacji musi być podzbiorem dostępnych licencji aplikacji usługi Batch. Jeśli zażądano licencji, która nie jest obsługiwana, tworzenie puli zakończy się niepowodzeniem.
applicationPackages	Zmiany odwołań do pakietu aplikacji mają wpływ na wszystkie nowe węzły obliczeniowe łączące pulę, ale nie mają wpływu na węzły obliczeniowe, które znajdują się już w puli, dopóki nie zostaną ponownie uruchomione lub zostaną ponownie wyświetlone. W dowolnej puli istnieje maksymalnie 10 odwołań do pakietu aplikacji.
autoScaleRun	Ta właściwość jest ustawiana tylko wtedy, gdy pula jest automatycznie skalowana, tj. są używane ustawienia autoSkalowania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
certificates	W przypadku węzłów obliczeniowych systemu Windows usługa Batch instaluje certyfikaty w określonym magazynie certyfikatów i lokalizacji. W przypadku węzłów obliczeniowych systemu Linux certyfikaty są przechowywane w katalogu roboczym zadania, a zmienna środowiskowa AZ_BATCH_CERTIFICATES_DIR jest dostarczana do zadania do wykonywania zapytań dotyczących tej lokalizacji. W przypadku certyfikatów z widocznością "remoteUser" katalog "certs" jest tworzony w katalogu głównym użytkownika (np. /home/{user-name}/certs) i certyfikaty są umieszczane w tym katalogu. Ostrzeżenie: Ta właściwość jest przestarzała i zostanie usunięta po lutym 2024 r. Zamiast tego użyj rozszerzenia Azure KeyVault .
creationTime	Czas tworzenia puli. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
currentDedicatedNodes	Liczba dedykowanych węzłów obliczeniowych obecnie w puli. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
currentLowPriorityNodes	Liczba węzłów obliczeniowych typu spot/o niskim priorytetu obecnie w puli. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
currentNodeCommunicationMode	Określa sposób komunikowania się puli z usługą Batch. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
deploymentConfiguration	Użycie usługi CloudServiceConfiguration określa, że węzły powinny tworzyć przy użyciu usługi Azure Cloud Services (PaaS), podczas gdy usługa VirtualMachineConfiguration używa usługi Azure Virtual Machines (IaaS).
displayName	Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.
identity	Typ tożsamości używany dla puli usługi Batch.
interNodeCommunication	Nakłada to ograniczenia dotyczące węzłów, które można przypisać do puli. Włączenie tej wartości może zmniejszyć prawdopodobieństwo przydzielenia żądanej liczby węzłów w puli. Jeśli nie zostanie określona, ta wartość jest domyślnie ustawiona na "Wyłączone".
lastModified	Jest to ostatni raz, w którym dane na poziomie puli, takie jak targetDedicatedNodes lub autoScaleSettings, uległy zmianie. Nie uwzględnia zmian na poziomie węzła, takich jak zmiana stanu węzła obliczeniowego. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
metadata	Usługa Batch nie przypisuje żadnego znaczenia do metadanych; służy wyłącznie do używania kodu użytkownika.
mountConfiguration	Obsługuje to Azure Files, NFS, CIFS/SMB i Blobfuse.
networkConfiguration	Konfiguracja sieci dla puli.
provisioningState	Bieżący stan puli. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
provisioningStateTransitionTime	Czas, w którym pula weszła w jego bieżący stan. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
resizeOperationStatus	Opisuje bieżącą operację (jeśli pula AllocationState zmienia rozmiar) lub poprzednio ukończoną operację (jeśli stan alokacji jest stały). UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
resourceTags	Tagi zdefiniowane przez użytkownika, które mają być skojarzone z pulą Azure Batch. Po określeniu te tagi są propagowane do zasobów platformy Azure skojarzonych z pulą. Tę właściwość można określić tylko wtedy, gdy konto usługi Batch zostało utworzone za pomocą właściwości poolAllocationMode ustawionej na wartość "UserSubscription".
scaleSettings	Definiuje żądany rozmiar puli. Może to być wartość "fixedScale", w której określono żądany element targetDedicatedNodes lub "autoScale", który definiuje formułę, która jest okresowo ponownie obliczana. Jeśli ta właściwość nie zostanie określona, pula będzie miała stałą skalę z 0 elementami targetDedicatedNodes.
startTask	W operacji PATCH (update) tę właściwość można ustawić na pusty obiekt, aby usunąć zadanie uruchamiania z puli.
targetNodeCommunicationMode	Jeśli pominięto, wartość domyślna to Domyślna.
taskSchedulingPolicy	Jeśli nie zostanie określony, wartość domyślna zostanie rozłożona.
taskSlotsPerNode	Wartość domyślna to 1. Maksymalna wartość jest mniejsza niż 4 razy mniejsza liczba rdzeni maszyny wirtualnej VmSize puli lub 256.
upgradePolicy	Opisuje zasady uaktualniania — automatyczne, ręczne lub stopniowe.
userAccounts	Lista kont użytkowników do utworzenia w każdym węźle w puli.
vmSize	Aby uzyskać informacje o dostępnych rozmiarach maszyn wirtualnych dla pul Cloud Services (pule utworzone za pomocą usługi cloudServiceConfiguration), zobacz Rozmiary dla Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Usługa Batch obsługuje wszystkie rozmiary maszyn wirtualnych Cloud Services z wyjątkiem ExtraSmall. Aby uzyskać informacje o dostępnych rozmiarach maszyn wirtualnych dla pul korzystających z obrazów z witryny Virtual Machines Marketplace (pule utworzone za pomocą funkcji virtualMachineConfiguration) zobacz Rozmiary Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) lub Rozmiary dla Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Usługa Batch obsługuje wszystkie rozmiary maszyn wirtualnych platformy Azure z wyjątkiem STANDARD_A0 i z magazynem w warstwie Premium (STANDARD_GS, STANDARD_DS i serii STANDARD_DSV2).

Właściwości dziedziczone

etag	Element ETag zasobu używany do instrukcji współbieżności. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
id	Identyfikator zasobu. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
name	Nazwa zasobu. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
type	Typ zasobu. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

allocationState

Określa, czy pula zmienia rozmiar. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

allocationState?: AllocationState

Wartość właściwości

AllocationState

allocationStateTransitionTime

Czas, w którym pula weszła w bieżący stan alokacji. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

allocationStateTransitionTime?: Date

Wartość właściwości

Date

applicationLicenses

Lista licencji aplikacji musi być podzbiorem dostępnych licencji aplikacji usługi Batch. Jeśli zażądano licencji, która nie jest obsługiwana, tworzenie puli zakończy się niepowodzeniem.

applicationLicenses?: string[]

Wartość właściwości

string[]

applicationPackages

Zmiany odwołań do pakietu aplikacji mają wpływ na wszystkie nowe węzły obliczeniowe łączące pulę, ale nie mają wpływu na węzły obliczeniowe, które znajdują się już w puli, dopóki nie zostaną ponownie uruchomione lub zostaną ponownie wyświetlone. W dowolnej puli istnieje maksymalnie 10 odwołań do pakietu aplikacji.

applicationPackages?: ApplicationPackageReference[]

Wartość właściwości

ApplicationPackageReference[]

autoScaleRun

Ta właściwość jest ustawiana tylko wtedy, gdy pula jest automatycznie skalowana, tj. są używane ustawienia autoSkalowania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

autoScaleRun?: AutoScaleRun

Wartość właściwości

AutoScaleRun

certificates

W przypadku węzłów obliczeniowych systemu Windows usługa Batch instaluje certyfikaty w określonym magazynie certyfikatów i lokalizacji. W przypadku węzłów obliczeniowych systemu Linux certyfikaty są przechowywane w katalogu roboczym zadania, a zmienna środowiskowa AZ_BATCH_CERTIFICATES_DIR jest dostarczana do zadania do wykonywania zapytań dotyczących tej lokalizacji. W przypadku certyfikatów z widocznością "remoteUser" katalog "certs" jest tworzony w katalogu głównym użytkownika (np. /home/{user-name}/certs) i certyfikaty są umieszczane w tym katalogu.

Ostrzeżenie: Ta właściwość jest przestarzała i zostanie usunięta po lutym 2024 r. Zamiast tego użyj rozszerzenia Azure KeyVault .

certificates?: CertificateReference[]

Wartość właściwości

CertificateReference[]

creationTime

Czas tworzenia puli. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

creationTime?: Date

Wartość właściwości

Date

currentDedicatedNodes

Liczba dedykowanych węzłów obliczeniowych obecnie w puli. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

currentDedicatedNodes?: number

Wartość właściwości

number

currentLowPriorityNodes

Liczba węzłów obliczeniowych typu spot/o niskim priorytetu obecnie w puli. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

currentLowPriorityNodes?: number

Wartość właściwości

number

currentNodeCommunicationMode

Określa sposób komunikowania się puli z usługą Batch. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

currentNodeCommunicationMode?: NodeCommunicationMode

Wartość właściwości

NodeCommunicationMode

deploymentConfiguration

Użycie usługi CloudServiceConfiguration określa, że węzły powinny tworzyć przy użyciu usługi Azure Cloud Services (PaaS), podczas gdy usługa VirtualMachineConfiguration używa usługi Azure Virtual Machines (IaaS).

deploymentConfiguration?: DeploymentConfiguration

Wartość właściwości

DeploymentConfiguration

displayName

Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.

displayName?: string

Wartość właściwości

string

identity

Typ tożsamości używany dla puli usługi Batch.

identity?: BatchPoolIdentity

Wartość właściwości

BatchPoolIdentity

interNodeCommunication

Nakłada to ograniczenia dotyczące węzłów, które można przypisać do puli. Włączenie tej wartości może zmniejszyć prawdopodobieństwo przydzielenia żądanej liczby węzłów w puli. Jeśli nie zostanie określona, ta wartość jest domyślnie ustawiona na "Wyłączone".

interNodeCommunication?: InterNodeCommunicationState

Wartość właściwości

InterNodeCommunicationState

lastModified

Jest to ostatni raz, w którym dane na poziomie puli, takie jak targetDedicatedNodes lub autoScaleSettings, uległy zmianie. Nie uwzględnia zmian na poziomie węzła, takich jak zmiana stanu węzła obliczeniowego. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

lastModified?: Date

Wartość właściwości

Date

metadata

Usługa Batch nie przypisuje żadnego znaczenia do metadanych; służy wyłącznie do używania kodu użytkownika.

metadata?: MetadataItem[]

Wartość właściwości

MetadataItem[]

mountConfiguration

Obsługuje to Azure Files, NFS, CIFS/SMB i Blobfuse.

mountConfiguration?: MountConfiguration[]

Wartość właściwości

MountConfiguration[]

networkConfiguration

Konfiguracja sieci dla puli.

networkConfiguration?: NetworkConfiguration

Wartość właściwości

NetworkConfiguration

provisioningState

Bieżący stan puli. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

provisioningState?: PoolProvisioningState

Wartość właściwości

PoolProvisioningState

provisioningStateTransitionTime

Czas, w którym pula weszła w jego bieżący stan. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

provisioningStateTransitionTime?: Date

Wartość właściwości

Date

resizeOperationStatus

Opisuje bieżącą operację (jeśli pula AllocationState zmienia rozmiar) lub poprzednio ukończoną operację (jeśli stan alokacji jest stały). UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

resizeOperationStatus?: ResizeOperationStatus

Wartość właściwości

ResizeOperationStatus

resourceTags

Tagi zdefiniowane przez użytkownika, które mają być skojarzone z pulą Azure Batch. Po określeniu te tagi są propagowane do zasobów platformy Azure skojarzonych z pulą. Tę właściwość można określić tylko wtedy, gdy konto usługi Batch zostało utworzone za pomocą właściwości poolAllocationMode ustawionej na wartość "UserSubscription".

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

Wartość właściwości

{[propertyName: string]: string}

scaleSettings

Definiuje żądany rozmiar puli. Może to być wartość "fixedScale", w której określono żądany element targetDedicatedNodes lub "autoScale", który definiuje formułę, która jest okresowo ponownie obliczana. Jeśli ta właściwość nie zostanie określona, pula będzie miała stałą skalę z 0 elementami targetDedicatedNodes.

scaleSettings?: ScaleSettings

Wartość właściwości

ScaleSettings

startTask

W operacji PATCH (update) tę właściwość można ustawić na pusty obiekt, aby usunąć zadanie uruchamiania z puli.

startTask?: StartTask

Wartość właściwości

StartTask

targetNodeCommunicationMode

Jeśli pominięto, wartość domyślna to Domyślna.

targetNodeCommunicationMode?: NodeCommunicationMode

Wartość właściwości

NodeCommunicationMode

taskSchedulingPolicy

Jeśli nie zostanie określony, wartość domyślna zostanie rozłożona.

taskSchedulingPolicy?: TaskSchedulingPolicy

Wartość właściwości

TaskSchedulingPolicy

taskSlotsPerNode

Wartość domyślna to 1. Maksymalna wartość jest mniejsza niż 4 razy mniejsza liczba rdzeni maszyny wirtualnej VmSize puli lub 256.

taskSlotsPerNode?: number

Wartość właściwości

number

upgradePolicy

Opisuje zasady uaktualniania — automatyczne, ręczne lub stopniowe.

upgradePolicy?: UpgradePolicy

Wartość właściwości

UpgradePolicy

userAccounts

Lista kont użytkowników do utworzenia w każdym węźle w puli.

userAccounts?: UserAccount[]

Wartość właściwości

UserAccount[]

vmSize

Aby uzyskać informacje o dostępnych rozmiarach maszyn wirtualnych dla pul Cloud Services (pule utworzone za pomocą usługi cloudServiceConfiguration), zobacz Rozmiary dla Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Usługa Batch obsługuje wszystkie rozmiary maszyn wirtualnych Cloud Services z wyjątkiem ExtraSmall. Aby uzyskać informacje o dostępnych rozmiarach maszyn wirtualnych dla pul korzystających z obrazów z witryny Virtual Machines Marketplace (pule utworzone za pomocą funkcji virtualMachineConfiguration) zobacz Rozmiary Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) lub Rozmiary dla Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Usługa Batch obsługuje wszystkie rozmiary maszyn wirtualnych platformy Azure z wyjątkiem STANDARD_A0 i z magazynem w warstwie Premium (STANDARD_GS, STANDARD_DS i serii STANDARD_DSV2).

vmSize?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

etag

Element ETag zasobu używany do instrukcji współbieżności. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

etag?: string

Wartość właściwości

string

Dziedziczone zserwera proxyResource.etag

id

Identyfikator zasobu. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

id?: string

Wartość właściwości

string

Dziedziczone zProxyResource.id

name

Nazwa zasobu. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

name?: string

Wartość właściwości

string

Dziedziczone zProxyResource.name

type

Typ zasobu. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

type?: string

Wartość właściwości

string

Dziedziczone zserwera proxyResource.type