Tasks - List Task Files

Service:: Batch Service

Version d'API:: 2025-06-01

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

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/files?api-version=2025-06-01

Avec des paramètres facultatifs:

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/files?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}&recursive={recursive}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Point de terminaison de compte Batch (par exemple : https://batchaccount.eastus2.batch.azure.com).
jobId	path	True	string	L’ID du Job qui contient la Tâche.
taskId	path	True	string	L’ID de la tâche dont vous souhaitez lister les fichiers.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$filter	query		string	Clause OData $filter. Pour plus d’informations sur la construction de ce filtre, voir https://dotnet.territoriali.olinfo.it/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1000 candidatures peuvent être retournées.
recursive	query		boolean	S’il faut lister les enfants du répertoire Tâches. Ce paramètre peut être utilisé en combinaison avec le paramètre filtre pour lister des types spécifiques de fichiers.
timeOut	query		integer (int32)	Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, le par défaut sera utilisé à la place. »

En-tête de la demande

Nom	Type	Description
client-request-id	string	L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Indique si le serveur doit retourner l’ID client-request-id dans la réponse.
ocp-date	string (date-time-rfc7231)	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST.

Réponses

Nom	Type	Description
200 OK	BatchNodeFileListResult	La demande a réussi. En-têtes ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

BatchNodeFileListResult

La demande a réussi.

En-têtes

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://batch.core.windows.net//.default

Exemples

File list from task

Exemple de requête

HTTP

GET {endpoint}/jobs/jobId/tasks/taskId/files?api-version=2025-06-01&recursive=False

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "name": "startup\\ProcessEnv.cmd",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup/ProcessEnv.cmd",
      "isDirectory": false,
      "properties": {
        "creationTime": "2025-09-19T21:56:17.679195Z",
        "lastModified": "2025-09-19T21:56:17.679195Z",
        "contentLength": "1813",
        "contentType": "application/octet-stream"
      }
    },
    {
      "name": "startup\\stderr.txt",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup/stderr.txt",
      "isDirectory": false,
      "properties": {
        "creationTime": "2025-09-19T21:56:17.5590855Z",
        "lastModified": "2025-09-19T21:56:17.5590855Z",
        "contentLength": "0",
        "contentType": "application/octet-stream"
      }
    }
  ]
}

Définitions

Nom	Description
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
BatchErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
BatchNodeFile	Informations sur un fichier ou un répertoire sur un nœud de calcul.
BatchNodeFileListResult	Résultat de la liste des fichiers sur un nœud de calcul ou des fichiers associés à une tâche sur un nœud de calcul.
FileProperties	Propriétés d’un fichier sur un nœud de calcul.

BatchError

Objet

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
message	BatchErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Objet

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

BatchErrorMessage

Objet

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom	Type	Description
lang	string	Le code de langue du message d’erreur.
value	string	Le texte du message.

BatchNodeFile

Objet

Informations sur un fichier ou un répertoire sur un nœud de calcul.

Nom	Type	Description
isDirectory	boolean	Que l’objet représente un répertoire.
name	string	Chemin d'accès au fichier.
properties	FileProperties	Les propriétés du fichier.
url	string (uri)	URL du fichier.

BatchNodeFileListResult

Objet

Résultat de la liste des fichiers sur un nœud de calcul ou des fichiers associés à une tâche sur un nœud de calcul.

Nom	Type	Description
odata.nextLink	string (uri)	L’URL permettant d’obtenir la prochaine série de résultats.
value	BatchNodeFile[]	La liste des fichiers.

FileProperties

Objet

Propriétés d’un fichier sur un nœud de calcul.

Nom	Type	Description
contentLength	string (int64)	La longueur du dossier.
contentType	string	Type de contenu du fichier.
creationTime	string (date-time)	Le temps de création du fichier. Le temps de création n’est pas retourné pour les fichiers sur Linux Compute Nodes.
fileMode	string	L’attribut du mode fichier est au format octal. Le mode fichier n’est retourné que pour les fichiers sur Linux Compute Nodes.
lastModified	string (date-time)	Le moment auquel le fichier a été modifié pour la dernière fois.

Partager via

Tasks - List Task Files

Paramètres URI

En-tête de la demande

Réponses

Sécurité

OAuth2Auth

Étendues

Exemples

File list from task

Exemple de requête

Exemple de réponse

Définitions

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeFile

BatchNodeFileListResult

FileProperties