Delen via


PoolAddParameter Klas

Een pool in de Azure Batch-service om toe te voegen.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.

Overname
PoolAddParameter

Constructor

PoolAddParameter(*, id: str, vm_size: str, display_name: str = None, cloud_service_configuration=None, virtual_machine_configuration=None, resize_timeout=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, 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, mount_configuration=None, target_node_communication_mode=None, **kwargs)

Parameters

id
str
Vereist

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 (u hebt mogelijk geen twee pool-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.

vm_size
str
Vereist

Vereist. Zie Grootten voor Cloud Services () voor informatie over de beschikbare grootten van virtuele machines voor Cloud Services pools (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/pools die zijn gemaakt met cloudServiceConfiguration). Batch ondersteunt alle Cloud Services VM-grootten, met uitzondering van ExtraSmall, A1V2 en A2V2. Zie Grootten voor Virtual Machines (Linux) () of Grootten voor Virtual Machines (Windowshttps://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ voor informatie over beschikbare VM-grootten voor pools met behulp van installatiekopieën uit de Virtual Machines Marketplace (pools die zijn gemaakt met virtualMachineConfiguration). Batch ondersteunt alle Vm-grootten van Azure, met uitzondering van STANDARD_A0 en grootten met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 serie).

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

Deze time-out is alleen van toepassing op handmatig schalen; dit heeft geen effect wanneer enableAutoScale is ingesteld op true. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde van minder dan 5 minuten opgeeft, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

target_dedicated_nodes
int
Vereist

Het gewenste aantal toegewezen rekenknooppunten in de pool. Deze eigenschap moet niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.

target_low_priority_nodes
int
Vereist

Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool. Deze eigenschap moet niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.

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 moet niet worden opgegeven als enableAutoScale is ingesteld op false. Dit is vereist als enableAutoScale is ingesteld op true. De formule wordt gecontroleerd op geldigheid voordat de pool wordt gemaakt. Als de formule ongeldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie 'Compute Nodes in an Azure Batch Pool automatisch schalen' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) voor meer informatie over het opgeven van deze formule.

auto_scale_evaluation_interval
<xref:timedelta>
Vereist

De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die kleiner is dan 5 minuten of langer dan 168 uur, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

enable_inter_node_communication
bool
Vereist

Of de pool directe communicatie tussen rekenknooppunten toestaat. Als u communicatie tussen knooppunten inschakelt, wordt de maximale grootte van de pool beperkt vanwege implementatiebeperkingen op de rekenknooppunten van de pool. Dit kan ertoe leiden dat de pool niet de gewenste grootte bereikt. De standaardwaarde is false.

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. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt gestart.

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

Wanneer u een groep maakt, moet de toepassings-id van het pakket volledig zijn gekwalificeerd (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). 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

De Batch-service wijst geen betekenis toe aan metagegevens; het is uitsluitend voor het gebruik van gebruikerscode.

mount_configuration
list[MountConfiguration]
Vereist

Koppel de opslag met behulp van azure-bestandsshare, NFS, CIFS of op Blobfuse gebaseerd bestandssysteem.

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'

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