DataLakeFileSystemClient class
DataLakeFileSystemClient representa una dirección URL al sistema de archivos de Azure Storage que le permite manipular sus directorios y archivos.
- Extends
-
StorageClient
Constructores
Data |
Crea una instancia de DataLakeFileSystemClient a partir de la dirección URL y la canalización. |
Data |
Crea una instancia de DataLakeFileSystemClient a partir de la dirección URL y las credenciales. |
Propiedades
name | Nombre del sistema de archivos actual. |
Propiedades heredadas
account |
|
credential | Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del |
url | Valor de cadena de dirección URL codificada. |
Métodos
create(File |
Crea un nuevo sistema de archivos en la cuenta especificada. Si el sistema de archivos con el mismo nombre ya existe, se produce un error en la operación. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/create-container. |
create |
Crea un nuevo sistema de archivos en la cuenta especificada. Si el sistema de archivos con el mismo nombre ya existe, no se cambia. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/create-container. |
delete(File |
Elimine el sistema de archivos actual. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container. |
delete |
Elimine el sistema de archivos actual si existe. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container. |
exists(File |
Devuelve true si el sistema de archivos 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 sistema de archivos existente. Viceversa, el nuevo sistema de archivos con el mismo nombre puede ser agregado por otros clientes o aplicaciones una vez completada esta función. |
generate |
Solo está disponible para DataLakeFileSystemClient construido con una credencial de clave compartida. Genera un URI de firma de acceso compartido (SAS) de servicio basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas. |
get |
Obtiene los permisos para el sistema de archivos especificado. Los permisos indican si se puede acceder a los datos del sistema de archivos públicamente. ADVERTENCIA: La fecha de JavaScript perderá la precisión al analizar las cadenas StartsOn y expiresOn. Por ejemplo, new Date("2018-12-31T03:44:23.8827891Z").toISOString() obtendrá "2018-12-31T03:44:23.882Z". Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl. |
get |
Obtenga un DataLakeLeaseClient que administre concesiones en el sistema de archivos. |
get |
Crea un objeto DataLakeDirectoryClient en el sistema de archivos actual. |
get |
Crea un objeto DataLakeFileClient en el sistema de archivos actual. |
get |
Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el sistema de archivos especificado. ADVERTENCIA: El Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties. |
list |
Devuelve un iterador asincrónico para enumerar todas las rutas de acceso (directorios y archivos) en el sistema de archivos especificado. .byPage() devuelve un iterador asincrónico para enumerar las rutas de acceso de las páginas. Ejemplo de uso de
Ejemplo con
Ejemplo con
Ejemplo de uso de paginación con un marcador:
Consulta https://docs.microsoft.com/rest/api/storageservices/list-blobs. |
list |
Devuelve un iterador asincrónico para enumerar todas las rutas de acceso (directorios y archivos) en el sistema de archivos especificado. .byPage() devuelve un iterador asincrónico para enumerar las rutas de acceso de las páginas. Ejemplo de uso de
Ejemplo con
Ejemplo con
Ejemplo de uso de paginación con un marcador:
Consulta https://docs.microsoft.com/rest/api/storageservices/list-blobs. |
set |
Establece los permisos para el sistema de archivos especificado. Los permisos indican si se puede acceder a los directorios o archivos de un sistema de archivos públicamente. Al establecer permisos para un sistema de archivos, se reemplazan los permisos existentes. Si no se proporciona ningún acceso o containerAcl, se quitará la ACL del sistema de archivos existente. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl. |
set |
Establece uno o varios pares nombre-valor definidos por el usuario para el sistema de archivos especificado. Si no se proporciona ninguna opción o no hay metadatos definidos en el parámetro , se quitarán los metadatos del sistema de archivos. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata. |
undelete |
Restaura una ruta de acceso eliminada temporalmente. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob. |
Detalles del constructor
DataLakeFileSystemClient(string, Pipeline)
Crea una instancia de DataLakeFileSystemClient a partir de la dirección URL y la canalización.
new DataLakeFileSystemClient(url: string, pipeline: Pipeline)
Parámetros
- url
-
string
Cadena de cliente que apunta al sistema de archivos de Data Lake de Azure Storage, como "https://myaccount.dfs.core.windows.net/filesystem". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem?sasString".
- pipeline
- Pipeline
Llame a newPipeline() para crear una canalización predeterminada o proporcione una canalización personalizada.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Crea una instancia de DataLakeFileSystemClient a partir de la dirección URL y las credenciales.
new DataLakeFileSystemClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parámetros
- url
-
string
Cadena de cliente que apunta al sistema de archivos de Data Lake de Azure Storage, como "https://myaccount.dfs.core.windows.net/filesystem". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del @azure/identity
paquete para autenticar las solicitudes en el 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
name
Nombre del sistema de archivos actual.
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 @azure/identity
paquete para autenticar las solicitudes en el 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
Heredado de StorageClient.credential
url
Valor de cadena de dirección URL codificada.
url: string
Valor de propiedad
string
Heredado de StorageClient.url
Detalles del método
create(FileSystemCreateOptions)
Crea un nuevo sistema de archivos en la cuenta especificada. Si el sistema de archivos con el mismo nombre ya existe, se produce un error en la operación.
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.
function create(options?: FileSystemCreateOptions): Promise<FileSystemCreateResponse>
Parámetros
- options
- FileSystemCreateOptions
Opcional. Opciones al crear el sistema de archivos.
Devoluciones
Promise<FileSystemCreateResponse>
createIfNotExists(FileSystemCreateOptions)
Crea un nuevo sistema de archivos en la cuenta especificada. Si el sistema de archivos con el mismo nombre ya existe, no se cambia.
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.
function createIfNotExists(options?: FileSystemCreateOptions): Promise<FileSystemCreateIfNotExistsResponse>
Parámetros
- options
- FileSystemCreateOptions
Devoluciones
Promise<FileSystemCreateIfNotExistsResponse>
delete(FileSystemDeleteOptions)
Elimine el sistema de archivos actual.
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.
function delete(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteResponse>
Parámetros
- options
- FileSystemDeleteOptions
Opcional. Opciones al eliminar el sistema de archivos.
Devoluciones
Promise<FileSystemDeleteResponse>
deleteIfExists(FileSystemDeleteOptions)
Elimine el sistema de archivos actual si existe.
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.
function deleteIfExists(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteIfExistsResponse>
Parámetros
- options
- FileSystemDeleteOptions
Devoluciones
Promise<FileSystemDeleteIfExistsResponse>
exists(FileSystemExistsOptions)
Devuelve true si el sistema de archivos 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 sistema de archivos existente. Viceversa, el nuevo sistema de archivos con el mismo nombre puede ser agregado por otros clientes o aplicaciones una vez completada esta función.
function exists(options?: FileSystemExistsOptions): Promise<boolean>
Parámetros
- options
- FileSystemExistsOptions
Devoluciones
Promise<boolean>
generateSasUrl(FileSystemGenerateSasUrlOptions)
Solo está disponible para DataLakeFileSystemClient construido con una credencial de clave compartida.
Genera un URI de firma de acceso compartido (SAS) de servicio basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
function generateSasUrl(options: FileSystemGenerateSasUrlOptions): Promise<string>
Parámetros
- options
- FileSystemGenerateSasUrlOptions
Parámetros opcionales.
Devoluciones
Promise<string>
El URI de SAS que consta del URI para el recurso representado por este cliente, seguido del token de SAS generado.
getAccessPolicy(FileSystemGetAccessPolicyOptions)
Obtiene los permisos para el sistema de archivos especificado. Los permisos indican si se puede acceder a los datos del sistema de archivos públicamente.
ADVERTENCIA: La fecha de JavaScript perderá la precisión al analizar las cadenas StartsOn y expiresOn. Por ejemplo, new Date("2018-12-31T03:44:23.8827891Z").toISOString() obtendrá "2018-12-31T03:44:23.882Z".
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl.
function getAccessPolicy(options?: FileSystemGetAccessPolicyOptions): Promise<FileSystemGetAccessPolicyResponse>
Parámetros
- options
- FileSystemGetAccessPolicyOptions
Opcional. Opciones al obtener la directiva de acceso del sistema de archivos.
Devoluciones
Promise<FileSystemGetAccessPolicyResponse>
getDataLakeLeaseClient(string)
Obtenga un DataLakeLeaseClient que administre concesiones en el sistema de archivos.
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient
Parámetros
- proposeLeaseId
-
string
Opcional. Identificador de concesión propuesto inicial.
Devoluciones
getDirectoryClient(string)
Crea un objeto DataLakeDirectoryClient en el sistema de archivos actual.
function getDirectoryClient(directoryName: string): DataLakeDirectoryClient
Parámetros
- directoryName
-
string
Devoluciones
getFileClient(string)
Crea un objeto DataLakeFileClient en el sistema de archivos actual.
function getFileClient(fileName: string): DataLakeFileClient
Parámetros
- fileName
-
string
Devoluciones
getProperties(FileSystemGetPropertiesOptions)
Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el sistema de archivos especificado.
ADVERTENCIA: El metadata
objeto devuelto en la respuesta tendrá sus claves en minúsculas, incluso si contenían caracteres en mayúsculas originalmente. Esto difiere de las claves de metadatos devueltas por el listFileSystems
método de DataLakeServiceClient mediante la includeMetadata
opción , que conservará su mayúscula y minúscula original.
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties.
function getProperties(options?: FileSystemGetPropertiesOptions): Promise<FileSystemGetPropertiesResponse>
Parámetros
- options
- FileSystemGetPropertiesOptions
Opcional. Opciones al obtener las propiedades del sistema de archivos.
Devoluciones
Promise<FileSystemGetPropertiesResponse>
listDeletedPaths(ListDeletedPathsOptions)
Devuelve un iterador asincrónico para enumerar todas las rutas de acceso (directorios y archivos) en el sistema de archivos especificado.
.byPage() devuelve un iterador asincrónico para enumerar las rutas de acceso de las páginas.
Ejemplo de uso de for await
la sintaxis:
// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const deletePath of fileSystemClient.listDeletedPaths()) {
console.log(`Path ${i++}: ${deletePath.name}`);
}
Ejemplo con iter.next()
:
let i = 1;
let iter = fileSystemClient.listDeletedPaths();
let deletedPathItem = await iter.next();
while (!deletedPathItem.done) {
console.log(`Path ${i++}: ${deletedPathItem.value.name}`);
pathItem = await iter.next();
}
Ejemplo con byPage()
:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
for (const deletePath of response.pathItems) {
console.log(`Path ${i++}: ${deletePath.name}`);
}
}
Ejemplo de uso de paginación con un marcador:
let i = 1;
let iterator = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 path names
for (const path of response.pathItems) {
console.log(`Path ${i++}: ${path.name}}`);
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = fileSystemClient.listDeletedPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 path names
for (const deletePath of response.deletedPathItems) {
console.log(`Path ${i++}: ${deletePath.name}`);
}
Consulta https://docs.microsoft.com/rest/api/storageservices/list-blobs.
function listDeletedPaths(options?: ListDeletedPathsOptions): PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>
Parámetros
- options
- ListDeletedPathsOptions
Opcional. Opciones al enumerar rutas de acceso eliminadas.
Devoluciones
listPaths(ListPathsOptions)
Devuelve un iterador asincrónico para enumerar todas las rutas de acceso (directorios y archivos) en el sistema de archivos especificado.
.byPage() devuelve un iterador asincrónico para enumerar las rutas de acceso de las páginas.
Ejemplo de uso de for await
la sintaxis:
// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const path of fileSystemClient.listPaths()) {
console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}
Ejemplo con iter.next()
:
let i = 1;
let iter = fileSystemClient.listPaths();
let pathItem = await iter.next();
while (!pathItem.done) {
console.log(`Path ${i++}: ${pathItem.value.name}, isDirectory?: ${pathItem.value.isDirectory}`);
pathItem = await iter.next();
}
Ejemplo con byPage()
:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
for (const path of response.pathItems) {
console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}
}
Ejemplo de uso de paginación con un marcador:
let i = 1;
let iterator = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 path names
for (const path of response.pathItems) {
console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 path names
for (const path of response.pathItems) {
console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}
Consulta https://docs.microsoft.com/rest/api/storageservices/list-blobs.
function listPaths(options?: ListPathsOptions): PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>
Parámetros
- options
- ListPathsOptions
Opcional. Opciones al enumerar rutas de acceso.
Devoluciones
setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)
Establece los permisos para el sistema de archivos especificado. Los permisos indican si se puede acceder a los directorios o archivos de un sistema de archivos públicamente.
Al establecer permisos para un sistema de archivos, se reemplazan los permisos existentes. Si no se proporciona ningún acceso o containerAcl, se quitará la ACL del sistema de archivos existente.
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl.
function setAccessPolicy(access?: PublicAccessType, fileSystemAcl?: SignedIdentifier<AccessPolicy>[], options?: FileSystemSetAccessPolicyOptions): Promise<FileSystemSetAccessPolicyResponse>
Parámetros
- access
- PublicAccessType
Opcional. Nivel de acceso público a los datos del sistema de archivos.
- fileSystemAcl
Opcional. Matriz de elementos que tienen un identificador único y detalles de la directiva de acceso.
- options
- FileSystemSetAccessPolicyOptions
Opcional. Opciones al establecer la directiva de acceso del sistema de archivos.
Devoluciones
Promise<FileSystemSetAccessPolicyResponse>
setMetadata(Metadata, FileSystemSetMetadataOptions)
Establece uno o varios pares nombre-valor definidos por el usuario para el sistema de archivos especificado.
Si no se proporciona ninguna opción o no hay metadatos definidos en el parámetro , se quitarán los metadatos del sistema de archivos.
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata.
function setMetadata(metadata?: Metadata, options?: FileSystemSetMetadataOptions): Promise<FileSystemSetMetadataResponse>
Parámetros
- metadata
- Metadata
Reemplace los metadatos existentes por este valor. Si no se quita ningún valor proporcionado, se quitarán los metadatos existentes.
- options
- FileSystemSetMetadataOptions
Opcional. Opciones al establecer metadatos del sistema de archivos.
Devoluciones
Promise<FileSystemSetMetadataResponse>
undeletePath(string, string, FileSystemUndeletePathOption)
Restaura una ruta de acceso eliminada temporalmente.
Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob.
function undeletePath(deletedPath: string, deletionId: string, options?: FileSystemUndeletePathOption): Promise<FileSystemUndeletePathResponse>
Parámetros
- deletedPath
-
string
Necesario. Ruta de acceso de la ruta de acceso eliminada.
- deletionId
-
string
Necesario. Identificador de eliminación asociado a la ruta de acceso eliminada temporalmente.
- options
- FileSystemUndeletePathOption
Devoluciones
Promise<FileSystemUndeletePathResponse>