DataLakePathClient class

Paquete:

@azure/storage-file-datalake

DataLakePathClient representa una dirección URL a la ruta de acceso de Azure Storage (directorio o archivo).

Extends

StorageClient

Constructores

DataLakePathClient(string, Pipeline)	Crea una instancia de DataLakePathClient a partir de la dirección URL y la canalización.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Crea una instancia de DataLakePathClient a partir de la dirección URL y las credenciales.

Propiedades

fileSystemName	Nombre del sistema de archivos actual.
name	Nombre de la ruta de acceso actual (directorio o archivo).

Propiedades heredadas

accountName
credential	Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.
url	Valor de cadena de dirección URL codificada.

Métodos

create(PathResourceTypeModel, PathCreateOptions)	Cree un directorio o ruta de acceso. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Cree un directorio o archivo. Si el recurso ya existe, no se cambia. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
delete(boolean, PathDeleteOptions)	Elimine la ruta de acceso actual (directorio o archivo). Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Elimine la ruta de acceso actual (directorio o archivo) si existe. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Devuelve true si el archivo de Data Lake representado por este cliente existe; False en caso contrario. NOTA: Use esta función con cuidado, ya que otros clientes o aplicaciones pueden eliminar un archivo existente. Viceversa, otros clientes o aplicaciones pueden agregar archivos nuevos viceversa una vez completada esta función.
getAccessControl(PathGetAccessControlOptions)	Devuelve los datos de control de acceso de una ruta de acceso (directorio de archivo). Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Obtenga un dataLakeLeaseClient de que administra las concesiones en la ruta de acceso (directorio o archivo).
getProperties(PathGetPropertiesOptions)	Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para la ruta de acceso (directorio o archivo). ADVERTENCIA: El objeto metadata devuelto en la respuesta tendrá sus claves en minúsculas, incluso si originalmente contenían caracteres en mayúsculas. Esto difiere de las claves de metadatos devueltas por los métodos de DataLakeFileSystemClient que enumeran las rutas de acceso mediante la opción includeMetadata, que conservarán su mayúscula y minúscula original. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Mueva el directorio o el archivo dentro del mismo sistema de archivos. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Mueva el directorio o el archivo a otro sistema de archivos. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Quita el control de acceso en una ruta de acceso y subrutas. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Establezca los datos de control de acceso para una ruta de acceso (directorio del archivo). Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Establece el Control de acceso en una ruta de acceso y subrutas. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Establece las propiedades del sistema en la ruta de acceso (directorio o archivo). Si no se proporciona ningún valor o ningún valor proporcionado para los encabezados HTTP de blob especificados, estos encabezados HTTP de blob sin un valor se borrarán. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Establece los metadatos definidos por el usuario para la ruta de acceso especificada (directorio del archivo) como uno o varios pares nombre-valor. Si no se proporciona ninguna opción o ningún metadato definido en el parámetro , se quitarán los metadatos de la ruta de acceso. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Establece los permisos de archivo en una ruta de acceso. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Convierta dataLakePathClient actual en DataLakeDirectoryClient si la ruta de acceso actual es un directorio.
toFileClient()	Convierta dataLakePathClient actual en DataLakeFileClient si la ruta de acceso actual es un archivo.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Modifica el Control de acceso en una ruta de acceso y subrutas. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Detalles del constructor

DataLakePathClient(string, Pipeline)

Crea una instancia de DataLakePathClient a partir de la dirección URL y la canalización.

new DataLakePathClient(url: string, pipeline: Pipeline)

Parámetros

url

string

Cadena de cliente que apunta a la ruta de acceso del lago de datos de Azure Storage (directorio o archivo), como "https://myaccount.dfs.core.windows.net/filesystem/directory" o "https://myaccount.dfs.core.windows.net/filesystem/file". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

pipeline

Pipeline

Llame a newPipeline() para crear una canalización predeterminada o proporcionar una canalización personalizada.

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

Crea una instancia de DataLakePathClient a partir de la dirección URL y las credenciales.

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

Parámetros

url

string

Cadena de cliente que apunta a la ruta de acceso del lago de datos de Azure Storage (directorio o archivo), como "https://myaccount.dfs.core.windows.net/filesystem/directory" o "https://myaccount.dfs.core.windows.net/filesystem/file". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

options

StoragePipelineOptions

Opcional. Opciones para configurar la canalización HTTP.

Detalles de las propiedades

fileSystemName

Nombre del sistema de archivos actual.

string fileSystemName

Valor de propiedad

string

name

Nombre de la ruta de acceso actual (directorio o archivo).

string name

Valor de propiedad

string

Detalles de las propiedades heredadas

accountName

accountName: string

Valor de propiedad

string

Heredado de StorageClient.accountName

credential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de propiedad

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

heredado de StorageClient.credential

url

Valor de cadena de dirección URL codificada.

url: string

Valor de propiedad

string

se hereda de StorageClient.url

Detalles del método

create(PathResourceTypeModel, PathCreateOptions)

Cree un directorio o ruta de acceso.

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

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

Parámetros

resourceType

PathResourceTypeModel

Tipo de recurso, "directorio" o "archivo".

options

PathCreateOptions

Opcional. Opciones al crear la ruta de acceso.

Devoluciones

Promise<PathCreateResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Cree un directorio o archivo. Si el recurso ya existe, no se cambia.

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

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

Parámetros

resourceType

PathResourceTypeModel

Tipo de recurso, "directorio" o "archivo".

options

PathCreateIfNotExistsOptions

Devoluciones

Promise<PathCreateIfNotExistsResponse>

delete(boolean, PathDeleteOptions)

Elimine la ruta de acceso actual (directorio o archivo).

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

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

Parámetros

recursive

boolean

Obligatorio y válido solo cuando el recurso es un directorio. Si es "true", se eliminarán todas las rutas de acceso debajo del directorio.

options

PathDeleteOptions

Opcional. Opciones al eliminar la ruta de acceso.

Devoluciones

Promise<PathDeleteResponse>

deleteIfExists(boolean, PathDeleteOptions)

Elimine la ruta de acceso actual (directorio o archivo) si existe.

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

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

Parámetros

recursive

boolean

Obligatorio y válido solo cuando el recurso es un directorio. Si es "true", se eliminarán todas las rutas de acceso debajo del directorio.

options

PathDeleteOptions

Devoluciones

Promise<PathDeleteIfExistsResponse>

exists(PathExistsOptions)

Devuelve true si el archivo de Data Lake representado por este cliente existe; False en caso contrario.

NOTA: Use esta función con cuidado, ya que otros clientes o aplicaciones pueden eliminar un archivo existente. Viceversa, otros clientes o aplicaciones pueden agregar archivos nuevos viceversa una vez completada esta función.

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

Parámetros

options

PathExistsOptions

opciones para la operación Exists.

Devoluciones

Promise<boolean>

getAccessControl(PathGetAccessControlOptions)

Devuelve los datos de control de acceso de una ruta de acceso (directorio de archivo).

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

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

Parámetros

options

PathGetAccessControlOptions

Opcional. Opciones al obtener el control de acceso a archivos.

Devoluciones

Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient(string)

Obtenga un dataLakeLeaseClient de que administra las concesiones en la ruta de acceso (directorio o archivo).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parámetros

proposeLeaseId

string

Opcional. Identificador de concesión propuesto inicial.

Devoluciones

DataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para la ruta de acceso (directorio o archivo).

ADVERTENCIA: El objeto metadata devuelto en la respuesta tendrá sus claves en minúsculas, incluso si originalmente contenían caracteres en mayúsculas. Esto difiere de las claves de metadatos devueltas por los métodos de DataLakeFileSystemClient que enumeran las rutas de acceso mediante la opción includeMetadata, que conservarán su mayúscula y minúscula original.

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

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

Parámetros

options

PathGetPropertiesOptions

Opcional. Opciones al obtener propiedades de ruta de acceso.

Devoluciones

Promise<PathGetPropertiesResponse>

move(string, PathMoveOptions)

Mueva el directorio o el archivo dentro del mismo sistema de archivos.

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

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

Parámetros

destinationPath

string

Ruta de acceso del directorio de destino, como "directorio" o ruta de acceso de archivo "directorio/archivo". Si destinationPath se autentica con SAS, agregue la SAS a la ruta de acceso de destino como "directory/file?sasToken".

options

PathMoveOptions

Opcional. Opciones al mover el directorio o el archivo.

Devoluciones

Promise<PathMoveResponse>

move(string, string, PathMoveOptions)

Mueva el directorio o el archivo a otro sistema de archivos.

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

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

Parámetros

destinationFileSystem

string

Sistema de archivos de destino como "filesystem".

destinationPath

string

Ruta de acceso del directorio de destino como "directorio" o ruta de acceso de archivo "directorio/archivo" Si destinationPath se autentica con SAS, agregue la SAS a la ruta de acceso de destino como "directory/file?sasToken".

options

PathMoveOptions

Opcional. Opciones al mover el directorio o el archivo.

Devoluciones

Promise<PathMoveResponse>

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Quita el control de acceso en una ruta de acceso y subrutas.

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

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

Parámetros

acl

RemovePathAccessControlItem[]

Lista de control de acceso POSIX para el archivo o directorio.

options

PathChangeAccessControlRecursiveOptions

Opcional. Opciones

Devoluciones

Promise<PathChangeAccessControlRecursiveResponse>

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Establezca los datos de control de acceso para una ruta de acceso (directorio del archivo).

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

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

Parámetros

acl

PathAccessControlItem[]

Lista de control de acceso POSIX para el archivo o directorio.

options

PathSetAccessControlOptions

Opcional. Opciones al establecer el control de acceso de ruta de acceso.

Devoluciones

Promise<PathSetAccessControlResponse>

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Establece el Control de acceso en una ruta de acceso y subrutas.

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

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

Parámetros

acl

PathAccessControlItem[]

Lista de control de acceso POSIX para el archivo o directorio.

options

PathChangeAccessControlRecursiveOptions

Opcional. Opciones

Devoluciones

Promise<PathChangeAccessControlRecursiveResponse>

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Establece las propiedades del sistema en la ruta de acceso (directorio o archivo).

Si no se proporciona ningún valor o ningún valor proporcionado para los encabezados HTTP de blob especificados, estos encabezados HTTP de blob sin un valor se borrarán.

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

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

Parámetros

httpHeaders

PathHttpHeaders

options

PathSetHttpHeadersOptions

Devoluciones

Promise<PathSetHttpHeadersResponse>

setMetadata(Metadata, PathSetMetadataOptions)

Establece los metadatos definidos por el usuario para la ruta de acceso especificada (directorio del archivo) como uno o varios pares nombre-valor.

Si no se proporciona ninguna opción o ningún metadato definido en el parámetro , se quitarán los metadatos de la ruta de acceso.

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

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

Parámetros

metadata

Metadata

Opcional. Reemplace los metadatos existentes por este valor. Si no se proporciona ningún valor, se quitarán los metadatos existentes.

options

PathSetMetadataOptions

Opcional. Opciones al establecer metadatos de ruta de acceso.

Devoluciones

Promise<PathSetMetadataResponse>

setPermissions(PathPermissions, PathSetPermissionsOptions)

Establece los permisos de archivo en una ruta de acceso.

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

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

Parámetros

permissions

PathPermissions

Los permisos de acceso POSIX para el propietario del archivo, el grupo propietario del archivo y otros.

options

PathSetPermissionsOptions

Opcional. Opciones al establecer permisos de ruta de acceso.

Devoluciones

Promise<PathSetPermissionsResponse>

toDirectoryClient()

Convierta dataLakePathClient actual en DataLakeDirectoryClient si la ruta de acceso actual es un directorio.

function toDirectoryClient(): DataLakeDirectoryClient

Devoluciones

DataLakeDirectoryClient

toFileClient()

Convierta dataLakePathClient actual en DataLakeFileClient si la ruta de acceso actual es un archivo.

function toFileClient(): DataLakeFileClient

Devoluciones

DataLakeFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Modifica el Control de acceso en una ruta de acceso y subrutas.

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

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

Parámetros

acl

PathAccessControlItem[]

Lista de control de acceso POSIX para el archivo o directorio.

options

PathChangeAccessControlRecursiveOptions

Opcional. Opciones

Devoluciones

Promise<PathChangeAccessControlRecursiveResponse>