File - List From Task

リファレンス

サービス:: Batch Service

API バージョン:: 2023-11-01.18.0

コンピューティングノード上のタスクのディレクトリ内のファイルを一覧表示します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべてのAzure Batchサービス要求のベース URL。
jobId	path	True	string	タスクを含むジョブの ID。
taskId	path	True	string	ファイルを一覧表示するタスクの ID。
api-version	query	True	string	クライアント API のバージョン。
$filter	query		string	OData $filter 句。このフィルターの構築の詳細については、「」を参照してください https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files。
maxresults	query		integer int32	応答で返される項目の最大数。最大 1,000 個のファイルを返すことができます。
recursive	query		boolean	Task ディレクトリの子を一覧表示するかどうか。このパラメーターは、フィルターパラメーターと組み合わせて使用して、特定の種類のファイルを一覧表示できます。
timeout	query		integer int32	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。

要求ヘッダー

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

名前	型	説明
client-request-id	string uuid	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id	boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date	string date-time-rfc1123	要求が発行された時刻。クライアントライブラリは通常、これを現在のシステムクロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

応答

名前	型	説明
200 OK	NodeFileListResult	ファイルの一覧を含む応答。ヘッダー client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

200 OK

NodeFileListResult

ファイルの一覧を含む応答。

ヘッダー

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

Other Status Codes

BatchError

Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コードフロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

Authorization

型: apiKey
/: header

例

File list from task

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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"
      }
    }
  ]
}

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
ErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
FileProperties	コンピューティングノード上のファイルのプロパティ。
NodeFile	コンピューティングノード上のファイルまたはディレクトリに関する情報。
NodeFileListResult	コンピューティングノード上のファイル、またはコンピューティングノード上のタスクに関連付けられているファイルを一覧表示した結果。

BatchError

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
message	ErrorMessage	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Azure Batchエラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

ErrorMessage

Azure Batch エラー応答で受信したエラーメッセージ。

名前	型	説明
lang	string	エラーメッセージの言語コード
value	string	メッセージのテキストです。

FileProperties

コンピューティングノード上のファイルのプロパティ。

名前	型	説明
contentLength	integer	ファイルの長さ。
contentType	string	ファイルのコンテンツの種類。
creationTime	string	ファイルの作成時刻。 Linux コンピューティングノード上のファイルの作成時刻は返されません。
fileMode	string	8 進数形式のファイルモード属性。ファイルモードは、Linux コンピューティングノード上のファイルに対してのみ返されます。
lastModified	string	ファイルが最後に変更された時刻。

NodeFile

コンピューティングノード上のファイルまたはディレクトリに関する情報。

名前	型	説明
isDirectory	boolean	オブジェクトがディレクトリを表すかどうか。
name	string	ファイルパス。
properties	FileProperties	ファイルのプロパティ。
url	string	ファイルの URL。

NodeFileListResult

コンピューティングノード上のファイル、またはコンピューティングノード上のタスクに関連付けられているファイルを一覧表示した結果。

名前	型	説明
odata.nextLink	string	次の結果セットを取得する URL。
value	NodeFile[]	ファイルの一覧。

次の方法で共有

File - List From Task

URI パラメーター

要求ヘッダー

応答

セキュリティ

azure_auth

スコープ

Authorization

例

File list from task

要求のサンプル

応答のサンプル

定義

BatchError

BatchErrorDetail

ErrorMessage

FileProperties

NodeFile

NodeFileListResult

その他のリソース