@azure/storage-file-datalake package

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un AccountSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà le autorizzazioni per tale operazione. Dopo aver impostato tutti i valori, questo valore deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto AccountSASSignatureValues . È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza.

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Si tratta di una classe helper per costruire una stringa che rappresenta le risorse accessibili da un AccountSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà l'accesso a tale tipo di risorsa. Dopo aver impostato tutti i valori, questo valore deve essere serializzato con toString e impostato come campo delle risorse in un oggetto AccountSASSignatureValues . È possibile costruire la stringa di risorse senza questa classe, ma l'ordine delle risorse è particolare e questa classe garantisce la correttezza.

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Si tratta di una classe helper per costruire una stringa che rappresenta i servizi accessibili da un AccountSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà l'accesso a tale servizio. Dopo aver impostato tutti i valori, questo valore deve essere serializzato con toString e impostato come campo dei servizi in un oggetto AccountSASSignatureValues . È possibile costruire la stringa dei servizi senza questa classe, ma l'ordine dei servizi è particolare e questa classe garantisce la correttezza.

AnonymousCredential fornisce un membro credentialPolicyCreator usato per creare oggetti AnonymousCredentialPolicy. AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggono risorse pubbliche o per l'uso con firme di accesso condiviso.

AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggono risorse pubbliche o per l'uso con firme di accesso condiviso.

Classe di base da cui derivano tutti i criteri di richiesta.

Credential è una classe astratta per la firma delle richieste HTTP di Archiviazione di Azure. Questa classe ospiterà una factory credentialPolicyCreator che genera CredentialPolicy.

Criteri delle credenziali usati per firmare le richieste HTTP(S) prima dell'invio. Questa è una classe abstract.

Viene generato un errore quando un'operazione viene interrotta e può essere continuata in un secondo momento.

DataLakeDirectoryClient rappresenta un URL della directory di Archiviazione di Azure.

DataLakeFileClient rappresenta un URL del file di archiviazione di Azure.

DataLakeFileSystemClient rappresenta un URL del file system di Archiviazione di Azure che consente di modificare le directory e i file.

DataLakePathClient rappresenta un URL del percorso di Archiviazione di Azure (directory o file).

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un ServiceSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà le autorizzazioni per tale operazione. Dopo aver impostato tutti i valori, questo valore deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto DataLakeSASSignatureValues . È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza.

DataLakeServiceClient consente di modificare le risorse e i file system del servizio Azure Data Lake. L'account di archiviazione fornisce lo spazio dei nomi di primo livello per il servizio Data Lake.

Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un ServiceSAS a una directory. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà le autorizzazioni per tale operazione. Dopo aver impostato tutti i valori, questo valore deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto DataLakeSASSignatureValues . È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza.

Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un serviceSAS a un contenitore. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà le autorizzazioni per tale operazione. Dopo aver impostato tutti i valori, questa operazione deve essere serializzata con toString e impostata come campo autorizzazioni in un oggetto DataLakeSASSignatureValues . È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è specifico e questa classe garantisce la correttezza.

Classe Pipeline contenente i criteri di richiesta HTTP. È possibile creare una pipeline predefinita chiamando newPipeline. In alternativa, è possibile creare una pipeline con criteri personalizzati dal costruttore di Pipeline.

Fare riferimento a newPipeline e ai criteri forniti prima di implementare la pipeline personalizzata.

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

Rappresenta i componenti che costituiscono i parametri di query della firma di accesso condiviso di Archiviazione di Azure. Questo tipo non viene costruito direttamente dall'utente; viene generato solo dai tipi e <xref:BlobSASSignatureValues>AccountSASSignatureValues. Una volta generato, può essere codificato in un toString() oggetto e aggiunto direttamente a un URL( anche se è necessario prestare attenzione nel caso in cui siano presenti parametri di query esistenti, che potrebbero influire sui mezzi appropriati per accodare questi parametri di query).

NOTA: le istanze di questa classe non sono modificabili.

StorageBrowserPolicy gestirà le differenze tra Node.js e il runtime del browser, tra cui:

1. I browser memorizzano nella cache le richieste GET/HEAD aggiungendo intestazioni condizionali, ad esempio "IF_MODIFIED_SINCE". StorageBrowserPolicy è un criterio usato per aggiungere una query timestamp all'URL della richiesta GET/HEAD, evitando così la cache del browser.

2. Rimuovere l'intestazione del cookie per la sicurezza

3. Rimuovere l'intestazione content-length per evitare avvisi del browser

StorageBrowserPolicyFactory è una classe factory che consente di generare oggetti StorageBrowserPolicy.

Criteri di ripetizione dei tentativi con ripetizione esponenziale e ripetizione lineare implementati.

StorageRetryPolicyFactory è una classe factory che consente di generare oggetti StorageRetryPolicy .

DISPONIBILE SOLO IN NODE.JS RUNTIME.

StorageSharedKeyCredential per l'autorizzazione della chiave dell'account del servizio archiviazione di Azure.

StorageSharedKeyCredentialPolicy è un criterio usato per firmare una richiesta HTTP con una chiave condivisa.

AccessControlChangeCounters contiene i conteggi delle operazioni che modificano gli elenchi di controllo di accesso in modo ricorsivo.

Rappresenta una voce che non è riuscita ad aggiornare l'elenco di controllo di accesso durante setAccessControlRecursivee updateAccessControlRecursiveremoveAccessControlRecursive.

AccessControlChanges contiene conteggi batch e cumulativi delle operazioni che modificano gli elenchi di controllo di accesso in modo ricorsivo. Espone inoltre le voci di percorso che non sono riuscite ad aggiornare durante l'avanzamento di queste operazioni.

DISPONIBILE SOLO IN NODE.JS RUNTIME.

AccountSASSignatureValues viene usato per generare una firma di accesso condiviso per un account di archiviazione di Azure. Dopo aver impostato tutti i valori qui in modo appropriato, chiamare generateAccountSASQueryParameters per ottenere una rappresentazione della firma di accesso condiviso che può essere effettivamente applicata agli URL del data lake. Nota: questa classe e SASQueryParameters esistono perché la prima è modificabile e una rappresentazione logica, mentre quest'ultima non è modificabile e usata per generare richieste REST effettive.

Per https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 altre informazioni concettuali sulla firma di accesso condiviso, vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas per le descrizioni dei parametri, inclusi quelli necessari

UN BLOB di Archiviazione di Azure

Proprietà di un BLOB

Opzioni comuni di FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions e FileGenerateSasUrlOptions.

Interfaccia per le opzioni comuni a ogni operazione remota.

Gruppo di parametri

Gruppo di parametri

DISPONIBILE SOLO IN NODE.JS RUNTIME.

DataLakeSASSignatureValues viene usato per generare token di firma di accesso condiviso del servizio Blob e DataLake per contenitori, BLOB, file system, directory e file.

Proprietà del servizio di archiviazione.

Interfaccia per le opzioni comuni a ogni operazione remota.

Contiene i dati di risposta per l'operazione createIfNotExists .

Opzioni per configurare l'operazione generateSasUrl .

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Contiene i dati di risposta per l'operazione createIfNotExists .

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Opzioni per configurare l'operazione generateSasUrl .

Interfaccia di opzione per il file Data Lake - Operazioni di caricamento

Vedere:

• upload
• uploadFile
• uploadStream

Opzioni per eseguire query sul file con formato CSV.

Tipo di errore di query file.

Opzioni per eseguire query su file con formato JSON.

Interfaccia dell'opzione per il file Data Lake - Operazioni di query

Vedere:

• query

Opzioni per eseguire query su file con formato Parquet.

Interfaccia di opzione per il file Data Lake - Operazioni readToBuffer

Vedere:

• readToBuffer

Definisce le intestazioni per l'operazione di Path_setExpiry.

Interfaccia dell'opzione per l'operazione setExpiry .

Contiene i dati di risposta per l'operazione createIfNotExists .

Contiene i dati di risposta per l'operazione deleteIfExists .

Interfaccia per le opzioni comuni a ogni operazione remota.

Opzioni per specificare l'ambito di crittografia in un file system.

L'interfaccia dell'opzione per il file system di Data Lake esiste

Vedere:

• exists

Opzioni per configurare l'operazione generateSasUrl .

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Definisce le intestazioni per l'operazione di FileSystem_listBlobHierarchySegment.

Definisce le intestazioni per l'operazione di FileSystem_listPaths.

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Raccolta di coppie chiave/valore dell'intestazione HTTP.

Risposta Http compatibile con core-v1(core-http).

Interfaccia compatibile per i criteri di richiesta core-http

Dettagli per un lease specifico.

Gruppo di parametri

Configura le operazioni di lease.

Enumerazione dei BLOB

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Definisce le intestazioni per l'operazione di Path_appendData.

Tipo di opzioni per setAccessControlRecursivee removeAccessControlRecursiveupdateAccessControlRecursive .

Tipo di risposta per setAccessControlRecursivee removeAccessControlRecursiveupdateAccessControlRecursive .

Definisce le intestazioni per l'operazione di Path_create.

Interfaccia per le opzioni comuni a ogni operazione remota.

Contiene i dati di risposta per l'operazione createIfNotExists .

Interfaccia per le opzioni comuni a ogni operazione remota.

Definisce le intestazioni per l'operazione di Path_delete.

Contiene i dati di risposta per l'operazione deleteIfExists .

Interfaccia per le opzioni comuni a ogni operazione remota.

L'interfaccia dell'opzione per la directory/file di Data Lake esiste

Vedere:

• exists

Definisce le intestazioni per l'operazione di Path_flushData.

Interfaccia per le opzioni comuni a ogni operazione remota.

Definisce le intestazioni per l'operazione di Path_getProperties.

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Definisce le intestazioni per l'operazione di Path_setAccessControl.

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Interfaccia per le opzioni comuni a ogni operazione remota.

Definisce le intestazioni per Path_undelete'operazione.

Definisce le intestazioni per Path_update'operazione.

Interfaccia per la classe Pipeline contenente i criteri di richiesta HTTP. È possibile creare una pipeline predefinita chiamando newPipeline. In alternativa, è possibile creare una pipeline con criteri personalizzati dal costruttore di Pipeline.

Fare riferimento a newPipeline e ai criteri forniti prima di implementare la pipeline personalizzata.

Interfaccia di opzione per il costruttore Pipeline.

Interfaccia per la compatibilità con RequestPolicyFactory di core-http

Interfaccia per la compatibilità con RequestPolicy

Opzioni per costruire SASQueryParameters.

Intervallo IP consentito per una firma di accesso condiviso.

Subset di @azure/core-http ServiceClientOptions

Opzioni per configurare l'operazione generateAccountSasUrl .

Interfaccia per le opzioni comuni a ogni operazione remota.

Opzioni per configurare undeleteFileSystem.

Interfaccia options per la funzione newPipeline .

Interfaccia delle opzioni di ripetizione dei tentativi dei BLOB di archiviazione.

Chiave di delega utente

Descrizione di una richiesta HTTP da effettuare a un server remoto.

Contiene i dati di risposta per l'operazione getProperties.

Definisce i valori per EncryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> può essere usato in modo intercambiabile con EncryptionAlgorithmType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Nessuna
AES256

Definisce i valori per PathExpiryOptions.

Opzioni per eseguire query su file con formato Apache Arrow. Valido solo per outputTextConfiguration.

Contiene i dati di risposta per l'operazione <xref:DataLakeServiceClient.renameFileSystem> .

Contiene i dati di risposta per l'operazione undeleteFileSystem .

Tipi di corpi supportati nella richiesta. NodeJS.ReadableStream e () => NodeJS.ReadableStream è solo Node. BLOB, ReadableStream e () => ReadableStream sono solo browser.

Contiene i dati di risposta per le operazioni che creano, modificano o eliminano un lease.

Vedere <xref:BlobLeaseClient>.

Definisce i valori per PathGetPropertiesAction.

Definisce i valori per PathRenameMode.

Definisce i valori per PathResourceType.

Contiene i dati di risposta per l'operazione listContainersSegment.

Opzioni per configurare <xref:DataLakeServiceClient.renameFileSystem>.

Definisce i valori per PathGetPropertiesAction. I valori possibili includono: 'getAccessControl', 'getStatus'

Definisce i valori per PathRenameMode. I valori possibili includono: 'legacy', 'posix'

Definisce i valori per PathResourceType. I valori possibili includono: 'directory', 'file'

Protocolli per la firma di accesso condiviso generato.

Definisce i gruppi di destinatari del cloud noti per l'archiviazione.

Tipi RetryPolicy.

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Genera un oggetto SASQueryParameters che contiene tutti i parametri di query sas necessari per effettuare una richiesta REST effettiva.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Crea un'istanza di SASQueryParameters.

Accetta solo le impostazioni necessarie per creare una firma di accesso condiviso. Per le impostazioni facoltative, impostare direttamente le proprietà corrispondenti, ad esempio autorizzazioni, startsOn e identificatore.

AVVISO: quando non viene specificato l'identificatore, sono necessarie autorizzazioni e expiresOn. È NECESSARIO assegnare il valore all'identificatore o alla scadenzaOn & manualmente le autorizzazioni se si esegue l'inizializzazione con questo costruttore.

Compilare i dettagli necessari prima di eseguire i frammenti di codice seguenti.

Esempio

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Compilare i dettagli necessari prima di eseguire il frammento.

Esempio

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Crea un'istanza di SASQueryParameters. AVVISO: l'identificatore verrà ignorato durante la generazione della firma di accesso condiviso della delega utente, le autorizzazioni e la scadenzaOn sono necessari.

Esempio

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

Per ottenere destinatari OAuth per un account di archiviazione per il servizio datalake.

Helper per decidere se un determinato argomento soddisfa il contratto pipeline

Crea un nuovo oggetto Pipeline con credenziali fornite.