DataLakeFileClient class
DataLakeFileClient представляет URL-адрес файла службы хранилища Azure.
- Extends
Конструкторы
Data |
Создает экземпляр DataLakeFileClient из URL-адреса и конвейера. |
Data |
Создает экземпляр DataLakeFileClient на основе URL-адреса и учетных данных. |
Свойства
file |
Имя текущей файловой системы. |
name | Имя текущего пути (каталог или файл). |
Унаследованные свойства
account |
|
credential | Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные |
url | Закодированное значение строки URL-адреса. |
Методы
append(Request |
Передает данные для добавления в файл. Данные можно добавлять только в файл. Чтобы применить к файлу переданные данные, вызовите функцию очистки. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
create(File |
Создайте файл. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
create(Path |
Создайте файл. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
create |
Создайте файл, если он еще не существует. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
create |
Создайте файл, если он еще не существует. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
flush(number, File |
Сбрасывает (записывает) ранее добавленные данные в файл. |
generate |
Доступно только для клиентов, созданных с учетными данными общего ключа. Создает URI подписанного URL-адреса службы (SAS) на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
query(string, File |
Быстрый запрос к файлу в формате JSON или CSV. Пример использования (Node.js):
|
read(number, number, File |
Скачивает файл из службы, включая его метаданные и свойства.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
Пример использования (браузер):
|
read |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Считывает файл Data Lake параллельно с буфером. Смещение и счетчик являются необязательными. Передайте 0 для обоих, чтобы прочитать весь файл. Предупреждение. Буферы могут поддерживать только файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для файлов, превышающих этот размер, рассмотрите возможность readToFile. |
read |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS Считывает файл Data Lake параллельно с буфером. Смещение и счетчик являются необязательными. Передайте 0 для обоих, чтобы прочитать весь файл. Предупреждение. Буферы могут поддерживать только файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для файлов, превышающих этот размер, рассмотрите возможность readToFile. |
read |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Загружает файл Data Lake в локальный файл. Сбой, если указанный путь к файлу уже завершается. Смещение и счетчик являются необязательными, передаются 0 и undefined соответственно, чтобы скачать весь файл. |
set |
Задает время истечения срока действия для файла. После того, как это время будет выполнено, файл удаляется. |
upload(Blob | Array |
Отправляет buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView в файл. |
upload |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет локальный файл в файл Data Lake. |
upload |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет Node.js читаемый поток в файл Data Lake. Этот метод попытается создать файл, а затем начнет отправку фрагментов по блокам. Убедитесь, что потенциальный размер потока не превышает FILE_MAX_SIZE_BYTES, а потенциальное количество блоков не превышает BLOCK_BLOB_MAX_BLOCKS. СОВЕТЫ ПО ПОВЫШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ.
|
Наследуемые методы
delete(boolean, Path |
Удалите текущий путь (каталог или файл). См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
delete |
Удалите текущий путь (каталог или файл), если он существует. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
exists(Path |
Возвращает значение true, если файл Data Lake, представленный этим клиентом, существует; Значение false в противном случае. ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий файл может быть удален другими клиентами или приложениями. В обратном случае новые файлы могут добавляться другими клиентами или приложениями после завершения этой функции. |
get |
Возвращает данные управления доступом для пути (каталога файла). См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties |
get |
Получите Объект DataLakeLeaseClient , который управляет арендой пути (каталог или файл). |
get |
Возвращает все определяемые пользователем метаданные, стандартные свойства HTTP и системные свойства для пути (каталога или файла). ПРЕДУПРЕЖДЕНИЕ. Ключи См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties |
move(string, Path |
Перемещение каталога или файла в одной файловой системе. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
move(string, string, Path |
Перемещение каталога или файла в другую файловую систему. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
remove |
Удаляет контроль доступа в пути и вложенных путях. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
set |
Задайте данные управления доступом для пути (каталога файла). См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
set |
Задает контроль доступа для пути и вложенных путей. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
set |
Задает системные свойства по пути (каталог или файл). Если значение не указано или не указано для указанных HTTP-заголовков BLOB-объектов, эти HTTP-заголовки больших двоичных объектов без значения будут удалены. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Задает определяемые пользователем метаданные для указанного пути (каталога файла) в виде одной или нескольких пар "имя-значение". Если параметр не указан или метаданные не определены в параметре, метаданные пути будут удалены. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
set |
Задает разрешения файла на путь. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
to |
Преобразование текущего DataLakePathClient в DataLakeDirectoryClient, если текущий путь является каталогом. |
to |
Преобразование текущего DataLakePathClient в DataLakeFileClient, если текущий путь является файлом. |
update |
Изменяет контроль доступа в пути и вложенных путях. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
Сведения о конструкторе
DataLakeFileClient(string, Pipeline)
Создает экземпляр DataLakeFileClient из URL-адреса и конвейера.
new DataLakeFileClient(url: string, pipeline: Pipeline)
Параметры
- url
-
string
Строка клиента, указывающая на файл озера данных службы хранилища Azure, например "https://myaccount.dfs.core.windows.net/filesystem/file"". Вы можете добавить SAS при использовании AnonymousCredential, например "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString"".
- pipeline
- Pipeline
Вызовите newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.
DataLakeFileClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Создает экземпляр DataLakeFileClient на основе URL-адреса и учетных данных.
new DataLakeFileClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Параметры
- url
-
string
Строка клиента, указывающая на файл озера данных службы хранилища Azure, например "https://myaccount.dfs.core.windows.net/filesystem/file"". Вы можете добавить SAS при использовании AnonymousCredential, например "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString"".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity
данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект , реализующий интерфейс TokenCredential. Если значение не указано, используется AnonymousCredential.
- options
- StoragePipelineOptions
Необязательный элемент. Параметры для настройки конвейера HTTP.
Сведения о свойстве
fileSystemName
Имя текущей файловой системы.
string fileSystemName
Значение свойства
string
name
Имя текущего пути (каталог или файл).
string name
Значение свойства
string
Сведения об унаследованном свойстве
accountName
credential
Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity
данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Значение свойства
Наследуется отDataLakePathClient.credential
url
Закодированное значение строки URL-адреса.
url: string
Значение свойства
string
Наследуется отDataLakePathClient.url
Сведения о методе
append(RequestBodyType, number, number, FileAppendOptions)
Передает данные для добавления в файл. Данные можно добавлять только в файл. Чтобы применить к файлу переданные данные, вызовите функцию очистки.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function append(body: RequestBodyType, offset: number, length: number, options?: FileAppendOptions): Promise<FileAppendResponse>
Параметры
- body
- HttpRequestBody
Содержимое для отправки.
- offset
-
number
Добавление смещения в байтах.
- length
-
number
Длина добавляемого содержимого в байтах.
- options
- FileAppendOptions
Необязательный элемент. Параметры при добавлении данных.
Возвращаемое значение
Promise<FileAppendResponse>
create(FileCreateOptions)
Создайте файл.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: FileCreateOptions): Promise<FileCreateResponse>
Параметры
- options
- FileCreateOptions
Необязательный элемент. Параметры при создании файла.
Возвращаемое значение
Promise<FileCreateResponse>
create(PathResourceTypeModel, PathCreateOptions)
Создайте файл.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>
Параметры
- resourceType
- PathResourceTypeModel
Тип ресурса должен быть "file" для DataLakeFileClient.
- options
- PathCreateOptions
Необязательный элемент. Параметры при создании файла.
Возвращаемое значение
Promise<PathCreateResponse>
createIfNotExists(FileCreateIfNotExistsOptions)
Создайте файл, если он еще не существует.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: FileCreateIfNotExistsOptions): Promise<FileCreateIfNotExistsResponse>
Параметры
- options
- FileCreateIfNotExistsOptions
Необязательный элемент. Параметры при создании файла.
Возвращаемое значение
Promise<FileCreateIfNotExistsResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
Создайте файл, если он еще не существует.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>
Параметры
- resourceType
- PathResourceTypeModel
Тип ресурса должен быть "file" для DataLakeFileClient.
- options
- PathCreateIfNotExistsOptions
Возвращаемое значение
Promise<PathCreateIfNotExistsResponse>
flush(number, FileFlushOptions)
Сбрасывает (записывает) ранее добавленные данные в файл.
function flush(position: number, options?: FileFlushOptions): Promise<FileFlushResponse>
Параметры
- position
-
number
Позиция файла для очистки. Этот параметр позволяет вызывающему объекту отправлять данные параллельно и управлять порядком их добавления в файл. Это необходимо при отправке данных, которые должны быть добавлены в файл, и при очистке ранее отправленных данных в файл. Значение должно быть позицией, в которой должны быть добавлены данные. Отправленные данные не сразу сбрасываются или записываются в файл. Для очистки ранее отправленные данные должны быть непрерывными, параметр position должен быть указан и равен длине файла после записи всех данных, а также не должно быть текста сущности запроса, включаемого в запрос.
- options
- FileFlushOptions
Необязательный элемент. Параметры при очистке данных.
Возвращаемое значение
Promise<FileFlushResponse>
generateSasUrl(FileGenerateSasUrlOptions)
Доступно только для клиентов, созданных с учетными данными общего ключа.
Создает URI подписанного URL-адреса службы (SAS) на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: FileGenerateSasUrlOptions): Promise<string>
Параметры
- options
- FileGenerateSasUrlOptions
Дополнительные параметры.
Возвращаемое значение
Promise<string>
URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.
query(string, FileQueryOptions)
Быстрый запрос к файлу в формате JSON или CSV.
Пример использования (Node.js):
// Query and convert a file to a string
const queryResponse = await fileClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryResponse.readableStreamBody)).toString();
console.log("Query file content:", downloaded);
async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
function query(query: string, options?: FileQueryOptions): Promise<FileReadResponse>
Параметры
- query
-
string
- options
- FileQueryOptions
Возвращаемое значение
Promise<FileReadResponse>
read(number, number, FileReadOptions)
Скачивает файл из службы, включая его метаданные и свойства.
- В Node.js данные возвращаются в потоке readableStreamBody.
- В браузерах данные возвращаются в содержимом promiseAsBlob
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
- Пример использования (Node.js):
// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
console.log("Downloaded file content:", downloaded.toString());
async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
Пример использования (браузер):
// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await blobToString(await downloadResponse.contentAsBlob);
console.log("Downloaded file content", downloaded);
async function blobToString(blob: Blob): Promise<string> {
const fileReader = new FileReader();
return new Promise<string>((resolve, reject) => {
fileReader.onloadend = (ev: any) => {
resolve(ev.target!.result);
};
fileReader.onerror = reject;
fileReader.readAsText(blob);
});
}
function read(offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>
Параметры
- offset
-
number
Необязательный элемент. Смещение в файл чтения, значение по умолчанию равно 0.
- count
-
number
Необязательный элемент. Сколько считывается байтов, по умолчанию будет считываться от смещения до конца.
- options
- FileReadOptions
Необязательный элемент. Параметры при чтении файла.
Возвращаемое значение
Promise<FileReadResponse>
readToBuffer(Buffer, number, number, FileReadToBufferOptions)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Считывает файл Data Lake параллельно с буфером. Смещение и счетчик являются необязательными. Передайте 0 для обоих, чтобы прочитать весь файл.
Предупреждение. Буферы могут поддерживать только файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для файлов, превышающих этот размер, рассмотрите возможность readToFile.
function readToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>
Параметры
- buffer
-
Buffer
Буфер для заполнения должен иметь длину больше счетчика
- offset
-
number
Расположение файла Data Lake для чтения
- count
-
number
Объем считываемого объема данных. Будет считываться до конца при передаче неопределенного
- options
- FileReadToBufferOptions
Возвращаемое значение
Promise<Buffer>
readToBuffer(number, number, FileReadToBufferOptions)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS
Считывает файл Data Lake параллельно с буфером. Смещение и счетчик являются необязательными. Передайте 0 для обоих, чтобы прочитать весь файл.
Предупреждение. Буферы могут поддерживать только файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для файлов, превышающих этот размер, рассмотрите возможность readToFile.
function readToBuffer(offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>
Параметры
- offset
-
number
С какой позиции файла Data Lake следует считывать (в байтах)
- count
-
number
Объем считываемого объема данных (в байтах). Будет считываться до конца при передаче неопределенного
- options
- FileReadToBufferOptions
Возвращаемое значение
Promise<Buffer>
readToFile(string, number, number, FileReadOptions)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Загружает файл Data Lake в локальный файл. Сбой, если указанный путь к файлу уже завершается. Смещение и счетчик являются необязательными, передаются 0 и undefined соответственно, чтобы скачать весь файл.
function readToFile(filePath: string, offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>
Параметры
- filePath
-
string
- offset
-
number
С какой позиции скачиваемого файла.
- count
-
number
Сколько данных нужно скачать. Скачивание до конца при передаче неопределенного значения.
- options
- FileReadOptions
Параметры для чтения файла Data Lake.
Возвращаемое значение
Promise<FileReadResponse>
Данные ответа для операции чтения файла, но с параметром readableStreamBody задано значение undefined, так как его содержимое уже считывается и записывается в локальный файл по указанному пути.
setExpiry(FileExpiryMode, FileSetExpiryOptions)
Задает время истечения срока действия для файла. После того, как это время будет выполнено, файл удаляется.
function setExpiry(mode: FileExpiryMode, options?: FileSetExpiryOptions): Promise<FileSetExpiryResponse>
Параметры
- mode
- FileExpiryMode
- options
- FileSetExpiryOptions
Возвращаемое значение
Promise<FileSetExpiryResponse>
upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)
Отправляет buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView в файл.
function upload(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<FileUploadResponse>
Параметры
- data
-
Blob | ArrayBuffer | ArrayBufferView | Buffer
Buffer(Node), Blob, ArrayBuffer или ArrayBufferView
- options
- FileParallelUploadOptions
Возвращаемое значение
Promise<FileUploadResponse>
uploadFile(string, FileParallelUploadOptions)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Отправляет локальный файл в файл Data Lake.
function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<FileUploadResponse>
Параметры
- filePath
-
string
Полный путь к локальному файлу
- options
- FileParallelUploadOptions
Возвращаемое значение
Promise<FileUploadResponse>
uploadStream(Readable, FileParallelUploadOptions)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Отправляет Node.js читаемый поток в файл Data Lake. Этот метод попытается создать файл, а затем начнет отправку фрагментов по блокам. Убедитесь, что потенциальный размер потока не превышает FILE_MAX_SIZE_BYTES, а потенциальное количество блоков не превышает BLOCK_BLOB_MAX_BLOCKS.
СОВЕТЫ ПО ПОВЫШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ.
- Входной поток highWaterMark лучше задать то же значение с параметром options.chunkSize, что позволит избежать операций Buffer.concat().
function uploadStream(stream: Readable, options?: FileParallelUploadOptions): Promise<FileUploadResponse>
Параметры
- stream
-
Readable
Node.js читаемый поток.
- options
- FileParallelUploadOptions
Возвращаемое значение
Promise<FileUploadResponse>
Сведения о наследуемом методе
delete(boolean, PathDeleteOptions)
Удалите текущий путь (каталог или файл).
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>
Параметры
- recursive
-
boolean
Обязательный и допустимый только в том случае, если ресурс является каталогом. Если задано значение true, все пути под каталогом будут удалены.
- options
- PathDeleteOptions
Необязательный элемент. Параметры при удалении пути.
Возвращаемое значение
Promise<PathDeleteResponse>
Наследуется отDataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Удалите текущий путь (каталог или файл), если он существует.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>
Параметры
- recursive
-
boolean
Обязательный и допустимый только в том случае, если ресурс является каталогом. Если задано значение true, все пути под каталогом будут удалены.
- options
- PathDeleteOptions
Возвращаемое значение
Promise<PathDeleteIfExistsResponse>
Наследуется отDataLakePathClient.deleteIfExists
exists(PathExistsOptions)
Возвращает значение true, если файл Data Lake, представленный этим клиентом, существует; Значение false в противном случае.
ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий файл может быть удален другими клиентами или приложениями. В обратном случае новые файлы могут добавляться другими клиентами или приложениями после завершения этой функции.
function exists(options?: PathExistsOptions): Promise<boolean>
Параметры
- options
- PathExistsOptions
параметры операции Существует.
Возвращаемое значение
Promise<boolean>
Наследуется отDataLakePathClient.exists
getAccessControl(PathGetAccessControlOptions)
Возвращает данные управления доступом для пути (каталога файла).
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>
Параметры
- options
- PathGetAccessControlOptions
Необязательный элемент. Параметры при получении управления доступом к файлам.
Возвращаемое значение
Promise<PathGetAccessControlResponse>
Наследуется отDataLakePathClient.getAccessControl
getDataLakeLeaseClient(string)
Получите Объект DataLakeLeaseClient , который управляет арендой пути (каталог или файл).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient
Параметры
- proposeLeaseId
-
string
Необязательный элемент. Первоначальный предлагаемый идентификатор аренды.
Возвращаемое значение
Наследуется отDataLakePathClient.getDataLakeLeaseClient
getProperties(PathGetPropertiesOptions)
Возвращает все определяемые пользователем метаданные, стандартные свойства HTTP и системные свойства для пути (каталога или файла).
ПРЕДУПРЕЖДЕНИЕ. Ключи metadata
, возвращаемые в ответе, будут содержаться в нижнем регистре, даже если они изначально содержали символы верхнего регистра. Это отличается от ключей метаданных, возвращаемых методами DataLakeFileSystemClient , которые перечисляют пути с помощью includeMetadata
параметра , который сохранит исходный регистр.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>
Параметры
- options
- PathGetPropertiesOptions
Необязательный элемент. Параметры при получении свойств пути.
Возвращаемое значение
Promise<PathGetPropertiesResponse>
Наследуется отDataLakePathClient.getProperties
move(string, PathMoveOptions)
Перемещение каталога или файла в одной файловой системе.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
Параметры
- destinationPath
-
string
Путь к целевому каталогу, например "каталог" или путь к файлу "каталог/файл". Если destinationPath проходит проверку подлинности с помощью SAS, добавьте SAS в путь назначения, например "directory/file?sasToken".
- options
- PathMoveOptions
Необязательный элемент. Параметры при перемещении каталога или файла.
Возвращаемое значение
Promise<PathMoveResponse>
Наследуется отDataLakePathClient.move
move(string, string, PathMoveOptions)
Перемещение каталога или файла в другую файловую систему.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
Параметры
- destinationFileSystem
-
string
Целевая файловая система, например "файловая система".
- destinationPath
-
string
Путь к целевому каталогу, например "каталог" или путь к файлу "directory/file" Если destinationPath проходит проверку подлинности с помощью SAS, добавьте SAS в целевой путь, например "directory/file?sasToken".
- options
- PathMoveOptions
Необязательный элемент. Параметры при перемещении каталога или файла.
Возвращаемое значение
Promise<PathMoveResponse>
Наследуется отDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Удаляет контроль доступа в пути и вложенных путях.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Параметры
Список управления доступом POSIX для файла или каталога.
Необязательный элемент. Варианты
Возвращаемое значение
Наследуется отDataLakePathClient.removeAccessControlRecursive
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Задайте данные управления доступом для пути (каталога файла).
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>
Параметры
- acl
Список управления доступом POSIX для файла или каталога.
- options
- PathSetAccessControlOptions
Необязательный элемент. Параметры при настройке управления доступом к пути.
Возвращаемое значение
Promise<PathSetAccessControlResponse>
Наследуется отDataLakePathClient.setAccessControl
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Задает контроль доступа для пути и вложенных путей.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Параметры
- acl
Список управления доступом POSIX для файла или каталога.
Необязательный элемент. Варианты
Возвращаемое значение
Наследуется отDataLakePathClient.setAccessControlRecursive
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Задает системные свойства по пути (каталог или файл).
Если значение не указано или не указано для указанных HTTP-заголовков BLOB-объектов, эти HTTP-заголовки больших двоичных объектов без значения будут удалены.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>
Параметры
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Возвращаемое значение
Promise<PathSetHttpHeadersResponse>
Наследуется отDataLakePathClient.setHttpHeaders
setMetadata(Metadata, PathSetMetadataOptions)
Задает определяемые пользователем метаданные для указанного пути (каталога файла) в виде одной или нескольких пар "имя-значение".
Если параметр не указан или метаданные не определены в параметре, метаданные пути будут удалены.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>
Параметры
- metadata
- Metadata
Необязательный элемент. Замените существующие метаданные этим значением. Если значение не указано, существующие метаданные будут удалены.
- options
- PathSetMetadataOptions
Необязательный элемент. Параметры при настройке метаданных пути.
Возвращаемое значение
Promise<PathSetMetadataResponse>
Наследуется отDataLakePathClient.setMetadata
setPermissions(PathPermissions, PathSetPermissionsOptions)
Задает разрешения файла на путь.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>
Параметры
- permissions
- PathPermissions
Разрешения на доступ к POSIX для владельца файла, группы владельцев файлов и т. д.
- options
- PathSetPermissionsOptions
Необязательный элемент. Параметры при настройке разрешений пути.
Возвращаемое значение
Promise<PathSetPermissionsResponse>
Наследуется отDataLakePathClient.setPermissions
toDirectoryClient()
Преобразование текущего DataLakePathClient в DataLakeDirectoryClient, если текущий путь является каталогом.
function toDirectoryClient(): DataLakeDirectoryClient
Возвращаемое значение
Наследуется отDataLakePathClient.toDirectoryClient
toFileClient()
Преобразование текущего DataLakePathClient в DataLakeFileClient, если текущий путь является файлом.
function toFileClient(): DataLakeFileClient
Возвращаемое значение
Наследуется отDataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Изменяет контроль доступа в пути и вложенных путях.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Параметры
- acl
Список управления доступом POSIX для файла или каталога.
Необязательный элемент. Варианты
Возвращаемое значение
Наследуется отDataLakePathClient.updateAccessControlRecursive