Partager via

@azure/storage-queue package

Classes

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: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 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: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 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: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 <xref:CredentialPolicyCreator> utilisé pour créer des objets <xref:AnonymousCredentialPolicy>. <xref: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).
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.
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.
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 les stratégies fournies comme référence avant d’implémenter votre pipeline personnalisé.
QueueClient

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

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 à une file d’attente. 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: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 stockage Azure, ce qui vous permet de manipuler des files d’attente.
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:AccountSASSignatureValues> et <xref:QueueSASSignatureValues>. Une fois généré, il peut être encodé dans un <xref: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.
StorageBrowserPolicy

StorageBrowserPolicy 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 ». StorageBrowserPolicy 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
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory est une classe de fabrique qui permet de générer des objets <xref:StorageBrowserPolicy>.
StorageClient

Un StorageClient représente une classe de client basée pour <xref:QueueServiceClient>, <xref:QueueClient> et etc.
StorageClientContext
StorageRetryPolicy

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

StorageRetryPolicyFactory est une classe de fabrique qui permet de générer des objets <xref: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 définies de manière appropriée, appel generateSASQueryParameters() pour obtenir une représentation de la SAP qui peut réellement être appliquée aux URL de file d’attente. 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.
CommonOptions

Interface pour les options communes à chaque opération distante.
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
DequeuedMessageItem

Objet retourné dans le tableau QueueMessageList lors de l’appel d’obtenir des messages sur une file d’attente.
EnqueuedMessage

Objet retourné dans le tableau QueueMessageList lors de l’appel du message sur une file d’attente
GeoReplication

informations Geo-Replication pour le service de stockage secondaire
ListQueuesSegmentResponse

Objet retourné lors de l’appel des files d’attente de liste sur un service de file d’attente.
Logging

Paramètres de journalisation Azure Analytics.
MessageIdDeleteHeaders

Définit des en-têtes pour l’opération de MessageId_delete.
MessageIdUpdateHeaders

Définit des en-têtes pour l’opération de MessageId_update.
MessagesClearHeaders

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

Définit des en-têtes pour l’opération de Messages_dequeue.
MessagesDequeueOptionalParams

Paramètres facultatifs.
MessagesEnqueueHeaders

Définit des en-têtes pour l’opération de Messages_enqueue.
MessagesEnqueueOptionalParams

Paramètres facultatifs.
MessagesPeekHeaders

Définit des en-têtes pour l’opération de Messages_peek.
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 messages d’aperçu sur une file d’attente
PipelineOptions

Interface d’option pour le constructeur de pipeline.
QueueClearMessagesOptions

Options de configuration de l’opération de <xref:QueueClient.clearMessages>
QueueCreateHeaders

Définit des en-têtes pour l’opération de Queue_create.
QueueCreateIfNotExistsResponse

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

Options de configuration de l’opération de <xref:QueueClient.create>
QueueDeleteHeaders

Définit des en-têtes pour l’opération de Queue_delete.
QueueDeleteIfExistsResponse

Contient des données de réponse pour l’opération de <xref:QueueClient.deleteIfExists>.
QueueDeleteMessageOptions

Options de configuration de l’opération de <xref:QueueClient.deleteMessage>
QueueDeleteOptions

Options de configuration de l’opération de <xref:QueueClient.delete>
QueueExistsOptions

Options de configuration de l’opération de <xref:QueueClient.exists>
QueueGenerateSasUrlOptions

Options permettant de configurer <xref:QueueClient.generateSasUrl> opération.
QueueGetAccessPolicyHeaders

Définit des en-têtes pour l’opération de Queue_getAccessPolicy.
QueueGetAccessPolicyOptions

Options de configuration de l’opération de <xref:QueueClient.getAccessPolicy>
QueueGetPropertiesHeaders

Définit des en-têtes pour l’opération de Queue_getProperties.
QueueGetPropertiesOptions

Options de configuration de l’opération de <xref:QueueClient.getProperties>
QueueItem

File d’attente stockage Azure.
QueuePeekMessagesOptions

Options de configuration de l’opération de <xref:QueueClient.peekMessages>
QueueReceiveMessageOptions

Options de configuration de l’opération de <xref:QueueClient.receiveMessages>
QueueSASSignatureValues

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. QueueSASSignatureValues est utilisé pour aider à générer des jetons SAS du service file d’attente pour les files d’attente.
QueueSendMessageOptions

Options de configuration de l’opération de <xref:QueueClient.sendMessage>
QueueServiceProperties

Propriétés du service de stockage.
QueueServiceStatistics

Statistiques pour le service de stockage.
QueueSetAccessPolicyHeaders

Définit des en-têtes pour l’opération de Queue_setAccessPolicy.
QueueSetAccessPolicyOptions

Options de configuration de l’opération de <xref:QueueClient.setAccessPolicy>
QueueSetMetadataHeaders

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

Options de configuration de l’opération de <xref:QueueClient.setMetadata>
QueueUpdateMessageOptions

Options de configuration de l’opération de <xref:QueueClient.updateMessage>
RetentionPolicy

la stratégie de rétention
SasIPRange

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

Options permettant de configurer <xref:QueueServiceClient.generateAccountSasUrl> opération.
ServiceGetPropertiesHeaders

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

Options de configuration de l’opération de <xref:QueueServiceClient.getProperties>
ServiceGetStatisticsHeaders

Définit des en-têtes pour l’opération de Service_getStatistics.
ServiceGetStatisticsOptions

Options de configuration de l’opération de <xref:QueueServiceClient.getStatistics>
ServiceListQueuesOptions

Options de configuration de l’opération de <xref:QueueServiceClient.listQueues>
ServiceListQueuesSegmentHeaders

Définit des en-têtes pour l’opération de Service_listQueuesSegment.
ServiceSetPropertiesHeaders

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

Options de configuration de l’opération de <xref:QueueServiceClient.setProperties>
SignedIdentifier

Identificateur signé.
SignedIdentifierModel

identificateur signé
StorageClientOptionalParams

Paramètres facultatifs.
StoragePipelineOptions

Interface d’option pour la méthode newPipeline().
StorageRetryOptions

Interface des options de nouvelle tentative de file d’attente de stockage.

Alias de type

CredentialPolicyCreator

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

Définit des valeurs pour GeoReplicationStatusType.
ListQueuesIncludeType

Définit des valeurs pour ListQueuesIncludeType. Les valeurs possibles sont les suivantes : « métadonnées »
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 de <xref:QueueClient.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 de <xref:QueueClient.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 de <xref:QueueClient.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 de <xref:QueueClient.peekMessages>.
QueueReceiveMessageResponse

Contient les données de réponse pour l’opération de <xref:QueueClient.receiveMessages>.
QueueSendMessageResponse

Contient les données de réponse pour l’opération de <xref:QueueClient.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 de <xref:QueueClient.updateMessage>.
ReceivedMessageItem

Objet retourné dans le tableau receivedMessageItems lors de l’appel de <xref:QueueClient.receiveMessages>. Voir : <xref: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.

Énumérations

SASProtocol

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

Types RetryPolicy.

Functions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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.
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, les démarragesOn et l’identificateur.

AVERTISSEMENT : Lorsque l’identificateur n’est pas fourni, les autorisations et expirentOn sont requises. Vous DEVEZ attribuer une valeur à l’identificateur ou expirer manuellement & autorisations si vous initialisez avec ce constructeur.
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 <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: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Paramètres

accountSASSignatureValues
AccountSASSignatureValues

Valeurs de signature SAP du compte

sharedKeyCredential
StorageSharedKeyCredential

Informations d’identification de clé partagée.

Retours

SASQueryParameters

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, les démarragesOn et l’identificateur.

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

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Paramètres

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retours

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

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

Paramètres

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.

pipelineOptions
StoragePipelineOptions

Options.

Retours

Pipeline

Nouvel objet Pipeline.