File - Get From Task

  • Referência
Service:
Batch Service
API Version:
2023-11-01.18.0

Devolve o conteúdo do ficheiro de Tarefa especificado.

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

Parâmetros do URI

Name Em Necessário Tipo Description
batchUrl
 path True

string

O URL base para todos os pedidos de serviço Azure Batch.
filePath
 path True

string

O caminho para o ficheiro de Tarefas do qual pretende obter o conteúdo.
jobId
 path True

string

O ID da Tarefa que contém a Tarefa.
taskId
 path True

string

O ID da Tarefa cujo ficheiro pretende obter.
api-version
 query True

string

Versão da API de Cliente.
timeout
 query

integer

int32

O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name Necessário Tipo Description
client-request-id

string

uuid

A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Se o servidor deve devolver o client-request-id na resposta.
ocp-date

string

date-time-rfc1123

A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente.
ocp-range

string

O intervalo de bytes a obter. A predefinição é obter todo o ficheiro. O formato é bytes=startRange-endRange.
If-Modified-Since

string

date-time-rfc1123

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação só será efetuada se o recurso no serviço tiver sido modificado desde a hora especificada.
If-Unmodified-Since

string

date-time-rfc1123

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação só será efetuada se o recurso no serviço não tiver sido modificado desde a hora especificada.

Respostas

Name Tipo Description
200 OK

object

Uma resposta que contém o conteúdo do ficheiro.

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

O erro do serviço Batch.

Media Types: "application/json", "application/octet-stream"

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

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

Scopes

Name Description
user_impersonation Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

Get File From Task

Sample Request

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"

Definições

Name Description
BatchError

Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

BatchError

Uma resposta de erro recebida do serviço Azure Batch.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message

ErrorMessage

Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
values

BatchErrorDetail[]

Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Valor.
value

string

As informações adicionais incluídas na resposta do erro.

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

Name Tipo Description
lang

string

O código de idioma da mensagem de erro
value

string

O texto da mensagem.