CloudPool Klass

En pool i Azure Batch-tjänsten.

Variabler fylls bara i av servern och ignoreras när en begäran skickas.

Arv
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)

Parametrar

id
str
Obligatorisk

ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken. ID:t är skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två ID:n inom ett konto som endast skiljer sig åt från fall till fall).

display_name
str
Obligatorisk

Visningsnamnet behöver inte vara unikt och kan innehålla alla Unicode-tecken upp till en maximal längd på 1024.

url
str
Obligatorisk
e_tag
str
Obligatorisk

Det här är en täckande sträng. Du kan använda den för att identifiera om poolen har ändrats mellan begäranden. Du kan i synnerhet skicka ETag när du uppdaterar en pool för att ange att ändringarna ska börja gälla endast om ingen annan har ändrat poolen under tiden.

last_modified
datetime
Obligatorisk

Det här är sista gången data på poolnivå, till exempel targetDedicatedNodes eller enableAutoscale settings, ändrades. Den tar inte hänsyn till ändringar på nodnivå, till exempel ändringstillstånd för beräkningsnoder.

creation_time
datetime
Obligatorisk
state
str eller PoolState
Obligatorisk

Möjliga värden är: "aktiv", "ta bort"

state_transition_time
datetime
Obligatorisk
allocation_state
str eller AllocationState
Obligatorisk

Möjliga värden är: "steady", "resizing", "stop"

allocation_state_transition_time
datetime
Obligatorisk
vm_size
str
Obligatorisk

Information om tillgängliga storlekar på virtuella datorer i pooler finns i Välja en VM-storlek för beräkningsnoder i en Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

cloud_service_configuration
CloudServiceConfiguration
Obligatorisk

Molntjänstkonfigurationen för poolen. Den här egenskapen och virtualMachineConfiguration är ömsesidigt uteslutande och en av egenskaperna måste anges. Det går inte att ange den här egenskapen om Batch-kontot har skapats med egenskapen poolAllocationMode inställd på UserSubscription.

virtual_machine_configuration
VirtualMachineConfiguration
Obligatorisk

Konfigurationen av den virtuella datorn för poolen. Den här egenskapen och cloudServiceConfiguration är ömsesidigt uteslutande och en av egenskaperna måste anges.

resize_timeout
<xref:timedelta>
Obligatorisk

Det här är tidsgränsen för den senaste storleksändringsåtgärden. (Den inledande storleksändringen när poolen skapas räknas som en storleksändring.) Standardvärdet är 15 minuter.

resize_errors
list[ResizeError]
Obligatorisk

Den här egenskapen anges endast om ett eller flera fel inträffade under den senaste poolens storleksändring och endast när Pool allocationState är Stabil.

current_dedicated_nodes
int
Obligatorisk

Antalet dedikerade beräkningsnoder som för närvarande finns i poolen.

current_low_priority_nodes
int
Obligatorisk

Antalet beräkningsnoder med oanvänd kapacitet/låg prioritet som för närvarande finns i poolen. Beräkningsnoder med låg prioritet för oanvänd kapacitet och låg prioritet ingår i det här antalet.

target_dedicated_nodes
int
Obligatorisk

Önskat antal dedikerade beräkningsnoder i poolen.

target_low_priority_nodes
int
Obligatorisk

Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen.

enable_auto_scale
bool
Obligatorisk

Om poolstorleken ska justeras automatiskt över tid. Om det är falskt måste minst ett av targetDedicatedNodes och targetLowPriorityNodes anges. Om det är sant krävs egenskapen autoScaleFormula och poolen ändras automatiskt enligt formeln. Standardvärdet är false.

auto_scale_formula
str
Obligatorisk

Den här egenskapen anges endast om poolen skalar automatiskt, dvs. enableAutoScale är sant.

auto_scale_evaluation_interval
<xref:timedelta>
Obligatorisk

Den här egenskapen anges endast om poolen skalar automatiskt, dvs. enableAutoScale är sant.

auto_scale_run
AutoScaleRun
Obligatorisk

Resultat och fel från den senaste körningen av autoskalningsformeln. Den här egenskapen anges endast om poolen skalar automatiskt, dvs. enableAutoScale är sant.

enable_inter_node_communication
bool
Obligatorisk

Om poolen tillåter direkt kommunikation mellan beräkningsnoder. Detta medför begränsningar för vilka beräkningsnoder som kan tilldelas till poolen. Om du anger det här värdet kan du minska risken för det begärda antalet beräkningsnoder som ska allokeras i poolen.

network_configuration
NetworkConfiguration
Obligatorisk

Nätverkskonfigurationen för poolen.

start_task
StartTask
Obligatorisk

En uppgift som har angetts för att köras på varje beräkningsnod när den ansluter till poolen.

certificate_references
list[CertificateReference]
Obligatorisk

För Windows-noder installerar Batch-tjänsten certifikaten till det angivna certifikatarkivet och platsen. För Linux-beräkningsnoder lagras certifikaten i en katalog i arbetskatalogen Aktivitet och en miljövariabel AZ_BATCH_CERTIFICATES_DIR skickas till uppgiften för att fråga efter den här platsen. För certifikat med synlighet för "remoteUser" skapas en "certs"-katalog i användarens hemkatalog (t.ex. /home/{användarnamn}/certifikat) och certifikat placeras i den katalogen. Varning! Den här egenskapen är inaktuell och tas bort efter februari 2024. Använd Azure KeyVault-tillägget i stället.

application_package_references
list[ApplicationPackageReference]
Obligatorisk

Ändringar av paketreferenser påverkar alla nya noder som ansluter till poolen, men påverkar inte beräkningsnoder som redan finns i poolen förrän de har startats om eller omskapats. Det finns högst 10 paketreferenser i en viss pool.

application_licenses
list[str]
Obligatorisk

Listan över programlicenser måste vara en delmängd av tillgängliga Batch-tjänstprogramlicenser. Om en licens begärs som inte stöds misslyckas skapandet av poolen.

task_slots_per_node
int
Obligatorisk

Antalet aktivitetsfack som kan användas för att köra samtidiga aktiviteter på en enda beräkningsnod i poolen. Standardvärdet är 1. Det maximala värdet är mindre än 4 gånger antalet kärnor i vmSize för poolen eller 256.

task_scheduling_policy
TaskSchedulingPolicy
Obligatorisk

Hur aktiviteter distribueras mellan beräkningsnoder i en pool. Om det inte anges sprids standardvärdet.

user_accounts
list[UserAccount]
Obligatorisk
metadata
list[MetadataItem]
Obligatorisk
stats
PoolStatistics
Obligatorisk

Användnings- och resursanvändningsstatistik för hela poolens livslängd. Den här egenskapen fylls endast i om CloudPool hämtades med en expanderingssats som innehåller attributet stats. annars är den null. Statistiken kanske inte är omedelbart tillgänglig. Batch-tjänsten utför regelbunden sammanslagning av statistik. Den typiska fördröjningen är cirka 30 minuter.

mount_configuration
list[MountConfiguration]
Obligatorisk

Detta stöder Azure Files, NFS, CIFS/SMB och Blobfuse.

identity
BatchPoolIdentity
Obligatorisk

Identiteten för Batch-poolen, om den är konfigurerad. Listan över användaridentiteter som är associerade med Batch-poolen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

target_node_communication_mode
str eller NodeCommunicationMode
Obligatorisk

Önskat nodkommunikationsläge för poolen. Om det utelämnas är standardvärdet Standard. Möjliga värden är: "default", "classic", "simplified"

Variabler

current_node_communication_mode
str eller NodeCommunicationMode

Det aktuella tillståndet för poolkommunikationsläget. Möjliga värden är: "default", "classic", "simplified" (förenklad)

Metoder

as_dict

Returnera en diktamen som kan vara JSONify med hjälp av json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

enable_additional_properties_sending
from_dict

Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell.

Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Returnera den JSON som skulle skickas till Azure från den här modellen.

Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

validate

Verifiera den här modellen rekursivt och returnera en lista över ValidationError.

as_dict

Returnera en diktamen som kan vara JSONify med hjälp av json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

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

Parametrar

key_transformer
<xref:function>

En nyckeltransformatorfunktion.

keep_readonly
standardvärde: True

Returer

Ett dict JSON-kompatibelt objekt

Returtyp

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

deserialize(data, content_type=None)

Parametrar

data
str
Obligatorisk

En str som använder RestAPI-struktur. JSON som standard.

content_type
str
standardvärde: None

JSON som standard anger du application/xml om XML.

Returer

En instans av den här modellen

Undantag

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell.

Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)

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

Parametrar

data
dict
Obligatorisk

En dikta med Hjälp av RestAPI-struktur

content_type
str
standardvärde: None

JSON som standard anger du application/xml om XML.

key_extractors
standardvärde: None

Returer

En instans av den här modellen

Undantag

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Returnera den JSON som skulle skickas till Azure från den här modellen.

Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametrar

keep_readonly
bool
standardvärde: False

Om du vill serialisera readonly-attributen

Returer

Ett dict JSON-kompatibelt objekt

Returtyp

validate

Verifiera den här modellen rekursivt och returnera en lista över ValidationError.

validate()

Returer

En lista över valideringsfel

Returtyp