Partager via


@azure/storage-queue 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. Définir 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. Définir 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 en tant que 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. Définir 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 en tant que champ de services sur un objet AccountSASSignatureValues . Il est possible de construire la chaîne de services sans cette classe, mais l’ordre des services est particulier et cette classe garantit l’exactitude.

AnonymousCredential

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

AnonymousCredentialPolicy

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

BaseRequestPolicy

Classe de base dont dérivent toutes les stratégies de requête.

Credential

Les informations d’identification sont une classe abstraite pour la signature des 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.

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

QueueClient

Un QueueClient représente une URL vers les messages d’une file d’attente de stockage Azure qui vous permet de manipuler ses messages.

QueueSASPermissions

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 à une file d’attente. 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 QueueSASSignatureValues . 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.

QueueServiceClient

Un QueueServiceClient représente une URL vers le service File d’attente de stockage Azure qui vous permet de manipuler des files d’attente.

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

SASQueryParameters

Représente les composants qui composent les paramètres de requête d’une sape de stockage Azure. Ce type n’est pas construit directement par l’utilisateur ; elle est générée uniquement par les types AccountSASSignatureValues et QueueSASSignatureValues . Une fois généré, il peut être encodé dans un toString() et ajouté à une URL directement (même si la prudence doit être prise ici dans le cas où il existe des paramètres de requête existants, ce qui peut affecter les moyens appropriés d’ajouter ces paramètres de requête).

REMARQUE : Les instances de cette classe sont immuables.

StorageBrowserPolicy

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

  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 d’horodatage à 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 d’usine qui permet de générer des objets StorageBrowserPolicy.

StorageRetryPolicy

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

StorageRetryPolicyFactory

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

StorageSharedKeyCredential

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

StorageSharedKeyCredential pour l’autorisation de clé de compte du service Stockage Azure.

StorageSharedKeyCredentialPolicy

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

Interfaces

AccessPolicy

Une stratégie d’accès

AccountSASSignatureValues

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

AccountSASSignatureValues est utilisé pour générer une signature d’accès partagé (SAP) pour un compte de stockage Azure. Une fois que toutes les valeurs ici sont correctement définies, appelez generateSASQueryParameters() pour obtenir une représentation de la sap qui peut en fait être appliquée aux URL de file d’attente. Remarque : cette classe et SASQueryParameters existent à la fois, car la première est mutable et une représentation logique, tandis que la seconde est immuable et utilisée 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 les sapes, 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

CommonOptions

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

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

DequeuedMessageItem

Objet retourné dans le tableau QueueMessageList lors de l’appel de Get Messages sur une file d’attente.

EnqueuedMessage

Objet retourné dans le tableau QueueMessageList lors de l’appel de Put Message sur une file d’attente

GeoReplication

Geo-Replication informations pour le service de stockage secondaire

HttpHeaders

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

HttpOperationResponse

Réponse HTTP compatible avec core-v1(core-http).

HttpResponse

Représentation d’une réponse HTTP qui inclut une référence à la requête à l’origine de celle-ci.

IHttpClient

Interface compatible pour les stratégies de requête core-http

ListQueuesSegmentResponse

Objet retourné lors de l’appel de listes d’attente sur un service de file d’attente.

Logging

Paramètres de journalisation Azure Analytics.

MessageIdDeleteHeaders

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

MessageIdUpdateHeaders

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

MessagesClearHeaders

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

MessagesDequeueHeaders

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

MessagesDequeueOptionalParams

Paramètres facultatifs.

MessagesEnqueueHeaders

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

MessagesEnqueueOptionalParams

Paramètres facultatifs.

MessagesPeekHeaders

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

MessagesPeekOptionalParams

Paramètres facultatifs.

Metadata

Collection de paires de chaînes clé-valeur.

Metrics

Interface représentant les métriques.

PeekedMessageItem

Objet retourné dans le tableau QueueMessageList lors de l’appel de Peek Messages sur une file d’attente

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.

QueueClearMessagesOptions

Options de configuration de l’opération clearMessages

QueueCreateHeaders

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

QueueCreateIfNotExistsResponse

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

QueueCreateOptions

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

QueueDeleteHeaders

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

QueueDeleteIfExistsResponse

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

QueueDeleteMessageOptions

Options permettant de configurer l’opération deleteMessage

QueueDeleteOptions

Options de configuration de l’opération de suppression

QueueExistsOptions

Options de configuration de l’opération exists

QueueGenerateSasUrlOptions

Options pour configurer l’opération generateSasUrl .

QueueGetAccessPolicyHeaders

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

QueueGetAccessPolicyOptions

Options pour configurer l’opération getAccessPolicy

QueueGetPropertiesHeaders

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

QueueGetPropertiesOptions

Options pour configurer l’opération getProperties

QueueItem

File d’attente stockage Azure.

QueuePeekMessagesOptions

Options pour configurer l’opération peekMessages

QueueReceiveMessageOptions

Options pour configurer l’opération receiveMessages

QueueSASSignatureValues

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

QueueSASSignatureValues est utilisé pour aider à générer des jetons SAP du service file d’attente pour les files d’attente.

QueueSendMessageOptions

Options pour configurer l’opération sendMessage

QueueServiceProperties

Propriétés du service de stockage.

QueueServiceStatistics

Statistiques pour le service de stockage.

QueueSetAccessPolicyHeaders

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

QueueSetAccessPolicyOptions

Options pour configurer l’opération setAccessPolicy

QueueSetMetadataHeaders

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

QueueSetMetadataOptions

Options pour configurer l’opération setMetadata

QueueUpdateMessageOptions

Options pour configurer l’opération updateMessage

RequestPolicyFactory

Interface de compatibilité avec RequestPolicyFactory de core-http

RequestPolicyOptions

Interface de compatibilité avec RequestPolicy

ResponseLike

Objet avec une propriété _response simple.

ResponseWithBody

Objet avec une propriété _response dont le corps et les en-têtes sont déjà analysés en types connus.

ResponseWithHeaders

Objet avec une propriété _response dont les en-têtes sont déjà analysés dans un objet typé.

RetentionPolicy

la stratégie de rétention

SasIPRange

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

ServiceClientOptions

Sous-ensemble de @azure/core-http ServiceClientOptions

ServiceGenerateAccountSasUrlOptions

Options permettant de configurer l’opération generateAccountSasUrl .

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

ServiceListQueuesOptions

Options pour configurer l’opération listQueues

ServiceListQueuesSegmentHeaders

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

ServiceSetPropertiesHeaders

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

ServiceSetPropertiesOptions

Options pour configurer l’opération setProperties

SignedIdentifier

Identificateur signé.

SignedIdentifierModel

identificateur signé

StoragePipelineOptions

Interface d’options pour la fonction newPipeline .

StorageRetryOptions

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

WebResource

Description d’une requête HTTP à envoyer à un serveur distant.

Alias de type

CredentialPolicyCreator

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

GeoReplicationStatusType

Définit des valeurs pour GeoReplicationStatusType.

HttpRequestBody

Types de corps pris en charge sur la demande. NodeJS.ReadableStream et () => NodeJS.ReadableStream est Node uniquement. Blob, ReadableStream et () => ReadableStream sont des navigateurs uniquement.

ListQueuesIncludeType

Définit des valeurs pour ListQueuesIncludeType. Les valeurs possibles sont les suivantes : « metadata »

MessageIdDeleteResponse

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

MessageIdUpdateResponse

Contient des données de réponse pour l’opération de mise à jour.

MessagesClearResponse

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

QueueClearMessagesResponse

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

QueueCreateResponse

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

QueueDeleteMessageResponse

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

QueueDeleteResponse

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

QueueGetAccessPolicyResponse

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

QueueGetPropertiesResponse

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

QueuePeekMessagesResponse

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

QueueReceiveMessageResponse

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

QueueSendMessageResponse

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

QueueSetAccessPolicyResponse

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

QueueSetMetadataResponse

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

QueueUpdateMessageResponse

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

ReceivedMessageItem

Objet retourné dans le tableau lors de l’appel receivedMessageItemsde receiveMessages.

Voir : QueueReceiveMessageResponse

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.

ServiceListQueuesSegmentResponse

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

ServiceSetPropertiesResponse

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

WithResponse

Type qui représente un résultat d’opération avec une propriété _response connue.

Énumérations

SASProtocol

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

StorageQueueAudience

Définit les audiences cloud connues pour le stockage.

StorageRetryPolicyType

Types RetryPolicy.

Fonctions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

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

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

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée une instance de SASQueryParameters.

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

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

getQueueServiceAccountAudience(string)

Pour obtenir l’audience OAuth pour un compte de stockage pour le service de file d’attente.

isPipelineLike(unknown)

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

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

Informations relatives à la fonction

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

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

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

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

Paramètres

accountSASSignatureValues
AccountSASSignatureValues

Valeurs de signature SAP du compte

sharedKeyCredential
StorageSharedKeyCredential

Informations d’identification de clé partagée.

Retours

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée une instance de SASQueryParameters.

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

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

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Paramètres

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retours

getQueueServiceAccountAudience(string)

Pour obtenir l’audience OAuth pour un compte de stockage pour le service de file d’attente.

function getQueueServiceAccountAudience(storageAccountName: string): string

Paramètres

storageAccountName

string

Retours

string

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown): pipeline

Paramètres

pipeline

unknown

Argument qui peut être un pipeline

Retours

pipeline

true lorsque l’argument satisfait au contrat de pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

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

Paramètres

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

facultatif. Options.

Retours

Nouvel objet Pipeline.