Partager via


FileOperations Classe

Opérations FileOperations.

Vous ne devez pas instancier directement cette classe, mais créer un instance client qui la créera pour vous et l’attachera en tant qu’attribut.

Héritage
builtins.object
FileOperations

Constructeur

FileOperations(client, config, serializer, deserializer)

Paramètres

client
Obligatoire

Client pour les demandes de service.

config
Obligatoire

Configuration du client de service.

serializer
Obligatoire

Sérialiseur de modèle objet.

deserializer
Obligatoire

Désérialiseur de modèle objet.

Variables

api_version

Version de l’API à utiliser pour la requête. Valeur constante : « 2023-05-01.17.0 ».

Méthodes

delete_from_compute_node

Supprime le fichier spécifié du nœud de calcul.

delete_from_task

Supprime le fichier de tâche spécifié du nœud de calcul où la tâche s’est exécutée.

get_from_compute_node

Retourne le contenu du fichier de nœud de calcul spécifié.

get_from_task

Retourne le contenu du fichier Task spécifié.

get_properties_from_compute_node

Obtient les propriétés du fichier de nœud de calcul spécifié.

get_properties_from_task

Obtient les propriétés du fichier Task spécifié.

list_from_compute_node

Répertorie tous les fichiers dans les répertoires de tâches sur le nœud de calcul spécifié.

list_from_task

Répertorie les fichiers dans le répertoire d’une tâche sur son nœud de calcul.

delete_from_compute_node

Supprime le fichier spécifié du nœud de calcul.

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)

Paramètres

pool_id
str
Obligatoire

ID du pool qui contient le nœud de calcul.

node_id
str
Obligatoire

ID du nœud de calcul à partir duquel vous souhaitez supprimer le fichier.

file_path
str
Obligatoire

Chemin d’accès au fichier ou au répertoire que vous souhaitez supprimer.

recursive
bool
valeur par défaut: None

Indique s’il faut supprimer les enfants d’un répertoire. Si le paramètre filePath représente un répertoire au lieu d’un fichier, vous pouvez définir récursif sur true pour supprimer le répertoire et tous les fichiers et sous-répertoires qu’il contient. Si la valeur récursive est false, le répertoire doit être vide ou la suppression échoue.

file_delete_from_compute_node_options
FileDeleteFromComputeNodeOptions
valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers
dict
valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw
bool
valeur par défaut: False

retourne la réponse directe en même temps que la réponse désérialisée

operation_config
Obligatoire

Remplacements de configuration d’opération.

Retours

None ou ClientRawResponse si raw=true

Type de retour

None,

Exceptions

delete_from_task

Supprime le fichier de tâche spécifié du nœud de calcul où la tâche s’est exécutée.

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

Paramètres

job_id
str
Obligatoire

ID du travail qui contient la tâche.

task_id
str
Obligatoire

ID de la tâche dont vous souhaitez supprimer le fichier.

file_path
str
Obligatoire

Chemin d’accès au fichier ou répertoire Tâche que vous souhaitez supprimer.

recursive
bool
valeur par défaut: None

Indique s’il faut supprimer les enfants d’un répertoire. Si le paramètre filePath représente un répertoire au lieu d’un fichier, vous pouvez définir récursif sur true pour supprimer le répertoire et tous les fichiers et sous-répertoires qu’il contient. Si la valeur récursive est false, le répertoire doit être vide ou la suppression échoue.

file_delete_from_task_options
FileDeleteFromTaskOptions
valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers
dict
valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw
bool
valeur par défaut: False

retourne la réponse directe en même temps que la réponse désérialisée

operation_config
Obligatoire

Remplacements de configuration d’opération.

Retours

None ou ClientRawResponse si raw=true

Type de retour

None,

Exceptions

get_from_compute_node

Retourne le contenu du fichier de nœud de calcul spécifié.

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)

Paramètres

pool_id
str
Obligatoire

ID du pool qui contient le nœud de calcul.

node_id
str
Obligatoire

ID du nœud de calcul qui contient le fichier.

file_path
str
Obligatoire

Chemin d’accès au fichier de nœud de calcul dont vous souhaitez obtenir le contenu.

file_get_from_compute_node_options
FileGetFromComputeNodeOptions
valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers
dict
valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw
bool
valeur par défaut: False

retourne la réponse directe en même temps que la réponse désérialisée

callback
Callable[<xref:Bytes>, <xref:response=None>]
valeur par défaut: None

Quand il est spécifié, est appelé avec chaque bloc de données qui est diffusé en continu. Le rappel doit prendre deux arguments, les octets du bloc de données actuel et l’objet de réponse. Si les données sont en cours de chargement, la réponse est None.

operation_config
Obligatoire

Remplacements de configuration d’opération.

Retours

object ou ClientRawResponse si raw=true

Type de retour

Exceptions

get_from_task

Retourne le contenu du fichier Task spécifié.

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

Paramètres

job_id
str
Obligatoire

ID du travail qui contient la tâche.

task_id
str
Obligatoire

ID de la tâche dont vous souhaitez récupérer le fichier.

file_path
str
Obligatoire

Chemin d’accès au fichier tâche dont vous souhaitez obtenir le contenu.

file_get_from_task_options
FileGetFromTaskOptions
valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers
dict
valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw
bool
valeur par défaut: False

retourne la réponse directe en même temps que la réponse désérialisée

callback
Callable[<xref:Bytes>, <xref:response=None>]
valeur par défaut: None

Quand il est spécifié, est appelé avec chaque bloc de données qui est diffusé en continu. Le rappel doit prendre deux arguments, les octets du bloc de données actuel et l’objet de réponse. Si les données sont en cours de chargement, la réponse est None.

operation_config
Obligatoire

Remplacements de configuration d’opération.

Retours

object ou ClientRawResponse si raw=true

Type de retour

Exceptions

get_properties_from_compute_node

Obtient les propriétés du fichier de nœud de calcul spécifié.

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)

Paramètres

pool_id
str
Obligatoire

ID du pool qui contient le nœud de calcul.

node_id
str
Obligatoire

ID du nœud de calcul qui contient le fichier.

file_path
str
Obligatoire

Chemin d’accès au fichier de nœud de calcul dont vous souhaitez obtenir les propriétés.

file_get_properties_from_compute_node_options
FileGetPropertiesFromComputeNodeOptions
valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers
dict
valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw
bool
valeur par défaut: False

retourne la réponse directe en même temps que la réponse désérialisée

operation_config
Obligatoire

Remplacements de configuration d’opération.

Retours

None ou ClientRawResponse si raw=true

Type de retour

None,

Exceptions

get_properties_from_task

Obtient les propriétés du fichier Task spécifié.

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

Paramètres

job_id
str
Obligatoire

ID du travail qui contient la tâche.

task_id
str
Obligatoire

ID de la tâche dont vous souhaitez obtenir les propriétés.

file_path
str
Obligatoire

Chemin d’accès au fichier tâche dont vous souhaitez obtenir les propriétés.

file_get_properties_from_task_options
FileGetPropertiesFromTaskOptions
valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers
dict
valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw
bool
valeur par défaut: False

retourne la réponse directe en même temps que la réponse désérialisée

operation_config
Obligatoire

Remplacements de configuration d’opération.

Retours

None ou ClientRawResponse si raw=true

Type de retour

None,

Exceptions

list_from_compute_node

Répertorie tous les fichiers dans les répertoires de tâches sur le nœud de calcul spécifié.

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

Paramètres

pool_id
str
Obligatoire

ID du pool qui contient le nœud de calcul.

node_id
str
Obligatoire

ID du nœud de calcul dont vous souhaitez répertorier les fichiers.

recursive
bool
valeur par défaut: None

Indique s’il faut répertorier les enfants d’un annuaire.

file_list_from_compute_node_options
FileListFromComputeNodeOptions
valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers
dict
valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw
bool
valeur par défaut: False

retourne la réponse directe en même temps que la réponse désérialisée

operation_config
Obligatoire

Remplacements de configuration d’opération.

Retours

Un itérateur comme instance de NodeFile

Type de retour

Exceptions

list_from_task

Répertorie les fichiers dans le répertoire d’une tâche sur son nœud de calcul.

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

Paramètres

job_id
str
Obligatoire

ID du travail qui contient la tâche.

task_id
str
Obligatoire

ID de la tâche dont vous souhaitez répertorier les fichiers.

recursive
bool
valeur par défaut: None

Indique s’il faut répertorier les enfants du répertoire Des tâches. Ce paramètre peut être utilisé en combinaison avec le paramètre de filtre pour répertorier un type spécifique de fichiers.

file_list_from_task_options
FileListFromTaskOptions
valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers
dict
valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw
bool
valeur par défaut: False

retourne la réponse directe en même temps que la réponse désérialisée

operation_config
Obligatoire

Remplacements de configuration d’opération.

Retours

Un itérateur comme instance de NodeFile

Type de retour

Exceptions

Attributs

models

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