Delen via


CloudPool Klas

Een pool in de Azure Batch-service.

Variabelen worden alleen ingevuld door de server en worden genegeerd bij het verzenden van een aanvraag.

Overname
CloudPool

Constructor

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)

Parameters

id
str
Vereist

De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is hoofdletterbewaarbaar en niet hoofdlettergevoelig (dat wil gezegd, u hebt mogelijk geen twee id's binnen een account die alleen per geval verschillen).

display_name
str
Vereist

De weergavenaam hoeft niet uniek te zijn en kan Unicode-tekens bevatten met een maximale lengte van 1024.

url
str
Vereist
e_tag
str
Vereist

Dit is een ondoorzichtige tekenreeks. U kunt deze gebruiken om te detecteren of de pool is gewijzigd tussen aanvragen. U kunt met name de ETag doorgeven bij het bijwerken van een pool om op te geven dat uw wijzigingen alleen van kracht moeten worden als niemand anders de pool in de tussentijd heeft gewijzigd.

last_modified
datetime
Vereist

Dit is de laatste keer dat de gegevens op poolniveau, zoals de instellingen targetDedicatedNodes of enableAutoscale, zijn gewijzigd. Er wordt geen rekening meege houden met wijzigingen op knooppuntniveau, zoals het wijzigen van de status van een rekenknooppunt.

creation_time
datetime
Vereist
state
str of PoolState
Vereist

Mogelijke waarden zijn: 'actief', 'verwijderen'

state_transition_time
datetime
Vereist
allocation_state
str of AllocationState
Vereist

Mogelijke waarden zijn: 'steady', 'resizing', 'stopping'

allocation_state_transition_time
datetime
Vereist
vm_size
str
Vereist

Zie Een VM-grootte kiezen voor rekenknooppunten in een Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes) voor informatie over de beschikbare grootten van virtuele machines in pools.

cloud_service_configuration
CloudServiceConfiguration
Vereist

De cloudserviceconfiguratie voor de pool. Deze eigenschap en virtualMachineConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven. Deze eigenschap kan niet worden opgegeven als het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.

virtual_machine_configuration
VirtualMachineConfiguration
Vereist

De configuratie van de virtuele machine voor de pool. Deze eigenschap en cloudServiceConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven.

resize_timeout
<xref:timedelta>
Vereist

Dit is de time-out voor de meest recente bewerking voor het wijzigen van de grootte. (De initiële groottebepaling wanneer de pool wordt gemaakt, telt als een formaat wijzigen.) De standaardwaarde is 15 minuten.

resize_errors
list[ResizeError]
Vereist

Deze eigenschap wordt alleen ingesteld als er een of meer fouten zijn opgetreden tijdens de laatste poolgrootte en alleen wanneer pool allocationState Stabiel is.

current_dedicated_nodes
int
Vereist

Het aantal toegewezen rekenknooppunten dat zich momenteel in de pool bevindt.

current_low_priority_nodes
int
Vereist

Het aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit dat zich momenteel in de pool bevindt. Spot-rekenknooppunten met lage prioriteit die zijn gepreempteerd, worden opgenomen in dit aantal.

target_dedicated_nodes
int
Vereist

Het gewenste aantal toegewezen rekenknooppunten in de pool.

target_low_priority_nodes
int
Vereist

Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool.

enable_auto_scale
bool
Vereist

Of de grootte van de pool automatisch moet worden aangepast in de loop van de tijd. Indien onwaar, moet ten minste één van de targetDedicatedNodes en targetLowPriorityNodes worden opgegeven. Als dit waar is, is de eigenschap autoScaleFormula vereist en wordt de grootte van de pool automatisch aangepast volgens de formule. De standaardwaarde is false.

auto_scale_formula
str
Vereist

Deze eigenschap wordt alleen ingesteld als de pool automatisch wordt geschaald, dat wil zeggen dat enableAutoScale true is.

auto_scale_evaluation_interval
<xref:timedelta>
Vereist

Deze eigenschap wordt alleen ingesteld als de pool automatisch wordt geschaald, dat wil zeggen dat enableAutoScale true is.

auto_scale_run
AutoScaleRun
Vereist

De resultaten en fouten van de laatste uitvoering van de formule voor automatische schaalaanpassing. Deze eigenschap wordt alleen ingesteld als de pool automatisch wordt geschaald, dat wil zeggen dat enableAutoScale true is.

enable_inter_node_communication
bool
Vereist

Of de pool directe communicatie tussen rekenknooppunten toestaat. Dit legt beperkingen op aan welke rekenknooppunten kunnen worden toegewezen aan de pool. Als u deze waarde opgeeft, kan de kans verkleinen dat het aangevraagde aantal rekenknooppunten in de pool wordt toegewezen.

network_configuration
NetworkConfiguration
Vereist

De netwerkconfiguratie voor de pool.

start_task
StartTask
Vereist

Een taak die is opgegeven om te worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool.

certificate_references
list[CertificateReference]
Vereist

Voor Windows-knooppunten installeert de Batch-service de certificaten in het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR wordt geleverd aan de taak om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst. Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie .

application_package_references
list[ApplicationPackageReference]
Vereist

Wijzigingen in pakketverwijzingen zijn van invloed op alle nieuwe knooppunten die lid worden van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw zijn geïnstalleerd. Er zijn maximaal 10 pakketverwijzingen voor een bepaalde pool.

application_licenses
list[str]
Vereist

De lijst met toepassingslicenties moet een subset zijn van beschikbare licenties voor Batch-servicetoepassingen. Als er een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van de pool.

task_slots_per_node
int
Vereist

Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool. De standaardwaarde is 1. De maximumwaarde is de kleinste van 4 keer het aantal kernen van de vmSize van de pool of 256.

task_scheduling_policy
TaskSchedulingPolicy
Vereist

Hoe taken worden verdeeld over rekenknooppunten in een pool. Als dit niet is opgegeven, is de standaardwaarde spread.

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

Statistieken over gebruik en resourcegebruik voor de hele levensduur van de pool. Deze eigenschap wordt alleen ingevuld als de CloudPool is opgehaald met een uitbreidingscomponent, waaronder het kenmerk 'stats'; anders is het null. De statistieken zijn mogelijk niet onmiddellijk beschikbaar. De Batch-service voert periodiek samengetelde statistieken uit. De typische vertraging is ongeveer 30 minuten.

mount_configuration
list[MountConfiguration]
Vereist

Dit ondersteunt Azure Files, NFS, CIFS/SMB en Blobfuse.

identity
BatchPoolIdentity
Vereist

De identiteit van de Batch-pool, indien geconfigureerd. De lijst met gebruikersidentiteiten die zijn gekoppeld aan de Batch-pool. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

target_node_communication_mode
str of NodeCommunicationMode
Vereist

De gewenste knooppuntcommunicatiemodus voor de pool. Als u dit weglaat, is de standaardwaarde Standaard. Mogelijke waarden zijn: 'default', 'classic', 'simplified'

Variabelen

current_node_communication_mode
str of NodeCommunicationMode

De huidige status van de groepscommunicatiemodus. Mogelijke waarden zijn: 'default', 'classic', 'simplified'

Methoden

as_dict

Retourneer een dict die JSONify kan zijn met behulp van json.dump.

Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.

De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren.

Bekijk de drie voorbeelden in dit bestand:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.

enable_additional_properties_sending
from_dict

Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model.

Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Retourneert de JSON die vanuit dit model naar Azure wordt verzonden.

Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

validate

Valideer dit model recursief en retourneer een lijst met ValidationError.

as_dict

Retourneer een dict die JSONify kan zijn met behulp van json.dump.

Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.

De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren.

Bekijk de drie voorbeelden in dit bestand:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

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

Parameters

key_transformer
<xref:function>

Een sleuteltransformatorfunctie.

keep_readonly
standaardwaarde: True

Retouren

Een dict JSON-compatibel object

Retourtype

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.

deserialize(data, content_type=None)

Parameters

data
str
Vereist

Een str met behulp van restAPI-structuur. JSON standaard.

content_type
str
standaardwaarde: None

JSON standaard: stel application/xml in als XML.

Retouren

Een exemplaar van dit model

Uitzonderingen

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model.

Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)

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

Parameters

data
dict
Vereist

Een dict met behulp van de RestAPI-structuur

content_type
str
standaardwaarde: None

JSON standaard: stel application/xml in als XML.

key_extractors
standaardwaarde: None

Retouren

Een exemplaar van dit model

Uitzonderingen

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Retourneert de JSON die vanuit dit model naar Azure wordt verzonden.

Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

serialize(keep_readonly=False, **kwargs)

Parameters

keep_readonly
bool
standaardwaarde: False

Als u de alleen-lezen kenmerken wilt serialiseren

Retouren

Een dict JSON-compatibel object

Retourtype

validate

Valideer dit model recursief en retourneer een lijst met ValidationError.

validate()

Retouren

Een lijst met validatiefouten

Retourtype