AdlsClient Clase

Definición

Espacio de nombres:

Microsoft.Azure.DataLake.Store

Ensamblado:

Microsoft.Azure.DataLake.Store.dll

Paquete:

Microsoft.Azure.DataLake.Store v1.1.24

Cliente de Azure Data Lake Store. Contiene las API públicas para realizar operaciones de api REST que son más fáciles de llamar y más utilizables que las API principales. Las API principales proporcionan más libertad, pero ADLSClient proporcionan formularios más usados con más frecuencia. Encapsula el token de autorización y la actualización del token. Contiene métodos de fábrica que toman un ServiceClientCredential o un token de autenticación de cadena y devuelven la instancia de esta clase. Para cada operación, proporciona una versión asincrónica y de sincronización. Cada método de sincronización es una espera en el método asincrónico con excepción de Create y Concurrent append. Todas las API son seguras para subprocesos con algunas excepciones en CreateFile y GetAppendStream. No se puede llamar a CreateFile y GetAppendStream para la misma ruta de acceso de subprocesos diferentes porque la escritura se realiza con una concesión para que haya conflictos de concesión Si una aplicación quiere realizar operaciones multiproceso mediante este SDK, se recomienda encarecidamente establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que el SDK use antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit se establece en 2. Adls usa NLog para el registro. adls.dotnet.* es el nombre del registrador para obtener todos los registros.

public class AdlsClient

type AdlsClient = class

Public Class AdlsClient

Herencia

Object

AdlsClient

Derivado

Microsoft.Azure.DataLake.Store.MockAdlsFileSystem.MockAdlsClient

Constructores

AdlsClient()

Constructor protegido para pruebas moq

Campos

ClientLogger

Registrador para registrar información (depuración, error o seguimiento) con respecto al cliente

Propiedades

AccountFQDN	Nombre de cuenta de Azure Data Lake Store, incluido el nombre de dominio completo
ClientId	Id. de objeto de cliente
DefaultNumThreads	Número predeterminado de subprocesos usados por herramientas como el cargador o el descargador, el cambio de acl recursivo y otras herramientas multiproceso mediante el SDK. Se puede usar para establecer ServicePointManager.DefaultConnectionLimit si desea que el SDK decida el número de subprocesos que usa para las herramientas multiproceso.

Métodos

AddUserAgentSuffix(String)	Agrega el sufijo del agente de usuario.
BulkDownload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	Descargue el directorio o el archivo del servidor remoto a local. Transfiere el contenido en el directorio de origen en el directorio de destino. Transfiere el archivo de origen y lo guarda como ruta de acceso de destino. Este método no produce ninguna excepción para el error de transferencia de ninguna entrada. Consulte el valor TransferStatus devuelto para obtener el estado o la excepción de la transferencia de cada entrada. De forma predeterminada, registra el progreso de la transferencia en la ruta temporal del sistema, para que el usuario pueda recuperarse mediante resume si la carga se ha bloqueado. Este registro de progreso se puede deshabilitar mediante disableTransferLogging. Se recomienda encarecidamente establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que el sdk use antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit se establece en 2.
BulkDownload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	Descargue el directorio o el archivo del servidor remoto a local. Transfiere el contenido en el directorio de origen en el directorio de destino. Transfiere el archivo de origen y lo guarda como ruta de acceso de destino. Este método no produce ninguna excepción para el error de transferencia de ninguna entrada. Consulte el valor TransferStatus devuelto para obtener el estado o la excepción de la transferencia de cada entrada. Se recomienda encarecidamente establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que el sdk use antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit se establece en 2.
BulkUpload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	Cargue el directorio o el archivo de local a remoto. Transfiere el contenido en el directorio de origen en el directorio de destino. Transfiere el archivo de origen y lo guarda como ruta de acceso de destino. Este método no produce ninguna excepción para el error de transferencia de ninguna entrada. Consulte el valor TransferStatus devuelto para obtener el estado o la excepción de la transferencia de cada entrada. De forma predeterminada, registra el progreso de la transferencia en la ruta temporal del sistema, para que el usuario pueda recuperarse mediante resume si la carga se ha bloqueado. Este registro de progreso se puede deshabilitar mediante disableTransferLogging. Se recomienda encarecidamente establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que el sdk use antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit se establece en 2. De forma predeterminada, los archivos se cargan en nuevos límites de línea. Sin embargo, si los archivos no tienen nueva línea dentro de fragmentos de 4 MB, se producirá un error en la transferencia. En ese caso, es necesario pasar true para isBinary evitar cargas en límites de nueva línea.
BulkUpload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	Cargue el directorio o el archivo de local a remoto. Transfiere el contenido en el directorio de origen en el directorio de destino. Transfiere el archivo de origen y lo guarda como ruta de acceso de destino. Este método no produce ninguna excepción para el error de transferencia de ninguna entrada. Consulte el valor TransferStatus devuelto para obtener el estado o la excepción de la transferencia de cada entrada. Se recomienda encarecidamente establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que el sdk use antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit se establece en 2. De forma predeterminada, los archivos se cargan en nuevos límites de línea. Sin embargo, si los archivos no tienen nueva línea dentro de fragmentos de 4 MB, se producirá un error en la transferencia. En ese caso, es necesario pasar true para isBinary evitar cargas en límites de nueva línea.
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32)	Cambiar Acl (Modificar, establecer y quitar) de forma recursiva en un árbol de directorios Es muy recomendable establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que use el SDK antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit se establece en 2.
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32, IProgress<AclProcessorStats>, CancellationToken)	Cambiar Acl (Modificar, establecer y quitar) de forma recursiva en un árbol de directorios Es muy recomendable establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que use el SDK antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit se establece en 2.
CheckAccess(String, String, CancellationToken)	Comprueba si el usuario o grupo ha especificado el acceso de la ruta de acceso especificada.
CheckAccessAsync(String, String, CancellationToken)	Comprueba de forma asincrónica si el usuario o grupo ha especificado el acceso de la ruta de acceso especificada.
CheckExists(String)	Comprueba si existe un archivo o directorio.
ConcatenateFiles(String, List<String>, Boolean, CancellationToken)	API sincrónica para concatenar archivos de origen en un archivo de destino
ConcatenateFilesAsync(String, List<String>, Boolean, CancellationToken)	API asincrónica para concatenar archivos de origen en un archivo de destino
ConcurrentAppend(String, Boolean, Byte[], Int32, Int32)	API sincrónica para realizar la anexión simultánea en el servidor. El servidor determina el desplazamiento en el que se producirá la anexión. Se recomienda llamar a esta API con un tamaño de datos menor que 4 MB. Back-end gurantees 4 MB anexados atómicos.
ConcurrentAppendAsync(String, Boolean, Byte[], Int32, Int32, CancellationToken)	API asincrónica para realizar anexaciones simultáneas en el servidor. El servidor determina el desplazamiento en el que se producirá la anexión. Operación asincrónica. Se recomienda llamar a esta API con un tamaño de datos menor que 4 MB. Back-end gurantees 4 MB anexados atómicos.
CreateClient(String, ServiceClientCredentials)	Método factory que crea una instancia de AdlsClient mediante ServiceClientCredential. Si una aplicación quiere realizar operaciones multiproceso mediante este SDK, se recomienda encarecidamente establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que use el SDK antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit se establece en 2.
CreateClient(String, String)	Método factory que crea una instancia de AdlsClient mediante la clave de token. Si una aplicación quiere realizar operaciones multiproceso mediante este SDK, se recomienda encarecidamente establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que use el SDK antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit se establece en 2.
CreateDirectory(String, String, CancellationToken)	API sincrónica para crear un directorio
CreateDirectoryAsync(String, String, CancellationToken)	API asincrónica para crear un directorio.
CreateFile(String, IfExists, String, Boolean)	API sincrónica que crea un archivo y devuelve la secuencia para escribir datos en ese archivo en ADLS. El archivo se abre con acceso exclusivo; cualquier intento de abrir el mismo archivo para append producirá un error mientras esta secuencia está abierta. Subprocesos: la secuencia devuelta no es segura para subprocesos.
CreateFileAsync(String, IfExists, String, Boolean, CancellationToken)	API asincrónica que crea un archivo y devuelve la secuencia para escribir datos en ese archivo en ADLS. El archivo se abre con acceso exclusivo; cualquier intento de abrir el mismo archivo para append producirá un error mientras esta secuencia está abierta. Subprocesos: la secuencia devuelta no es segura para subprocesos.
Delete(String, CancellationToken)	API sincrónica para eliminar un archivo o directorio. Para el directorio, solo se eliminará si está vacío.
DeleteAsync(String, CancellationToken)	Api asincrónica para eliminar un archivo o directorio. Para el directorio, solo se eliminará si está vacío.
DeleteRecursive(String, CancellationToken)	API sincrónica para eliminar un archivo o directorio de forma recursiva. Si es un directorio no vacío, elimina los subdirectorios o los archivos.
DeleteRecursiveAsync(String, CancellationToken)	API asincrónica para eliminar un archivo o directorio de forma recursiva
EnumerateDeletedItems(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	Busque la papelera en una cuenta con sugerencia y un punto de partida. Se trata de una operación de larga duración y el usuario se actualiza periódicamente con el progreso. Precaución: La eliminación de archivos es una operación de mejor esfuerzo. No hay garantías de que se pueda restaurar un archivo una vez eliminado. El uso de esta API está habilitado mediante la inclusión en la lista blanca. Si la cuenta de ADL no está en la lista de permitidos, el uso de esta API producirá una excepción no implementada. Para obtener más información y ayuda, póngase en contacto con el soporte técnico de Microsoft.
EnumerateDeletedItemsAsync(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	Obtiene asincrónicamente las entradas de papelera Precaución: La eliminación de archivos es una operación de mejor esfuerzo. No hay garantías de que se pueda restaurar un archivo una vez eliminado. El uso de esta API está habilitado mediante la inclusión en la lista blanca. Si la cuenta de ADL no está en la lista de permitidos, el uso de esta API producirá una excepción no implementada. Para obtener más información y ayuda, póngase en contacto con el soporte técnico de Microsoft.
EnumerateDirectory(String, UserGroupRepresentation, CancellationToken)	Devuelve un enumerador que enumera los subdirectorios o archivos contenidos en un directorio. De forma predeterminada, listAfter y listBefore están vacíos y enumeramos todas las entradas del directorio.
GetAclStatus(String, UserGroupRepresentation, CancellationToken)	Obtiene la lista de entradas de ACL, el identificador de propietario, el identificador de grupo, el permiso octal y el bit pegajoso (solo para un directorio) del archivo o directorio.
GetAclStatusAsync(String, UserGroupRepresentation, CancellationToken)	Obtiene de forma asincrónica la lista de entradas de ACL, el identificador de propietario, el identificador de grupo, el permiso octal y el bit pegajoso (solo para un directorio) del archivo o directorio.
GetAppendStream(String, CancellationToken)	API sincrónica que devuelve la secuencia para escribir datos en un archivo en ADLS. El archivo se abre con acceso exclusivo; cualquier intento de abrir el mismo archivo para append producirá un error mientras esta secuencia está abierta. Subprocesos: la secuencia devuelta no es segura para subprocesos.
GetAppendStreamAsync(String, CancellationToken)	API asincrónica que devuelve la secuencia para escribir datos en un archivo en ADLS. El archivo se abre con acceso exclusivo; cualquier intento de abrir el mismo archivo para append producirá un error mientras esta secuencia está abierta. Subprocesos: la secuencia devuelta no es segura para subprocesos.
GetContentSummary(String, Int32, CancellationToken)	Obtiene el resumen de contenido de un archivo o directorio. Se recomienda encarecidamente establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que use el SDK antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit está establecido en 2.
GetDirectoryEntry(String, UserGroupRepresentation, CancellationToken)	Obtiene metadatos de forma sincrónica, como ruta de acceso completa, tipo (archivo o directorio), grupo, usuario, permiso, longitud, hora de último acceso,hora de última modificación, hora de expiración, acl Bit, factor de replicación
GetDirectoryEntryAsync(String, UserGroupRepresentation, CancellationToken)	Obtiene de forma asincrónica metadatos como ruta de acceso completa, tipo (archivo o directorio), grupo, usuario, permiso, longitud, hora de último acceso,hora de última modificación, hora de expiración, acl Bit, factor de replicación
GetExceptionFromResponse(OperationResponse, String)	Devuelve una excepción de ADLS basada en la respuesta del servidor.
GetFileProperties(String, Boolean, String, Boolean, Boolean, Int32, Boolean, Boolean, Int64, CancellationToken)	Volca de forma recursiva la propiedad de archivo de todos los directorios o archivos en la ruta de acceso especificada a un archivo local o adl. La propiedad file puede ser el uso del disco o Acl o ambos. Se recomienda encarecidamente establecer ServicePointManager.DefaultConnectionLimit en el número de subprocesos que la aplicación quiere que use el SDK antes de crear cualquier instancia de AdlsClient. De forma predeterminada, ServicePointManager.DefaultConnectionLimit está establecido en 2.
GetReadStream(String, CancellationToken)	API sincrónica que devuelve la secuencia para leer datos del archivo en ADLS
GetReadStream(String, Int32, CancellationToken)	API sincrónica que devuelve la secuencia para leer datos del archivo en ADLS
GetReadStreamAsync(String, CancellationToken)	API asincrónica que devuelve la secuencia para leer datos del archivo en ADLS
GetReadStreamAsync(String, Int32, CancellationToken)	API asincrónica que devuelve la secuencia para leer datos del archivo en ADLS
ModifyAclEntries(String, List<AclEntry>, CancellationToken)	Modifica las entradas acl de un archivo o directorio con una lista de ACL determinada. Combina la lista de ACL exisitng con una lista determinada.
ModifyAclEntriesAsync(String, List<AclEntry>, CancellationToken)	Modifica de forma asincrónica las entradas acl de un archivo o directorio con una lista de ACL determinada. Combina la lista de ACL exisitng con una lista determinada.
RemoveAclEntries(String, List<AclEntry>, CancellationToken)	Quita las entradas de Acl especificadas para un archivo o directorio.
RemoveAclEntriesAsync(String, List<AclEntry>, CancellationToken)	Quita de forma asincrónica las entradas de Acl especificadas para un archivo o directorio.
RemoveAllAcls(String, CancellationToken)	Quita todas las entradas de Acl de un archivo o directorio.
RemoveAllAclsAsync(String, CancellationToken)	Quita de forma asincrónica todas las entradas de Acl para un archivo o directorio.
RemoveDefaultAcls(String, CancellationToken)	Quita todas las entradas de Acl De forma predeterminada para un archivo o directorio.
RemoveDefaultAclsAsync(String, CancellationToken)	Quita de forma asincrónica todas las entradas de AclScope predeterminadas para un archivo o directorio.
Rename(String, String, Boolean, CancellationToken)	API sincrónica para cambiar el nombre de un archivo o directorio. Para cambiar el nombre del directorio: si el destino existe, coloca el directorio de origen en un nivel bajo el destino.
RenameAsync(String, String, Boolean, CancellationToken)	API asincrónica para cambiar el nombre de un archivo o directorio. Para cambiar el nombre del directorio: si el destino existe, coloca el directorio de origen en un nivel bajo el destino.
RestoreDeletedItems(String, String, String, String, CancellationToken)	Restaura de forma sincrónica la entrada de papelera Precaución: La eliminación de archivos es una operación de mejor esfuerzo. No hay garantías de que se pueda restaurar un archivo una vez eliminado. El uso de esta API está habilitado mediante la inclusión en la lista blanca. Si la cuenta de ADL no está en la lista de permitidos, el uso de esta API producirá una excepción no implementada. Para obtener más información y ayuda, póngase en contacto con el soporte técnico de Microsoft.
RestoreDeletedItemsAsync(String, String, String, String, CancellationToken)	Restaura asincrónicamente la entrada de papelera Precaución: La eliminación de archivos es una operación de mejor esfuerzo. No hay garantías de que se pueda restaurar un archivo una vez eliminado. El uso de esta API está habilitado mediante la inclusión en la lista blanca. Si la cuenta de ADL no está en la lista de permitidos, el uso de esta API producirá una excepción no implementada. Para obtener más información y ayuda, póngase en contacto con el soporte técnico de Microsoft.
SetAcl(String, List<AclEntry>, CancellationToken)	Establece entradas de Acl para un archivo o directorio. Borra las entradas de Acl existentes para la ruta de acceso.
SetAclAsync(String, List<AclEntry>, CancellationToken)	Establece asincrónicamente entradas de Acl para un archivo o directorio. Borra las entradas de Acl existentes para la ruta de acceso.
SetConditionalCreateWithOverwrite(Boolean)	Establece si se va a realizar la creación condicional con sobrescritura. Ayuda a resolver problemas atómicos con reintentos
SetExpiryTime(String, ExpiryOption, Int64, CancellationToken)	Establece de forma sincrónica la hora de expiración
SetExpiryTimeAsync(String, ExpiryOption, Int64, CancellationToken)	Establece de forma asincrónica la hora de expiración
SetOwner(String, String, String, CancellationToken)	Establece el propietario o el grupo de la ruta de acceso.
SetOwnerAsync(String, String, String, CancellationToken)	Establece de forma asincrónica el propietario o el grupo de la ruta de acceso.
SetPermission(String, String, CancellationToken)	Establece el permiso de la ruta de acceso especificada.
SetPermissionAsync(String, String, CancellationToken)	Establece de forma asincrónica el permiso de la ruta de acceso especificada.
SetPerRequestTimeout(TimeSpan)	Establece el tiempo de espera por solicitud. Se recomienda encarecidamente establecerlo después de crear el cliente. No se recomienda establecerlo mientras las solicitudes están en curso desde un subproceso diferente.
SetToken(String)	Establece el token de autenticación.