DataLakeDirectoryClient class

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

new DataLakeDirectoryClient(url: string, pipeline: Pipeline)

Параметры

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

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

Параметры

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

string fileSystemName

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

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

string name

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

accountName: string

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

наследуется отDataLakePathClient.accountName

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

унаследован отDataLakePathClient.credential

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

url: string

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

наследуется отDataLakePathClient.url

Создайте каталог.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>

Параметры

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

Создайте каталог.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>

Параметры

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

Создайте каталог, если он еще не существует.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>

Параметры

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

Создайте каталог, если он еще не существует.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

Параметры

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

Создает строку для входа в универсальный код ресурса (SAS) службы на основе свойств и параметров клиента, переданных.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): string

Параметры

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

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Доступно только для клиентов, созданных с использованием учетных данных общего ключа.

Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>

Параметры

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

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Создает строку для входа в URI подписанного URL-адреса службы (SAS) на основе свойств клиента и параметров, переданных в SAS, подписывается ключом делегирования входных пользователей.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Параметры

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

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан ключом делегирования входных пользователей.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Параметры

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

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Создает объект DataLakeFileClient в текущем каталоге.

function getFileClient(fileName: string): DataLakeFileClient

Параметры

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

Создает объект DataLakeDirectoryClient в текущем каталоге.

function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient

Параметры

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

Удалите текущий путь (каталог или файл).

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

Параметры

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

наследуется отDataLakePathClient.delete

Удалите текущий путь (каталог или файл), если он существует.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

Параметры

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

унаследован отDataLakePathClient.deleteIfExists

Возвращает значение true, если файл Data Lake, представленный этим клиентом; False в противном случае.

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

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

Параметры

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

наследуется отDataLakePathClient.существует

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

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

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

Параметры

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

унаследовано отDataLakePathClient.getAccessControl

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Параметры

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

наследуется отDataLakePathClient.getDataLakeLeaseClient

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

ПРЕДУПРЕЖДЕНИЕ. Объект metadata, возвращенный в ответе, будет иметь свои ключи в нижнем регистре, даже если они первоначально содержали прописные символы. Это отличается от ключей метаданных, возвращаемых методами DataLakeFileSystemClient, которые перечисляют пути с помощью параметра includeMetadata, который будет хранить исходный регистр.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

Параметры

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

наследуется отDataLakePathClient.getProperties

Перемещение каталога или файла в одной файловой системе.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Параметры

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

наследуется отDataLakePathClient.move

Перемещение каталога или файла в другую файловую систему.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Параметры

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

наследуется отDataLakePathClient.move

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

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Параметры

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

наследуется отDataLakePathClient.removeAccessControlRecursive

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

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Параметры

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

унаследован отDataLakePathClient.setAccessControl

Задает управление доступом по пути и вложенным путям.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Параметры

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

наследуется отDataLakePathClient.setAccessControlRecursive

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

Если для указанных заголовков HTTP большого двоичного объекта не задано никакого значения, эти заголовки HTTP БОЛЬШИХ двоичных объектов без значения будут удалены.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

Параметры

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

унаследовано отDataLakePathClient.setHttpHeaders

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

Если в параметре не указан параметр или метаданные, определенные в параметре, метаданные пути будут удалены.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

Параметры

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

наследуется отDataLakePathClient.setMetadata

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

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Параметры

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

наследуется отDataLakePathClient.setPermissions

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

function toDirectoryClient(): DataLakeDirectoryClient

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

унаследовано отDataLakePathClient.toDirectoryClient

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

function toFileClient(): DataLakeFileClient

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

наследуется отDataLakePathClient.toFileClient

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

См. https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Параметры

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

унаследован отDataLakePathClient.updateAccessControlRecursive