File - List From Task

Referenz

Dienst:: Batch Service

API-Version:: 2023-11-01.18.0

Listet die Dateien im Verzeichnis einer Aufgabe auf dem Computeknoten auf.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
jobId	path	True	string	Die ID des Auftrags, der den Task enthält.
taskId	path	True	string	Die ID der Aufgabe, deren Dateien Sie auflisten möchten.
api-version	query	True	string	Client-API-Version.
$filter	query		string	Eine OData $filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults	query		integer int32	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Es können maximal 1000 Dateien zurückgegeben werden.
recursive	query		boolean	Gibt an, ob untergeordnete Elemente des Aufgabenverzeichnisses aufgelistet werden sollen. Dieser Parameter kann in Kombination mit dem Filterparameter verwendet werden, um einen bestimmten Dateityp aufzulisten.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name	Typ	Beschreibung
client-request-id	string uuid	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date	string date-time-rfc1123	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. explizit festlegen, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	NodeFileListResult	Eine Antwort, die die Liste der Dateien enthält. Header client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst.

Name

Typ

Beschreibung

200 OK

NodeFileListResult

Eine Antwort, die die Liste der Dateien enthält.

Header

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

Other Status Codes

BatchError

Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

File list from task

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.
FileProperties	Die Eigenschaften einer Datei auf einem Computeknoten.
NodeFile	Informationen zu einer Datei oder einem Verzeichnis auf einem Computeknoten.
NodeFileListResult	Das Ergebnis der Auflistung der Dateien auf einem Computeknoten oder der Dateien, die einem Task auf einem Computeknoten zugeordnet sind.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.

Name	Typ	Beschreibung
key	string	Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value	string	Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung
value	string	Der Text der Meldung.

FileProperties

Die Eigenschaften einer Datei auf einem Computeknoten.

Name	Typ	Beschreibung
contentLength	integer	Die Länge der Datei.
contentType	string	Der Inhaltstyp der Datei.
creationTime	string	Die Erstellungszeit der Datei. Die Erstellungszeit wird für Dateien auf Linux-Computeknoten nicht zurückgegeben.
fileMode	string	Das Dateimodus-Attribut im oktalen Format. Der Dateimodus wird nur für Dateien auf Linux-Computeknoten zurückgegeben.
lastModified	string	Der Zeitpunkt, zu dem die Datei zuletzt geändert wurde.

NodeFile

Informationen zu einer Datei oder einem Verzeichnis auf einem Computeknoten.

Name	Typ	Beschreibung
isDirectory	boolean	Gibt an, ob das Objekt ein Verzeichnis darstellt.
name	string	Der Dateipfad.
properties	FileProperties	Die Dateieigenschaften.
url	string	Die URL der Datei.

NodeFileListResult

Das Ergebnis der Auflistung der Dateien auf einem Computeknoten oder der Dateien, die einem Task auf einem Computeknoten zugeordnet sind.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL zum Abrufen der nächsten Gruppe von Ergebnissen.
value	NodeFile[]	Die Liste der Dateien.

Freigeben über

File - List From Task

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Authorization

Beispiele

File list from task

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchError

BatchErrorDetail

ErrorMessage

FileProperties

NodeFile

NodeFileListResult

Zusätzliche Ressourcen