Path - Read
Read File
Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see Specifying Conditional Headers for Blob Service Operations.
GET https://{accountName}.{dnsSuffix}/{filesystem}/{path}
GET https://{accountName}.{dnsSuffix}/{filesystem}/{path}?timeout={timeout}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
The Azure Storage account name. |
dns
|
path | True |
string |
The DNS suffix for the Azure Data Lake Storage endpoint. |
filesystem
|
path | True |
string |
The filesystem identifier. Regex pattern: |
path
|
path | True |
string |
The file or directory path. |
timeout
|
query |
integer int32 |
An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
Range |
string |
The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved. |
|
x-ms-lease-id |
string |
Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path. Regex pattern: |
|
x-ms-range-get-content-md5 |
boolean |
Optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request). |
|
If-Match |
string |
Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes. |
|
If-None-Match |
string |
Optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes. |
|
If-Modified-Since |
string |
Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. |
|
If-Unmodified-Since |
string |
Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. |
|
x-ms-encryption-key |
string |
Optional. The Base64-encoded AES-256 encryption key. |
|
x-ms-encryption-key-sha256 |
string |
Optional. The Base64-encoded SHA256 hash of the encryption key. |
|
x-ms-encryption-algorithm: AES256 |
string |
Optional. Specifies the algorithm to use for encryption. The value of this header must be AES256. |
|
x-ms-client-request-id |
string |
A UUID recorded in the analytics logs for troubleshooting and correlation. Regex pattern: |
|
x-ms-date |
string |
Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization. |
|
x-ms-version |
string |
Specifies the version of the REST protocol used for processing the request. This is required when using shared key authorization. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
file |
Ok Media Types: "application/json", "application/octet-stream", "text/plain" Headers
|
Other Status Codes |
file |
Partial content Media Types: "application/json", "application/octet-stream", "text/plain" Headers
|
Other Status Codes |
An error occurred. The possible HTTP status, code, and message strings are listed below:
Media Types: "application/json", "application/octet-stream", "text/plain" Headers
|
Definitions
Name | Description |
---|---|
Data |
|
Error |
The service error response object. |
DataLakeStorageError
Name | Type | Description |
---|---|---|
error |
The service error response object. |
Error
The service error response object.
Name | Type | Description |
---|---|---|
code |
string |
The service error code. |
message |
string |
The service error message. |