Compartilhar via

Tasks - List Task Files

Serviço:
Batch Service
Versão da API:
2025-06-01

Lista os arquivos no diretório de uma Tarefa em seu Nó de Computação.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string (uri)

Ponto de extremidade da conta do Lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
jobId
 path True

string

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

string

O ID da tarefa cujos arquivos você quer listar.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.
$filter
 query

string

Uma cláusula $filter OData. Para mais informações sobre como construir esse filtro, veja https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults
 query

integer (int32)

minimum: 1
maximum: 1000

O número máximo de itens a serem retornados na resposta. No máximo 1000 solicitações podem ser devolvidas.
recursive
 query

boolean

Se deve listar os filhos do diretório Tarefas. Esse parâmetro pode ser usado em combinação com o parâmetro de filtro para listar tipos específicos de arquivos.
timeOut
 query

integer (int32)

O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado em seu lugar.".

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
client-request-id

string

A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Se o servidor deve retornar a ID de solicitação do cliente na resposta.
ocp-date

string (date-time-rfc7231)

A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Nome Tipo Description
200 OK

BatchNodeFileListResult

A solicitação foi bem-sucedida.

Cabeçalhos

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

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

Exemplos

File list from task

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
      }
    }
  ]
}

Definições

Nome Description
BatchError

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

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
BatchErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
BatchNodeFile

Informações sobre um arquivo ou diretório em um Nó de Computação.
BatchNodeFileListResult

O resultado da listagem dos arquivos em um Nó de Computação ou os arquivos associados a uma Tarefa em um Nó de Computação.
FileProperties

As propriedades de um arquivo em um Nó de Computação.

BatchError

Objeto

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

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message

BatchErrorMessage

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
values

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Objeto

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Nome Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.
value

string

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

BatchErrorMessage

Objeto

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Nome Tipo Description
lang

string

O código de idioma da mensagem de erro.
value

string

O texto da mensagem.

BatchNodeFile

Objeto

Informações sobre um arquivo ou diretório em um Nó de Computação.

Nome Tipo Description
isDirectory

boolean

Se o objeto representa um diretório.
name

string

O caminho do arquivo.
properties

FileProperties

As propriedades do arquivo.
url

string (uri)

A URL do arquivo.

BatchNodeFileListResult

Objeto

O resultado da listagem dos arquivos em um Nó de Computação ou os arquivos associados a uma Tarefa em um Nó de Computação.

Nome Tipo Description
odata.nextLink

string (uri)

A URL para obter o próximo conjunto de resultados.
value

BatchNodeFile[]

A lista de arquivos.

FileProperties

Objeto

As propriedades de um arquivo em um Nó de Computação.

Nome Tipo Description
contentLength

string (int64)

O tamanho do arquivo.
contentType

string

O tipo de conteúdo do arquivo.
creationTime

string (date-time)

O tempo de criação do arquivo. O tempo de criação não é retornado para arquivos nos Nós de Computação do Linux.
fileMode

string

O atributo modo de arquivo em formato octal. O modo de arquivo é retornado apenas para arquivos em Nós de Computação do Linux.
lastModified

string (date-time)

O momento em que o arquivo foi modificado pela última vez.