DataLakeDirectoryClient class
DataLakeDirectoryClient представляет URL-адрес каталога службы хранилища Azure.
- Extends
Конструкторы
| Data |
Создает экземпляр DataLakePathClient из URL-адреса и конвейера. |
| Data |
Создает экземпляр DataLakePathClient на основе URL-адреса и учетных данных. |
Свойства
| file |
Имя текущей файловой системы. |
| name | Имя текущего пути (каталога или файла). |
Унаследованные свойства
| account |
|
| credential | Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные |
| url | Значение строки закодированного URL-адреса. |
Методы
Наследуемые методы
| 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 |
Сведения о конструкторе
DataLakeDirectoryClient(string, Pipeline)
Создает экземпляр DataLakePathClient из URL-адреса и конвейера.
new DataLakeDirectoryClient(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() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Создает экземпляр DataLakePathClient на основе URL-адреса и учетных данных.
new DataLakeDirectoryClient(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
credential
Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект , реализующий интерфейс TokenCredential. Если значение не указано, используется AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialЗначение свойства
Наследуется отDataLakePathClient.credential
url
Значение строки закодированного URL-адреса.
url: stringЗначение свойства
string
Наследуется отDataLakePathClient.url
Сведения о методе
create(DirectoryCreateOptions)
Создайте каталог.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>Параметры
- options
- DirectoryCreateOptions
Необязательный элемент. Параметры при создании каталога.
Возвращаемое значение
Promise<DirectoryCreateResponse>
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" для DataLakeDirectoryClient.
- options
- PathCreateOptions
Необязательный элемент. Параметры при создании каталога.
Возвращаемое значение
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
Создайте каталог, если он еще не существует.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>Параметры
Возвращаемое значение
Promise<DirectoryCreateIfNotExistsResponse>
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" для DataLakeDirectoryClient.
- options
- PathCreateIfNotExistsOptions
Возвращаемое значение
Promise<PathCreateIfNotExistsResponse>
generateSasUrl(DirectoryGenerateSasUrlOptions)
Доступно только для клиентов, созданных с учетными данными общего ключа.
Создает URI подписанного URL-адреса службы (SAS) на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>Параметры
- options
- DirectoryGenerateSasUrlOptions
Дополнительные параметры.
Возвращаемое значение
Promise<string>
URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.
getFileClient(string)
Создает объект DataLakeFileClient в текущем каталоге.
function getFileClient(fileName: string): DataLakeFileClientПараметры
- fileName
-
string
Возвращаемое значение
getSubdirectoryClient(string)
Создает объект DataLakeDirectoryClient в текущем каталоге.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClientПараметры
- subdirectoryName
-
string
Имя подкаталога.
Возвращаемое значение
Сведения о наследуемом методе
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
параметров для операции Exists.
Возвращаемое значение
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
Целевая файловая система, например filesystem.
- destinationPath
-
string
Путь к конечному каталогу, например "каталог", или путь к файлу "каталог/файл". Если проверка подлинности 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