@azure/storage-file-datalake package
Classi
| AccountSASPermissions |
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. |
| AccountSASResourceTypes |
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 consentirà 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. |
| AccountSASServices |
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 consentirà 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 |
AnonymousCredential fornisce un membro credentialPolicyCreator usato per creare oggetti AnonymousCredentialPolicy. AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggono risorse pubbliche o da usare con firme di accesso condiviso. |
| AnonymousCredentialPolicy |
AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggono risorse pubbliche o da usare con firme di accesso condiviso. |
| BaseRequestPolicy |
Classe di base da cui derivano tutti i criteri di richiesta. |
| Credential |
Credential è una classe astratta per la firma delle richieste HTTP di Archiviazione di Azure. Questa classe ospiterà una factory credentialPolicyCreator che genera CredentialPolicy. |
| CredentialPolicy |
Criteri di credenziali usati per firmare le richieste HTTP(S) prima dell'invio. Si tratta di una classe astratta. |
| DataLakeAclChangeFailedError |
Errore generato quando un'operazione viene interrotta e può essere continuata in un secondo momento. |
| DataLakeDirectoryClient |
DataLakeDirectoryClient rappresenta un URL della directory di Archiviazione di Azure. |
| DataLakeFileClient |
Un Oggetto DataLakeFileClient rappresenta un URL del file di archiviazione di Azure. |
| DataLakeFileSystemClient |
DataLakeFileSystemClient rappresenta un URL del file system di Archiviazione di Azure che consente di modificare le directory e i file. |
| DataLakeLeaseClient | |
| DataLakePathClient |
DataLakePathClient rappresenta un URL del percorso di Archiviazione di Azure (directory o file). |
| DataLakeSASPermissions |
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, deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto DataLakeSASSignatureValues di. È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza. |
| DataLakeServiceClient |
DataLakeServiceClient consente di modificare le risorse del servizio Azure Data Lake e i file system. L'account di archiviazione fornisce lo spazio dei nomi di primo livello per il servizio Data Lake. |
| DirectorySASPermissions |
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, deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto DataLakeSASSignatureValues di. È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza. |
| FileSystemSASPermissions |
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, deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto DataLakeSASSignatureValues di. È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza. |
| Pipeline |
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. |
| SASQueryParameters |
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 AccountSASSignatureValues e <xref:BlobSASSignatureValues>. Una volta generato, può essere codificato in un toString() e accodato 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 |
StorageBrowserPolicy gestirà le differenze tra Node.js e il runtime del browser, tra cui:
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory è una classe factory che consente di generare oggetti StorageBrowserPolicy. |
| StorageRetryPolicy |
Criteri di ripetizione dei tentativi con ripetizione esponenziale e ripetizione lineare implementati. |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory è una classe factory che consente di generare oggetti StorageRetryPolicy. |
| StorageSharedKeyCredential |
DISPONIBILE SOLO IN NODE.JS RUNTIME. StorageSharedKeyCredential per l'autorizzazione della chiave dell'account del servizio archiviazione di Azure. |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy è un criterio usato per firmare una richiesta HTTP con una chiave condivisa. |
Interfacce
| AccessControlChangeCounters |
AccessControlChangeCounters contiene i conteggi delle operazioni che modificano gli elenchi di controllo di accesso in modo ricorsivo. |
| AccessControlChangeError |
Rappresenta una voce che non è riuscita ad aggiornare l'elenco di controllo di accesso durante |
| AccessControlChanges |
AccessControlChanges contiene conteggi cumulativi e batch di 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. |
| AccessPolicy | |
| AccountSASSignatureValues |
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. Si noti che sia questa classe che SASQueryParameters esistono perché il primo è modificabile e una rappresentazione logica mentre quest'ultimo non è modificabile e usato per generare richieste REST effettive. Per altre informazioni concettuali sulla firma di accesso condiviso, vedere https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas per le descrizioni dei parametri, inclusi quelli necessari |
| BlobHierarchyListSegment | |
| BlobItemModel |
UN BLOB di Archiviazione di Azure |
| BlobPrefix | |
| BlobPropertiesModel |
Proprietà di un BLOB |
| CommonGenerateSasUrlOptions |
Opzioni comuni dell'FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions e FileGenerateSasUrlOptions. |
| CommonOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| CpkInfo |
Gruppo di parametri |
| DataLakeRequestConditions |
Gruppo di parametri |
| DataLakeSASSignatureValues |
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. |
| DataLakeServiceProperties |
Proprietà del servizio di archiviazione. |
| DeletedPath | |
| DeletedPathList | |
| DirectoryCreateIfNotExistsOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| DirectoryCreateIfNotExistsResponse |
Contiene i dati di risposta per l'operazione di createIfNotExists. |
| DirectoryCreateOptions |
|
| DirectoryCreateResponse | |
| DirectoryGenerateSasUrlOptions |
Opzioni per configurare 'operazione di generateSasUrl. |
| FileAppendOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| FileCreateIfNotExistsOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| FileCreateIfNotExistsResponse |
Contiene i dati di risposta per l'operazione di createIfNotExists. |
| FileCreateOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| FileCreateResponse | |
| FileFlushOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| FileGenerateSasUrlOptions |
Opzioni per configurare 'operazione di generateSasUrl. |
| FileParallelUploadOptions |
Interfaccia dell'opzione per il file Data Lake - Operazioni di caricamento See: |
| FileQueryCsvTextConfiguration |
Opzioni per eseguire query su file con formato CSV. |
| FileQueryError |
Tipo di errore della query file. |
| FileQueryJsonTextConfiguration |
Opzioni per eseguire query su file con formato JSON. |
| FileQueryOptions |
Interfaccia dell'opzione per il file Data Lake - Operazioni di query See: |
| FileQueryParquetConfiguration |
Opzioni per eseguire query sul file con formato Parquet. |
| FileReadHeaders | |
| FileReadOptions |
|
| FileReadToBufferOptions |
Interfaccia di opzione per il file Data Lake - Operazioni readToBuffer See: |
| FileSetExpiryHeaders |
Definisce le intestazioni per Path_setExpiry'operazione. |
| FileSetExpiryOptions |
Interfaccia di opzione per l'operazione setExpiry. |
| FileSystemCreateHeaders | |
| FileSystemCreateIfNotExistsResponse |
Contiene i dati di risposta per l'operazione di createIfNotExists. |
| FileSystemCreateOptions |
|
| FileSystemDeleteHeaders | |
| FileSystemDeleteIfExistsResponse |
Contiene i dati di risposta per l'operazione di deleteIfExists. |
| FileSystemDeleteOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| FileSystemEncryptionScope |
Opzioni per specificare l'ambito di crittografia in un file system. |
| FileSystemExistsOptions |
L'interfaccia dell'opzione per il file system Data Lake esiste See: |
| FileSystemGenerateSasUrlOptions |
Opzioni per configurare 'operazione di generateSasUrl. |
| FileSystemGetAccessPolicyHeaders | |
| FileSystemGetAccessPolicyOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| FileSystemGetPropertiesHeaders | |
| FileSystemGetPropertiesOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| FileSystemItem | |
| FileSystemListBlobHierarchySegmentHeaders |
Definisce le intestazioni per FileSystem_listBlobHierarchySegment'operazione. |
| FileSystemListPathsHeaders |
Definisce le intestazioni per l'operazione di FileSystem_listPaths. |
| FileSystemProperties | |
| FileSystemSetAccessPolicyHeaders | |
| FileSystemSetAccessPolicyOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| FileSystemSetMetadataHeaders | |
| FileSystemSetMetadataOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| FileSystemUndeletePathOption |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| HttpHeaders |
Raccolta di coppie chiave/valore di intestazione HTTP. |
| HttpOperationResponse |
Risposta HTTP compatibile con core-v1(core-http). |
| Lease |
Dettagli per un lease specifico. |
| LeaseAccessConditions |
Gruppo di parametri |
| LeaseOperationOptions |
Configura le operazioni di lease. |
| ListBlobsHierarchySegmentResponse |
Enumerazione di BLOB |
| ListDeletedPathsOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| ListDeletedPathsSegmentOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| ListFileSystemsSegmentResponse | |
| ListPathsOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| ListPathsSegmentOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| Metadata |
|
| Path | |
| PathAccessControl | |
| PathAccessControlItem | |
| PathAppendDataHeaders |
Definisce le intestazioni per Path_appendData'operazione. |
| PathChangeAccessControlRecursiveOptions |
Tipo di opzioni per |
| PathChangeAccessControlRecursiveResponse |
Tipo di risposta per |
| PathCreateHeaders |
Definisce le intestazioni per Path_create'operazione. |
| PathCreateHttpHeaders | |
| PathCreateIfNotExistsOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathCreateIfNotExistsResponse |
Contiene i dati di risposta per l'operazione di createIfNotExists. |
| PathCreateOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathDeleteHeaders |
Definisce le intestazioni per Path_delete'operazione. |
| PathDeleteIfExistsResponse |
Contiene i dati di risposta per l'operazione di deleteIfExists. |
| PathDeleteOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathExistsOptions |
L'interfaccia dell'opzione per le operazioni di directory/file Data Lake esiste See: |
| PathFlushDataHeaders |
Definisce le intestazioni per Path_flushData'operazione. |
| PathGetAccessControlHeaders | |
| PathGetAccessControlOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathGetPropertiesHeaders | |
| PathGetPropertiesHeadersModel |
Definisce le intestazioni per Path_getProperties'operazione. |
| PathGetPropertiesOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathHttpHeaders | |
| PathList | |
| PathListModel | |
| PathModel | |
| PathMoveOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathPermissions | |
| PathRemoveHeaders | |
| PathSetAccessControlHeaders |
Definisce le intestazioni per Path_setAccessControl'operazione. |
| PathSetAccessControlOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathSetHttpHeadersHeaders | |
| PathSetHttpHeadersOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathSetMetadataHeaders | |
| PathSetMetadataOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathSetPermissionsOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| PathUndeleteHeaders |
Definisce le intestazioni per Path_undelete'operazione. |
| PathUpdateHeaders |
Definisce le intestazioni per Path_update'operazione. |
| PipelineLike |
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. |
| PipelineOptions |
Interfaccia di opzione per il costruttore Pipeline. |
| RawAccessPolicy | |
| RemovePathAccessControlItem | |
| RequestPolicy |
Interfaccia compatibile per i criteri di richiesta core-http |
| RequestPolicyFactory |
Interfaccia per la compatibilità con RequestPolicyFactory di core-http |
| RequestPolicyOptions |
Interfaccia per la compatibilità con RequestPolicy |
| RestError |
Tipo di errore personalizzato per le richieste di pipeline non riuscite. |
| RolePermissions | |
| SASQueryParametersOptions |
Opzioni per costruire SASQueryParameters. |
| SasIPRange |
Intervallo IP consentito per una firma di accesso condiviso. |
| ServiceClientOptions |
Subset di |
| ServiceGenerateAccountSasUrlOptions |
Opzioni per configurare 'operazione di generateAccountSasUrl. |
| ServiceGetUserDelegationKeyHeaders | |
| ServiceGetUserDelegationKeyOptions |
|
| ServiceListFileSystemsOptions |
Interfaccia per le opzioni comuni a ogni operazione remota. |
| ServiceListFileSystemsSegmentHeaders | |
| ServiceUndeleteFileSystemOptions |
Opzioni per configurare undeleteFileSystem. |
| SignedIdentifier | |
| StoragePipelineOptions |
Interfaccia options per la funzione newPipeline. |
| StorageRetryOptions |
Interfaccia delle opzioni di ripetizione dei tentativi dei BLOB di archiviazione. |
| UserDelegationKey | |
| UserDelegationKeyModel |
Una chiave di delega utente |
| WebResource |
Descrizione di una richiesta HTTP da effettuare a un server remoto. |
Alias tipo
| AccessControlType | |
| CopyStatusType | |
| DataLakeServiceGetPropertiesResponse |
Contiene i dati di risposta per l'operazione getProperties. |
| EncryptionAlgorithmType |
Definisce i valori per EncryptionAlgorithmType. Valori noti supportati dal servizio
None |
| FileAppendResponse | |
| FileExpiryMode |
Definisce i valori per PathExpiryOptions. |
| FileFlushResponse | |
| FileQueryArrowConfiguration |
Opzioni per eseguire query su file con formato Apache Arrow. Valido solo per outputTextConfiguration. |
| FileReadResponse | |
| FileSetExpiryResponse | |
| FileSystemCreateResponse | |
| FileSystemDeleteResponse | |
| FileSystemGetAccessPolicyResponse | |
| FileSystemGetPropertiesResponse | |
| FileSystemListDeletedPathsResponse | |
| FileSystemListPathsResponse | |
| FileSystemRenameResponse |
Contiene i dati di risposta per l'operazione di <xref:DataLakeServiceClient.renameFileSystem>. |
| FileSystemSetAccessPolicyResponse | |
| FileSystemSetMetadataResponse | |
| FileSystemUndeletePathResponse | |
| FileSystemUndeleteResponse |
Contiene i dati di risposta per l'operazione di undeleteFileSystem. |
| FileUploadResponse | |
| HttpRequestBody |
Tipi di corpi supportati nella richiesta. NodeJS.ReadableStream e () => NodeJS.ReadableStream è solo Node. Blob, ReadableStream<Uint8Array> e () => ReadableStream<Uint8Array> sono solo browser. |
| LeaseDurationType | |
| LeaseOperationResponse |
Contiene i dati di risposta per le operazioni che creano, modificano o eliminano un lease. Vedere <xref:BlobLeaseClient>. |
| LeaseStateType | |
| LeaseStatusType | |
| ModifiedAccessConditions | |
| PathCreateResponse | |
| PathDeleteResponse | |
| PathGetAccessControlResponse | |
| PathGetPropertiesActionModel |
Definisce i valori per PathGetPropertiesAction. |
| PathGetPropertiesResponse | |
| PathMoveResponse | |
| PathRenameModeModel |
Definisce i valori per PathRenameMode. |
| PathResourceTypeModel |
Definisce i valori per PathResourceType. |
| PathSetAccessControlResponse | |
| PathSetHttpHeadersResponse | |
| PathSetMetadataResponse | |
| PathSetPermissionsResponse | |
| PublicAccessType | |
| ServiceGetUserDelegationKeyResponse | |
| ServiceListContainersSegmentResponse |
Contiene i dati di risposta per l'operazione listContainersSegment. |
| ServiceListFileSystemsSegmentResponse | |
| ServiceRenameFileSystemOptions |
Opzioni per configurare <xref:DataLakeServiceClient.renameFileSystem>. |
Enumerazioni
| PathGetPropertiesAction |
Definisce i valori per PathGetPropertiesAction. I valori possibili includono: 'getAccessControl', 'getStatus' |
| PathRenameMode |
Definisce i valori per PathRenameMode. I valori possibili includono: 'legacy', 'posix' |
| PathResourceType |
Definisce i valori per PathResourceType. I valori possibili includono: 'directory', 'file' |
| SASProtocol |
Protocolli per la firma di accesso condiviso generato. |
| StorageDataLakeAudience |
Definisce i gruppi di destinatari del cloud noti per l'archiviazione. |
| StorageRetryPolicyType |
Tipi RetryPolicy. |
Funzioni
| generate |
DISPONIBILE SOLO IN NODE.JS RUNTIME. Genera un SASQueryParameters oggetto che contiene tutti i parametri di query sas necessari per effettuare una richiesta REST effettiva. Vedere https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas |
| generate |
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 l'identificatore non viene fornito, sono necessarie le autorizzazioni e la scadenzaOn. È NECESSARIO assegnare un valore all'identificatore o alla scadenzaOn & autorizzazioni manualmente se si esegue l'inizializzazione con questo costruttore. Compilare i dettagli necessari prima di eseguire i frammenti di codice seguenti. Example
Compilare i dettagli necessari prima di eseguire il frammento di codice. Example
|
| generate |
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. Example
|
| get |
Per ottenere destinatari OAuth per un account di archiviazione per il servizio datalake. |
| is |
Helper per decidere se un determinato argomento soddisfa il contratto pipeline |
| new |
Crea un nuovo oggetto Pipeline con credenziali fornite. |
Dettagli funzione
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
DISPONIBILE SOLO IN NODE.JS RUNTIME.
Genera un SASQueryParameters oggetto che contiene tutti i parametri di query sas necessari per effettuare una richiesta REST effettiva.
Vedere https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
Parametri
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Restituisce
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)
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 l'identificatore non viene fornito, sono necessarie le autorizzazioni e la scadenzaOn. È NECESSARIO assegnare un valore all'identificatore o alla scadenzaOn & autorizzazioni manualmente se si esegue l'inizializzazione con questo costruttore.
Compilare i dettagli necessari prima di eseguire i frammenti di codice seguenti.
Example
// 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 di codice.
Example
// 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();
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
Parametri
- dataLakeSASSignatureValues
- DataLakeSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Restituisce
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)
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.
Example
// 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();
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters
Parametri
- dataLakeSASSignatureValues
- DataLakeSASSignatureValues
- userDelegationKey
- UserDelegationKey
Valore restituito di blobServiceClient.getUserDelegationKey()
- accountName
-
string
Restituisce
getDataLakeServiceAccountAudience(string)
Per ottenere destinatari OAuth per un account di archiviazione per il servizio datalake.
function getDataLakeServiceAccountAudience(storageAccountName: string): string
Parametri
- storageAccountName
-
string
Restituisce
string
isPipelineLike(unknown)
Helper per decidere se un determinato argomento soddisfa il contratto pipeline
function isPipelineLike(pipeline: unknown): pipeline
Parametri
- pipeline
-
unknown
Argomento che può essere una pipeline
Restituisce
pipeline
true quando l'argomento soddisfa il contratto pipeline
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Crea un nuovo oggetto Pipeline con credenziali fornite.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline
Parametri
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato AnonymousCredential.
- pipelineOptions
- StoragePipelineOptions
Optional. Options.
Restituisce
Nuovo oggetto Pipeline.