File - Get From Task

Servizio:

Batch Service

Versione API:

2024-07-01.20.0

Restituisce il contenuto del file attività specificato.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?api-version=2024-07-01.20.0

Con parametri facoltativi:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?timeout={timeout}&api-version=2024-07-01.20.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste del servizio Azure Batch.
filePath	path	True	string	Percorso del file attività di cui si vuole ottenere il contenuto.
jobId	path	True	string	ID del processo che contiene l'attività.
taskId	path	True	string	ID dell'attività di cui si desidera recuperare il file.
api-version	query	True	string	Versione dell'API client.
timeout	query		integer (int32)	Tempo massimo di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è maggiore di 30, verrà usato il valore predefinito.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
client-request-id		string (uuid)	Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indica se il server deve restituire l'ID richiesta client nella risposta.
ocp-date		string (date-time-rfc1123)	Ora di emissione della richiesta. Le librerie client in genere impostano questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.
ocp-range		string	Intervallo di byte da recuperare. L'impostazione predefinita consiste nel recuperare l'intero file. Il formato è bytes=startRange-endRange.
If-Modified-Since		string (date-time-rfc1123)	Timestamp che indica l'ora dell'ultima modifica della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio è stata modificata dall'ora specificata.
If-Unmodified-Since		string (date-time-rfc1123)	Timestamp che indica l'ora dell'ultima modifica della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio non è stata modificata dall'ora specificata.

Risposte

Nome	Tipo	Descrizione
200 OK	object	Risposta contenente il contenuto del file. Media Types: "application/json", "application/octet-stream" Intestazioni 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	Errore del servizio Batch. Media Types: "application/json", "application/octet-stream"

Sicurezza

azure_auth

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

Get File From Task

Esempio di richiesta

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/task1/files/wd\testFile.txt?api-version=2024-07-01.20.0

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.

BatchError

Object

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	ErrorMessage	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Object

Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta di errore.

ErrorMessage

Object

Messaggio di errore ricevuto in una risposta di errore di Azure Batch.

Nome	Tipo	Descrizione
lang	string	Codice linguistico del messaggio di errore
value	string	Testo del messaggio.