CloudPool Klasa

Pula w usłudze Azure Batch.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

Dziedziczenie

Model

CloudPool

Konstruktor

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)

Parametry

id

str

Wymagane

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, które różnią się tylko wielkością liter).

display_name

str

Wymagane

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

url

str

Wymagane

e_tag

str

Wymagane

Jest to nieprzezroczystych ciągów. Można go użyć do wykrywania, czy pula zmieniła się między żądaniami. W szczególności można przekazać element ETag podczas aktualizowania puli, aby określić, że zmiany powinny obowiązywać tylko wtedy, gdy nikt inny nie zmodyfikował puli w międzyczasie.

last_modified

datetime

Wymagane

Jest to ostatni raz, w którym dane na poziomie puli, takie jak targetDedicatedNodes lub enableAutoscale ustawienia, zostały zmienione. Nie uwzględnia zmian na poziomie węzła, takich jak zmiana stanu węzła obliczeniowego.

creation_time

datetime

Wymagane

state

str lub PoolState

Wymagane

Możliwe wartości to: "aktywny", "usuwanie"

state_transition_time

datetime

Wymagane

allocation_state

str lub AllocationState

Wymagane

Możliwe wartości to: "steady", "resizing", "stop"

allocation_state_transition_time

datetime

Wymagane

vm_size

str

Wymagane

Aby uzyskać informacje o dostępnych rozmiarach maszyn wirtualnych w pulach, zobacz Wybieranie rozmiaru maszyny wirtualnej dla węzłów obliczeniowych w puli Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

cloud_service_configuration

CloudServiceConfiguration

Wymagane

Konfiguracja usługi w chmurze dla puli. Ta właściwość i element virtualMachineConfiguration wykluczają się wzajemnie i należy określić jedną z właściwości. Nie można określić tej właściwości, jeśli konto usługi Batch zostało utworzone z właściwością poolAllocationMode ustawioną na wartość "UserSubscription".

virtual_machine_configuration

VirtualMachineConfiguration

Wymagane

Konfiguracja maszyny wirtualnej dla puli. Ta właściwość i właściwość cloudServiceConfiguration wzajemnie się wykluczają i należy określić jedną z właściwości.

resize_timeout

<xref:timedelta>

Wymagane

Jest to limit czasu dla ostatniej operacji zmiany rozmiaru. (Początkowe określanie rozmiaru podczas tworzenia puli jest liczone jako zmiana rozmiaru). Wartość domyślna to 15 minut.

resize_errors

list[ResizeError]

Wymagane

Ta właściwość jest ustawiana tylko w przypadku wystąpienia co najmniej jednego błędu podczas ostatniej zmiany rozmiaru puli i tylko wtedy, gdy właściwość Pool allocationState jest stała.

current_dedicated_nodes

int

Wymagane

Liczba dedykowanych węzłów obliczeniowych obecnie w puli.

current_low_priority_nodes

int

Wymagane

Liczba węzłów obliczeniowych o niskim priorytcie typu spot/low-priority w puli. Węzły obliczeniowe typu spot/low-priority, które zostały wywłaszczone, są uwzględniane w tej liczbie.

target_dedicated_nodes

int

Wymagane

Żądana liczba dedykowanych węzłów obliczeniowych w puli.

target_low_priority_nodes

int

Wymagane

Żądana liczba węzłów obliczeniowych typu spot/low-priority w puli.

enable_auto_scale

bool

Wymagane

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 jest automatycznie zmieniany zgodnie z formułą. Wartość domyślna to false.

auto_scale_formula

str

Wymagane

Ta właściwość jest ustawiana tylko wtedy, gdy pula jest automatycznie skalowana, tj. enableAutoScale ma wartość true.

auto_scale_evaluation_interval

<xref:timedelta>

Wymagane

Ta właściwość jest ustawiana tylko wtedy, gdy pula jest automatycznie skalowana, tj. enableAutoScale ma wartość true.

auto_scale_run

AutoScaleRun

Wymagane

Wyniki i błędy z ostatniego wykonania formuły autoskalowania. Ta właściwość jest ustawiana tylko wtedy, gdy pula jest automatycznie skalowana, tj. enableAutoScale ma wartość true.

enable_inter_node_communication

bool

Wymagane

Określa, czy pula zezwala na bezpośrednią komunikację między węzłami obliczeniowymi. Nakłada to ograniczenia, do których można przypisać węzły obliczeniowe do puli. Określenie tej wartości może zmniejszyć prawdopodobieństwo przydzielenia żądanej liczby węzłów obliczeniowych w puli.

network_configuration

NetworkConfiguration

Wymagane

Konfiguracja sieci dla puli.

start_task

StartTask

Wymagane

Zadanie określone do uruchomienia w każdym węźle obliczeniowym podczas dołączania do puli.

certificate_references

list[CertificateReference]

Wymagane

W przypadku węzłów 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 w celu wykonania zapytania o tę lokalizację. 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 .

application_package_references

list[ApplicationPackageReference]

Wymagane

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 ponownie z obrazu. W dowolnej puli istnieje maksymalnie 10 odwołań do pakietu.

application_licenses

list[str]

Wymagane

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.

task_slots_per_node

int

Wymagane

Liczba miejsc zadań, których można użyć do uruchamiania współbieżnych zadań w jednym węźle obliczeniowym w puli. Wartość domyślna to 1. Wartość maksymalna jest mniejsza niż 4 razy mniejsza niż liczba rdzeni vmSize puli lub 256.

task_scheduling_policy

TaskSchedulingPolicy

Wymagane

Jak zadania są dystrybuowane między węzłami obliczeniowymi w puli. Jeśli nie zostanie określony, wartość domyślna zostanie rozłożona.

user_accounts

list[UserAccount]

Wymagane

metadata

list[MetadataItem]

Wymagane

stats

PoolStatistics

Wymagane

Statystyki użycia zasobów i wykorzystania zasobów przez cały okres istnienia puli. Ta właściwość jest wypełniana tylko wtedy, gdy pula CloudPool została pobrana za pomocą klauzuli expand, w tym atrybutu "stats"; w przeciwnym razie ma wartość null. Statystyki mogą nie być natychmiast dostępne. Usługa Batch wykonuje okresowe zestawienia statystyk. Typowe opóźnienie wynosi około 30 minut.

mount_configuration

list[MountConfiguration]

Wymagane

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

identity

BatchPoolIdentity

Wymagane

Tożsamość puli usługi Batch, jeśli została skonfigurowana. Lista tożsamości użytkowników skojarzonych z pulą usługi Batch. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

target_node_communication_mode

str lub NodeCommunicationMode

Wymagane

Żądany tryb komunikacji węzła dla puli. Jeśli pominięto, wartością domyślną jest Wartość domyślna. Możliwe wartości to: "default", "classic", "simplified"

Zmienne

current_node_communication_mode

str lub NodeCommunicationMode

Bieżący stan trybu komunikacji puli. Możliwe wartości to: "default", "classic", "simplified"

Metody

as_dict	Zwróć dykt, który może być JSONify przy użyciu pliku json.dump. Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru: Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie. Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku. Zobacz trzy przykłady w tym pliku: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
deserialize	Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.
enable_additional_properties_sending
from_dict	Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model. Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu. Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False). Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
validate	Zweryfikuj ten model cyklicznie i zwróć listę błędu ValidationError.

as_dict

Zwróć dykt, który może być JSONify przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku.

Zobacz trzy przykłady w tym pliku:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parametry

key_transformer

<xref:function>

Funkcja transformatora klucza.

keep_readonly

wartość domyślna: True

Zwraca

Obiekt zgodny z dyktacją JSON

Typ zwracany

dict

deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.

deserialize(data, content_type=None)

Parametry

data

str

Wymagane

Str używający struktury RestAPI. Domyślnie dane JSON.

content_type

str

wartość domyślna: None

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

Zwraca

Wystąpienie tego modelu

Wyjątki

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model.

Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parametry

data

dict

Wymagane

Dykt używający struktury RestAPI

content_type

str

wartość domyślna: None

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

key_extractors

wartość domyślna: None

Zwraca

Wystąpienie tego modelu

Wyjątki

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu.

Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametry

keep_readonly

bool

wartość domyślna: False

Jeśli chcesz serializować atrybuty tylko do odczytu

Zwraca

Obiekt zgodny z dyktacją JSON

Typ zwracany

dict

validate

Zweryfikuj ten model cyklicznie i zwróć listę błędu ValidationError.

validate()

Zwraca

Lista błędów walidacji

Typ zwracany

list