File - List From Task

Service:

Batch Service

API Version:

2023-11-01.18.0

Bir Görevin dizinindeki dosyaları İşlem Düğümünde listeler.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
batchUrl	path	True	string	Tüm Azure Batch hizmet isteklerinin temel URL'si.
jobId	path	True	string	Görevi içeren İşin kimliği.
taskId	path	True	string	Dosyalarını listelemek istediğiniz Görevin kimliği.
api-version	query	True	string	İstemci API Sürümü.
$filter	query		string	OData $filter yan tümcesi. Bu filtreyi oluşturma hakkında daha fazla bilgi için bkz https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. .
maxresults	query		integer int32	Yanıtta döndürülecek en fazla öğe sayısı. En fazla 1000 dosya döndürülebilir.
recursive	query		boolean	Görev dizininin alt öğelerinin listelenip listelenmeyeceği. Bu parametre, belirli dosya türlerini listelemek için filtre parametresiyle birlikte kullanılabilir.
timeout	query		integer int32	Sunucunun isteği işlemek için harcayabileceği en uzun süre (saniye olarak). Varsayılan değer 30 saniyedir.

İstek Başlığı

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

Name	Gerekli	Tür	Description
client-request-id		string uuid	Çağıran tarafından oluşturulan istek kimliği, küme ayraçları gibi dekorasyonu olmayan bir GUID biçimindedir; örneğin 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Sunucunun yanıtta client-request-id döndürip döndürmeyeceği.
ocp-date		string date-time-rfc1123	İsteğin verildiği saat. İstemci kitaplıkları bunu genellikle geçerli sistem saat saatine ayarlar; REST API'yi doğrudan çağırıyorsanız açıkça ayarlayın.

Yanıtlar

Name	Tür	Description
200 OK	NodeFileListResult	Dosya listesini içeren bir yanıt. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch hizmetinden gelen hata.

Güvenlik

azure_auth

OAuth 2.0 kimlik doğrulama kodu akışını Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Kullanıcı hesabınızın kimliğine bürünme

Authorization

Type: apiKey
In: header

Örnekler

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

Tanımlar

Name	Description
BatchError	Azure Batch hizmetinden alınan bir hata yanıtı.
BatchErrorDetail	Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.
ErrorMessage	Azure Batch hata yanıtında bir hata iletisi alındı.
FileProperties	İşlem Düğümündeki bir dosyanın özellikleri.
NodeFile	İşlem Düğümündeki bir dosya veya dizin hakkında bilgi.
NodeFileListResult	İşlem Düğümündeki dosyaları veya İşlem Düğümündeki bir Görevle ilişkili dosyaları listelemenin sonucu.

BatchError

Azure Batch hizmetinden alınan bir hata yanıtı.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
message	ErrorMessage	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
values	BatchErrorDetail[]	Hatayla ilgili ek ayrıntıları içeren anahtar-değer çiftleri koleksiyonu.

BatchErrorDetail

Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.

Name	Tür	Description
key	string	Value özelliğinin anlamını belirten tanımlayıcı.
value	string	Hata yanıtına eklenen ek bilgiler.

ErrorMessage

Azure Batch hata yanıtında bir hata iletisi alındı.

Name	Tür	Description
lang	string	Hata iletisinin dil kodu
value	string	İletinin metni.

FileProperties

İşlem Düğümündeki bir dosyanın özellikleri.

Name	Tür	Description
contentLength	integer	Dosyanın uzunluğu.
contentType	string	Dosyanın içerik türü.
creationTime	string	Dosya oluşturma zamanı. Linux İşlem Düğümleri üzerindeki dosyalar için oluşturma süresi döndürülmüyor.
fileMode	string	Sekizli biçimde dosya modu özniteliği. Dosya modu yalnızca Linux İşlem Düğümleri üzerindeki dosyalar için döndürülür.
lastModified	string	Dosyanın en son değiştirildiği saat.

NodeFile

İşlem Düğümündeki bir dosya veya dizin hakkında bilgi.

Name	Tür	Description
isDirectory	boolean	Nesnenin bir dizini temsil edip etmediği.
name	string	Dosya yolu.
properties	FileProperties	Dosya özellikleri.
url	string	Dosyanın URL'si.

NodeFileListResult

İşlem Düğümündeki dosyaları veya İşlem Düğümündeki bir Görevle ilişkili dosyaları listelemenin sonucu.

Name	Tür	Description
odata.nextLink	string	Sonraki sonuç kümesini almak için URL.
value	NodeFile[]	Dosya listesi.