DataLakePathClient class

Пакет:

@azure/storage-file-datalake

DataLakePathClient представляет URL-адрес пути к службе хранилища Azure (каталог или файл).

Extends

StorageClient

Конструкторы

DataLakePathClient(string, Pipeline)	Создает экземпляр DataLakePathClient из URL-адреса и конвейера.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Создает экземпляр DataLakePathClient на основе URL-адреса и учетных данных.

Свойства

fileSystemName	Имя текущей файловой системы.
name	Имя текущего пути (каталог или файл).

Унаследованные свойства

accountName
credential	Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.
url	Закодированное значение строки URL-адреса.

Методы

create(PathResourceTypeModel, PathCreateOptions)	Создайте каталог или путь. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Создайте каталог или файл. Если ресурс уже существует, он не изменяется. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
delete(boolean, PathDeleteOptions)	Удалите текущий путь (каталог или файл). См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Удалите текущий путь (каталог или файл), если он существует. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Возвращает значение true, если файл Data Lake, представленный этим клиентом, существует; Значение false в противном случае. ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий файл может быть удален другими клиентами или приложениями. В обратном случае новые файлы могут добавляться другими клиентами или приложениями после завершения этой функции.
getAccessControl(PathGetAccessControlOptions)	Возвращает данные управления доступом для пути (каталога файла). См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Получите объект DataLakeLeaseClient , который управляет арендами по пути (каталогу или файлу).
getProperties(PathGetPropertiesOptions)	Возвращает все определяемые пользователем метаданные, стандартные свойства HTTP и системные свойства для пути (каталога или файла). ПРЕДУПРЕЖДЕНИЕ. Ключи metadata , возвращаемые в ответе, будут содержаться в нижнем регистре, даже если они изначально содержали символы верхнего регистра. Это отличается от ключей метаданных, возвращаемых методами DataLakeFileSystemClient путей к списку includeMetadata с использованием параметра , который сохранит исходный регистр. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Перемещение каталога или файла в одной файловой системе. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Перемещение каталога или файла в другую файловую систему. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Удаляет контроль доступа в пути и вложенных путях. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Задайте данные управления доступом для пути (каталога файла). См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Задает контроль доступа для пути и вложенных путей. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Задает системные свойства по пути (каталог или файл). Если значение не указано или не указано для указанных HTTP-заголовков BLOB-объектов, эти HTTP-заголовки больших двоичных объектов без значения будут удалены. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Задает определяемые пользователем метаданные для указанного пути (каталога файла) в виде одной или нескольких пар "имя-значение". Если параметр не указан или метаданные не определены в параметре, метаданные пути будут удалены. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Задает разрешения файла на путь. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Преобразование текущего DataLakePathClient в DataLakeDirectoryClient, если текущий путь является каталогом.
toFileClient()	Преобразование текущего DataLakePathClient в DataLakeFileClient, если текущий путь является файлом.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Изменяет контроль доступа в пути и вложенных путях. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Сведения о конструкторе

DataLakePathClient(string, Pipeline)

Создает экземпляр DataLakePathClient из URL-адреса и конвейера.

new DataLakePathClient(url: string, pipeline: Pipeline)

Параметры

url

string

Строка клиента, указывающая на путь к озеру данных службы хранилища Azure (каталог или файл), например "https://myaccount.dfs.core.windows.net/filesystem/directory" или "https://myaccount.dfs.core.windows.net/filesystem/file". Вы можете добавить SAS с помощью AnonymousCredential, например "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString"".

pipeline

Pipeline

Вызовите newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.

DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Создает экземпляр DataLakePathClient на основе URL-адреса и учетных данных.

new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Параметры

url

string

Строка клиента, указывающая на путь к озеру данных службы хранилища Azure (каталог или файл), например "https://myaccount.dfs.core.windows.net/filesystem/directory" или "https://myaccount.dfs.core.windows.net/filesystem/file". Вы можете добавить SAS с помощью AnonymousCredential, например "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString"".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.

options

StoragePipelineOptions

Необязательный элемент. Параметры для настройки конвейера HTTP.

Сведения о свойстве

fileSystemName

Имя текущей файловой системы.

string fileSystemName

Значение свойства

string

name

Имя текущего пути (каталог или файл).

string name

Значение свойства

string

Сведения об унаследованном свойстве

accountName

accountName: string

Значение свойства

string

Наследуется отStorageClient.accountName

credential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Значение свойства

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Наследуется отStorageClient.credential

url

Закодированное значение строки URL-адреса.

url: string

Значение свойства

string

Наследуется отStorageClient.url

Сведения о методе

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

Тип ресурса, "directory" или "file".

options

PathCreateOptions

Необязательный элемент. Параметры при создании пути.

Возвращаемое значение

Promise<PathCreateResponse>

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

Тип ресурса, "directory" или "file".

options

PathCreateIfNotExistsOptions

Возвращаемое значение

Promise<PathCreateIfNotExistsResponse>

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>

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>

exists(PathExistsOptions)

Возвращает значение true, если файл Data Lake, представленный этим клиентом, существует; Значение false в противном случае. ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий файл может быть удален другими клиентами или приложениями. В обратном случае новые файлы могут добавляться другими клиентами или приложениями после завершения этой функции.

function exists(options?: PathExistsOptions): Promise<boolean>

Параметры

options

PathExistsOptions

параметры операции Существует.

Возвращаемое значение

Promise<boolean>

getAccessControl(PathGetAccessControlOptions)

Возвращает данные управления доступом для пути (каталога файла).

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

Параметры

options

PathGetAccessControlOptions

Необязательный элемент. Параметры при получении управления доступом к файлам.

Возвращаемое значение

Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient(string)

Получите объект DataLakeLeaseClient , который управляет арендами по пути (каталогу или файлу).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Параметры

proposeLeaseId

string

Необязательный элемент. Первоначальный предлагаемый идентификатор аренды.

Возвращаемое значение

DataLakeLeaseClient

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>

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>

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>

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Удаляет контроль доступа в пути и вложенных путях.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Параметры

acl

RemovePathAccessControlItem[]

Список управления доступом POSIX для файла или каталога.

options

PathChangeAccessControlRecursiveOptions

Необязательный элемент. Варианты

Возвращаемое значение

Promise<PathChangeAccessControlRecursiveResponse>

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Задайте данные управления доступом для пути (каталога файла).

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

Параметры

acl

PathAccessControlItem[]

Список управления доступом POSIX для файла или каталога.

options

PathSetAccessControlOptions

Необязательный элемент. Параметры при настройке управления доступом к пути.

Возвращаемое значение

Promise<PathSetAccessControlResponse>

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Задает контроль доступа для пути и вложенных путей.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Параметры

acl

PathAccessControlItem[]

Список управления доступом POSIX для файла или каталога.

options

PathChangeAccessControlRecursiveOptions

Необязательный элемент. Варианты

Возвращаемое значение

Promise<PathChangeAccessControlRecursiveResponse>

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>

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>

setPermissions(PathPermissions, PathSetPermissionsOptions)

Задает разрешения файла на путь.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetAccessControlResponse>

Параметры

permissions

PathPermissions

Разрешения на доступ к POSIX для владельца файла, группы владельцев файлов и т. д.

options

PathSetPermissionsOptions

Необязательный элемент. Параметры при настройке разрешений пути.

Возвращаемое значение

Promise<PathSetAccessControlResponse>

toDirectoryClient()

Преобразование текущего DataLakePathClient в DataLakeDirectoryClient, если текущий путь является каталогом.

function toDirectoryClient(): DataLakeDirectoryClient

Возвращаемое значение

DataLakeDirectoryClient

toFileClient()

Преобразование текущего DataLakePathClient в DataLakeFileClient, если текущий путь является файлом.

function toFileClient(): DataLakeFileClient

Возвращаемое значение

DataLakeFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Изменяет контроль доступа в пути и вложенных путях.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Параметры

acl

PathAccessControlItem[]

Список управления доступом POSIX для файла или каталога.

options

PathChangeAccessControlRecursiveOptions

Необязательный элемент. Варианты

Возвращаемое значение

Promise<PathChangeAccessControlRecursiveResponse>