@azure/core-amqp package

Classes

CbsClient	Décrit le client EventHub/ServiceBus Cbs qui communique avec le point de terminaison $cbs via la connexion AMQP.
MessagingError	Décrit la classe de base pour l’erreur de messagerie.
RequestResponseLink	Décrit un lien amqp request(sender)-response(receiver) créé sur une session amqp.

Interfaces

AcquireLockProperties	Décrit les propriétés qui doivent être fournies lors de l’acquisition d’un verrou.
CancellableAsyncLock	CancellableAsyncLock fournit un mécanisme permettant de forcer les tâches à l’aide de la même « clé » à exécuter en série. Les tâches en attente peuvent être annulées manuellement par le biais d’un abandonSignal ou automatiquement annulées par atteindre une valeur de délai d’expiration fournie.
CbsResponse	Décrit la réponse CBS.
ConnectionConfigOptions	Décrit les options qui peuvent être fournies lors de la création d’une configuration de connexion.
ConnectionProperties	Définit les propriétés qui doivent être définies lors de l’établissement de la connexion AMQP.
CreateConnectionContextBaseParameters	Décrit les paramètres qui peuvent être fournis pour créer le contexte de connexion de base.
NetworkSystemError	Décrit les champs d’une Node.js SystemError. Omet les champs qui ne sont pas liés aux appels réseau (par exemple, les appels de système de fichiers). Voir https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Décrit les paramètres qui doivent être configurés pour l’opération de nouvelle tentative.
RetryOptions	Options de stratégie de nouvelle tentative qui déterminent le mode, le nombre de nouvelles tentatives, l’intervalle de nouvelle tentative, etc.
SendRequestOptions	Décrit les options qui peuvent être spécifiées lors de l’envoi d’une demande.
WebSocketOptions	Options de configuration du canal de la connexion AMQP via Web Sockets.

Alias de type

ParsedOutput

Définit un objet avec les propriétés possibles définies dans T.

Énumérations

ConditionErrorNameMapper	Mappe les conditions d’erreur amqp aux noms d’erreurs.
ErrorNameConditionMapper	Mappe les noms d’erreurs aux conditions d’erreur amqp.
RetryMode	Décrit le type de mode nouvelle tentative
RetryOperationType	Décrit le type d’opération de nouvelle tentative.
SystemErrorConditionMapper	Mappe certaines conditions d’erreur SystemErrors à amqp
TokenType	Décrit le type de jetons pris en charge.

Functions

delay<T>(number, AbortSignalLike, string, T)	Wrapper pour setTimeout qui résout une promesse après t millisecondes.
isMessagingError(MessagingError | Error)	Détermine si une erreur est une MessagingError.
isSystemError(unknown)	Vérifie si l’erreur fournie est une node.js SystemError.
parseConnectionString<T>(string)	Analyse la chaîne de connexion et retourne un objet de type T. Les chaînes de connexion ont la syntaxe suivante : ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ « = » PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Littéral [ WhiteSpace ] Littéral ::= ? n’importe quelle séquence de caractères sauf ; ou = ou WhiteSpace ? Espace ::= ? tous les espaces blancs, y compris \r et \n ?
retry<T>(RetryConfig<T>)	Chaque opération est tentée au moins une fois. Des tentatives supplémentaires sont effectuées si la tentative précédente a échoué avec une erreur retentenable. Le nombre de tentatives supplémentaires est régi par la propriété maxRetries fournie sur l’argument RetryConfig. Si mode option est définie sur Fixed, les nouvelles tentatives sont effectuées sur l’opération donnée pour un nombre spécifié de fois, avec un délai fixe entre chaque nouvelle tentative chaque fois. Si mode option est définie sur Exponential, le délai entre les nouvelles tentatives est ajusté pour augmenter de manière exponentielle avec chaque tentative utilisant le facteur d’interruption de puissance 2.
translate(unknown)	Convertit l’erreur AMQP reçue au niveau de la couche de protocole ou d’un SystemError en message MessagingError. Toutes les autres erreurs sont retournées non inchangées.

Variables

AmqpAnnotatedMessage	Décrit les opérations qui peuvent être effectuées sur (ou pour obtenir) l’AmqpAnnotatedMessage.
AmqpMessageHeader	Décrit les opérations pouvant être effectuées sur l’en-tête du message.
AmqpMessageProperties	Décrit les opérations pouvant être effectuées sur les propriétés du message amqp.
ConnectionConfig	Décrit le module ConnectionConfig
ConnectionContextBase
Constants
defaultCancellableLock	L’instance de verrouillage asynchrone annulable.
logger	La @azure/logger configuration de ce paquet. Cela produira les journaux en utilisant le préfixe d’espace azure:event-hubs de noms.
retryableErrors	Fournit une liste d’erreurs AMQP réessayables. « ErrorServerIntern », « ServerMissyError », « ServiceUnavailableError », « OperationCancelledError », « SenderBusyError », « SenderNotreadyError », « MessagingError », « DetachForcedError », « ConnectionForcedError », « TransferLimitExceedError »

Informations relatives à la fonction

delay<T>(number, AbortSignalLike, string, T)

Wrapper pour setTimeout qui résout une promesse après t millisecondes.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

Paramètres

delayInMs

number

Nombre de millisecondes à retarder.

abortSignal

AbortSignalLike

AbandonSignal associé à l’opération contenante.

abortErrorMsg

string

Message d’erreur d’abandon associé à l’opération contenant.

value

T

Valeur à résoudre après un délai d’expiration de t millisecondes.

Retours

Promise<T | void>

• Promesse résolue

isMessagingError(MessagingError | Error)

Détermine si une erreur est une MessagingError.

function isMessagingError(error: MessagingError | Error): error

Paramètres

error

MessagingError | Error

Erreur pouvant être une erreur ou une messagingError.

Retours

error

isSystemError(unknown)

Vérifie si l’erreur fournie est une node.js SystemError.

function isSystemError(err: unknown): err

Paramètres

err

unknown

Objet qui peut contenir des informations d’erreur.

Retours

err

parseConnectionString<T>(string)

Analyse la chaîne de connexion et retourne un objet de type T.

Les chaînes de connexion ont la syntaxe suivante :

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ « = » PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Littéral [ WhiteSpace ] Littéral ::= ? n’importe quelle séquence de caractères sauf ; ou = ou WhiteSpace ? Espace ::= ? tous les espaces blancs, y compris \r et \n ?

function parseConnectionString<T>(connectionString: string): ParsedOutput<T>

Paramètres

connectionString

string

Chaîne de connexion à analyser.

Retours

ParsedOutput<T>

ParsedOutput<T>.

retry<T>(RetryConfig<T>)

Chaque opération est tentée au moins une fois. Des tentatives supplémentaires sont effectuées si la tentative précédente a échoué avec une erreur retentenable. Le nombre de tentatives supplémentaires est régi par la propriété maxRetries fournie sur l’argument RetryConfig.

Si mode option est définie sur Fixed, les nouvelles tentatives sont effectuées sur l’opération donnée pour un nombre spécifié de fois, avec un délai fixe entre chaque nouvelle tentative chaque fois.

Si mode option est définie sur Exponential, le délai entre les nouvelles tentatives est ajusté pour augmenter de manière exponentielle avec chaque tentative utilisant le facteur d’interruption de puissance 2.

function retry<T>(config: RetryConfig<T>): Promise<T>

Paramètres

config

RetryConfig<T>

Paramètres pour configurer l’opération de nouvelle tentative

Retours

Promise<T>

Promesse<T>.

translate(unknown)

Convertit l’erreur AMQP reçue au niveau de la couche de protocole ou d’un SystemError en message MessagingError. Toutes les autres erreurs sont retournées non inchangées.

function translate(err: unknown): MessagingError | Error

Paramètres

err

unknown

Erreur amqp reçue.

Retours

MessagingError | Error

Objet MessagingError.

Variable Details

AmqpAnnotatedMessage

Décrit les opérations qui peuvent être effectuées sur (ou pour obtenir) l’AmqpAnnotatedMessage.

AmqpAnnotatedMessage: { fromRheaMessage(msg: Message) => AmqpAnnotatedMessage, toRheaMessage(msg: AmqpAnnotatedMessage) => Message }

Type

{ fromRheaMessage(msg: Message) => AmqpAnnotatedMessage, toRheaMessage(msg: AmqpAnnotatedMessage) => Message }

AmqpMessageHeader

Décrit les opérations pouvant être effectuées sur l’en-tête du message.

AmqpMessageHeader: { fromRheaMessageHeader(props: MessageHeader) => AmqpMessageHeader, toRheaMessageHeader(props: AmqpMessageHeader) => MessageHeader }

Type

{ fromRheaMessageHeader(props: MessageHeader) => AmqpMessageHeader, toRheaMessageHeader(props: AmqpMessageHeader) => MessageHeader }

AmqpMessageProperties

Décrit les opérations pouvant être effectuées sur les propriétés du message amqp.

AmqpMessageProperties: { fromRheaMessageProperties(props: MessageProperties) => AmqpMessageProperties, toRheaMessageProperties(props: AmqpMessageProperties) => MessageProperties }

Type

{ fromRheaMessageProperties(props: MessageProperties) => AmqpMessageProperties, toRheaMessageProperties(props: AmqpMessageProperties) => MessageProperties }

ConnectionConfig

Décrit le module ConnectionConfig

ConnectionConfig: { create(connectionString: string, path?: string) => ConnectionConfig, validate(config: ConnectionConfig, options?: ConnectionConfigOptions) => void }

Type

{ create(connectionString: string, path?: string) => ConnectionConfig, validate(config: ConnectionConfig, options?: ConnectionConfigOptions) => void }

ConnectionContextBase

ConnectionContextBase: { create(parameters: CreateConnectionContextBaseParameters) => ConnectionContextBase }

Type

{ create(parameters: CreateConnectionContextBaseParameters) => ConnectionContextBase }

Constants

Constants: { TCP: "tcp", TLS: "tls", aadEventHubsAudience: "https://eventhubs.azure.net/", aadEventHubsScope: "https://eventhubs.azure.net//.default", aadServiceBusAudience: "https://servicebus.azure.net/", aadServiceBusScope: "https://servicebus.azure.net//.default", aadTokenValidityMarginInMs: 5000, associatedLinkName: "associated-link-name", attachEpoch: "com.microsoft:epoch", cbsEndpoint: "$cbs", cbsReplyTo: "cbs", connectionError: "connection_error", connectionReconnectDelay: 300, dateTimeOffset: "com.microsoft:datetime-offset", deadLetterDescription: "deadletter-description", deadLetterName: "com.microsoft:dead-letter", deadLetterReason: "deadletter-reason", deadLetterSource: "x-opt-deadletter-source", defaultConnectionIdleTimeoutInMs: 60000, defaultConsumerGroup: "$default", defaultDelayBetweenOperationRetriesInMs: 30000, defaultMaxDelayForExponentialRetryInMs: 90000, defaultMaxRetries: 3, defaultMaxRetriesForConnection: 150, defaultOperationTimeoutInMs: 60000, defaultPrefetchCount: 1000, descriptorCodes: { correlationFilterList: 83483426825, falseFilterList: 83483426824, ruleDescriptionList: 1335734829060, sqlFilterList: 83483426822, sqlRuleActionList: 1335734829062, trueFilterList: 83483426823 }, dispositionStatus: "disposition-status", enableReceiverRuntimeMetricName: "com.microsoft:enable-receiver-runtime-metric", enqueueSequenceNumber: "x-opt-enqueue-sequence-number", enqueuedTime: "x-opt-enqueued-time", enqueuedTimeAnnotation: "amqp.annotation.x-opt-enqueued-time", enqueuedTimeUtc: "enqueued-time-utc", ensureContainerAndBlob: "ensureContainerAndBlob", error: "error", errorCondition: "error-condition", establishConnection: "establishConnection", eventHub: "eventhub", fromSequenceNumber: "from-sequence-number", guidSize: 16, lockTokenMapKey: "lock-token", lockTokens: "lock-tokens", lockedUntil: "x-opt-locked-until", management: "$management", managementRequestKey: "managementRequest", maxAbsoluteExpiryTime: number, maxDeadLetterReasonLength: 4096, maxDurationValue: 922337203685477, maxMessageIdLength: 128, maxPartitionKeyLength: 128, maxSessionIdLength: 128, maxUint32Value: 4294967295, maxUserAgentLength: 512, maximumSqlFilterStatementLength: 1024, maximumSqlRuleActionStatementLength: 1024, message: "message", messageCount: "message-count", messageIdMapKey: "message-id", messageState: "x-opt-message-state", minDurationValue: -922337203685477, negotiateCbsKey: "negotiateCbs", negotiateClaim: "negotiateClaim", offset: "x-opt-offset", offsetAnnotation: "amqp.annotation.x-opt-offset", operationPutToken: "put-token", operations: { addRule: "com.microsoft:add-rule", cancelScheduledMessage: "com.microsoft:cancel-scheduled-message", deleteMessages: "com.microsoft:batch-delete-messages", enumerateRules: "com.microsoft:enumerate-rules", enumerateSessions: "com.microsoft:get-message-sessions", getSessionState: "com.microsoft:get-session-state", peekMessage: "com.microsoft:peek-message", putToken: "put-token", read: "READ", receiveBySequenceNumber: "com.microsoft:receive-by-sequence-number", removeRule: "com.microsoft:remove-rule", renewLock: "com.microsoft:renew-lock", renewSessionLock: "com.microsoft:renew-session-lock", scheduleMessage: "com.microsoft:schedule-message", setSessionState: "com.microsoft:set-session-state", updateDisposition: "com.microsoft:update-disposition" }, partition: "partition", partitionId: "partitionId", partitionIdName: "x-opt-partition-id", partitionKey: "x-opt-partition-key", pathDelimiter: "/", propertiesToModify: "properties-to-modify", publisher: "x-opt-publisher-name", readOperation: "READ", receiverError: "receiver_error", receiverIdentifierName: "com.microsoft:receiver-name", receiverSettleMode: "receiver-settle-mode", reconnectLimit: 100, ruleNameMaximumLength: 50, scheduledEnqueueTime: "x-opt-scheduled-enqueue-time", senderError: "sender_error", sequenceNumber: "x-opt-sequence-number", sequenceNumberAnnotation: "amqp.annotation.x-opt-sequence-number", sequenceNumberMapKey: "sequence-number", sequenceNumbers: "sequence-numbers", serverTimeout: "com.microsoft:server-timeout", sessionError: "session_error", sessionFilterName: "com.microsoft:session-filter", sessionIdMapKey: "session-id", statusCode: "status-code", statusDescription: "status-description", timespan: "com.microsoft:timespan", trackingId: "com.microsoft:tracking-id", uri: "com.microsoft:uri", vendorString: "com.microsoft", viaPartitionKey: "x-opt-via-partition-key" }

Type

{ TCP: "tcp", TLS: "tls", aadEventHubsAudience: "https://eventhubs.azure.net/", aadEventHubsScope: "https://eventhubs.azure.net//.default", aadServiceBusAudience: "https://servicebus.azure.net/", aadServiceBusScope: "https://servicebus.azure.net//.default", aadTokenValidityMarginInMs: 5000, associatedLinkName: "associated-link-name", attachEpoch: "com.microsoft:epoch", cbsEndpoint: "$cbs", cbsReplyTo: "cbs", connectionError: "connection_error", connectionReconnectDelay: 300, dateTimeOffset: "com.microsoft:datetime-offset", deadLetterDescription: "deadletter-description", deadLetterName: "com.microsoft:dead-letter", deadLetterReason: "deadletter-reason", deadLetterSource: "x-opt-deadletter-source", defaultConnectionIdleTimeoutInMs: 60000, defaultConsumerGroup: "$default", defaultDelayBetweenOperationRetriesInMs: 30000, defaultMaxDelayForExponentialRetryInMs: 90000, defaultMaxRetries: 3, defaultMaxRetriesForConnection: 150, defaultOperationTimeoutInMs: 60000, defaultPrefetchCount: 1000, descriptorCodes: { correlationFilterList: 83483426825, falseFilterList: 83483426824, ruleDescriptionList: 1335734829060, sqlFilterList: 83483426822, sqlRuleActionList: 1335734829062, trueFilterList: 83483426823 }, dispositionStatus: "disposition-status", enableReceiverRuntimeMetricName: "com.microsoft:enable-receiver-runtime-metric", enqueueSequenceNumber: "x-opt-enqueue-sequence-number", enqueuedTime: "x-opt-enqueued-time", enqueuedTimeAnnotation: "amqp.annotation.x-opt-enqueued-time", enqueuedTimeUtc: "enqueued-time-utc", ensureContainerAndBlob: "ensureContainerAndBlob", error: "error", errorCondition: "error-condition", establishConnection: "establishConnection", eventHub: "eventhub", fromSequenceNumber: "from-sequence-number", guidSize: 16, lockTokenMapKey: "lock-token", lockTokens: "lock-tokens", lockedUntil: "x-opt-locked-until", management: "$management", managementRequestKey: "managementRequest", maxAbsoluteExpiryTime: number, maxDeadLetterReasonLength: 4096, maxDurationValue: 922337203685477, maxMessageIdLength: 128, maxPartitionKeyLength: 128, maxSessionIdLength: 128, maxUint32Value: 4294967295, maxUserAgentLength: 512, maximumSqlFilterStatementLength: 1024, maximumSqlRuleActionStatementLength: 1024, message: "message", messageCount: "message-count", messageIdMapKey: "message-id", messageState: "x-opt-message-state", minDurationValue: -922337203685477, negotiateCbsKey: "negotiateCbs", negotiateClaim: "negotiateClaim", offset: "x-opt-offset", offsetAnnotation: "amqp.annotation.x-opt-offset", operationPutToken: "put-token", operations: { addRule: "com.microsoft:add-rule", cancelScheduledMessage: "com.microsoft:cancel-scheduled-message", deleteMessages: "com.microsoft:batch-delete-messages", enumerateRules: "com.microsoft:enumerate-rules", enumerateSessions: "com.microsoft:get-message-sessions", getSessionState: "com.microsoft:get-session-state", peekMessage: "com.microsoft:peek-message", putToken: "put-token", read: "READ", receiveBySequenceNumber: "com.microsoft:receive-by-sequence-number", removeRule: "com.microsoft:remove-rule", renewLock: "com.microsoft:renew-lock", renewSessionLock: "com.microsoft:renew-session-lock", scheduleMessage: "com.microsoft:schedule-message", setSessionState: "com.microsoft:set-session-state", updateDisposition: "com.microsoft:update-disposition" }, partition: "partition", partitionId: "partitionId", partitionIdName: "x-opt-partition-id", partitionKey: "x-opt-partition-key", pathDelimiter: "/", propertiesToModify: "properties-to-modify", publisher: "x-opt-publisher-name", readOperation: "READ", receiverError: "receiver_error", receiverIdentifierName: "com.microsoft:receiver-name", receiverSettleMode: "receiver-settle-mode", reconnectLimit: 100, ruleNameMaximumLength: 50, scheduledEnqueueTime: "x-opt-scheduled-enqueue-time", senderError: "sender_error", sequenceNumber: "x-opt-sequence-number", sequenceNumberAnnotation: "amqp.annotation.x-opt-sequence-number", sequenceNumberMapKey: "sequence-number", sequenceNumbers: "sequence-numbers", serverTimeout: "com.microsoft:server-timeout", sessionError: "session_error", sessionFilterName: "com.microsoft:session-filter", sessionIdMapKey: "session-id", statusCode: "status-code", statusDescription: "status-description", timespan: "com.microsoft:timespan", trackingId: "com.microsoft:tracking-id", uri: "com.microsoft:uri", vendorString: "com.microsoft", viaPartitionKey: "x-opt-via-partition-key" }

defaultCancellableLock

L’instance de verrouillage asynchrone annulable.

defaultCancellableLock: CancellableAsyncLock

Type

CancellableAsyncLock

logger

La @azure/logger configuration de ce paquet. Cela produira les journaux en utilisant le préfixe d’espace azure:event-hubs de noms.

logger: AzureLogger

Type

AzureLogger

retryableErrors

Fournit une liste d’erreurs AMQP réessayables. « ErrorServerIntern », « ServerMissyError », « ServiceUnavailableError », « OperationCancelledError », « SenderBusyError », « SenderNotreadyError », « MessagingError », « DetachForcedError », « ConnectionForcedError », « TransferLimitExceedError »

retryableErrors: string[]

Type

string[]