PoolAddParameter Třída

  • Reference

Fond ve službě Azure Batch, který chcete přidat.

Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.

Dědičnost
Model
PoolAddParameter

Konstruktor

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)

Parametry

id
str
Vyžadováno

Povinná hodnota. ID může obsahovat libovolnou kombinaci alfanumerických znaků, včetně pomlček a podtržítků, a nesmí obsahovat více než 64 znaků. ID zachovává malá a malá písmena a nerozlišuje velká a malá písmena (to znamená, že v účtu nemusí být dvě ID fondu, která se liší pouze písmeny).

display_name
str
Vyžadováno

Zobrazovaný název nemusí být jedinečný a může obsahovat znaky Unicode až do maximální délky 1024.

vm_size
str
Vyžadováno

Povinná hodnota. Informace o dostupných velikostech virtuálních počítačů pro fondy Cloud Services (fondy vytvořené pomocí cloudServiceConfiguration) najdete v tématu Velikosti pro Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch podporuje všechny velikosti virtuálních počítačů Cloud Services s výjimkou ExtraSmall, A1V2 a A2V2. Informace o dostupných velikostech virtuálních počítačů pro fondy používající image z Virtual Machines Marketplace (fondy vytvořené pomocí virtualMachineConfiguration) najdete v tématu Velikosti pro Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) nebo Velikosti pro Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch podporuje všechny velikosti virtuálních počítačů Azure s výjimkou STANDARD_A0 a virtuálních počítačů s úložištěm premium (STANDARD_GS, STANDARD_DS a STANDARD_DSV2 series).

cloud_service_configuration
CloudServiceConfiguration
Vyžadováno

Konfigurace cloudové služby pro fond Tato vlastnost a virtualMachineConfiguration se vzájemně vylučují a musí být zadána jedna z vlastností. Tuto vlastnost nelze zadat, pokud byl účet Batch vytvořen s vlastností poolAllocationMode nastavenou na UserSubscription.

virtual_machine_configuration
VirtualMachineConfiguration
Vyžadováno

Konfigurace virtuálního počítače pro fond. Tato vlastnost a cloudServiceConfiguration se vzájemně vylučují a musí být zadána jedna z vlastností.

resize_timeout
<xref:timedelta>
Vyžadováno

Tento časový limit se vztahuje pouze na ruční škálování. pokud je vlastnost enableAutoScale nastavená na hodnotu true, nemá žádný vliv. Výchozí hodnota je 15 minut. Minimální hodnota je 5 minut. Pokud zadáte hodnotu menší než 5 minut, služba Batch vrátí chybu; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (chybný požadavek).

target_dedicated_nodes
int
Vyžadováno

Požadovaný počet vyhrazených výpočetních uzlů ve fondu Tato vlastnost nesmí být zadána, pokud je vlastnost enableAutoScale nastavena na hodnotu true. Pokud je vlastnost enableAutoScale nastavena na hodnotu false, musíte nastavit buď targetDedicatedNodes, targetLowPriorityNodes, nebo obojí.

target_low_priority_nodes
int
Vyžadováno

Požadovaný počet spotových výpočetních uzlů nebo výpočetních uzlů s nízkou prioritou ve fondu Tato vlastnost nesmí být zadána, pokud je vlastnost enableAutoScale nastavena na hodnotu true. Pokud je vlastnost enableAutoScale nastavena na hodnotu false, musíte nastavit buď targetDedicatedNodes, targetLowPriorityNodes, nebo obojí.

enable_auto_scale
bool
Vyžadováno

Určuje, jestli se má velikost fondu v průběhu času automaticky upravovat. Pokud je false, musí být zadána alespoň jedna z targetDedicatedNodes a targetLowPriorityNodes. Pokud ano, je vyžadována vlastnost autoScaleFormula a velikost fondu se automaticky změní podle vzorce. Výchozí hodnota je False.

auto_scale_formula
str
Vyžadováno

Tato vlastnost nesmí být zadána, pokud je vlastnost enableAutoScale nastavená na hodnotu false. Vyžaduje se, pokud je vlastnost enableAutoScale nastavená na hodnotu true. Platnost vzorce se před vytvořením fondu zkontroluje. Pokud vzorec není platný, služba Batch žádost odmítne s podrobnými informacemi o chybě. Další informace o zadání tohoto vzorce najdete v tématu Automatické škálování výpočetních uzlů ve fondu Azure Batch (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

auto_scale_evaluation_interval
<xref:timedelta>
Vyžadováno

Výchozí hodnota je 15 minut. Minimální a maximální hodnota je 5 minut a 168 hodin. Pokud zadáte hodnotu menší než 5 minut nebo více než 168 hodin, vrátí služba Batch chybu; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (chybný požadavek).

enable_inter_node_communication
bool
Vyžadováno

Jestli fond umožňuje přímou komunikaci mezi výpočetními uzly. Povolení komunikace mezi uzly omezuje maximální velikost fondu kvůli omezením nasazení na výpočetních uzlech fondu. To může vést k tomu, že fond nedosáhne požadované velikosti. Výchozí hodnota je False.

network_configuration
NetworkConfiguration
Vyžadováno

Konfigurace sítě pro fond

start_task
StartTask
Vyžadováno

Úloha určená ke spuštění na každém výpočetním uzlu při připojení k fondu. Úloha se spustí při přidání výpočetního uzlu do fondu nebo při restartování výpočetního uzlu.

certificate_references
list[CertificateReference]
Vyžadováno

U uzlů Windows služba Batch nainstaluje certifikáty do zadaného úložiště certifikátů a umístění. V případě linuxových výpočetních uzlů se certifikáty ukládají v adresáři v pracovním adresáři úlohy a do úlohy se zadává proměnná prostředí, AZ_BATCH_CERTIFICATES_DIR se má dotazovat na toto umístění. U certifikátů s viditelností remoteUser se v domovském adresáři uživatele vytvoří adresář certs (např. /home/{user-name}/certs) a certifikáty se umístí do tohoto adresáře. Upozornění: Tato vlastnost je zastaralá a po únoru 2024 se odebere. Místo toho použijte rozšíření Azure KeyVault .

application_package_references
list[ApplicationPackageReference]
Vyžadováno

Při vytváření fondu musí být ID aplikace balíčku plně kvalifikované (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Změny odkazů na balíčky mají vliv na všechny nové uzly, které se připojují k fondu, ale nemají vliv na výpočetní uzly, které už jsou ve fondu, dokud se nerestartují nebo nereimagují. V každém daném fondu je maximálně 10 odkazů na balíčky.

application_licenses
list[str]
Vyžadováno

Seznam licencí aplikací musí být podmnožinou dostupných licencí aplikací služby Batch. Pokud je požadována licence, která není podporovaná, vytvoření fondu se nezdaří.

task_slots_per_node
int
Vyžadováno

Počet slotů úloh, které lze použít ke spouštění souběžných úloh na jednom výpočetním uzlu ve fondu. Výchozí hodnota je 1. Maximální hodnota je menší ze 4násobku počtu jader vmSize fondu nebo 256.

task_scheduling_policy
TaskSchedulingPolicy
Vyžadováno

Jak se úlohy distribuují mezi výpočetní uzly ve fondu. Pokud není zadáno, je výchozí rozprostřený.

user_accounts
list[UserAccount]
Vyžadováno
metadata
list[MetadataItem]
Vyžadováno

Služba Batch nepřiřazuje metadatům žádný význam. je určen výhradně pro použití uživatelského kódu.

mount_configuration
list[MountConfiguration]
Vyžadováno

Připojte úložiště pomocí sdílené složky Azure, systému souborů NFS, CIFS nebo systému souborů blobfuse.

target_node_communication_mode
str nebo NodeCommunicationMode
Vyžadováno

Požadovaný režim komunikace uzlu pro fond. Pokud je vynechán, výchozí hodnota je Výchozí. Mezi možné hodnoty patří: 'default', 'classic', 'simplified'

Metody

as_dict

Vrátí dikt, který může být JSONify pomocí json.dump.

Rozšířené využití může volitelně použít zpětné volání jako parametr:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.
enable_additional_properties_sending
from_dict

Analýza diktu pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).
is_xml_model
serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
validate

Rekurzivně ověřte tento model a vraťte seznam ValidationError.

as_dict

Vrátí dikt, který může být JSONify pomocí json.dump.

Rozšířené využití může volitelně použít zpětné volání jako parametr:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

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

Parametry

key_transformer
<xref:function>

Funkce klíčového transformátoru.

keep_readonly
výchozí hodnota: True

Návraty

Objekt kompatibilní s diktem JSON

Návratový typ

dict

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

deserialize(data, content_type=None)

Parametry

data
str
Vyžadováno

Str používající strukturu RestAPI. Ve výchozím nastavení JSON.

content_type
str
výchozí hodnota: None

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

Návraty

Instance tohoto modelu

Výjimky

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Analýza diktu pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).

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

Parametry

data
dict
Vyžadováno

Diktování pomocí struktury RestAPI

content_type
str
výchozí hodnota: None

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

key_extractors
výchozí hodnota: None

Návraty

Instance tohoto modelu

Výjimky

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametry

keep_readonly
bool
výchozí hodnota: False

Pokud chcete serializovat atributy readonly

Návraty

Objekt kompatibilní s diktem JSON

Návratový typ

dict

validate

Rekurzivně ověřte tento model a vraťte seznam ValidationError.

validate()

Návraty

Seznam chyb ověření

Návratový typ

list