DataLakePathClient class
DataLakePathClient представляет URL-адрес пути хранилища Azure (каталог или файл).
- Extends
-
StorageClient
Конструкторы
| Data |
Создает экземпляр DataLakePathClient из URL-адреса и конвейера. |
| Data |
Создает экземпляр DataLakePathClient из URL-адреса и учетных данных. |
Свойства
| file |
Имя текущей файловой системы. |
| name | Имя текущего пути (каталог или файл). |
Унаследованные свойства
| account |
|
| credential | Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные данные из пакета |
| url | Закодированное строковое значение URL-адреса. |
Методы
Сведения о конструкторе
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". При использовании AnonymousCredential можно добавить SAS, например "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". При использовании AnonymousCredential можно добавить SAS, например "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Значение свойства
наследуется от StorageClient.credential
url
Закодированное строковое значение URL-адреса.
url: stringЗначение свойства
string
наследуется от StorageClient.url
Сведения о методе
create(PathResourceTypeModel, PathCreateOptions)
Создайте каталог или путь.
См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>Параметры
- resourceType
- PathResourceTypeModel
Тип ресурса, каталог или файл.
- options
- PathCreateOptions
Необязательный. Параметры при создании пути.
Возвращаемое значение
Promise<PathCreateResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
Создайте каталог или файл. Если ресурс уже существует, он не изменяется.
См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Параметры
- resourceType
- PathResourceTypeModel
Тип ресурса, каталог или файл.
- options
- PathCreateIfNotExistsOptions
Возвращаемое значение
Promise<PathCreateIfNotExistsResponse>
delete(boolean, PathDeleteOptions)
Удалите текущий путь (каталог или файл).
См. https://learn.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://learn.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://learn.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
Необязательный. Первоначальный предлагаемый идентификатор аренды.
Возвращаемое значение
getProperties(PathGetPropertiesOptions)
Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства пути (каталог или файл).
ПРЕДУПРЕЖДЕНИЕ. Объект metadata, возвращенный в ответе, будет иметь свои ключи в нижнем регистре, даже если они первоначально содержали прописные символы. Это отличается от ключей метаданных, возвращаемых методами DataLakeFileSystemClient, которые перечисляют пути с помощью параметра includeMetadata, который будет хранить исходный регистр.
См. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Параметры
- options
- PathGetPropertiesOptions
Необязательный. Параметры при получении свойств пути.
Возвращаемое значение
Promise<PathGetPropertiesResponse>
move(string, PathMoveOptions)
Перемещение каталога или файла в одной файловой системе.
См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Параметры
- destinationPath
-
string
Путь к целевому каталогу, например "каталог" или путь к файлу "directory/file". Если целевой Путь проходит проверку подлинности с помощью SAS, добавьте SAS в путь назначения, например directory/file?sasToken.
- options
- PathMoveOptions
Необязательный. Параметры при перемещении каталога или файла.
Возвращаемое значение
Promise<PathMoveResponse>
move(string, string, PathMoveOptions)
Перемещение каталога или файла в другую файловую систему.
См. https://learn.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", если целевойpath проходит проверку подлинности с помощью SAS, добавьте SAS в путь назначения, например directory/file?sasToken.
- options
- PathMoveOptions
Необязательный. Параметры при перемещении каталога или файла.
Возвращаемое значение
Promise<PathMoveResponse>
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Удаляет управление доступом по пути и вложенным путям.
См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Параметры
Список управления доступом POSIX для файла или каталога.
Необязательный. Параметры
Возвращаемое значение
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Задайте данные управления доступом для пути (каталога файла).
См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>Параметры
- acl
Список управления доступом POSIX для файла или каталога.
- options
- PathSetAccessControlOptions
Необязательный. Параметры при настройке управления доступом пути.
Возвращаемое значение
Promise<PathSetAccessControlResponse>
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Задает управление доступом по пути и вложенным путям.
См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Параметры
- acl
Список управления доступом POSIX для файла или каталога.
Необязательный. Параметры
Возвращаемое значение
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Задает системные свойства пути (каталог или файл).
Если для указанных заголовков HTTP большого двоичного объекта не задано никакого значения, эти заголовки HTTP БОЛЬШИХ двоичных объектов без значения будут удалены.
См. https://learn.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://learn.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://learn.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>
toDirectoryClient()
Преобразуйте текущий DataLakePathClient в DataLakeDirectoryClient, если текущий путь является каталогом.
function toDirectoryClient(): DataLakeDirectoryClientВозвращаемое значение
toFileClient()
Преобразуйте current DataLakePathClient в DataLakeFileClient, если текущий путь является файлом.
function toFileClient(): DataLakeFileClientВозвращаемое значение
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Изменяет управление доступом по пути и вложенным путям.
См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Параметры
- acl
Список управления доступом POSIX для файла или каталога.
Необязательный. Параметры