File - Get From Task
指定したタスク ファイルの内容を返します。
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?api-version=2023-11-01.18.0
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?timeout={timeout}&api-version=2023-11-01.18.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
batch
|
path | True |
string |
すべてのAzure Batchサービス要求のベース URL。 |
file
|
path | True |
string |
コンテンツを取得するタスク ファイルへのパス。 |
job
|
path | True |
string |
タスクを含むジョブの ID。 |
task
|
path | True |
string |
取得するファイルを持つタスクの ID。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
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 を直接呼び出す場合は、明示的に設定します。 |
|
ocp-range |
string |
取得するバイト範囲。 既定では、ファイル全体を取得します。 形式は bytes=startRange-endRange です。 |
|
If-Modified-Since |
string date-time-rfc1123 |
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、サービス上のリソースが指定された時刻以降に変更された場合にのみ実行されます。 |
|
If-Unmodified-Since |
string date-time-rfc1123 |
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、指定された時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
object |
ファイルの内容を含む応答。 Media Types: "application/json", "application/octet-stream" ヘッダー
|
Other Status Codes |
Batch サービスからのエラー。 Media Types: "application/json", "application/octet-stream" |
セキュリティ
azure_auth
Microsoft Entra OAuth 2.0 認証コード フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
Authorization
型:
apiKey
/:
header
例
Get File From Task
要求のサンプル
GET account.region.batch.azure.com/jobs/jobId/tasks/task1/files/wd\testFile.txt?api-version=2023-11-01.18.0
応答のサンプル
"This is actually a byte stream. This request/response is being presented as a string for readability in the example"
定義
名前 | 説明 |
---|---|
Batch |
Azure Batch サービスから受信したエラー応答。 |
Batch |
Azure Batchエラー応答に含まれる追加情報の項目。 |
Error |
Azure Batchエラー応答で受信したエラー メッセージ。 |
BatchError
Azure Batch サービスから受信したエラー応答。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。 |
message |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
|
values |
エラーに関する追加の詳細を含むキーと値のペアのコレクション。 |
BatchErrorDetail
Azure Batchエラー応答に含まれる追加情報の項目。
名前 | 型 | 説明 |
---|---|---|
key |
string |
Value プロパティの意味を指定する識別子。 |
value |
string |
エラー応答に含まれる追加情報。 |
ErrorMessage
Azure Batchエラー応答で受信したエラー メッセージ。
名前 | 型 | 説明 |
---|---|---|
lang |
string |
エラー メッセージの言語コード |
value |
string |
メッセージのテキストです。 |