PoolOperations Třída
Operace PoolOperations.
Neměli byste vytvořit instanci přímo této třídy, ale vytvořit instanci klienta, která ji vytvoří pro vás a připojí ji jako atribut.
- Dědičnost
-
builtins.objectPoolOperations
Konstruktor
PoolOperations(client, config, serializer, deserializer)Parametry
- client
Klient pro žádosti o služby.
- config
Konfigurace klienta služby.
- serializer
Serializátor objektového modelu.
- deserializer
Deserializátor objektového modelu.
Proměnné
- api_version
Verze rozhraní API, která se má použít pro požadavek. Konstantní hodnota: "2023-05-01.17.0".
Metody
| add |
Přidá fond do zadaného účtu. Při pojmenování fondů nepoužívejte citlivé informace, jako jsou uživatelská jména nebo názvy tajných projektů. Tyto informace se můžou zobrazit v protokolech telemetrie přístupných technikům podpora Microsoftu. |
| delete |
Odstraní fond ze zadaného účtu. Když požádáte o odstranění fondu, dojde k následujícím akcím: Stav fondu je nastaven na odstranění; všechny probíhající operace změny velikosti fondu jsou zastaveny; Služba Batch zahájí změnu velikosti fondu na nulu výpočetních uzlů; Všechny úlohy spuštěné na existujících výpočetních uzlech se ukončí a znovu zadají do fronty (jako kdyby byla požadována operace změny velikosti fondu s výchozí možností opětovného zařazení do fronty); Nakonec se fond odebere ze systému. Vzhledem k tomu, že spuštěné úlohy jsou znovu ve frontě, může uživatel tyto úlohy znovu spustit aktualizací své úlohy tak, aby cílila na jiný fond. Úkoly pak můžou běžet v novém fondu. Pokud chcete chování opětovného vytvoření fronty přepsat, měli byste před odstraněním fondu explicitně zavolat změnit velikost fondu a zmenšit tak fond na nulu. Pokud zavoláte rozhraní API pro aktualizaci, opravu nebo odstranění ve fondu ve stavu odstraňování, selže se stavovým kódem HTTP 409 s kódem chyby PoolBeingDeleted. |
| disable_auto_scale |
Zakáže automatické škálování fondu. |
| enable_auto_scale |
Povolí automatické škálování fondu. Automatické škálování fondu nelze povolit, pokud ve fondu probíhá operace změny velikosti. Pokud je automatické škálování fondu aktuálně zakázané, musíte jako součást požadavku zadat platný vzorec automatického škálování. Pokud už je automatické škálování fondu povolené, můžete zadat nový vzorec automatického škálování nebo nový interval vyhodnocení. Toto rozhraní API pro stejný fond nelze volat více než jednou za 30 sekund. |
| evaluate_auto_scale |
Získá výsledek vyhodnocení vzorce automatického škálování ve fondu. Toto rozhraní API slouží primárně k ověřování vzorce automatického škálování, protože jednoduše vrací výsledek bez použití vzorce ve fondu. Aby bylo možné vyhodnotit vzorec, musí mít fond povolené automatické škálování. |
| exists |
Získá základní vlastnosti fondu. |
| get |
Získá informace o zadaném fondu. |
| list |
Zobrazí seznam všech fondů v zadaném účtu. |
| list_usage_metrics |
Zobrazí seznam metrik využití agregovaných podle fondu v jednotlivých časových intervalech pro zadaný účet. Pokud nezadáte klauzuli $filter včetně poolId, odpověď zahrne všechny fondy, které existovaly v účtu v časovém rozsahu vrácených agregačních intervalů. Pokud nezadáte klauzuli $filter, včetně startTime nebo endTime, tyto filtry mají výchozí počáteční a koncový čas posledního dostupného agregačního intervalu. To znamená, že se vrátí pouze poslední interval agregace. |
| patch |
Aktualizace vlastnosti zadaného fondu. Tím se nahradí pouze vlastnosti fondu zadané v požadavku. Pokud má například fond přidružený startTask a požadavek neurčuje prvek StartTask, pak fond zachová existující startTask. |
| remove_nodes |
Odebere výpočetní uzly ze zadaného fondu. Tato operace se může spustit pouze v případě, že stav přidělení fondu je stabilní. Při spuštění této operace se stav přidělení změní ze stabilního na změnu velikosti. Každý požadavek může odebrat až 100 uzlů. |
| resize |
Změní počet výpočetních uzlů přiřazených k fondu. Velikost fondu můžete změnit pouze v případech, kdy je jeho stav přidělení stabilní. Pokud se velikost fondu už změní, požadavek selže se stavovým kódem 409. Když změníte velikost fondu, stav přidělení fondu se změní ze stabilního na změnu velikosti. Velikost fondů nakonfigurovaných pro automatické škálování nejde změnit. Pokud se o to pokusíte, vrátí služba Batch chybu 409. Pokud změníte velikost fondu směrem dolů, služba Batch zvolí, které výpočetní uzly se mají odebrat. Pokud chcete odebrat konkrétní výpočetní uzly, použijte místo toho rozhraní API pro odebrání výpočetních uzlů fondu. |
| stop_resize |
Zastaví probíhající operaci změny velikosti ve fondu. Tím se fond neobnoví do předchozího stavu před operací změny velikosti: zastaví se pouze jakékoli další změny a fond si zachová aktuální stav. Po zastavení se fond stabilizuje na počtu výpočetních uzlů, na které byl při dokončení operace zastavení. Během operace zastavení se stav přidělení fondu nejprve změní na zastavení a pak na stabilní. Operace změny velikosti nemusí být explicitní požadavek na změnu velikosti fondu. Toto rozhraní API lze také použít k zastavení počáteční velikosti fondu při jeho vytvoření. |
| update_properties |
Aktualizace vlastnosti zadaného fondu. Tím se plně nahradí všechny aktualizovatelné vlastnosti fondu. Pokud má fond například přidružený startTask a pokud není v tomto požadavku zadán StartTask, služba Batch odebere existující startTask. |
add
Přidá fond do zadaného účtu.
Při pojmenování fondů nepoužívejte citlivé informace, jako jsou uživatelská jména nebo názvy tajných projektů. Tyto informace se můžou zobrazit v protokolech telemetrie přístupných technikům podpora Microsoftu.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
delete
Odstraní fond ze zadaného účtu.
Když požádáte o odstranění fondu, dojde k následujícím akcím: Stav fondu je nastaven na odstranění; všechny probíhající operace změny velikosti fondu jsou zastaveny; Služba Batch zahájí změnu velikosti fondu na nulu výpočetních uzlů; Všechny úlohy spuštěné na existujících výpočetních uzlech se ukončí a znovu zadají do fronty (jako kdyby byla požadována operace změny velikosti fondu s výchozí možností opětovného zařazení do fronty); Nakonec se fond odebere ze systému. Vzhledem k tomu, že spuštěné úlohy jsou znovu ve frontě, může uživatel tyto úlohy znovu spustit aktualizací své úlohy tak, aby cílila na jiný fond. Úkoly pak můžou běžet v novém fondu. Pokud chcete chování opětovného vytvoření fronty přepsat, měli byste před odstraněním fondu explicitně zavolat změnit velikost fondu a zmenšit tak fond na nulu. Pokud zavoláte rozhraní API pro aktualizaci, opravu nebo odstranění ve fondu ve stavu odstraňování, selže se stavovým kódem HTTP 409 s kódem chyby PoolBeingDeleted.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
disable_auto_scale
Zakáže automatické škálování fondu.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Další parametry pro operaci
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
enable_auto_scale
Povolí automatické škálování fondu.
Automatické škálování fondu nelze povolit, pokud ve fondu probíhá operace změny velikosti. Pokud je automatické škálování fondu aktuálně zakázané, musíte jako součást požadavku zadat platný vzorec automatického škálování. Pokud už je automatické škálování fondu povolené, můžete zadat nový vzorec automatického škálování nebo nový interval vyhodnocení. Toto rozhraní API pro stejný fond nelze volat více než jednou za 30 sekund.
enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- auto_scale_formula
- str
Než se vzorec použije pro fond, zkontroluje se platnost. 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/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
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ětší než 168 hodin, služba Batch odmítne požadavek s chybou neplatné hodnoty vlastnosti; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (chybný požadavek). Pokud zadáte nový interval, zastaví se stávající plán vyhodnocení automatického škálování a spustí se nový plán vyhodnocení automatického škálování, přičemž jeho počátečním časem je čas vystavení této žádosti.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Další parametry pro operaci
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
evaluate_auto_scale
Získá výsledek vyhodnocení vzorce automatického škálování ve fondu.
Toto rozhraní API slouží primárně k ověřování vzorce automatického škálování, protože jednoduše vrací výsledek bez použití vzorce ve fondu. Aby bylo možné vyhodnotit vzorec, musí mít fond povolené automatické škálování.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- auto_scale_formula
- str
Vzorec se ověří a jeho výsledky se vypočítají, ale na fond se nepoužijí. Pokud chcete použít vzorec pro fond, povolte automatické škálování ve fondu. 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/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Další parametry pro operaci
- operation_config
Přepsání konfigurace operace
Návraty
AutoScaleRun nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
exists
Získá základní vlastnosti fondu.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Přepsání konfigurace operace
Návraty
bool nebo ClientRawResponse, pokud raw=true
Návratový typ
Výjimky
get
Získá informace o zadaném fondu.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Přepsání konfigurace operace
Návraty
CloudPool nebo ClientRawResponse, pokud raw=true
Návratový typ
Výjimky
list
Zobrazí seznam všech fondů v zadaném účtu.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Přepsání konfigurace operace
Návraty
Iterátor, jako je instance CloudPoolu
Návratový typ
Výjimky
list_usage_metrics
Zobrazí seznam metrik využití agregovaných podle fondu v jednotlivých časových intervalech pro zadaný účet.
Pokud nezadáte klauzuli $filter včetně poolId, odpověď zahrne všechny fondy, které existovaly v účtu v časovém rozsahu vrácených agregačních intervalů. Pokud nezadáte klauzuli $filter, včetně startTime nebo endTime, tyto filtry mají výchozí počáteční a koncový čas posledního dostupného agregačního intervalu. To znamená, že se vrátí pouze poslední interval agregace.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Další parametry pro operaci
- operation_config
Přepsání konfigurace operace
Návraty
Iterátor, jako je instance PoolUsageMetrics
Návratový typ
Výjimky
patch
Aktualizace vlastnosti zadaného fondu.
Tím se nahradí pouze vlastnosti fondu zadané v požadavku. Pokud má například fond přidružený startTask a požadavek neurčuje prvek StartTask, pak fond zachová existující startTask.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
remove_nodes
Odebere výpočetní uzly ze zadaného fondu.
Tato operace se může spustit pouze v případě, že stav přidělení fondu je stabilní. Při spuštění této operace se stav přidělení změní ze stabilního na změnu velikosti. Každý požadavek může odebrat až 100 uzlů.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
resize
Změní počet výpočetních uzlů přiřazených k fondu.
Velikost fondu můžete změnit pouze v případech, kdy je jeho stav přidělení stabilní. Pokud se velikost fondu už změní, požadavek selže se stavovým kódem 409. Když změníte velikost fondu, stav přidělení fondu se změní ze stabilního na změnu velikosti. Velikost fondů nakonfigurovaných pro automatické škálování nejde změnit. Pokud se o to pokusíte, vrátí služba Batch chybu 409. Pokud změníte velikost fondu směrem dolů, služba Batch zvolí, které výpočetní uzly se mají odebrat. Pokud chcete odebrat konkrétní výpočetní uzly, použijte místo toho rozhraní API pro odebrání výpočetních uzlů fondu.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
stop_resize
Zastaví probíhající operaci změny velikosti ve fondu.
Tím se fond neobnoví do předchozího stavu před operací změny velikosti: zastaví se pouze jakékoli další změny a fond si zachová aktuální stav. Po zastavení se fond stabilizuje na počtu výpočetních uzlů, na které byl při dokončení operace zastavení. Během operace zastavení se stav přidělení fondu nejprve změní na zastavení a pak na stabilní. Operace změny velikosti nemusí být explicitní požadavek na změnu velikosti fondu. Toto rozhraní API lze také použít k zastavení počáteční velikosti fondu při jeho vytvoření.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
update_properties
Aktualizace vlastnosti zadaného fondu.
Tím se plně nahradí všechny aktualizovatelné vlastnosti fondu. Pokud má fond například přidružený startTask a pokud není v tomto požadavku zadán StartTask, služba Batch odebere existující startTask.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- pool_update_properties_options
- PoolUpdatePropertiesOptions
Další parametry operace
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
Atributy
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro