File - Get From Task

Service:

Batch Service

API Version:

2023-11-01.18.0

Retourne le contenu du fichier de tâches spécifié.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?timeout={timeout}&api-version=2023-11-01.18.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
filePath	path	True	string	Chemin d’accès au fichier de tâches dont vous souhaitez obtenir le contenu.
jobId	path	True	string	ID du travail qui contient la tâche.
taskId	path	True	string	ID de la tâche dont vous souhaitez récupérer le fichier.
api-version	query	True	string	Version de l’API cliente.
timeout	query		integer int32	Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

Media Types: "application/json; odata=minimalmetadata"

Nom	Obligatoire	Type	Description
client-request-id		string uuid	Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indique si le serveur doit retourner le client-request-id dans la réponse.
ocp-date		string date-time-rfc1123	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement.
ocp-range		string	Plage d’octets à récupérer. La valeur par défaut consiste à récupérer l’intégralité du fichier. Le format est bytes=startRange-endRange.
If-Modified-Since		string date-time-rfc1123	Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération est effectuée uniquement si la ressource sur le service a été modifiée depuis l’heure spécifiée.
If-Unmodified-Since		string date-time-rfc1123	Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

Réponses

Nom	Type	Description
200 OK	object	Réponse contenant le contenu du fichier. Media Types: "application/json", "application/octet-stream" Headers client-request-id: string request-id: string ETag: string Last-Modified: string ocp-creation-time: string ocp-batch-file-isdirectory: boolean ocp-batch-file-url: string ocp-batch-file-mode: string Content-Type: string Content-Length: integer
Other Status Codes	BatchError	Erreur du service Batch. Media Types: "application/json", "application/octet-stream"

Sécurité

azure_auth

Microsoft Entra flux de code d’authentification OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

Get File From Task

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/task1/files/wd\testFile.txt?api-version=2023-11-01.18.0

Sample Response

Status code:

200

"This is actually a byte stream. This request/response is being presented as a string for readability in the example"

Définitions

Nom	Description
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.

BatchError

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 programmation.
message	ErrorMessage	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

Élément d’informations supplémentaires incluses 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.

ErrorMessage

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

Nom	Type	Description
lang	string	Code de langue du message d’erreur
value	string	Texte du message.