@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 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 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 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 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). |
| BaseRequestPolicy |
Classe de base à partir de laquelle toutes les stratégies de requête dérivent. |
| 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 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 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 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 ; il est uniquement généré par les types AccountSASSignatureValues et QueueSASSignatureValues . Une fois généré, il peut être encodé dans un toString() 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. |
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory est une classe de fabrique 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 de fabrique 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 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 classe SASQueryParameters existent, car l’ancien est mutable et une représentation logique alors que ce dernier est immuable et utilisé pour générer des requêtes REST réelles. Consultez https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 pour plus d’informations conceptuelles sur SAS Voir https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas pour obtenir des descriptions des paramètres, y compris ceux requis |
| 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 |
| 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 qui l’a générée. |
| 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 |
| 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 permettant de configurer opération 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 createIfNotExists. |
| QueueCreateOptions |
Options permettant de configurer opération de création de |
| 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 deleteIfExists. |
| QueueDeleteMessageOptions |
Options permettant de configurer l’opération de deleteMessage |
| QueueDeleteOptions |
Options permettant de configurer opération de suppression de |
| QueueExistsOptions |
Les options permettant de configurer existent opération |
| QueueGenerateSasUrlOptions |
Options permettant de configurer opération generateSasUrl. |
| QueueGetAccessPolicyHeaders |
Définit des en-têtes pour l’opération de Queue_getAccessPolicy. |
| QueueGetAccessPolicyOptions |
Options permettant de configurer opération getAccessPolicy |
| QueueGetPropertiesHeaders |
Définit des en-têtes pour l’opération de Queue_getProperties. |
| QueueGetPropertiesOptions |
Options pour configurer opération getProperties |
| QueueItem |
File d’attente stockage Azure. |
| QueuePeekMessagesOptions |
Options permettant de configurer opération peekMessages |
| QueueReceiveMessageOptions |
Options permettant de configurer opération 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 permettant de configurer 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 l’opération de Queue_setAccessPolicy. |
| QueueSetAccessPolicyOptions |
Options permettant de configurer opération de setAccessPolicy |
| QueueSetMetadataHeaders |
Définit des en-têtes pour l’opération Queue_setMetadata. |
| QueueSetMetadataOptions |
Options permettant de configurer opération de setMetadata |
| QueueUpdateMessageOptions |
Options permettant de configurer opération updateMessage |
| RequestPolicy |
Interface compatible pour les stratégies de requête core-http |
| RequestPolicyFactory |
Interface pour la compatibilité avec RequestPolicyFactory de core-http |
| RequestPolicyOptions |
Interface pour la 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 qui a des en-têtes déjà analysés dans un objet typé. |
| RestError |
Type d’erreur personnalisé pour les demandes de pipeline ayant échoué. |
| RetentionPolicy |
la stratégie de rétention |
| SasIPRange |
Plage d’adresses IP autorisées pour une SAP. |
| ServiceClientOptions |
Sous-ensemble de |
| ServiceGenerateAccountSasUrlOptions |
Options permettant de configurer opération generateAccountSasUrl. |
| ServiceGetPropertiesHeaders |
Définit des en-têtes pour l’opération Service_getProperties. |
| ServiceGetPropertiesOptions |
Options pour configurer opération getProperties |
| ServiceGetStatisticsHeaders |
Définit des en-têtes pour l’opération de Service_getStatistics. |
| ServiceGetStatisticsOptions |
Options permettant de configurer opération getStatistics |
| ServiceListQueuesOptions |
Options permettant de configurer opération 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 permettant de configurer opération setProperties |
| SignedIdentifier |
Identificateur signé. |
| SignedIdentifierModel |
identificateur signé |
| StoragePipelineOptions |
Interface options pour la fonction newPipeline. |
| StorageRetryOptions |
Interface des options de nouvelle tentative d’objet blob de stockage. |
| WebResource |
Description d’une requête HTTP à effectuer sur un serveur distant. |
Alias de type
| 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<Uint8Array> et () => ReadableStream<Uint8Array> sont uniquement disponibles sur navigateur. |
| 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 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 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 de réception receiveMessages. |
| QueueSendMessageResponse |
Contient les données de réponse pour l’opération d'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 updateMessage. |
| ReceivedMessageItem |
Objet retourné dans le tableau 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 SAP générée. |
| StorageQueueAudience |
Définit les audiences cloud connues pour le stockage. |
| StorageRetryPolicyType |
RetryPolicy. |
Functions
| generate |
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://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas |
| generate |
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. |
| get |
Pour obtenir une audience OAuth pour un compte de stockage pour le service de file d’attente. |
| is |
Assistance pour décider si un argument donné satisfait au contrat pipeline |
| new |
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://learn.microsoft.com/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, 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): SASQueryParameters
Paramètres
- queueSASSignatureValues
- QueueSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Retours
getQueueServiceAccountAudience(string)
Pour obtenir une 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)
Assistance pour décider si un argument donné satisfait au contrat 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
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
Optional. Options.
Retours
Nouvel objet Pipeline.