File - List From Task

Referência

Service:: Batch Service

API Version:: 2023-11-01.18.0

Lista os ficheiros no diretório de uma Tarefa no respetivo Nó de Computação.

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

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&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.
jobId	path	True	string	O ID da Tarefa que contém a Tarefa.
taskId	path	True	string	O ID da Tarefa cujos ficheiros pretende listar.
api-version	query	True	string	Versão da API de Cliente.
$filter	query		string	Uma cláusula OData $filter. Para obter mais informações sobre como construir este filtro, consulte https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults	query		integer int32	O número máximo de itens a devolver na resposta. Pode ser devolvido um máximo de 1000 ficheiros.
recursive	query		boolean	Se pretende listar subordinados do diretório Tarefa. Este parâmetro pode ser utilizado em combinação com o parâmetro de filtro para listar tipos específicos de ficheiros.
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	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.

Respostas

Name	Tipo	Description
200 OK	NodeFileListResult	Uma resposta que contém a lista de ficheiros. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço Batch.

Name

Tipo

Description

200 OK

NodeFileListResult

Uma resposta que contém a lista de ficheiros.

Headers

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

Other Status Codes

BatchError

O erro do serviço Batch.

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

File list from task

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/files?recursive=False&api-version=2023-11-01.18.0

Sample Response

Status code:: 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": "2014-09-19T21:56:17.679195Z",
        "lastModified": "2014-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": "2014-09-19T21:56:17.5590855Z",
        "lastModified": "2014-09-19T21:56:17.5590855Z",
        "contentLength": 0,
        "contentType": "application/octet-stream"
      }
    }
  ]
}

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.
FileProperties	As propriedades de um ficheiro num Nó de Computação.
NodeFile	Informações sobre um ficheiro ou diretório num Nó de Computação.
NodeFileListResult	O resultado da listagem dos ficheiros num Nó de Computação ou dos ficheiros associados a uma Tarefa num Nó de Computação.

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.

FileProperties

As propriedades de um ficheiro num Nó de Computação.

Name	Tipo	Description
contentLength	integer	O comprimento do ficheiro.
contentType	string	O tipo de conteúdo do ficheiro.
creationTime	string	A hora de criação do ficheiro. A hora de criação não é devolvida para ficheiros em Nós de Computação do Linux.
fileMode	string	O atributo do modo de ficheiro no formato octal. O modo de ficheiro é devolvido apenas para ficheiros em Nós de Computação do Linux.
lastModified	string	A hora em que o ficheiro foi modificado pela última vez.

NodeFile

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

Name	Tipo	Description
isDirectory	boolean	Se o objeto representa um diretório.
name	string	O caminho do ficheiro.
properties	FileProperties	As propriedades do ficheiro.
url	string	O URL do ficheiro.

NodeFileListResult

O resultado da listagem dos ficheiros num Nó de Computação ou dos ficheiros associados a uma Tarefa num Nó de Computação.

Name	Tipo	Description
odata.nextLink	string	O URL para obter o próximo conjunto de resultados.
value	NodeFile[]	A lista de ficheiros.

File - List From Task

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

azure_auth

Scopes

Authorization

Exemplos

File list from task

Sample Request

Sample Response

Definições

BatchError

BatchErrorDetail

ErrorMessage

FileProperties

NodeFile

NodeFileListResult

Recursos adicionais