BatchPoolCreateOptions interface

Pakiet:

@azure-rest/batch

Parametry tworzenia puli usługi Azure Batch.

Właściwości

applicationPackageReferences	Lista pakietów do zainstalowania w każdym węźle obliczeniowym w puli. Podczas tworzenia puli identyfikator aplikacji pakietu musi być w pełni kwalifikowany (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Zmiany odwołań do pakietu mają wpływ na wszystkie nowe węzły łą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 zrewidowane. W danej puli istnieje maksymalnie 10 odwołań do pakietu.
autoScaleEvaluationInterval	Interwał czasu, w którym ma być automatycznie dostosowywany rozmiar puli zgodnie z formułą autoskalowania. Wartość domyślna to 15 minut. Minimalna i maksymalna wartość to odpowiednio 5 minut i 168 godzin. Jeśli określisz wartość mniejszą niż 5 minut lub większą niż 168 godzin, usługa Batch zwróci błąd; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie).
autoScaleFormula	Formuła dla żądanej liczby węzłów obliczeniowych w puli. Nie można określić tej właściwości, jeśli dla parametru enableAutoScale ustawiono wartość false. Jest to wymagane, jeśli wartość enableAutoScale jest ustawiona na wartość true. Formuła jest sprawdzana pod kątem ważności przed utworzeniem puli. Jeśli formuła jest nieprawidłowa, usługa Batch odrzuca żądanie ze szczegółowymi informacjami o błędzie. Aby uzyskać więcej informacji na temat określania tej formuły, zobacz "Automatyczne skalowanie węzłów obliczeniowych w puli usługi Azure Batch" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).
displayName	Nazwa wyświetlana puli. Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.
enableAutoScale	Określa, czy rozmiar puli powinien być automatycznie dostosowywany w miarę upływu czasu. Jeśli wartość false, należy określić co najmniej jeden z elementów targetDedicatedNodes i targetLowPriorityNodes. Jeśli wartość true, właściwość autoScaleFormula jest wymagana, a rozmiar puli zostanie automatycznie zmieniony zgodnie z formułą. Wartość domyślna to fałsz.
enableInterNodeCommunication	Określa, czy pula zezwala na bezpośrednią komunikację między węzłami obliczeniowymi. Włączenie komunikacji między węzłami ogranicza maksymalny rozmiar puli z powodu ograniczeń wdrażania w węzłach obliczeniowych puli. Może to spowodować, że pula nie osiągnie żądanego rozmiaru. Wartość domyślna to fałsz.
id	Ciąg, który jednoznacznie identyfikuje pulę w ramach konta. Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączników i podkreśleń, i nie może zawierać więcej niż 64 znaków. Identyfikator zachowuje wielkość liter i nie uwzględnia wielkości liter (oznacza to, że w ramach konta nie ma dwóch identyfikatorów puli, które różnią się tylko wielkością liter).
metadata	Lista par name-value skojarzonych z pulą jako metadanych. Usługa Batch nie przypisuje żadnego znaczenia metadanym; służy wyłącznie do używania kodu użytkownika.
mountConfiguration	Zainstaluj magazyn przy użyciu określonego systemu plików przez cały okres istnienia puli. Zainstaluj magazyn przy użyciu udziału plików platformy Azure, systemu plików NFS, CIFS lub Blobfuse opartego na systemie plików.
networkConfiguration	Konfiguracja sieci dla puli.
resizeTimeout	Limit czasu alokacji węzłów obliczeniowych do puli. Ten limit czasu dotyczy tylko skalowania ręcznego; nie ma żadnego wpływu, gdy parametr enableAutoScale jest ustawiony na wartość true. Wartość domyślna to 15 minut. Minimalna wartość to 5 minut. Jeśli określisz wartość mniejszą niż 5 minut, usługa Batch zwróci błąd; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie).
startTask	Zadanie określone do uruchomienia w każdym węźle obliczeniowym podczas dołączania do puli. Zadanie jest uruchamiane po dodaniu węzła obliczeniowego do puli lub ponownym uruchomieniu węzła obliczeniowego.
targetDedicatedNodes	Żądana liczba dedykowanych węzłów obliczeniowych w puli. Nie można określić tej właściwości, jeśli parametr enableAutoScale jest ustawiony na wartość true. Jeśli parametr enableAutoScale ma wartość false, należy ustawić element targetDedicatedNodes, targetLowPriorityNodes lub oba te elementy.
targetLowPriorityNodes	Żądana liczba węzłów obliczeniowych typu spot/o niskim priorytcie w puli. Nie można określić tej właściwości, jeśli parametr enableAutoScale jest ustawiony na wartość true. Jeśli parametr enableAutoScale ma wartość false, należy ustawić element targetDedicatedNodes, targetLowPriorityNodes lub oba te elementy.
taskSchedulingPolicy	Sposób dystrybucji zadań między węzłami obliczeniowymi w puli. Jeśli nie zostanie określony, wartość domyślna zostanie rozłożona.
taskSlotsPerNode	Liczba slotów zadaniowych, których można użyć do uruchamiania współbieżnych zadań na pojedynczym węźle obliczeniowym w puli. Wartość domyślna to 1. Wartość maksymalna jest mniejsza od 4 razy liczbie rdzeni rozmiaru maszyny wirtualnej puli lub 256.
upgradePolicy	Zasady uaktualniania puli. Opisuje zasady uaktualniania — automatyczne, ręczne lub stopniowe.
userAccounts	Lista kont użytkowników do utworzenia w każdym węźle obliczeniowym w puli.
virtualMachineConfiguration	Konfiguracja maszyny wirtualnej dla puli. Tę właściwość należy określić.
vmSize	Rozmiar maszyn wirtualnych w puli. Wszystkie maszyny wirtualne w puli mają ten sam rozmiar. 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ą virtualMachineConfiguration), zobacz Rozmiary maszyn wirtualnych na platformie Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). 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).

Szczegóły właściwości

applicationPackageReferences

Lista pakietów do zainstalowania w każdym węźle obliczeniowym w puli. Podczas tworzenia puli identyfikator aplikacji pakietu musi być w pełni kwalifikowany (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Zmiany odwołań do pakietu mają wpływ na wszystkie nowe węzły łą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 zrewidowane. W danej puli istnieje maksymalnie 10 odwołań do pakietu.

applicationPackageReferences?: BatchApplicationPackageReference[]

Wartość właściwości

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

Interwał czasu, w którym ma być automatycznie dostosowywany rozmiar puli zgodnie z formułą autoskalowania. Wartość domyślna to 15 minut. Minimalna i maksymalna wartość to odpowiednio 5 minut i 168 godzin. Jeśli określisz wartość mniejszą niż 5 minut lub większą niż 168 godzin, usługa Batch zwróci błąd; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie).

autoScaleEvaluationInterval?: string

Wartość właściwości

string

autoScaleFormula

Formuła dla żądanej liczby węzłów obliczeniowych w puli. Nie można określić tej właściwości, jeśli dla parametru enableAutoScale ustawiono wartość false. Jest to wymagane, jeśli wartość enableAutoScale jest ustawiona na wartość true. Formuła jest sprawdzana pod kątem ważności przed utworzeniem puli. Jeśli formuła jest nieprawidłowa, usługa Batch odrzuca żądanie ze szczegółowymi informacjami o błędzie. Aby uzyskać więcej informacji na temat określania tej formuły, zobacz "Automatyczne skalowanie węzłów obliczeniowych w puli usługi Azure Batch" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

autoScaleFormula?: string

Wartość właściwości

string

displayName

Nazwa wyświetlana puli. 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

enableAutoScale

Określa, czy rozmiar puli powinien być automatycznie dostosowywany w miarę upływu czasu. Jeśli wartość false, należy określić co najmniej jeden z elementów targetDedicatedNodes i targetLowPriorityNodes. Jeśli wartość true, właściwość autoScaleFormula jest wymagana, a rozmiar puli zostanie automatycznie zmieniony zgodnie z formułą. Wartość domyślna to fałsz.

enableAutoScale?: boolean

Wartość właściwości

boolean

enableInterNodeCommunication

Określa, czy pula zezwala na bezpośrednią komunikację między węzłami obliczeniowymi. Włączenie komunikacji między węzłami ogranicza maksymalny rozmiar puli z powodu ograniczeń wdrażania w węzłach obliczeniowych puli. Może to spowodować, że pula nie osiągnie żądanego rozmiaru. Wartość domyślna to fałsz.

enableInterNodeCommunication?: boolean

Wartość właściwości

boolean

id

Ciąg, który jednoznacznie identyfikuje pulę w ramach konta. Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączników i podkreśleń, i nie może zawierać więcej niż 64 znaków. Identyfikator zachowuje wielkość liter i nie uwzględnia wielkości liter (oznacza to, że w ramach konta nie ma dwóch identyfikatorów puli, które różnią się tylko wielkością liter).

id: string

Wartość właściwości

string

metadata

Lista par name-value skojarzonych z pulą jako metadanych. Usługa Batch nie przypisuje żadnego znaczenia metadanym; służy wyłącznie do używania kodu użytkownika.

metadata?: BatchMetadataItem[]

Wartość właściwości

BatchMetadataItem[]

mountConfiguration

Zainstaluj magazyn przy użyciu określonego systemu plików przez cały okres istnienia puli. Zainstaluj magazyn przy użyciu udziału plików platformy Azure, systemu plików NFS, CIFS lub Blobfuse opartego na systemie plików.

mountConfiguration?: MountConfiguration[]

Wartość właściwości

MountConfiguration[]

networkConfiguration

Konfiguracja sieci dla puli.

networkConfiguration?: NetworkConfiguration

Wartość właściwości

NetworkConfiguration

resizeTimeout

Limit czasu alokacji węzłów obliczeniowych do puli. Ten limit czasu dotyczy tylko skalowania ręcznego; nie ma żadnego wpływu, gdy parametr enableAutoScale jest ustawiony na wartość true. Wartość domyślna to 15 minut. Minimalna wartość to 5 minut. Jeśli określisz wartość mniejszą niż 5 minut, usługa Batch zwróci błąd; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie).

resizeTimeout?: string

Wartość właściwości

string

startTask

Zadanie określone do uruchomienia w każdym węźle obliczeniowym podczas dołączania do puli. Zadanie jest uruchamiane po dodaniu węzła obliczeniowego do puli lub ponownym uruchomieniu węzła obliczeniowego.

startTask?: BatchStartTask

Wartość właściwości

BatchStartTask

targetDedicatedNodes

Żądana liczba dedykowanych węzłów obliczeniowych w puli. Nie można określić tej właściwości, jeśli parametr enableAutoScale jest ustawiony na wartość true. Jeśli parametr enableAutoScale ma wartość false, należy ustawić element targetDedicatedNodes, targetLowPriorityNodes lub oba te elementy.

targetDedicatedNodes?: number

Wartość właściwości

number

targetLowPriorityNodes

Żądana liczba węzłów obliczeniowych typu spot/o niskim priorytcie w puli. Nie można określić tej właściwości, jeśli parametr enableAutoScale jest ustawiony na wartość true. Jeśli parametr enableAutoScale ma wartość false, należy ustawić element targetDedicatedNodes, targetLowPriorityNodes lub oba te elementy.

targetLowPriorityNodes?: number

Wartość właściwości

number

taskSchedulingPolicy

Sposób dystrybucji zadań między węzłami obliczeniowymi w puli. Jeśli nie zostanie określony, wartość domyślna zostanie rozłożona.

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

Wartość właściwości

BatchTaskSchedulingPolicy

taskSlotsPerNode

Liczba slotów zadaniowych, których można użyć do uruchamiania współbieżnych zadań na pojedynczym węźle obliczeniowym w puli. Wartość domyślna to 1. Wartość maksymalna jest mniejsza od 4 razy liczbie rdzeni rozmiaru maszyny wirtualnej puli lub 256.

taskSlotsPerNode?: number

Wartość właściwości

number

upgradePolicy

Zasady uaktualniania puli. 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 obliczeniowym w puli.

userAccounts?: UserAccount[]

Wartość właściwości

UserAccount[]

virtualMachineConfiguration

Konfiguracja maszyny wirtualnej dla puli. Tę właściwość należy określić.

virtualMachineConfiguration?: VirtualMachineConfiguration

Wartość właściwości

VirtualMachineConfiguration

vmSize

Rozmiar maszyn wirtualnych w puli. Wszystkie maszyny wirtualne w puli mają ten sam rozmiar. 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ą virtualMachineConfiguration), zobacz Rozmiary maszyn wirtualnych na platformie Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). 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