PoolAddParameter Klass
En pool i Azure Batch-tjänsten att lägga till.
Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.
- Arv
-
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)Parametrar
- id
- str
Krävs. 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å pool-ID:n inom ett konto som endast skiljer sig från fall till fall).
- display_name
- str
Visningsnamnet behöver inte vara unikt och kan innehålla alla Unicode-tecken upp till en maximal längd på 1024.
- vm_size
- str
Krävs. Information om tillgängliga storlekar på virtuella datorer för Cloud Services-pooler (pooler som skapats med cloudServiceConfiguration) finns i Storlekar för Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch stöder alla Cloud Services VM-storlekar utom ExtraSmall, A1V2 och A2V2. Information om tillgängliga VM-storlekar för pooler med avbildningar från Virtual Machines Marketplace (pooler som skapats med virtualMachineConfiguration) finns i Storlekar för Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) eller Storlekar för Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch stöder alla storlekar på virtuella Azure-datorer utom STANDARD_A0 och de med premiumlagring (STANDARD_GS, STANDARD_DS och STANDARD_DSV2-serien).
- cloud_service_configuration
- CloudServiceConfiguration
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
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>
Den här tidsgränsen gäller endast för manuell skalning. det har ingen effekt när enableAutoScale är inställt på sant. Standardvärdet är 15 minuter. Det minsta värdet är 5 minuter. Om du anger ett värde som är mindre än 5 minuter returnerar Batch-tjänsten ett fel. om du anropar REST API direkt är HTTP-statuskoden 400 (felaktig begäran).
- target_dedicated_nodes
- int
Önskat antal dedikerade beräkningsnoder i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.
- target_low_priority_nodes
- int
Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.
- enable_auto_scale
- bool
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
Den här egenskapen får inte anges om enableAutoScale är inställt på false. Det krävs om enableAutoScale är inställt på true. Formeln kontrolleras för giltighet innan poolen skapas. Om formeln inte är giltig avvisar Batch-tjänsten begäran med detaljerad felinformation. Mer information om hur du anger den här formeln finns i Skala beräkningsnoder automatiskt i en Azure Batch pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
- auto_scale_evaluation_interval
- <xref:timedelta>
Standardvärdet är 15 minuter. Det minsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar returnerar Batch-tjänsten ett fel. om du anropar REST API direkt är HTTP-statuskoden 400 (felaktig begäran).
- enable_inter_node_communication
- bool
Om poolen tillåter direkt kommunikation mellan beräkningsnoder. Om du aktiverar kommunikation mellan noder begränsas poolens maximala storlek på grund av distributionsbegränsningar för poolens beräkningsnoder. Detta kan leda till att poolen inte når önskad storlek. Standardvärdet är false.
- start_task
- StartTask
En uppgift som har angetts för att köras på varje beräkningsnod när den ansluter till poolen. Aktiviteten körs när beräkningsnoden läggs till i poolen eller när beräkningsnoden startas om.
- certificate_references
- list[CertificateReference]
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]
När du skapar en pool måste paketets program-ID vara fullständigt kvalificerat (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Ä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.
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
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
Hur aktiviteter distribueras mellan beräkningsnoder i en pool. Om det inte anges sprids standardvärdet.
- user_accounts
- list[UserAccount]
- metadata
- list[MetadataItem]
Batch-tjänsten tilldelar ingen mening till metadata. det är endast för användning av användarkod.
- mount_configuration
- list[MountConfiguration]
Montera lagringen med azure-fildelning, NFS, CIFS eller Blobfuse-baserat filsystem.
- target_node_communication_mode
- str eller NodeCommunicationMode
Önskat nodkommunikationsläge för poolen. Om det utelämnas är standardvärdet Standard. Möjliga värden är: "default", "classic", "simplified"
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:
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
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
Returer
En instans av den här modellen
Undantag
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
- key_extractors
Returer
En instans av den här modellen
Undantag
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
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
Azure SDK for Python
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för