Share via


@azure/storage-blob package

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).

AppendBlobClient

AppendBlobClient définit un ensemble d’opérations applicables aux objets blob d’ajout.

BaseRequestPolicy

Classe de base d’où dérivent toutes les stratégies de requête.

BlobBatch

Un BlobBatch représente un ensemble agrégé d’opérations sur des objets blob. Actuellement, et setAccessTier sont uniquement delete pris en charge.

BlobBatchClient

Un BlobBatchClient vous permet d’effectuer des requêtes par lots au service Blob Stockage Azure.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

BlobClient

Un BlobClient représente une URL vers un objet blob stockage Azure ; l’objet blob peut être un objet blob de bloc, un objet blob d’ajout ou un objet blob de page.

BlobLeaseClient

Client qui gère les baux d’un ContainerClient ou d’un BlobClient.

BlobSASPermissions

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 à un objet blob. 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 BlobSASSignatureValues . 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.

BlobServiceClient

Un BlobServiceClient représente un client du service Blob Stockage Azure, ce qui vous permet de manipuler des conteneurs d’objets blob.

BlockBlobClient

BlockBlobClient définit un ensemble d’opérations applicables aux objets blob de blocs.

ContainerClient

Un ContainerClient représente une URL vers le conteneur Stockage Azure qui vous permet de manipuler ses objets blob.

ContainerSASPermissions

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 BlobSASSignatureValues . 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.

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.

HttpHeaders

Collection de paires clé/valeur d’en-tête HTTP.

PageBlobClient

PageBlobClient définit un ensemble d’opérations applicables aux objets blob de pages.

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é.

RequestPolicyOptions

Propriétés facultatives qui peuvent être utilisées lors de la création d’une stratégie RequestPolicy.

RestError

Erreur résultant d’une requête HTTP à un point de terminaison de service.

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 AccountSASSignatureValues et BlobSASSignatureValues . Une fois généré, il peut être encodé en un toString() et ajouté directement à une URL (bien qu’il soit prudent ici au 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 Node.js et le runtime du navigateur, notamment :

  1. 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 timestamp à l’URL de requête GET/HEAD afin d’éviter le cache du navigateur.

  2. Supprimer l’en-tête de cookie pour la sécurité

  3. Supprimer l’en-tête de longueur de contenu pour éviter l’avertissement des navigateurs

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory est une classe de fabrique qui aide à générer des objets StorageBrowserPolicy.

StorageRetryPolicy

Stratégie de nouvelle tentative avec nouvelle tentative exponentielle et nouvelle tentative linéaire implémentées.

StorageRetryPolicyFactory

StorageRetryPolicyFactory est une classe d’usine qui aide à 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.

WebResource

Crée un objet WebResource.

Cette classe fournit une abstraction sur un appel REST en étant indépendante de la bibliothèque/de l’implémentation et en encapsulant les propriétés nécessaires pour lancer une requête.

Interfaces

AccessPolicy

Une stratégie d’accès

AccountSASPermissionsLike

Type qui ressemble à une autorisation SAP de compte. Utilisé dans AccountSASPermissions pour analyser les autorisations SAP à partir d’objets bruts.

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 en fait être appliquée aux URL d’objet blob. 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.

AppendBlobAppendBlockFromURLOptions

Options pour configurer l’opération appendBlockFromURL .

AppendBlobAppendBlockFromUrlHeaders

Définit des en-têtes pour AppendBlob_appendBlockFromUrl opération.

AppendBlobAppendBlockHeaders

Définit des en-têtes pour AppendBlob_appendBlock opération.

AppendBlobAppendBlockOptions

Options permettant de configurer l’opération appendBlock .

AppendBlobCreateHeaders

Définit des en-têtes pour AppendBlob_create opération.

AppendBlobCreateIfNotExistsOptions

Options pour configurer l’opération createIfNotExists .

AppendBlobCreateIfNotExistsResponse

Contient des données de réponse pour l’opération <xref:appendBlobClient.createIfNotExists> .

AppendBlobCreateOptions

Options de configuration de l’opération de création .

AppendBlobRequestConditions

Conditions à ajouter à la création de cet objet blob d’ajout.

AppendBlobSealOptions

Options pour configurer l’opération de joint .

AppendPositionAccessConditions

Groupe de paramètres

BatchSubRequest

Requête associée à une opération de traitement par lots.

BatchSubResponse

Données de réponse associées à une requête unique au sein d’une opération de traitement par lots.

BlobAbortCopyFromURLHeaders

Définit des en-têtes pour Blob_abortCopyFromURL opération.

BlobAbortCopyFromURLOptions

Options permettant de configurer l’opération abortCopyFromURL .

BlobAcquireLeaseOptions

Options permettant de configurer l’opération Blob - Acquérir un bail.

BlobBatchSubmitBatchOptionalParams

Options permettant de configurer le service - Envoyer des paramètres facultatifs par lot.

BlobBeginCopyFromURLOptions

Options permettant de configurer l’opération beginCopyFromURL .

BlobBeginCopyFromURLResponse

Contient les données de réponse pour l’opération beginCopyFromURL .

BlobBeginCopyFromUrlPollState

État utilisé par l’polleur retourné à partir de beginCopyFromURL.

Cet état est passé dans le rappel spécifié par onProgress l’utilisateur chaque fois que la progression de la copie est détectée.

BlobBreakLeaseOptions

Options pour configurer l’opération Blob - Arrêter le bail.

BlobChangeLeaseOptions

Options pour configurer l’opération Blob - Modifier le bail.

BlobCopyFromURLHeaders

Définit des en-têtes pour Blob_copyFromURL opération.

BlobCreateSnapshotHeaders

Définit des en-têtes pour Blob_createSnapshot opération.

BlobCreateSnapshotOptions

Options permettant de configurer l’opération createSnapshot .

BlobDeleteHeaders

Définit des en-têtes pour Blob_delete opération.

BlobDeleteIfExistsResponse

Contient des données de réponse pour l’opération deleteIfExists .

BlobDeleteImmutabilityPolicyHeaders

Définit des en-têtes pour Blob_deleteImmutabilityPolicy opération.

BlobDeleteImmutabilityPolicyOptions

Options de suppression de l’opération de stratégie d’immuabilité DeleteImmutabilityPolicy .

BlobDeleteOptions

Options permettant de configurer l’opération de suppression .

BlobDownloadHeaders

Définit des en-têtes pour Blob_download opération.

BlobDownloadOptionalParams

Paramètres facultatifs.

BlobDownloadOptions

Options permettant de configurer l’opération de téléchargement .

BlobDownloadResponseParsed

Contient des données de réponse pour l’opération de téléchargement .

BlobDownloadToBufferOptions

Interface d’option pour l’opération downloadToBuffer .

BlobExistsOptions

Options permettant de configurer l’opération exists .

BlobFlatListSegment

Interface représentant BlobFlatListSegment.

BlobFlatListSegmentModel
BlobGenerateSasUrlOptions

Options pour configurer l’opération generateSasUrl .

BlobGetPropertiesHeaders

Définit des en-têtes pour Blob_getProperties opération.

BlobGetPropertiesOptions

Options permettant de configurer l’opération getProperties .

BlobGetPropertiesResponse

Contient des données de réponse pour l’opération getProperties .

BlobGetTagsHeaders

Définit des en-têtes pour Blob_getTags opération.

BlobGetTagsOptions

Options permettant de configurer l’opération getTags .

BlobHTTPHeaders

Groupe de paramètres

BlobHierarchyListSegment

Interface représentant BlobHierarchyListSegment.

BlobHierarchyListSegmentModel
BlobImmutabilityPolicy

Décrire la stratégie immuable pour l’objet blob.

BlobItem

Objet blob stockage Azure

BlobItemInternal

Objet blob stockage Azure

BlobPrefix
BlobProperties

Propriétés d’un objet blob

BlobQueryArrowConfiguration

Options d’interrogation d’objet blob au format Apache Arrow. Valide uniquement pour outputTextConfiguration.

BlobQueryArrowField

Décrire un champ dans BlobQueryArrowConfiguration.

BlobQueryCsvTextConfiguration

Options d’interrogation d’objet blob au format CSV.

BlobQueryError

Type d’erreur de requête d’objet blob.

BlobQueryHeaders

Définit des en-têtes pour Blob_query opération.

BlobQueryJsonTextConfiguration

Options permettant d’interroger un objet blob au format JSON.

BlobQueryParquetConfiguration

Options d’interrogation d’objet blob au format Parquet. Valide uniquement pour inputTextConfiguration.

BlobReleaseLeaseOptions

Options pour configurer l’opération Blob - Bail de mise en production.

BlobRenewLeaseOptions

Options permettant de configurer l’opération Blob - Renouveler le bail.

BlobRequestConditions

en-têtes conditionnels HTTP standard, condition d’étiquettes et condition de bail

BlobSASPermissionsLike

Type qui ressemble à une autorisation SAS Blob. Utilisé dans BlobSASPermissions pour analyser les autorisations SAS à partir d’objets bruts.

BlobSASSignatureValues

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

BlobSASSignatureValues est utilisé pour aider à générer des jetons SAP du service Blob pour les conteneurs ou les objets blob.

BlobServiceProperties

Propriétés du service de stockage.

BlobServiceStatistics

Statistiques pour le service de stockage.

BlobSetHTTPHeadersHeaders

Définit des en-têtes pour Blob_setHttpHeaders opération.

BlobSetHTTPHeadersOptions

Options permettant de configurer l’opération setHTTPHeaders .

BlobSetImmutabilityPolicyHeaders

Définit des en-têtes pour Blob_setImmutabilityPolicy opération.

BlobSetImmutabilityPolicyOptions

Options permettant de définir l’opération set de stratégie d’immuabilitéImmutabilityPolicy .

BlobSetLegalHoldHeaders

Définit des en-têtes pour Blob_setLegalHold opération.

BlobSetLegalHoldOptions

Options permettant de définir l’opération setLegalHold de conservation légale.

BlobSetMetadataHeaders

Définit des en-têtes pour Blob_setMetadata opération.

BlobSetMetadataOptions

Options permettant de configurer l’opération setMetadata .

BlobSetTagsHeaders

Définit des en-têtes pour Blob_setTags opération.

BlobSetTagsOptions

Options permettant de configurer l’opération setTags .

BlobSetTierHeaders

Définit des en-têtes pour Blob_setTier opération.

BlobSetTierOptions

Options permettant de configurer l’opération setAccessTier .

BlobStartCopyFromURLHeaders

Définit des en-têtes pour Blob_startCopyFromURL opération.

BlobStartCopyFromURLOptions

Options permettant de configurer l’opération beginCopyFromURL .

BlobSyncCopyFromURLOptions

Options permettant de configurer l’opération syncCopyFromURL .

BlobTag
BlobTags

Balises d’objet blob

BlobUndeleteHeaders

Définit des en-têtes pour Blob_undelete opération.

BlobUndeleteOptions

Options permettant de configurer l’opération d’annulation de la suppression .

Block

Représente un seul bloc dans un objet blob de blocs. Il décrit l’ID et la taille du bloc.

BlockBlobCommitBlockListHeaders

Définit des en-têtes pour BlockBlob_commitBlockList opération.

BlockBlobCommitBlockListOptions

Options permettant de configurer l’opération commitBlockList .

BlockBlobGetBlockListHeaders

Définit des en-têtes pour BlockBlob_getBlockList opération.

BlockBlobGetBlockListOptions

Options permettant de configurer l’opération getBlockList .

BlockBlobParallelUploadOptions

Interface d’option pour uploadFile et <xref:BlockBlobClient.uploadSeekableStream>.

BlockBlobPutBlobFromUrlHeaders

Définit des en-têtes pour BlockBlob_putBlobFromUrl opération.

BlockBlobQueryOptions

Options pour configurer l’opération de requête .

BlockBlobStageBlockFromURLHeaders

Définit des en-têtes pour BlockBlob_stageBlockFromURL opération.

BlockBlobStageBlockFromURLOptions

Options pour configurer l’opération stageBlockFromURL .

BlockBlobStageBlockHeaders

Définit des en-têtes pour BlockBlob_stageBlock opération.

BlockBlobStageBlockOptions

Options pour configurer l’opération stageBlock .

BlockBlobSyncUploadFromURLOptions

Options permettant de configurer l’opération syncUploadFromURL .

BlockBlobUploadHeaders

Définit des en-têtes pour BlockBlob_upload opération.

BlockBlobUploadOptions

Options de configuration de l’opération de chargement .

BlockBlobUploadStreamOptions

Interface d’option pour l’opération uploadStream .

BlockList
CommonGenerateSasUrlOptions

Options courantes de BlobGenerateSasUrlOptions et ContainerGenerateSasUrlOptions.

CommonOptions

Interface pour les options communes à chaque opération distante.

ContainerAcquireLeaseOptions

Options permettant de configurer l’opération Conteneur - Acquérir un bail.

ContainerBreakLeaseOptionalParams

Paramètres facultatifs.

ContainerBreakLeaseOptions

Options permettant de configurer l’opération Container - Break Lease.

ContainerChangeLeaseOptions

Options permettant de configurer l’opération Conteneur - Modifier le bail.

ContainerCreateHeaders

Définit des en-têtes pour Container_create opération.

ContainerCreateIfNotExistsResponse

Contient des données de réponse pour l’opération createIfNotExists .

ContainerCreateOptions

Options de configuration de l’opération de création .

ContainerDeleteBlobOptions

Options permettant de configurer l’opération deleteBlob .

ContainerDeleteHeaders

Définit les en-têtes pour Container_delete opération.

ContainerDeleteIfExistsResponse

Contient des données de réponse pour l’opération deleteIfExists .

ContainerDeleteMethodOptions

Options de configuration de l’opération de suppression .

ContainerEncryptionScope

Groupe de paramètres

ContainerExistsOptions

Options pour configurer l’opération existe .

ContainerFilterBlobsHeaders

Définit des en-têtes pour Container_filterBlobs opération.

ContainerFindBlobByTagsOptions

Options permettant de configurer l’opération findBlobsByTags .

ContainerGenerateSasUrlOptions

Options pour configurer l’opération generateSasUrl .

ContainerGetAccessPolicyHeaders

Définit les en-têtes pour Container_getAccessPolicy opération.

ContainerGetAccessPolicyOptions

Options permettant de configurer l’opération getAccessPolicy .

ContainerGetPropertiesHeaders

Définit des en-têtes pour Container_getProperties opération.

ContainerGetPropertiesOptions

Options permettant de configurer l’opération getProperties .

ContainerItem

Un conteneur stockage Azure

ContainerListBlobFlatSegmentHeaders

Définit des en-têtes pour Container_listBlobFlatSegment opération.

ContainerListBlobHierarchySegmentHeaders

Définit des en-têtes pour Container_listBlobHierarchySegment opération.

ContainerListBlobsOptions

Options permettant de configurer les opérations Conteneur - Répertorier les objets blob.

Consultez l'article :

ContainerProperties

Propriétés d’un conteneur

ContainerReleaseLeaseOptions

Options permettant de configurer l’opération Container - Release Lease.

ContainerRenameHeaders

Définit des en-têtes pour Container_rename opération.

ContainerRenewLeaseOptions

Options permettant de configurer l’opération Conteneur - Renouveler le bail.

ContainerRequestConditions

Conditions à remplir pour le conteneur.

ContainerSASPermissionsLike

Type qui ressemble à une autorisation CONTAINER SAS. Utilisé dans ContainerSASPermissions pour analyser les autorisations SAS à partir d’objets bruts.

ContainerSetAccessPolicyHeaders

Définit des en-têtes pour Container_setAccessPolicy opération.

ContainerSetAccessPolicyOptions

Options permettant de configurer l’opération setAccessPolicy .

ContainerSetMetadataHeaders

Définit des en-têtes pour Container_setMetadata opération.

ContainerSetMetadataOptions

Options pour configurer l’opération setMetadata .

ContainerUndeleteHeaders

Définit des en-têtes pour Container_restore opération.

CorsRule

CORS est une fonctionnalité HTTP qui permet à une application web exécutée dans un domaine d'accéder aux ressources d'un autre domaine. Les navigateurs web implémentent une restriction de sécurité appelée stratégie de même origine qui empêche une page web d’appeler des API dans un autre domaine ; CORS fournit un moyen sécurisé d’autoriser un domaine (le domaine d’origine) à appeler des API dans un autre domaine

CpkInfo

Groupe de paramètres

FilterBlobItem

Informations d’objet blob d’un findBlobsByTags

FilterBlobItemModel

Informations d’objet blob d’un appel d’API Filtrer les objets blob

FilterBlobSegment

Réponse de segment de l’opération findBlobsByTags .

FilterBlobSegmentModel

Résultat d’un appel d’API Filter Blobs

GeoReplication

Geo-Replication informations pour le service de stockage secondaire

HttpAuthorization

Représente les informations d’authentification dans les valeurs d’en-tête Authorization, ProxyAuthorization, WWW-Authenticate et Proxy-Authenticate.

HttpOperationResponse

Objet Wrapper pour la requête et la réponse HTTP. L’objet désérialisé est stocké dans la parsedBody propriété lorsque le corps de la réponse est reçu en JSON ou XML.

IHttpClient

Interface qui peut envoyer des requêtes HttpRequest et recevoir des httpResponses promises.

Lease

Détails d’un bail spécifique.

LeaseAccessConditions

Groupe de paramètres

LeaseOperationOptions

Configure les opérations de bail.

ListBlobsFlatSegmentResponse

Énumération d’objets blob

ListBlobsFlatSegmentResponseModel

Énumération d’objets blob

ListBlobsHierarchySegmentResponse

Énumération d’objets blob

ListBlobsHierarchySegmentResponseModel

Énumération d’objets blob

ListContainersSegmentResponse

Énumération de conteneurs

Logging

Paramètres de journalisation Azure Analytics.

MatchConditions

Spécifie les options HTTP pour les requêtes conditionnelles basées sur la correspondance ETag.

Metadata

Mappage des paires nom-valeur à associer à la ressource.

Metrics

un résumé des statistiques de requêtes regroupées par API en agrégats d’heures ou de minutes pour les objets blob

ModificationConditions

Spécifie les options HTTP pour les requêtes conditionnelles en fonction de l’heure de modification.

ModifiedAccessConditions

Condition d’en-têtes et d’étiquettes conditionnelles HTTP standard.

ModifiedAccessConditionsModel

Groupe de paramètres

ObjectReplicationPolicy

Contient l’ID de stratégie de réplication d’objet et la liste respective d’ObjectReplicationRule. Cela est utilisé lors de la récupération des propriétés de réplication d’objet sur l’objet blob source. L’ID de stratégie pour l’objet blob de destination est défini dans ObjectReplicationDestinationPolicyId des réponses de méthode respectives (par exemple, <xref:BlobProperties.ObjectReplicationDestinationPolicyId>.

ObjectReplicationRule

Contient l’ID de règle de réplication d’objet et ObjectReplicationStatus d’un objet blob. Il peut y avoir plusieurs ObjectReplicationRule sous un ObjectReplicationPolicy.

PageBlobClearPagesHeaders

Définit des en-têtes pour PageBlob_clearPages opération.

PageBlobClearPagesOptions

Options permettant de configurer l’opération clearPages .

PageBlobCopyIncrementalHeaders

Définit des en-têtes pour PageBlob_copyIncremental opération.

PageBlobCreateHeaders

Définit des en-têtes pour PageBlob_create opération.

PageBlobCreateIfNotExistsOptions

Options permettant de configurer l’opération createIfNotExists .

PageBlobCreateIfNotExistsResponse

Contient des données de réponse pour l’opération createIfNotExists .

PageBlobCreateOptions

Options pour configurer l’opération de création .

PageBlobGetPageRangesDiffHeaders

Définit des en-têtes pour PageBlob_getPageRangesDiff opération.

PageBlobGetPageRangesDiffOptions

Options de configuration de l’opération <xref:PageBlobClient.getRangesDiff> .

PageBlobGetPageRangesDiffResponse

Contient des données de réponse pour l’opération getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions) .

PageBlobGetPageRangesHeaders

Définit des en-têtes pour PageBlob_getPageRanges opération.

PageBlobGetPageRangesOptions

Options pour configurer l’opération getPageRanges .

PageBlobGetPageRangesResponse

Contient des données de réponse pour l’opération getPageRanges(number, number, PageBlobGetPageRangesOptions) .

PageBlobListPageRangesDiffOptions

Options permettant de configurer l’opération listPageRangesDiff .

PageBlobListPageRangesOptions

Options permettant de configurer l’opération listPageRanges .

PageBlobRequestConditions

Conditions à ajouter à la création de cet objet blob de pages.

PageBlobResizeHeaders

Définit des en-têtes pour PageBlob_resize opération.

PageBlobResizeOptions

Options pour configurer l’opération de redimensionnement .

PageBlobStartCopyIncrementalOptions

Options pour configurer l’opération startCopyIncremental .

PageBlobUpdateSequenceNumberHeaders

Définit des en-têtes pour PageBlob_updateSequenceNumber opération.

PageBlobUpdateSequenceNumberOptions

Options permettant de configurer l’opération updateSequenceNumber .

PageBlobUploadPagesFromURLHeaders

Définit des en-têtes pour PageBlob_uploadPagesFromURL opération.

PageBlobUploadPagesFromURLOptions

Options pour configurer l’opération uploadPagesFromURL .

PageBlobUploadPagesHeaders

Définit des en-têtes pour PageBlob_uploadPages opération.

PageBlobUploadPagesOptions

Options permettant de configurer l’opération uploadPages .

PageList

Liste des plages de pages pour un objet blob.

PageRangeInfo
ParsedBatchResponse

Réponse multipart/mixte qui contient la réponse pour chaque sous-requête.

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 de pipeline.

PollOperationState

PollOperationState contient une liste avisée du plus petit ensemble de propriétés nécessaire pour définir un pollueur d’opérations de longue durée.

Alors que la classe Poller fonctionne en tant que mécanisme de contrôle local pour démarrer le déclenchement, attendre et éventuellement annuler une opération de longue durée, l’état PollOperationState documente les status de l’opération distante de longue durée.

Elle doit être mise à jour au moins au démarrage de l’opération, à sa fin et à son annulation. Toutefois, les implémentations peuvent avoir n’importe quel autre nombre de propriétés qui peuvent être mises à jour pour d’autres raisons.

PollerLike

Représentation abstraite d’un polleur, destinée à exposer uniquement l’API minimale avec laquelle l’utilisateur doit travailler.

PollerLikeWithCancellation

Représentation abstraite d’un polleur, destinée à exposer uniquement l’API minimale avec laquelle l’utilisateur doit travailler.

Range

Plage pour les opérations de service Blob.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations

RequestPolicy

Structure sous-jacente d’une stratégie de requête.

RetentionPolicy

stratégie de rétention qui détermine la durée pendant laquelle les données associées doivent être conservées

SASQueryParametersOptions

Options pour construire SASQueryParameters.

SasIPRange

Plage d’adresses IP autorisées pour une SAP.

SequenceNumberAccessConditions

Groupe de paramètres

ServiceFilterBlobsHeaders

Définit des en-têtes pour Service_filterBlobs opération.

ServiceFindBlobByTagsOptions

Options permettant de configurer l’opération findBlobsByTags .

ServiceGenerateAccountSasUrlOptions

Options pour configurer l’opération generateAccountSasUrl .

ServiceGetAccountInfoHeaders

Définit des en-têtes pour Service_getAccountInfo opération.

ServiceGetAccountInfoOptions

Options permettant de configurer l’opération getAccountInfo .

ServiceGetPropertiesHeaders

Définit des en-têtes pour Service_getProperties opération.

ServiceGetPropertiesOptions

Options pour configurer l’opération getProperties .

ServiceGetStatisticsHeaders

Définit des en-têtes pour Service_getStatistics opération.

ServiceGetStatisticsOptions

Options pour configurer l’opération getStatistics .

ServiceGetUserDelegationKeyHeaders

Définit des en-têtes pour Service_getUserDelegationKey opération.

ServiceGetUserDelegationKeyOptions

Options de configuration du service - Obtenir la clé de délégation d’utilisateur.

ServiceListContainersOptions

Options permettant de configurer l’opération listContainers .

ServiceListContainersSegmentHeaders

Définit des en-têtes pour Service_listContainersSegment opération.

ServiceRenameContainerOptions

Options de configuration <xref:BlobServiceClient.renameContainer> de l’opération.

ServiceSetPropertiesHeaders

Définit des en-têtes pour Service_setProperties opération.

ServiceSetPropertiesOptions

Options permettant de configurer l’opération setProperties .

ServiceSubmitBatchHeaders

Définit des en-têtes pour Service_submitBatch opération.

ServiceSubmitBatchOptionalParamsModel

Paramètres facultatifs.

ServiceUndeleteContainerOptions

Options permettant de configurer l’opération undeleteContainer .

SignedIdentifier

Identificateur signé.

SignedIdentifierModel

identificateur signé

StaticWebsite

Propriétés qui permettent à un compte d’héberger un site web statique

StoragePipelineOptions

Interface Options pour la fonction newPipeline .

StorageRetryOptions

Interface des options de nouvelle tentative d’objet blob de stockage.

TagConditions

Spécifie les options HTTP pour les requêtes conditionnelles basées sur des balises d’objet blob.

UserDelegationKey

Clé de délégation d’utilisateur.

UserDelegationKeyModel

Une clé de délégation d’utilisateur

Alias de type

AccessTier

Définit des valeurs pour AccessTier.

AccountKind

Définit des valeurs pour AccountKind.

AppendBlobAppendBlockFromUrlResponse

Contient des données de réponse pour l’opération appendBlockFromUrl.

AppendBlobAppendBlockResponse

Contient des données de réponse pour l’opération appendBlock.

AppendBlobCreateResponse

Contient des données de réponse pour l’opération de création.

ArchiveStatus

Définit des valeurs pour ArchiveStatus.

BlobAbortCopyFromURLResponse

Contient des données de réponse pour l’opération abortCopyFromURL.

BlobBatchDeleteBlobsResponse

Contient des données de réponse pour l’opération deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions) .

BlobBatchSetBlobsAccessTierResponse

Contient des données de réponse pour l’opération setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions) .

BlobBatchSubmitBatchResponse

Contient des données de réponse pour les opérations de lot d’objets blob.

BlobCopyFromURLResponse

Contient des données de réponse pour l’opération copyFromURL.

BlobCopySourceTags

Définit des valeurs pour BlobCopySourceTags.

BlobCreateSnapshotResponse

Contient des données de réponse pour l’opération createSnapshot.

BlobDeleteImmutabilityPolicyResponse

Contient des données de réponse pour l’opération deleteImmutabilityPolicy.

BlobDeleteResponse

Contient des données de réponse pour l’opération de suppression.

BlobDownloadResponseModel

Contient des données de réponse pour l’opération de téléchargement.

BlobGetPropertiesResponseModel

Contient des données de réponse pour l’opération getProperties.

BlobGetTagsResponse

Contient des données de réponse pour l’opération getTags .

BlobImmutabilityPolicyMode

Définit des valeurs pour BlobImmutabilityPolicyMode.

BlobQueryArrowFieldType

Type d’un BlobQueryArrowField.

BlobQueryResponseModel

Contient des données de réponse pour l’opération de requête.

BlobSetHTTPHeadersResponse

Contient des données de réponse pour l’opération setHttpHeaders.

BlobSetImmutabilityPolicyResponse

Contient des données de réponse pour l’opération setImmutabilityPolicy.

BlobSetLegalHoldResponse

Contient des données de réponse pour l’opération setLegalHold.

BlobSetMetadataResponse

Contient des données de réponse pour l’opération setMetadata.

BlobSetTagsResponse

Contient des données de réponse pour l’opération setTags.

BlobSetTierResponse

Contient des données de réponse pour l’opération setTier.

BlobStartCopyFromURLResponse

Contient des données de réponse pour l’opération startCopyFromURL.

BlobType

Définit des valeurs pour BlobType.

BlobUndeleteResponse

Contient des données de réponse pour l’opération annuler la suppression.

BlobUploadCommonResponse

Type de réponse pour uploadFile, uploadStream et <xref:BlockBlobClient.uploadBrowserDate>.

BlockBlobCommitBlockListResponse

Contient des données de réponse pour l’opération commitBlockList.

BlockBlobGetBlockListResponse

Contient des données de réponse pour l’opération getBlockList.

BlockBlobPutBlobFromUrlResponse

Contient des données de réponse pour l’opération putBlobFromUrl.

BlockBlobStageBlockFromURLResponse

Contient des données de réponse pour l’opération stageBlockFromURL.

BlockBlobStageBlockResponse

Contient des données de réponse pour l’opération stageBlock.

BlockBlobUploadResponse

Contient des données de réponse pour l’opération de chargement.

BlockListType

Définit des valeurs pour BlockListType.

ContainerCreateResponse

Contient des données de réponse pour l’opération de création.

ContainerDeleteResponse

Contient des données de réponse pour l’opération de suppression.

ContainerFindBlobsByTagsSegmentResponse

Réponse de l’opération findBlobsByTags .

ContainerGetAccessPolicyResponse

Contient des données de réponse pour l’opération getAccessPolicy .

ContainerGetPropertiesResponse

Contient des données de réponse pour l’opération getProperties.

ContainerListBlobFlatSegmentResponse

Contient des données de réponse pour l’opération listBlobFlatSegment.

ContainerListBlobHierarchySegmentResponse

Contient des données de réponse pour l’opération listBlobHierarchySegment.

ContainerRenameResponse

Contient des données de réponse pour l’opération de renommage.

ContainerSetAccessPolicyResponse

Contient des données de réponse pour l’opération setAccessPolicy.

ContainerSetMetadataResponse

Contient des données de réponse pour l’opération setMetadata.

ContainerUndeleteResponse

Contient des données de réponse pour l’opération de restauration.

CopyPollerBlobClient

Définit les opérations à partir d’un BlobClient qui sont nécessaires pour que l’polleur retourné par beginCopyFromURL fonctionne.

CopyStatusType

Définit des valeurs pour CopyStatusType.

CredentialPolicyCreator

Fonction de fabrique qui crée une nouvelle CredentialPolicy qui utilise la nextPolicy fournie.

DeleteSnapshotsOptionType

Définit des valeurs pour DeleteSnapshotsOptionType.

EncryptionAlgorithmType

Définit des valeurs pour EncryptionAlgorithmType.
KnownEncryptionAlgorithmType peut être utilisé indifféremment avec EncryptionAlgorithmType. Cette énumération contient les valeurs connues que le service prend en charge.

Connaître les valeurs prises en charge par le service

AES256

GeoReplicationStatusType

Définit des valeurs pour GeoReplicationStatusType.

HttpRequestBody

Types de corps de requête HTTP possibles

LeaseDurationType

Définit les valeurs de LeaseDurationType.

LeaseOperationResponse

Contient les données de réponse pour les opérations qui créent, modifient ou suppriment un bail.

Consultez BlobLeaseClient.

LeaseStateType

Définit les valeurs de LeaseStateType.

LeaseStatusType

Définit les valeurs de LeaseStatusType.

ObjectReplicationStatus

Spécifie l’état de réplication d’un objet blob. Elle est utilisée lorsqu’une ou plusieurs stratégies de réplication d’objet sont appliquées à un compte de stockage. Consultez ObjectReplicationPolicy et ObjectReplicationRule.

PageBlobClearPagesResponse

Contient des données de réponse pour l’opération clearPages.

PageBlobCopyIncrementalResponse

Contient des données de réponse pour l’opération copyIncremental.

PageBlobCreateResponse

Contient des données de réponse pour l’opération de création.

PageBlobGetPageRangesDiffResponseModel

Contient des données de réponse pour l’opération getPageRangesDiff.

PageBlobGetPageRangesResponseModel

Contient des données de réponse pour l’opération getPageRanges.

PageBlobResizeResponse

Contient des données de réponse pour l’opération de redimensionnement.

PageBlobUpdateSequenceNumberResponse

Contient des données de réponse pour l’opération updateSequenceNumber.

PageBlobUploadPagesFromURLResponse

Contient des données de réponse pour l’opération uploadPagesFromURL.

PageBlobUploadPagesResponse

Contient des données de réponse pour l’opération uploadPages.

PublicAccessType

Définit des valeurs pour PublicAccessType.

RehydratePriority

Définit des valeurs pour RehydratePriority.

RequestPolicyFactory

Crée une nouvelle RequestPolicy par demande qui utilise la nextPolicy fournie.

SequenceNumberActionType

Définit des valeurs pour SequenceNumberActionType.

ServiceFindBlobsByTagsSegmentResponse

Réponse de l’opération findBlobsByTags .

ServiceGetAccountInfoResponse

Contient des données de réponse pour l’opération getAccountInfo.

ServiceGetPropertiesResponse

Contient des données de réponse pour l’opération getProperties.

ServiceGetStatisticsResponse

Contient des données de réponse pour l’opération getStatistics.

ServiceGetUserDelegationKeyResponse

Contient des données de réponse pour l’opération getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) .

ServiceListContainersSegmentResponse

Contient des données de réponse pour l’opération listContainersSegment.

ServiceSetPropertiesResponse

Contient des données de réponse pour l’opération setProperties.

ServiceSubmitBatchResponseModel

Contient des données de réponse pour l’opération submitBatch.

SkuName

Définit les valeurs de SkuName.

SyncCopyStatusType

Définit les valeurs de SyncCopyStatusType.

Tags

Balises d’objets blob.

Énumérations

BlockBlobTier

Représente le niveau d’accès sur un objet blob. Pour plus d’informations sur la hiérarchisation au niveau des objets blob de blocs, consultez Niveaux de stockage chaud, froid et archive.

KnownEncryptionAlgorithmType

Valeurs connues de EncryptionAlgorithmType que le service accepte.

PremiumPageBlobTier

Spécifie le niveau d’objet blob de pages sur lequel définir l’objet blob. Cela s’applique uniquement aux objets blob de pages sur les comptes de stockage Premium. Consultez ici pour obtenir des informations détaillées sur les IOPS et le débit correspondants par PageBlobTier.

SASProtocol

Protocoles pour la signature d’accès partagé généré.

StorageBlobAudience

Définit les audiences cloud connues pour le stockage.

StorageRetryPolicyType

Types RetryPolicy.

Fonctions

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Créez un nouveau RequestPolicyCreator de sérialisation qui sérialisera les corps de requête HTTP au fur et à mesure qu’ils passent par le pipeline HTTP.

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

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée une instance de SASQueryParameters.

Accepte uniquement les paramètres requis nécessaires à la création d’une signature d’accès partagé. Pour les paramètres facultatifs, définissez directement les propriétés correspondantes, telles que les autorisations, startsOn et identifier.

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

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

Exemple d’utilisation :

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // 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();

Exemple utilisant un identificateur :

// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Exemple utilisant un nom d’objet blob :

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.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();
generateBlobSASQueryParameters(BlobSASSignatureValues, 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 sape de délégation d’utilisateur, les autorisations et expiresOn sont requises.

Exemple d’utilisation :

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.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();
getBlobServiceAccountAudience(string)
isPipelineLike(unknown)

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

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Créez un nouveau RequestPolicyCreator de sérialisation qui sérialisera les corps de requête HTTP au fur et à mesure qu’ils passent par le pipeline HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Paramètres

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

Retours

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

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée une instance de SASQueryParameters.

Accepte uniquement les paramètres requis nécessaires à la création d’une signature d’accès partagé. Pour les paramètres facultatifs, définissez directement les propriétés correspondantes, telles que les autorisations, startsOn et identifier.

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

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

Exemple d’utilisation :

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // 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();

Exemple utilisant un identificateur :

// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Exemple utilisant un nom d’objet blob :

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.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 generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Paramètres

blobSASSignatureValues
BlobSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retours

generateBlobSASQueryParameters(BlobSASSignatureValues, 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 sape de délégation d’utilisateur, les autorisations et expiresOn sont requises.

Exemple d’utilisation :

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.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 generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Paramètres

blobSASSignatureValues
BlobSASSignatureValues
userDelegationKey
UserDelegationKey

Valeur de retour de blobServiceClient.getUserDelegationKey()

accountName

string

Retours

getBlobServiceAccountAudience(string)

function getBlobServiceAccountAudience(storageAccountName: string): string

Paramètres

storageAccountName

string

Retours

string

isPipelineLike(unknown)

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

Telles que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du @azure/identity package pour authentifier les 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

Nouvel objet Pipeline.