@azure/storage-file-datalake package

Référence

Classes

AccountSASPermissions	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les autorisations accordées par un AccountSAS. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera des autorisations pour cette opération. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet AccountSASSignatureValues . Il est possible de construire la chaîne d’autorisations sans cette classe, mais l’ordre des autorisations est particulier et cette classe garantit l’exactitude.
AccountSASResourceTypes	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les ressources accessibles par un AccountSAS. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera l’accès à ce type de ressource. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ de ressources sur un objet AccountSASSignatureValues . Il est possible de construire la chaîne de ressources sans cette classe, mais l’ordre des ressources est particulier et cette classe garantit l’exactitude.
AccountSASServices	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les services accessibles par un AccountSAS. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera l’accès à ce service. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ services sur un objet AccountSASSignatureValues . Il est possible de construire la chaîne de services sans cette classe, mais l’ordre des services est particulier et cette classe garantit l’exactitude.
AnonymousCredential	AnonymousCredential fournit un membre credentialPolicyCreator utilisé pour créer des objets AnonymousCredentialPolicy. AnonymousCredentialPolicy est utilisé avec les requêtes HTTP(S) qui lisent des ressources publiques ou pour une utilisation avec des signatures d’accès partagé (SAP).
AnonymousCredentialPolicy	AnonymousCredentialPolicy est utilisé avec les requêtes HTTP(S) qui lisent des ressources publiques ou pour une utilisation avec des signatures d’accès partagé (SAP).
BaseRequestPolicy	Classe de base d’où dérivent toutes les stratégies de requête.
Credential	Les informations d’identification sont une classe abstraite pour la signature de requêtes HTTP de Stockage Azure. Cette classe hébergera une fabrique credentialPolicyCreator qui génère CredentialPolicy.
CredentialPolicy	Stratégie d’informations d’identification utilisée pour signer les requêtes HTTP(S) avant l’envoi. Il s’agit d’une classe abstraite.
DataLakeAclChangeFailedError	Erreur levée lorsqu’une opération est interrompue et peut être poursuivie ultérieurement.
DataLakeDirectoryClient	Un DataLakeDirectoryClient représente une URL vers le répertoire Stockage Azure.
DataLakeFileClient	Un DataLakeFileClient représente une URL vers le fichier Stockage Azure.
DataLakeFileSystemClient	Un DataLakeFileSystemClient représente une URL du système de fichiers Stockage Azure qui vous permet de manipuler ses répertoires et fichiers.
DataLakeLeaseClient
DataLakePathClient	Un DataLakePathClient représente une URL vers le chemin d’accès stockage Azure (répertoire ou fichier).
DataLakeSASPermissions	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les autorisations accordées par un ServiceSAS. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera des autorisations pour cette opération. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet DataLakeSASSignatureValues . Il est possible de construire la chaîne d’autorisations sans cette classe, mais l’ordre des autorisations est particulier et cette classe garantit l’exactitude.
DataLakeServiceClient	DataLakeServiceClient vous permet de manipuler les ressources et les systèmes de fichiers du service Azure Data Lake. Le compte de stockage fournit l’espace de noms de niveau supérieur pour le service Lac de données.
DirectorySASPermissions	Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les autorisations accordées par un ServiceSAS à un répertoire. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera des autorisations pour cette opération. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet DataLakeSASSignatureValues . Il est possible de construire la chaîne d’autorisations sans cette classe, mais l’ordre des autorisations est particulier et cette classe garantit l’exactitude.
FileSystemSASPermissions	Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les autorisations accordées par un ServiceSAS à un conteneur. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera des autorisations pour cette opération. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet DataLakeSASSignatureValues . Il est possible de construire la chaîne d’autorisations sans cette classe, mais l’ordre des autorisations est particulier et cette classe garantit l’exactitude.
Pipeline	Classe Pipeline contenant des stratégies de requête HTTP. Vous pouvez créer un pipeline par défaut en appelant newPipeline. Vous pouvez également créer un pipeline avec vos propres stratégies par le constructeur de Pipeline. Reportez-vous à newPipeline et aux stratégies fournies avant d’implémenter votre pipeline personnalisé.
RestError	Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.
SASQueryParameters	Représente les composants qui composent les paramètres de requête d’une sape de stockage Azure. Ce type n’est pas construit directement par l’utilisateur ; elle est générée uniquement par les types et valeurs AccountSASSignatureValues<xref:BlobSASSignatureValues>. Une fois généré, il peut être encodé dans un toString() et ajouté à une URL directement (même si la prudence doit être prise ici dans le cas où il existe des paramètres de requête existants, ce qui peut affecter les moyens appropriés d’ajouter ces paramètres de requête). REMARQUE : Les instances de cette classe sont immuables.
StorageBrowserPolicy	StorageBrowserPolicy gère les différences entre les Node.js et le runtime du navigateur, notamment : Les navigateurs mettez en cache les requêtes GET/HEAD en ajoutant des en-têtes conditionnels tels que « IF_MODIFIED_SINCE ». StorageBrowserPolicy est une stratégie utilisée pour ajouter une requête d’horodatage à l’URL de requête GET/HEAD afin d’éviter le cache du navigateur. Supprimer l’en-tête de cookie pour la sécurité Supprimer l’en-tête de longueur de contenu pour éviter l’avertissement des navigateurs
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory est une classe d’usine qui permet de générer des objets StorageBrowserPolicy.
StorageRetryPolicy	Stratégie de nouvelle tentative avec nouvelle tentative exponentielle et nouvelle tentative linéaire implémentée.
StorageRetryPolicyFactory	StorageRetryPolicyFactory est une classe d’usine qui permet de générer des objets StorageRetryPolicy .
StorageSharedKeyCredential	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. StorageSharedKeyCredential pour l’autorisation de clé de compte du service Stockage Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy est une stratégie utilisée pour signer une requête HTTP avec une clé partagée.

Interfaces

AccessControlChangeCounters	AccessControlChangeCounters contient le nombre d’opérations qui modifient les listes de contrôle d’accès de manière récursive.
AccessControlChangeError	Représente une entrée qui n’a pas pu mettre à jour la liste de contrôle d’accès pendant `setAccessControlRecursive`, `updateAccessControlRecursive` et `removeAccessControlRecursive`.
AccessControlChanges	AccessControlChanges contient des nombres d’opérations par lots et cumulatifs qui modifient les listes de contrôle d’accès de manière récursive. En outre, il expose les entrées de chemin d’accès qui n’ont pas pu être mises à jour pendant la progression de ces opérations.
AccessPolicy
AccountSASSignatureValues	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. AccountSASSignatureValues est utilisé pour générer une signature d’accès partagé (SAP) pour un compte stockage Azure. Une fois que toutes les valeurs ici sont correctement définies, appelez generateAccountSASQueryParameters pour obtenir une représentation de la SAP qui peut être appliquée aux URL de lac de données. Remarque : cette classe et SASQueryParameters existent, car le premier est mutable et une représentation logique, tandis que le second est immuable et utilisé pour générer des requêtes REST réelles. Pour https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 plus d’informations conceptuelles sur saS, consultez pour https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas obtenir des descriptions des paramètres, notamment ceux qui sont requis.
BlobHierarchyListSegment
BlobItemModel	Objet blob stockage Azure
BlobPrefix
BlobPropertiesModel	Propriétés d’un objet blob
CommonGenerateSasUrlOptions	Options courantes de FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions et FileGenerateSasUrlOptions.
CommonOptions	Interface pour les options communes à chaque opération distante.
CpkInfo	Groupe de paramètres
DataLakeRequestConditions	Groupe de paramètres
DataLakeSASSignatureValues	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. DataLakeSASSignatureValues permet de générer des jetons SAS d’objet blob et de service DataLake pour les conteneurs, les objets blob, le système de fichiers, les répertoires et les fichiers.
DataLakeServiceProperties	Propriétés du service de stockage.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions	Interface pour les options communes à chaque opération distante.
DirectoryCreateIfNotExistsResponse	Contient des données de réponse pour l’opération createIfNotExists .
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions	Options pour configurer l’opération generateSasUrl .
FileAppendOptions	Interface pour les options communes à chaque opération distante.
FileCreateIfNotExistsOptions	Interface pour les options communes à chaque opération distante.
FileCreateIfNotExistsResponse	Contient des données de réponse pour l’opération createIfNotExists .
FileCreateOptions	Interface pour les options communes à chaque opération distante.
FileCreateResponse
FileFlushOptions	Interface pour les options communes à chaque opération distante.
FileGenerateSasUrlOptions	Options pour configurer l’opération generateSasUrl .
FileParallelUploadOptions	Interface d’option pour le fichier Data Lake - Opérations de chargement Consultez l'article : upload uploadFile uploadStream
FileQueryCsvTextConfiguration	Options permettant d’interroger le fichier au format CSV.
FileQueryError	Type d’erreur de requête de fichier.
FileQueryJsonTextConfiguration	Options permettant d’interroger le fichier au format JSON.
FileQueryOptions	Interface d’option pour le fichier Data Lake - Opérations de requête Consultez l'article : requête
FileQueryParquetConfiguration	Options d’interrogation de fichier au format Parquet.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions	Interface d’option pour le fichier Data Lake - opérations readToBuffer Consultez l'article : readToBuffer
FileSetExpiryHeaders	Définit des en-têtes pour Path_setExpiry opération.
FileSetExpiryOptions	Interface d’option pour l’opération setExpiry .
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse	Contient des données de réponse pour l’opération createIfNotExists .
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse	Contient des données de réponse pour l’opération deleteIfExists .
FileSystemDeleteOptions	Interface pour les options communes à chaque opération distante.
FileSystemEncryptionScope	Options permettant de spécifier l’étendue du chiffrement sur un système de fichiers.
FileSystemExistsOptions	Interface d’option pour les opérations existant du système de fichiers Data Lake Consultez l'article : exists
FileSystemGenerateSasUrlOptions	Options pour configurer l’opération generateSasUrl .
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions	Interface pour les options communes à chaque opération distante.
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions	Interface pour les options communes à chaque opération distante.
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders	Définit des en-têtes pour FileSystem_listBlobHierarchySegment opération.
FileSystemListPathsHeaders	Définit des en-têtes pour FileSystem_listPaths opération.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions	Interface pour les options communes à chaque opération distante.
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions	Interface pour les options communes à chaque opération distante.
FileSystemUndeletePathOption	Interface pour les options communes à chaque opération distante.
HttpHeaders	Collection de paires clé/valeur d’en-tête HTTP.
HttpOperationResponse	Réponse Http compatible avec core-v1(core-http).
IHttpClient	Interface compatible pour les stratégies de requête core-http
Lease	Détails d’un bail spécifique.
LeaseAccessConditions	Groupe de paramètres
LeaseOperationOptions	Configure les opérations de bail.
ListBlobsHierarchySegmentResponse	Énumération d’objets blob
ListDeletedPathsOptions	Interface pour les options communes à chaque opération distante.
ListDeletedPathsSegmentOptions	Interface pour les options communes à chaque opération distante.
ListFileSystemsSegmentResponse
ListPathsOptions	Interface pour les options communes à chaque opération distante.
ListPathsSegmentOptions	Interface pour les options communes à chaque opération distante.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders	Définit les en-têtes pour Path_appendData opération.
PathChangeAccessControlRecursiveOptions	Type d’options pour `setAccessControlRecursive`, `updateAccessControlRecursive` et `removeAccessControlRecursive`.
PathChangeAccessControlRecursiveResponse	Type de réponse pour `setAccessControlRecursive`, `updateAccessControlRecursive` et `removeAccessControlRecursive`.
PathCreateHeaders	Définit des en-têtes pour Path_create opération.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions	Interface pour les options communes à chaque opération distante.
PathCreateIfNotExistsResponse	Contient des données de réponse pour l’opération createIfNotExists .
PathCreateOptions	Interface pour les options communes à chaque opération distante.
PathDeleteHeaders	Définit des en-têtes pour Path_delete opération.
PathDeleteIfExistsResponse	Contient des données de réponse pour l’opération deleteIfExists .
PathDeleteOptions	Interface pour les options communes à chaque opération distante.
PathExistsOptions	Interface d’option pour les opérations de répertoire/fichier Data Lake existe Consultez l'article : exists
PathFlushDataHeaders	Définit des en-têtes pour Path_flushData opération.
PathGetAccessControlHeaders
PathGetAccessControlOptions	Interface pour les options communes à chaque opération distante.
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel	Définit des en-têtes pour Path_getProperties opération.
PathGetPropertiesOptions	Interface pour les options communes à chaque opération distante.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions	Interface pour les options communes à chaque opération distante.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders	Définit des en-têtes pour Path_setAccessControl opération.
PathSetAccessControlOptions	Interface pour les options communes à chaque opération distante.
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions	Interface pour les options communes à chaque opération distante.
PathSetMetadataHeaders
PathSetMetadataOptions	Interface pour les options communes à chaque opération distante.
PathSetPermissionsOptions	Interface pour les options communes à chaque opération distante.
PathUndeleteHeaders	Définit des en-têtes pour Path_undelete opération.
PathUpdateHeaders	Définit des en-têtes pour Path_update opération.
PipelineLike	Interface pour la classe Pipeline contenant des stratégies de requête HTTP. Vous pouvez créer un pipeline par défaut en appelant newPipeline. Vous pouvez également créer un pipeline avec vos propres stratégies par le constructeur de Pipeline. Reportez-vous à newPipeline et aux stratégies fournies avant d’implémenter votre pipeline personnalisé.
PipelineOptions	Interface d’option pour le constructeur pipeline.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicyFactory	Interface de compatibilité avec RequestPolicyFactory de core-http
RequestPolicyOptions	Interface de compatibilité avec RequestPolicy
RolePermissions
SASQueryParametersOptions	Options pour construire SASQueryParameters.
SasIPRange	Plage d’adresses IP autorisée pour une SAP.
ServiceClientOptions	Sous-ensemble de `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Options permettant de configurer l’opération generateAccountSasUrl .
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions	Interface pour les options communes à chaque opération distante.
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions	Options pour configurer undeleteFileSystem.
SignedIdentifier
StoragePipelineOptions	Interface d’options pour la fonction newPipeline .
StorageRetryOptions	Interface des options de nouvelle tentative d’objet blob de stockage.
UserDelegationKey
UserDelegationKeyModel	Clé de délégation utilisateur
WebResource	Description d’une requête HTTP à envoyer à un serveur distant.

Alias de type

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse	Contient des données de réponse pour l’opération getProperties.
EncryptionAlgorithmType	Définit des valeurs pour EncryptionAlgorithmType. <xref:KnownEncryptionAlgorithmType> peut être utilisé de manière interchangeable avec EncryptionAlgorithmType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Aucun AES256
FileAppendResponse
FileExpiryMode	Définit des valeurs pour PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration	Options d’interrogation du fichier au format Apache Arrow. Valide uniquement pour outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse	Contient des données de réponse pour l’opération <xref:DataLakeServiceClient.renameFileSystem> .
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse	Contient des données de réponse pour l’opération undeleteFileSystem .
FileUploadResponse
HttpRequestBody	Types de corps pris en charge dans la demande. NodeJS.ReadableStream et () => NodeJS.ReadableStream est Node uniquement. Blob, ReadableStream et () => ReadableStream sont des navigateurs uniquement.
LeaseDurationType
LeaseOperationResponse	Contient les données de réponse pour les opérations qui créent, modifient ou suppriment un bail. Consultez <xref:BlobLeaseClient>.
LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel	Définit des valeurs pour PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel	Définit des valeurs pour PathRenameMode.
PathResourceTypeModel	Définit des valeurs pour PathResourceType.
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse	Contient des données de réponse pour l’opération listContainersSegment.
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions	Options pour configurer <xref:DataLakeServiceClient.renameFileSystem>.

Énumérations

PathGetPropertiesAction	Définit des valeurs pour PathGetPropertiesAction. Les valeurs possibles sont les suivantes : 'getAccessControl', 'getStatus'
PathRenameMode	Définit des valeurs pour PathRenameMode. Les valeurs possibles sont les suivantes : 'legacy', 'posix'
PathResourceType	Définit des valeurs pour PathResourceType. Les valeurs possibles sont les suivantes : 'directory', 'file'
SASProtocol	Protocoles pour la signature d’accès partagé généré.
StorageDataLakeAudience	Définit les audiences cloud connues pour le stockage.
StorageRetryPolicyType	Types RetryPolicy.

Fonctions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Génère un objet SASQueryParameters qui contient tous les paramètres de requête SAS nécessaires pour effectuer une requête REST réelle. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Crée une instance de SASQueryParameters. Accepte uniquement les paramètres requis pour créer une sap. Pour les paramètres facultatifs, définissez directement les propriétés correspondantes, telles que les autorisations, startsOn et l’identificateur. AVERTISSEMENT : Lorsque l’identificateur n’est pas fourni, les autorisations et expirentOn sont requises. Vous DEVEZ affecter une valeur à l’identificateur ou expireOn & autorisations manuellement si vous initialisez avec ce constructeur. Renseignez les détails requis avant d’exécuter les extraits de code suivants. Exemple // 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(); Renseignez les détails requis avant d’exécuter l’extrait de code. Exemple // 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();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Crée une instance de SASQueryParameters. AVERTISSEMENT : l’identificateur sera ignoré lors de la génération de la sap de délégation d’utilisateur, les autorisations et les expirationsOn sont requises. Exemple // 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();
getDataLakeServiceAccountAudience(string)	Pour obtenir l’audience OAuth pour un compte de stockage pour le service datalake.
isPipelineLike(unknown)	Un outil d’assistance pour déterminer si un argument donné satisfait au contrat de pipeline
newPipeline(StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Crée un objet Pipeline avec les informations d’identification fournies.

Informations relatives à la fonction

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Génère un objet SASQueryParameters qui contient tous les paramètres de requête SAS nécessaires pour effectuer une requête REST réelle.

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

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Paramètres

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Retours

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée une instance de SASQueryParameters.

Accepte uniquement les paramètres requis pour créer une sap. Pour les paramètres facultatifs, définissez directement les propriétés correspondantes, telles que les autorisations, startsOn et l’identificateur.

AVERTISSEMENT : Lorsque l’identificateur n’est pas fourni, les autorisations et expirentOn sont requises. Vous DEVEZ affecter une valeur à l’identificateur ou expireOn & autorisations manuellement si vous initialisez avec ce constructeur.

Renseignez les détails requis avant d’exécuter les extraits de code suivants.

Exemple

// 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();

Renseignez les détails requis avant d’exécuter l’extrait de code.

Exemple

// 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

Paramètres

dataLakeSASSignatureValues: DataLakeSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Retours

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée une instance de SASQueryParameters. AVERTISSEMENT : l’identificateur sera ignoré lors de la génération de la sap de délégation d’utilisateur, les autorisations et les expirationsOn sont requises.

Exemple

// 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

Paramètres

dataLakeSASSignatureValues: DataLakeSASSignatureValues

userDelegationKey: UserDelegationKey

Valeur de retour de blobServiceClient.getUserDelegationKey()

accountName: string

Retours

SASQueryParameters

getDataLakeServiceAccountAudience(string)

Pour obtenir l’audience OAuth pour un compte de stockage pour le service datalake.

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Paramètres

storageAccountName: string

Retours

string

isPipelineLike(unknown)

Un outil d’assistance pour déterminer si un argument donné satisfait au contrat de pipeline

function isPipelineLike(pipeline: unknown): pipeline

Paramètres

pipeline: unknown

Argument qui peut être un pipeline

Retours

pipeline

true lorsque l’argument satisfait au contrat de pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crée un objet Pipeline avec les informations d’identification fournies.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Paramètres

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Par exemple, AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package pour authentifier les @azure/identity demandes adressées au service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. S’il n’est pas spécifié, AnonymousCredential est utilisé.

pipelineOptions: StoragePipelineOptions

facultatif. Options.

Retours

Pipeline

Nouvel objet Pipeline.

Partager via

@azure/storage-file-datalake package

Classes

Interfaces

Alias de type

Valeurs connues prises en charge par le service

Énumérations

Fonctions

Informations relatives à la fonction

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Paramètres

Retours

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

Paramètres

Retours

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

Paramètres

Retours

getDataLakeServiceAccountAudience(string)

Paramètres

Retours

isPipelineLike(unknown)

Paramètres

Retours

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Paramètres

Retours

Ressources supplémentaires