FileOperations Třída

Operace FileOperations.

Neměli byste vytvořit instanci přímo této třídy, ale vytvořit instanci klienta, která ji vytvoří za vás a připojí ji jako atribut.

Dědičnost

builtins.object

FileOperations

Konstruktor

FileOperations(client, config, serializer, deserializer)

Parametry

client

Vyžadováno

Klient pro žádosti o služby.

config

Vyžadováno

Konfigurace klienta služby.

serializer

Vyžadováno

Serializátor objektového modelu.

deserializer

Vyžadováno

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

delete_from_compute_node	Odstraní zadaný soubor z výpočetního uzlu.
delete_from_task	Odstraní zadaný soubor úlohy z výpočetního uzlu, na kterém úloha běžela.
get_from_compute_node	Vrátí obsah zadaného souboru výpočetního uzlu.
get_from_task	Vrátí obsah zadaného souboru úlohy.
get_properties_from_compute_node	Získá vlastnosti zadaného souboru výpočetního uzlu.
get_properties_from_task	Získá vlastnosti zadaného souboru úlohy.
list_from_compute_node	Zobrazí seznam všech souborů v adresářích úloh na zadaném výpočetním uzlu.
list_from_task	Zobrazí seznam souborů v adresáři úlohy na výpočetním uzlu.

delete_from_compute_node

Odstraní zadaný soubor z výpočetního uzlu.

delete_from_compute_node(pool_id, node_id, file_path, recursive=None, file_delete_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

pool_id

str

Vyžadováno

ID fondu, který obsahuje výpočetní uzel.

node_id

str

Vyžadováno

ID výpočetního uzlu, ze kterého chcete soubor odstranit.

file_path

str

Vyžadováno

Cesta k souboru nebo adresáři, který chcete odstranit.

recursive

bool

výchozí hodnota: None

Jestli se mají odstranit podřízené položky adresáře. Pokud parametr filePath představuje adresář místo souboru, můžete nastavit rekurzivní na true a odstranit adresář a všechny soubory a podadresáře v něm. Pokud má rekurzivní hodnotu false, musí být adresář prázdný, jinak odstranění selže.

file_delete_from_compute_node_options

FileDeleteFromComputeNodeOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

None nebo ClientRawResponse if raw=true

Návratový typ

None,

ClientRawResponse

Výjimky

BatchErrorException

delete_from_task

Odstraní zadaný soubor úlohy z výpočetního uzlu, na kterém úloha běžela.

delete_from_task(job_id, task_id, file_path, recursive=None, file_delete_from_task_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy, která obsahuje úkol.

task_id

str

Vyžadováno

ID úlohy, jejíž soubor chcete odstranit.

file_path

str

Vyžadováno

Cesta k souboru nebo adresáři úlohy, který chcete odstranit.

recursive

bool

výchozí hodnota: None

Jestli se mají odstranit podřízené položky adresáře. Pokud parametr filePath představuje adresář místo souboru, můžete nastavit rekurzivní na true a odstranit adresář a všechny soubory a podadresáře v něm. Pokud má rekurzivní hodnotu false, musí být adresář prázdný, jinak odstranění selže.

file_delete_from_task_options

FileDeleteFromTaskOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

None nebo ClientRawResponse if raw=true

Návratový typ

None,

ClientRawResponse

Výjimky

BatchErrorException

get_from_compute_node

Vrátí obsah zadaného souboru výpočetního uzlu.

get_from_compute_node(pool_id, node_id, file_path, file_get_from_compute_node_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

Parametry

pool_id

str

Vyžadováno

ID fondu, který obsahuje výpočetní uzel.

node_id

str

Vyžadováno

ID výpočetního uzlu, který obsahuje soubor.

file_path

str

Vyžadováno

Cesta k souboru výpočetního uzlu, ze kterého chcete získat obsah.

file_get_from_compute_node_options

FileGetFromComputeNodeOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

callback

Callable[<xref:Bytes>, <xref:response=None>]

výchozí hodnota: None

Pokud je tato možnost zadána, bude volána s každým datovým proudem. Zpětné volání by mělo mít dva argumenty, bajty aktuálního bloku dat a objekt odpovědi. Pokud se data nahrávají, odpověď bude Žádná.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

object nebo ClientRawResponse if raw=true

Návratový typ

Generator,

ClientRawResponse

Výjimky

BatchErrorException

get_from_task

Vrátí obsah zadaného souboru úlohy.

get_from_task(job_id, task_id, file_path, file_get_from_task_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy, která obsahuje úkol.

task_id

str

Vyžadováno

ID úlohy, jejíž soubor chcete načíst.

file_path

str

Vyžadováno

Cesta k souboru úkolu, ze kterého chcete získat obsah.

file_get_from_task_options

FileGetFromTaskOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

callback

Callable[<xref:Bytes>, <xref:response=None>]

výchozí hodnota: None

Pokud je tato možnost zadána, bude volána s každým datovým proudem. Zpětné volání by mělo mít dva argumenty, bajty aktuálního bloku dat a objekt odpovědi. Pokud se data nahrávají, odpověď bude Žádná.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

object nebo ClientRawResponse if raw=true

Návratový typ

Generator,

ClientRawResponse

Výjimky

BatchErrorException

get_properties_from_compute_node

Získá vlastnosti zadaného souboru výpočetního uzlu.

get_properties_from_compute_node(pool_id, node_id, file_path, file_get_properties_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

pool_id

str

Vyžadováno

ID fondu, který obsahuje výpočetní uzel.

node_id

str

Vyžadováno

ID výpočetního uzlu, který obsahuje soubor.

file_path

str

Vyžadováno

Cesta k souboru výpočetního uzlu, pro který chcete získat vlastnosti.

file_get_properties_from_compute_node_options

FileGetPropertiesFromComputeNodeOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

None nebo ClientRawResponse if raw=true

Návratový typ

None,

ClientRawResponse

Výjimky

BatchErrorException

get_properties_from_task

Získá vlastnosti zadaného souboru úlohy.

get_properties_from_task(job_id, task_id, file_path, file_get_properties_from_task_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy, která obsahuje úkol.

task_id

str

Vyžadováno

ID úlohy, jejíž soubor chcete získat vlastnosti.

file_path

str

Vyžadováno

Cesta k souboru úlohy, pro který chcete získat vlastnosti.

file_get_properties_from_task_options

FileGetPropertiesFromTaskOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

None nebo ClientRawResponse if raw=true

Návratový typ

None,

ClientRawResponse

Výjimky

BatchErrorException

list_from_compute_node

Zobrazí seznam všech souborů v adresářích úloh na zadaném výpočetním uzlu.

list_from_compute_node(pool_id, node_id, recursive=None, file_list_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

pool_id

str

Vyžadováno

ID fondu, který obsahuje výpočetní uzel.

node_id

str

Vyžadováno

ID výpočetního uzlu, jehož soubory chcete vypsat.

recursive

bool

výchozí hodnota: None

Určuje, jestli se mají zobrazit podřízené položky adresáře.

file_list_from_compute_node_options

FileListFromComputeNodeOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

Iterátor, jako je instance NodeFile

Návratový typ

NodeFilePaged[NodeFile]

Výjimky

BatchErrorException

list_from_task

Zobrazí seznam souborů v adresáři úlohy na výpočetním uzlu.

list_from_task(job_id, task_id, recursive=None, file_list_from_task_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy, která obsahuje úkol.

task_id

str

Vyžadováno

ID úlohy, jejíž soubory chcete vypsat.

recursive

bool

výchozí hodnota: None

Určuje, jestli se mají zobrazit podřízené položky adresáře úloh. Tento parametr lze použít v kombinaci s parametrem filtru k výpisu konkrétního typu souborů.

file_list_from_task_options

FileListFromTaskOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

Iterátor, jako je instance NodeFile

Návratový typ

NodeFilePaged[NodeFile]

Výjimky

BatchErrorException

Atributy

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>