Partager via


@azure/storage-file package

Classes

Aborter

Une instance aborter implémente l’interface AbortSignal, peut abandonner les requêtes HTTP.

  • Appelez Aborter.none pour créer une instance Aborter sans délai d’expiration.
  • Appelez Aborter.timeout() pour créer une instance Aborter avec le délai d’expiration.

Pour un abandon d’instance existant :

  • Appelez aborter.withTimeout() pour créer et retourner une instance Aborter enfant avec le délai d’expiration.
  • Appelez aborter.withValue(key, value) pour créer et retourner une instance Aborter enfant avec une paire clé/valeur.
  • Appelez aborter.abort() pour abandonner l’instance actuelle et toutes les instances enfants.
  • Appelez aborter.getValue(key) pour rechercher et obtenir la valeur avec la clé correspondante de l’abandon actuel à tous les parents.
AccountSASPermissions

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance pour 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 accorde des autorisations pour cette opération. Une fois toutes les valeurs définies, elle doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet <xref:IAccountSASSignatureValues>. 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 pour 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, elle doit être sérialisée avec toString et définie comme champ de ressources sur un objet <xref:IAccountSASSignatureValues>. 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 pour 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, elle doit être sérialisée avec toString et définie comme champ de services sur un objet <xref:IAccountSASSignatureValues>. 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.

BrowserPolicyFactory

BrowserPolicyFactory est une classe de fabrique qui permet de générer des objets BrowserPolicy.

DirectoryURL

Un DirectoryURL représente une URL vers le répertoire stockage Azure qui vous permet de manipuler ses fichiers et répertoires.

FileSASPermissions

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance pour construire une chaîne représentant les autorisations accordées par un ServiceSAS à un fichier. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accorde des autorisations pour cette opération. Une fois toutes les valeurs définies, elle doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet <xref:IFileSASSignatureValues>. 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.

FileSystemAttributes

Il s’agit d’une classe d’assistance pour construire une chaîne représentant les attributs NTFS dans un fichier ou un répertoire.

FileURL

Un FileURL représente une URL vers un fichier stockage Azure.

KeepAlivePolicyFactory

KeepAlivePolicyFactory est une classe de fabrique qui permet de générer des objets KeepAlivePolicy.

LoggingPolicyFactory

LoggingPolicyFactory est une classe de fabrique qui permet de générer des objets LoggingPolicy.

Pipeline

Classe pipeline contenant des stratégies de requête HTTP. Vous pouvez créer un pipeline par défaut en appelant StorageURL.newPipeline(). Vous pouvez également créer un pipeline avec vos propres stratégies par le constructeur de Pipeline. Reportez-vous à StorageURL.newPipeline() et avez fourni des stratégies comme référence avant d’implémenter votre pipeline personnalisé.

RetryPolicyFactory

RetryPolicyFactory est une classe de fabrique qui permet de générer des objets RetryPolicy.

SASQueryParameters

Représente les composants qui composent les paramètres de requête d’azure Storage SAS. Ce type n’est pas construit directement par l’utilisateur ; elle est générée uniquement par les types <xref:IAccountSASSignatureValues> et <xref:IFileSASSignatureValues>. Une fois généré, il peut être encodé en {@code String} et ajouté directement à une URL (bien que la prudence soit 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.

ServiceURL

Un ServiceURL représente une URL vers le service de fichiers stockage Azure, ce qui vous permet de manipuler des partages de fichiers.

ShareSASPermissions

Il s’agit d’une classe d’assistance pour construire une chaîne représentant les autorisations accordées par un ServiceSAS à un partage. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accorde des autorisations pour cette opération. Une fois toutes les valeurs définies, elle doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet <xref:IFileSASSignatureValues>. 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.

ShareURL

Un ShareURL représente une URL vers le partage stockage Azure, ce qui vous permet de manipuler ses répertoires et fichiers.

StorageURL

Un ServiceURL représente une classe d’URL basée pour ServiceURL, ContainerURL et etc.

TelemetryPolicyFactory

TelemetryPolicyFactory est une classe d’usine qui permet de générer des objets TelemetryPolicy.

UniqueRequestIDPolicyFactory

UniqueRequestIDPolicyFactory est une classe de fabrique qui permet de générer des objets UniqueRequestIDPolicy.

AnonymousCredential

AnonymousCredential fournit un membre credentialPolicyCreator utilisé pour créer des objets AnonymousCredentialPolicy. AnonymousCredentialPolicy est utilisé avec des requêtes HTTP(S) qui lisent des ressources publiques ou pour une utilisation avec des signatures d’accès partagé (SAP).

Credential

Les informations d’identification sont une classe abstraite pour la signature des requêtes HTTP stockage Azure. Cette classe hébergera une fabrique CredentialPolicyCreator qui génère CredentialPolicy.

SharedKeyCredential

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. SharedKeyCredential pour l’autorisation de clé de compte du service Stockage Azure.

Directory

Classe représentant un répertoire.

File

Classe représentant un fichier.

Service

Classe représentant un service.

Share

Classe représentant un partage.

StorageClient
StorageClientContext
AnonymousCredentialPolicy

AnonymousCredentialPolicy est utilisé avec des requêtes HTTP(S) qui lisent des ressources publiques ou pour une utilisation avec des signatures d’accès partagé (SAP).

BrowserPolicy

BrowserPolicy gère les différences entre Node.js et le runtime du navigateur, notamment :

  1. Les navigateurs mettant en cache les requêtes GET/HEAD en ajoutant des en-têtes conditionnels tels que « IF_MODIFIED_SINCE ». BrowserPolicy est une stratégie utilisée pour ajouter une requête d’horodatage à l’URL de requête GET/HEAD, ce qui évite le cache du navigateur.

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

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

CredentialPolicy

Stratégie d’informations d’identification utilisée pour signer des requêtes HTTP(S) avant l’envoi. Il s’agit d’une classe abstraite.

KeepAlivePolicy

KeepAlivePolicy est une stratégie utilisée pour contrôler les paramètres actifs pour chaque requête.

LoggingPolicy

LoggingPolicy est une stratégie utilisée pour journaliser les demandes.

RetryPolicy

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

SharedKeyCredentialPolicy

SharedKeyCredentialPolicy est une stratégie utilisée pour signer une requête HTTP avec une clé partagée.

TelemetryPolicy

TelemetryPolicy est une stratégie utilisée pour baliser l’en-tête de l’agent utilisateur pour chaque requête.

UniqueRequestIDPolicy

UniqueRequestIDPolicy génère un UUID en tant que valeur d’en-tête x-ms-request-id.

Batch

Batch fournit une exécution parallèle de base avec des limites d’accès concurrentiel. Arrête l’exécution des opérations de gauche lorsque l’une des opérations exécutées génère une erreur. Mais Batch ne peut pas annuler les opérations en cours, vous devez les annuler par vous-même.

BufferScheduler

Cette classe accepte un Node.js flux lisible comme entrée et continue à lire les données du flux dans la structure de mémoire tampon interne jusqu’à ce qu’elle atteigne maxBuffers. Chaque mémoire tampon disponible tente de déclencher le gestionnaire sortant. La structure de mémoire tampon interne inclut un tableau de mémoires tampons entrantes et un tableau de mémoires tampons sortantes. Le tableau de mémoires tampons entrantes inclut les mémoires tampons « vides » peuvent être remplies de nouvelles données entrantes. Le tableau sortant inclut les mémoires tampons remplies à gérer par le gestionnaire sortant. Chaque taille de mémoire tampon ci-dessus est définie par bufferSize de paramètres.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

<NUM_OF_ALL_BUFFERS = maxBuffers

CONSEILS D’AMÉLIORATION DES PERFORMANCES :

  1. Le flux d’entrée highWaterMark est préférable à définir une même valeur avec le paramètre bufferSize, ce qui évite les opérations Buffer.concat().
  2. Le parallélisme doit définir une valeur inférieure à maxBuffers, ce qui est utile pour réduire la possibilité lorsqu’un gestionnaire sortant attend les données de flux. dans ce cas, les gestionnaires sortants sont bloqués. La file d’attente sortante ne doit pas être vide.
RetriableReadableStream

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Une Node.js ReadableStream retente en interne lorsque l’événement ReadableStream interne se termine de manière inattendue.

Interfaces

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions

L’option est définie en tant que parité avec la définition REST. Bien qu’il ne soit pas prêt à être utilisé maintenant, compte tenu du crc64 du contenu source n’est pas accessible.

IFileListHandlesSegmentOptions
IFileProperties
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
IAccountSASSignatureValues

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. IAccountSASSignatureValues est utilisé pour générer une signature d’accès partagé (SAP) pour un compte de stockage Azure. Une fois toutes les valeurs définies ici correctement, appel generateSASQueryParameters() pour obtenir une représentation de la SAP qui peut réellement être appliquée aux URL de fichier. Remarque : cette classe et cette <xref:SASQueryParameters> existent, car l’ancien est mutable et une représentation logique tandis que ce dernier est immuable et utilisé pour générer des requêtes REST réelles.

IFileSASSignatureValues

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. IFileSASSignatureValues est utilisé pour aider à générer des jetons SAP du service de fichiers pour les partages ou les fichiers.

IIPRange

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

IRange

Plage pour les opérations de service.

IKeepAliveOptions

Interface des options KeepAlivePolicy.

IRequestLogOptions

RequestLogOptions configure le comportement de la stratégie de nouvelle tentative.

IPipelineOptions

Interface d’option pour le constructeur de pipeline.

IRetryOptions

Interface des options de nouvelle tentative.

IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions

Interface d’option pour la méthode Pipeline.newPipeline.

ITelemetryOptions

Interface des options TelemetryPolicy.

AccessPolicy

Stratégie d’accès.

CorsRule

CORS est une fonctionnalité HTTP qui permet à une application web s’exécutant sous 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 offre un moyen sécurisé d’autoriser un domaine (le domaine d’origine) à appeler des API dans un autre domaine.

DirectoryCreateHeaders

Définit des en-têtes pour l’opération Créer.

DirectoryCreateOptionalParams

Paramètres facultatifs.

DirectoryDeleteHeaders

Définit les en-têtes pour l’opération Delete.

DirectoryDeleteMethodOptionalParams

Paramètres facultatifs.

DirectoryForceCloseHandlesHeaders

Définit des en-têtes pour l’opération ForceCloseHandles.

DirectoryForceCloseHandlesOptionalParams

Paramètres facultatifs.

DirectoryGetPropertiesHeaders

Définit des en-têtes pour l’opération GetProperties.

DirectoryGetPropertiesOptionalParams

Paramètres facultatifs.

DirectoryItem

Élément de répertoire répertorié.

DirectoryListFilesAndDirectoriesSegmentHeaders

Définit des en-têtes pour l’opération ListFilesAndDirectoriesSegment.

DirectoryListFilesAndDirectoriesSegmentOptionalParams

Paramètres facultatifs.

DirectoryListHandlesHeaders

Définit des en-têtes pour l’opération ListHandles.

DirectoryListHandlesOptionalParams

Paramètres facultatifs.

DirectorySetMetadataHeaders

Définit des en-têtes pour l’opération SetMetadata.

DirectorySetMetadataOptionalParams

Paramètres facultatifs.

DirectorySetPropertiesHeaders

Définit des en-têtes pour l’opération SetProperties.

DirectorySetPropertiesOptionalParams

Paramètres facultatifs.

FileAbortCopyHeaders

Définit des en-têtes pour l’opération AbortCopy.

FileAbortCopyOptionalParams

Paramètres facultatifs.

FileCreateHeaders

Définit des en-têtes pour l’opération Créer.

FileCreateOptionalParams

Paramètres facultatifs.

FileDeleteHeaders

Définit les en-têtes pour l’opération Delete.

FileDeleteMethodOptionalParams

Paramètres facultatifs.

FileDownloadHeaders

Définit les en-têtes pour l’opération de téléchargement.

FileDownloadOptionalParams

Paramètres facultatifs.

FileForceCloseHandlesHeaders

Définit des en-têtes pour l’opération ForceCloseHandles.

FileForceCloseHandlesOptionalParams

Paramètres facultatifs.

FileGetPropertiesHeaders

Définit des en-têtes pour l’opération GetProperties.

FileGetPropertiesOptionalParams

Paramètres facultatifs.

FileGetRangeListHeaders

Définit des en-têtes pour l’opération GetRangeList.

FileGetRangeListOptionalParams

Paramètres facultatifs.

FileHTTPHeaders

Paramètres supplémentaires pour un ensemble d’opérations, tels que : File_create, File_setHTTPHeaders.

FileItem

Élément de fichier répertorié.

FileListHandlesHeaders

Définit des en-têtes pour l’opération ListHandles.

FileListHandlesOptionalParams

Paramètres facultatifs.

FileProperty

Propriétés du fichier.

FileSetHTTPHeadersHeaders

Définit des en-têtes pour l’opération SetHTTPHeaders.

FileSetHTTPHeadersOptionalParams

Paramètres facultatifs.

FileSetMetadataHeaders

Définit des en-têtes pour l’opération SetMetadata.

FileSetMetadataOptionalParams

Paramètres facultatifs.

FileStartCopyHeaders

Définit des en-têtes pour l’opération StartCopy.

FileStartCopyOptionalParams

Paramètres facultatifs.

FileUploadRangeFromURLHeaders

Définit des en-têtes pour l’opération UploadRangeFromURL.

FileUploadRangeFromURLOptionalParams

Paramètres facultatifs.

FileUploadRangeHeaders

Définit des en-têtes pour l’opération UploadRange.

FileUploadRangeOptionalParams

Paramètres facultatifs.

FilesAndDirectoriesListSegment

Résumé pour les entrées qui peuvent être répertoriées à partir du répertoire.

HandleItem

Élément de handle stockage Azure répertorié.

ListFilesAndDirectoriesSegmentResponse

Énumération de répertoires et de fichiers.

ListHandlesResponse

Énumération de handles.

ListSharesResponse

Énumération de partages.

Metrics

Métriques Storage Analytics pour le service de fichiers.

Permission

Permission(un descripteur de sécurité) décrit dans le langage de définition du descripteur de sécurité (SDDL).

Range

Plage de fichiers stockage Azure.

RetentionPolicy

Stratégie de rétention.

ServiceGetPropertiesHeaders

Définit des en-têtes pour l’opération GetProperties.

ServiceGetPropertiesOptionalParams

Paramètres facultatifs.

ServiceListSharesSegmentHeaders

Définit des en-têtes pour l’opération ListSharesSegment.

ServiceListSharesSegmentOptionalParams

Paramètres facultatifs.

ServiceSetPropertiesHeaders

Définit des en-têtes pour l’opération SetProperties.

ServiceSetPropertiesOptionalParams

Paramètres facultatifs.

ShareCreateHeaders

Définit des en-têtes pour l’opération Créer.

ShareCreateOptionalParams

Paramètres facultatifs.

ShareCreatePermissionHeaders

Définit des en-têtes pour l’opération CreatePermission.

ShareCreatePermissionOptionalParams

Paramètres facultatifs.

ShareCreateSnapshotHeaders

Définit des en-têtes pour l’opération CreateSnapshot.

ShareCreateSnapshotOptionalParams

Paramètres facultatifs.

ShareDeleteHeaders

Définit les en-têtes pour l’opération Delete.

ShareDeleteMethodOptionalParams

Paramètres facultatifs.

ShareGetAccessPolicyHeaders

Définit des en-têtes pour l’opération GetAccessPolicy.

ShareGetAccessPolicyOptionalParams

Paramètres facultatifs.

ShareGetPermissionHeaders

Définit des en-têtes pour l’opération GetPermission.

ShareGetPermissionOptionalParams

Paramètres facultatifs.

ShareGetPropertiesHeaders

Définit des en-têtes pour l’opération GetProperties.

ShareGetPropertiesOptionalParams

Paramètres facultatifs.

ShareGetStatisticsHeaders

Définit des en-têtes pour l’opération GetStatistics.

ShareGetStatisticsOptionalParams

Paramètres facultatifs.

ShareItem

Élément de partage Stockage Azure répertorié.

ShareProperties

Propriétés d’un partage.

ShareSetAccessPolicyHeaders

Définit des en-têtes pour l’opération SetAccessPolicy.

ShareSetAccessPolicyOptionalParams

Paramètres facultatifs.

ShareSetMetadataHeaders

Définit des en-têtes pour l’opération SetMetadata.

ShareSetMetadataOptionalParams

Paramètres facultatifs.

ShareSetQuotaHeaders

Définit des en-têtes pour l’opération SetQuota.

ShareSetQuotaOptionalParams

Paramètres facultatifs.

ShareStats

Statistiques pour le partage.

SignedIdentifier

Identificateur signé.

SourceModifiedAccessConditions

Paramètres supplémentaires pour l’opération uploadRangeFromURL.

StorageError

Interface représentant StorageError.

StorageServiceProperties

Propriétés du service de stockage.

IDownloadFromAzureFileOptions

Interface d’option pour DownloadAzurefileToBuffer.

IUploadToAzureFileOptions

Interface d’option pour uploadFileToAzureFile et uploadSeekableStreamToAzureFile.

IUploadStreamToAzureFileOptions

Interface d’option pour uploadStreamToAzureFile.

IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

Alias de type

FileDownloadResponse

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

FileGetRangeListResponse

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

ShareGetAccessPolicyResponse

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

ShareGetStatisticsResponse

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

CredentialPolicyCreator

Fonction de fabrique qui crée une stratégie d’identification qui utilise la stratégie suivante fournie.

CopyStatusType

Définit des valeurs pour CopyStatusType. Les valeurs possibles sont les suivantes : « en attente », « success », « aborted », « failed » (échec)

DeleteSnapshotsOptionType

Définit des valeurs pour DeleteSnapshotsOptionType. Les valeurs possibles sont les suivantes : « include »

DirectoryCreateResponse

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

DirectoryDeleteResponse

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

DirectoryForceCloseHandlesResponse

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

DirectoryGetPropertiesResponse

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

DirectoryListFilesAndDirectoriesSegmentResponse

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

DirectoryListHandlesResponse

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

DirectorySetMetadataResponse

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

DirectorySetPropertiesResponse

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

FileAbortCopyResponse

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

FileCreateResponse

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

FileDeleteResponse

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

FileForceCloseHandlesResponse

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

FileGetPropertiesResponse

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

FileListHandlesResponse

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

FileRangeWriteType

Définit des valeurs pour FileRangeWriteType. Les valeurs possibles sont les suivantes : « update », « clear »

FileSetHTTPHeadersResponse

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

FileSetMetadataResponse

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

FileStartCopyResponse

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

FileType

Définit des valeurs pour FileType. Les valeurs possibles sont les suivantes : « Fichier »

FileUploadRangeFromURLResponse

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

FileUploadRangeResponse

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

ListSharesIncludeType

Définit des valeurs pour ListSharesIncludeType. Les valeurs possibles sont les suivantes : « captures instantanées », « métadonnées »

ServiceGetPropertiesResponse

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

ServiceListSharesSegmentResponse

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

ServiceSetPropertiesResponse

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

ShareCreatePermissionResponse

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

ShareCreateResponse

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

ShareCreateSnapshotResponse

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

ShareDeleteResponse

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

ShareGetPermissionResponse

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

ShareGetPropertiesResponse

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

ShareSetAccessPolicyResponse

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

ShareSetMetadataResponse

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

ShareSetQuotaResponse

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

StorageErrorCode

Définit des valeurs pour StorageErrorCode. Les valeurs possibles sont les suivantes : « AccountAlreadyExists », « AccountBeingCreated », « AccountIsDisabled », « AuthenticationFailed », « AuthorizationFailure », 'ConditionHeadersNotSupported', 'ConditionNotMet', 'EmptyMetadataKey', 'InsufficientAccountPermissions', 'InternalError', 'InvalidAuthenticationInfo', 'InvalidHeaderValue', 'InvalidHttpVerb', 'InvalidInput', 'InvalidMd5', 'InvalidMetadata', 'InvalidQueryParameterValue', 'InvalidRange', 'InvalidResourceName', 'InvalidUri', InvalidXmlDocument', 'InvalidXmlNodeValue', 'Md5Mismatch', 'MetadataTooLarge', 'MissingContentLengthHeader', 'MissingRequiredQueryParameter', 'MissingRequiredHeader', 'MissingRequiredHeader', 'MissingRequiredXmlNode', 'MultipleConditionHeadersNotSupported', 'OperationTimedOut', 'OutOfRangeInput', 'OutOfRangeQueryParameterValue', 'RequestBodyTooLarge', 'ResourceTypeMismatch', 'RequestUrlFailedToParse', 'ResourceAlreadyExists', 'ResourceNotFound', 'ServerBusy', 'UnsupportedHeader', ' UnsupportedXmlNode', 'UnsupportedQueryParameter', 'UnsupportedHttpVerb', 'CannotDeleteFileOrDirectory', 'ClientCacheFlushDelay', 'DeletePending', 'DirectoryNotEmpty', 'FileLockConflict', 'FileLockConflict', 'InvalidFileOrDirectoryPathName', 'ParentNotFound', 'ReadOnlyAttribute', 'ShareAlreadyExists', 'ShareBeingDeleted', 'ShareDisabled', 'ShareNotFound', 'SharingViolation', 'ShareSnapshotInProgress', 'ShareSnapshotCountExceeded', 'ShareSnapshotOperationNotSupported', ' ShareHasSnapshots', 'ContainerQuotaDowngradeNotAllowed'

FileAttributesPreserveType

Indique que les attributs de fichier existants restent inchangés.

FilePermissionInheritType

Indique hériter de l’autorisation de fichier du répertoire parent.

FilePermissionPreserveType

Indique que la valeur d’autorisation de fichier existante n’est pas modifiée.

TimeNowType

Indique le paramètre comme heure de la requête.

TimePreserveType

Indique que la valeur de temps existante n’est pas modifiée.

Operation

L’opération est une fonction asynchrone à exécuter et à gérer par Batch.

OutgoingHandler

OutgoingHandler est une fonction asynchrone déclenchée par BufferScheduler.

ReadableStreamGetter

Énumérations

SASProtocol

Protocoles pour la SAP générée.

RetryPolicyType

Types RetryPolicy.

Functions

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Génère un objet <xref:SASQueryParameters> qui contient tous les paramètres de requête SAP nécessaires pour effectuer une requête REST réelle.

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

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, startTime et l’identificateur.

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

ipRangeToString(IIPRange)

Générer une chaîne de format IPRange. Par exemple : « 8.8.8.8 » ou « 1.1.1.1-255.255.255.255.255 »

rangeToString(IRange)

Générez une chaîne de plage. Par exemple : « bytes=255- » ou « bytes=0-511 »

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

DISPONIBLE UNIQUEMENT DANS LES NAVIGATEURS. Charge un objet Blob de navigateur/File/ArrayBuffer/ArrayBufferView dans un fichier Azure.

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Télécharge un fichier Azure en parallèle vers une mémoire tampon. Le décalage et le nombre sont facultatifs, transmettez 0 pour les deux pour télécharger l’intégralité du fichier.

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Charge un fichier local dans un fichier Azure.

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Charge un flux Node.js lisible dans un fichier Azure. Cette méthode tente de créer un bloc Azure, puis commence à charger un bloc par segment. La taille du bloc est définie par bufferSize paramètre. Assurez-vous que la taille potentielle du flux ne dépasse pas la taille du fichier.

CONSEILS D’AMÉLIORATION DES PERFORMANCES :

  • Le flux d’entrée highWaterMark est préférable à définir une même valeur avec le paramètre bufferSize, ce qui évite les opérations Buffer.concat().
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined | string, undefined | string)
NewRetryPolicyFactory(IRetryOptions)

Méthode de fabrique utilisée pour générer une fabrique RetryPolicy.

blobToArrayBuffer(Blob)

Convertissez un objet blob de navigateur en ArrayBuffer.

appendToURLPath(string, string)

Ajoutez une chaîne au chemin d’URL. Supprime le « / » dupliqué devant la chaîne lorsque le chemin d’URL se termine par un « / ».

base64decode(string)

Décodage base64.

base64encode(string)

Encoder en Base64.

delay(number, AbortSignalLike, Error)

Intervalle de temps spécifié.

escapeURLPath(string)

Les caractères d’URL réservés doivent être correctement placés dans une séquence d’échappement pour les services de stockage tels que l’objet blob ou le fichier.

Stratégie d’encodage et d’échappement d’URL pour les kits SDK JSv10

Lorsque les clients passent une chaîne d’URL dans le constructeur de classes XXXURL, la chaîne d’URL peut déjà être encodée ou non. Mais avant d’envoyer au serveur stockage Azure, l’URL doit être encodée. Toutefois, il est difficile pour un SDK de deviner si la chaîne d’URL a été encodée ou non. Nous avons 2 stratégies potentielles et choisi la stratégie deux pour les constructeurs XXXURL.

Stratégie 1 : supposons que la chaîne d’URL du client n’est pas encodée et qu’elle code toujours la chaîne d’URL dans le Kit de développement logiciel (SDK).

C’est ce que fait le SDK V2 hérité, simple et fonctionne pour la plupart des cas.

  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b:", le SDK l’encodera sur «http://account.blob.core.windows.net/con/b%3A" et envoyer au serveur. Un objet blob nommé « b : » est créé.
  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b%3A", le SDK l’encodera sur «http://account.blob.core.windows.net/con/b%253A" et envoyer au serveur. Un objet blob nommé « b%3A» sera créé.

Mais cette stratégie ne permettra pas de créer un objet blob avec « ? » dans son nom. Étant donné que lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/blob?name", le « ?name » sera traité comme un analyseur d’URL au lieu du nom de l’objet blob. Si la chaîne d’URL du client est «http://account.blob.core.windows.net/con/blob%3Fname", un objet blob nommé « blob%3Fname» est créé. Le Kit de développement logiciel (SDK) V2 n’a pas ce problème, car il n’autorise pas le passage du client dans une URL complète, il accepte un nom d’objet blob distinct et encodeURIComponent pour celui-ci. Nous ne pouvons pas accepter qu’un KIT de développement logiciel (SDK) ne puisse pas créer un nom d’objet blob avec « ? ». Nous implémentons donc la stratégie 2 :

Stratégie 2 : le Kit de développement logiciel (SDK) ne suppose pas que l’URL a été encodée ou non. Il va juste échapper les caractères spéciaux.

C’est ce que fait le Kit de développement logiciel (SDK) Go d’objets blob V10. Il accepte un type d’URL dans Go et appelle l’URL. EscapedPath() pour échapper aux caractères spéciaux non échapés.

  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b:", le Kit de développement logiciel (SDK) s’échappe « : » comme «http://account.blob.core.windows.net/con/b%3A" et envoyer au serveur. Un objet blob nommé « b : » est créé.
  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b%3A", il n’y a pas de caractères spéciaux, donc envoyez «http://account.blob.core.windows.net/con/b%3A" sur le serveur. Un objet blob nommé « b : » est créé.
  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b%253A", il n’y a pas de caractères spéciaux, donc envoyez «http://account.blob.core.windows.net/con/b%253A" sur le serveur. Un objet blob nommé « b%3A» sera créé.

Cette stratégie nous donne la possibilité de créer avec tous les caractères spéciaux. Mais «%» sera traité comme un caractère spécial, si la chaîne d’URL n’est pas encodée, il ne doit pas y avoir de «%» dans la chaîne d’URL, sinon l’URL n’est pas une URL valide. Si le client doit créer un objet blob avec «%» dans son nom d’objet blob, utilisez «%25» insead of «%». Tout comme au-dessus du troisième échantillon. Les chaînes d’URL suivantes ne sont pas valides :

  • "http://account.blob.core.windows.net/con/b%" ;
  • "http://account.blob.core.windows.net/con/b%2" ;
  • "http://account.blob.core.windows.net/con/b%G" ;

Un autre caractère spécial est « ? », utilisez «%2F» pour représenter un nom d’objet blob avec « ? » dans une chaîne d’URL.

Stratégie pour containerName, blobName ou d’autres paramètres XXXName spécifiques dans des méthodes telles que BlobURL.fromContainerURL(containerURL, blobName)

Nous allons appliquer la stratégie 1 et appeler encodeURIComponent pour ces paramètres tels que blobName. Étant donné que ce que les clients passent est un nom brut au lieu d’une URL.

getURLParameter(string, string)

Obtenir le paramètre d’URL par nom.

getURLPath(string)

Obtenir le chemin d’URL à partir d’une chaîne d’URL.

getURLQueries(string)

Obtenir des paires valeur de clé de requête URL à partir d’une chaîne d’URL.

padStart(string, number, undefined | string)

String.prototype.padStart()

setURLHost(string, string)

Définissez l’hôte d’URL.

setURLParameter(string, string, undefined | string)

Définissez le nom et la valeur du paramètre d’URL. Si le nom existe dans les paramètres d’URL, l’ancienne valeur est remplacée par la clé de nom. Si ce n’est pas le cas, le paramètre est supprimé.

truncatedISO8061Date(Date, undefined | false | true)

Arrondit une date à quelques secondes.

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Lit un flux lisible dans la mémoire tampon. Remplissez la mémoire tampon du décalage à la fin.

Informations relatives à la fonction

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Génère un objet <xref:SASQueryParameters> qui contient tous les paramètres de requête SAP nécessaires pour effectuer une requête REST réelle.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Paramètres

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Retours

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

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, startTime et l’identificateur.

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

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Paramètres

fileSASSignatureValues
IFileSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Retours

ipRangeToString(IIPRange)

Générer une chaîne de format IPRange. Par exemple : « 8.8.8.8 » ou « 1.1.1.1-255.255.255.255.255 »

function ipRangeToString(ipRange: IIPRange)

Paramètres

ipRange
IIPRange

Retours

string

rangeToString(IRange)

Générez une chaîne de plage. Par exemple : « bytes=255- » ou « bytes=0-511 »

function rangeToString(iRange: IRange)

Paramètres

iRange
IRange

Retours

string

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

DISPONIBLE UNIQUEMENT DANS LES NAVIGATEURS. Charge un objet Blob de navigateur/File/ArrayBuffer/ArrayBufferView dans un fichier Azure.

function uploadBrowserDataToAzureFile(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Paramètres

aborter
Aborter

Créer une instance Aborter avec Aborter.none ou Aborter.timeout(), accéder aux documents d’Aborter pour plus d’exemples sur l’annulation de la demande

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer ou ArrayBufferView

fileURL
FileURL

Retours

Promise<void>

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Télécharge un fichier Azure en parallèle vers une mémoire tampon. Le décalage et le nombre sont facultatifs, transmettez 0 pour les deux pour télécharger l’intégralité du fichier.

function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: undefined | number, options?: IDownloadFromAzureFileOptions)

Paramètres

aborter
Aborter

Créer une instance Aborter avec Aborter.none ou Aborter.timeout(), accéder aux documents d’Aborter pour plus d’exemples sur l’annulation de la demande

buffer

Buffer

Mémoire tampon à remplir, doit avoir une longueur supérieure au nombre

fileURL
FileURL

Objet FileURL

offset

number

À partir de quelle position du fichier Azure à télécharger

count

undefined | number

Retours

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Charge un fichier local dans un fichier Azure.

function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Paramètres

aborter
Aborter

Créer une instance Aborter avec Aborter.none ou Aborter.timeout(), accéder aux documents d’Aborter pour plus d’exemples sur l’annulation de la demande

filePath

string

Chemin d’accès complet du fichier local

fileURL
FileURL

FileURL

Retours

Promise<void>

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Charge un flux Node.js lisible dans un fichier Azure. Cette méthode tente de créer un bloc Azure, puis commence à charger un bloc par segment. La taille du bloc est définie par bufferSize paramètre. Assurez-vous que la taille potentielle du flux ne dépasse pas la taille du fichier.

CONSEILS D’AMÉLIORATION DES PERFORMANCES :

  • Le flux d’entrée highWaterMark est préférable à définir une même valeur avec le paramètre bufferSize, ce qui évite les opérations Buffer.concat().
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

Paramètres

aborter
Aborter

Créer une instance Aborter avec Aborter.none ou Aborter.timeout(), accéder aux documents d’Aborter pour plus d’exemples sur l’annulation de la demande

stream

Readable

Node.js flux lisible. Doit être inférieur ou égal à la taille du fichier.

size

number

Taille du fichier à créer. La taille maxium autorisée est de 1 To. Si cette valeur est supérieure à la taille du flux, il y aura des octets vides dans la fin du fichier.

fileURL
FileURL

Instance FileURL

bufferSize

number

Taille de chaque mémoire tampon allouée en octets, également la taille de segment/plage pendant le fichier chargé. La taille doit être > 0 et <= 4 * 1024 * 1024 (4 Mo)

maxBuffers

number

Les mémoires tampons maximales sont allouées pendant le chargement, la corrélation positive avec la concurrence maximale de chargement

Retours

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Paramètres

Retours

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType)

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Paramètres

Retours

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Paramètres

Retours

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Paramètres

Retours

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Paramètres

Retours

validateFilePermissionOptions(undefined | string, undefined | string)

function validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string)

Paramètres

filePermission

undefined | string

filePermissionKey

undefined | string

NewRetryPolicyFactory(IRetryOptions)

Méthode de fabrique utilisée pour générer une fabrique RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Paramètres

retryOptions
IRetryOptions

Retours

RequestPolicyFactory

blobToArrayBuffer(Blob)

Convertissez un objet blob de navigateur en ArrayBuffer.

function blobToArrayBuffer(blob: Blob)

Paramètres

blob

Blob

Retours

Promise<ArrayBuffer>

appendToURLPath(string, string)

Ajoutez une chaîne au chemin d’URL. Supprime le « / » dupliqué devant la chaîne lorsque le chemin d’URL se termine par un « / ».

function appendToURLPath(url: string, name: string)

Paramètres

url

string

Chaîne d’URL source

name

string

Chaîne à ajouter à l’URL

Retours

string

Chaîne d’URL mise à jour

base64decode(string)

Décodage base64.

function base64decode(encodedString: string)

Paramètres

encodedString

string

Retours

string

base64encode(string)

Encoder en Base64.

function base64encode(content: string)

Paramètres

content

string

Retours

string

delay(number, AbortSignalLike, Error)

Intervalle de temps spécifié.

function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error)

Paramètres

timeInMs

number

aborter

AbortSignalLike

abortError

Error

Retours

Promise<unknown>

escapeURLPath(string)

Les caractères d’URL réservés doivent être correctement placés dans une séquence d’échappement pour les services de stockage tels que l’objet blob ou le fichier.

Stratégie d’encodage et d’échappement d’URL pour les kits SDK JSv10

Lorsque les clients passent une chaîne d’URL dans le constructeur de classes XXXURL, la chaîne d’URL peut déjà être encodée ou non. Mais avant d’envoyer au serveur stockage Azure, l’URL doit être encodée. Toutefois, il est difficile pour un SDK de deviner si la chaîne d’URL a été encodée ou non. Nous avons 2 stratégies potentielles et choisi la stratégie deux pour les constructeurs XXXURL.

Stratégie 1 : supposons que la chaîne d’URL du client n’est pas encodée et qu’elle code toujours la chaîne d’URL dans le Kit de développement logiciel (SDK).

C’est ce que fait le SDK V2 hérité, simple et fonctionne pour la plupart des cas.

  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b:", le SDK l’encodera sur «http://account.blob.core.windows.net/con/b%3A" et envoyer au serveur. Un objet blob nommé « b : » est créé.
  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b%3A", le SDK l’encodera sur «http://account.blob.core.windows.net/con/b%253A" et envoyer au serveur. Un objet blob nommé « b%3A» sera créé.

Mais cette stratégie ne permettra pas de créer un objet blob avec « ? » dans son nom. Étant donné que lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/blob?name", le « ?name » sera traité comme un analyseur d’URL au lieu du nom de l’objet blob. Si la chaîne d’URL du client est «http://account.blob.core.windows.net/con/blob%3Fname", un objet blob nommé « blob%3Fname» est créé. Le Kit de développement logiciel (SDK) V2 n’a pas ce problème, car il n’autorise pas le passage du client dans une URL complète, il accepte un nom d’objet blob distinct et encodeURIComponent pour celui-ci. Nous ne pouvons pas accepter qu’un KIT de développement logiciel (SDK) ne puisse pas créer un nom d’objet blob avec « ? ». Nous implémentons donc la stratégie 2 :

Stratégie 2 : le Kit de développement logiciel (SDK) ne suppose pas que l’URL a été encodée ou non. Il va juste échapper les caractères spéciaux.

C’est ce que fait le Kit de développement logiciel (SDK) Go d’objets blob V10. Il accepte un type d’URL dans Go et appelle l’URL. EscapedPath() pour échapper aux caractères spéciaux non échapés.

  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b:", le Kit de développement logiciel (SDK) s’échappe « : » comme «http://account.blob.core.windows.net/con/b%3A" et envoyer au serveur. Un objet blob nommé « b : » est créé.
  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b%3A", il n’y a pas de caractères spéciaux, donc envoyez «http://account.blob.core.windows.net/con/b%3A" sur le serveur. Un objet blob nommé « b : » est créé.
  • Lorsque la chaîne d’URL du client est «http://account.blob.core.windows.net/con/b%253A", il n’y a pas de caractères spéciaux, donc envoyez «http://account.blob.core.windows.net/con/b%253A" sur le serveur. Un objet blob nommé « b%3A» sera créé.

Cette stratégie nous donne la possibilité de créer avec tous les caractères spéciaux. Mais «%» sera traité comme un caractère spécial, si la chaîne d’URL n’est pas encodée, il ne doit pas y avoir de «%» dans la chaîne d’URL, sinon l’URL n’est pas une URL valide. Si le client doit créer un objet blob avec «%» dans son nom d’objet blob, utilisez «%25» insead of «%». Tout comme au-dessus du troisième échantillon. Les chaînes d’URL suivantes ne sont pas valides :

  • "http://account.blob.core.windows.net/con/b%" ;
  • "http://account.blob.core.windows.net/con/b%2" ;
  • "http://account.blob.core.windows.net/con/b%G" ;

Un autre caractère spécial est « ? », utilisez «%2F» pour représenter un nom d’objet blob avec « ? » dans une chaîne d’URL.

Stratégie pour containerName, blobName ou d’autres paramètres XXXName spécifiques dans des méthodes telles que BlobURL.fromContainerURL(containerURL, blobName)

Nous allons appliquer la stratégie 1 et appeler encodeURIComponent pour ces paramètres tels que blobName. Étant donné que ce que les clients passent est un nom brut au lieu d’une URL.

function escapeURLPath(url: string)

Paramètres

url

string

Retours

string

getURLParameter(string, string)

Obtenir le paramètre d’URL par nom.

function getURLParameter(url: string, name: string)

Paramètres

url

string

name

string

Retours

string | string[] | undefined

getURLPath(string)

Obtenir le chemin d’URL à partir d’une chaîne d’URL.

function getURLPath(url: string)

Paramètres

url

string

Chaîne d’URL source

Retours

string | undefined

getURLQueries(string)

Obtenir des paires valeur de clé de requête URL à partir d’une chaîne d’URL.

function getURLQueries(url: string)

Paramètres

url

string

Retours

[key: string]: string

padStart(string, number, undefined | string)

String.prototype.padStart()

function padStart(currentString: string, targetLength: number, padString?: undefined | string)

Paramètres

currentString

string

targetLength

number

padString

undefined | string

Retours

string

setURLHost(string, string)

Définissez l’hôte d’URL.

function setURLHost(url: string, host: string)

Paramètres

url

string

Chaîne d’URL source

host

string

Nouvelle chaîne d’hôte

Retours

string

Chaîne d’URL mise à jour

setURLParameter(string, string, undefined | string)

Définissez le nom et la valeur du paramètre d’URL. Si le nom existe dans les paramètres d’URL, l’ancienne valeur est remplacée par la clé de nom. Si ce n’est pas le cas, le paramètre est supprimé.

function setURLParameter(url: string, name: string, value?: undefined | string)

Paramètres

url

string

Chaîne d’URL source

name

string

Nom du paramètre

value

undefined | string

Retours

string

Chaîne d’URL mise à jour

truncatedISO8061Date(Date, undefined | false | true)

Arrondit une date à quelques secondes.

function truncatedISO8061Date(date: Date, withMilliseconds?: undefined | false | true)

Paramètres

date

Date

withMilliseconds

undefined | false | true

Retours

string

Chaîne de date au format ISO8061, avec ou sans composant de 7 millisecondes

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Lit un flux lisible dans la mémoire tampon. Remplissez la mémoire tampon du décalage à la fin.

function streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string)

Paramètres

stream

ReadableStream

Flux lisible Node.js

buffer

Buffer

Mémoire tampon à remplir, la longueur doit >= offset

offset

number

À partir de quelle position dans la mémoire tampon à remplir, inclusive

end

number

À quelle position dans la mémoire tampon à remplir, exclusive

encoding

undefined | string

Retours

Promise<void>