Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/service-bus

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AuthorizationRule

AuthorizationRule: { accessRights?: ("Manage" | "Send" | "Listen")[]; claimType: string; claimValue: string; keyName: string; primaryKey?: undefined | string; secondaryKey?: undefined | string }

Represents type of AuthorizationRule in ATOM based management operations.

Type declaration

  • Optional accessRights?: ("Manage" | "Send" | "Listen")[]
  • claimType: string
  • claimValue: string
  • keyName: string
  • Optional primaryKey?: undefined | string
  • Optional secondaryKey?: undefined | string

EntityStatus

EntityStatus: "Active" | "Creating" | "Deleting" | "ReceiveDisabled" | "SendDisabled" | "Disabled" | "Renaming" | "Restoring" | "Unknown"

Possible values for status of the Service Bus messaging entities.

MessageCountDetails

MessageCountDetails: { activeMessageCount: number; deadLetterMessageCount: number; scheduledMessageCount: number; transferDeadLetterMessageCount: number; transferMessageCount: number }

Represents type of message count details in ATOM based management operations.

Type declaration

  • activeMessageCount: number
  • deadLetterMessageCount: number
  • scheduledMessageCount: number
  • transferDeadLetterMessageCount: number
  • transferMessageCount: number

OperationOptionsBase

OperationOptionsBase: Pick<OperationOptions, "abortSignal" | "tracingOptions">

NOTE: This type is intended to mirror the relevant fields and structure from @azure/core-http OperationOptions

Options for configuring tracing and the abortSignal.

ReceiveMode

ReceiveMode: "peekLock" | "receiveAndDelete"

Represents the possible receive modes for the receiver.

SqlRuleAction

SqlRuleAction: { sqlExpression?: undefined | string; sqlParameters?: undefined | {} }

Represents all possible fields on SqlRuleAction

Type declaration

  • Optional sqlExpression?: undefined | string

    SQL expression to use in the rule action.

  • Optional sqlParameters?: undefined | {}

    SQL parameters to the SQL expression in the rule action.

SubQueue

SubQueue: "deadLetter" | "transferDeadLetter"

Represents the sub queue that is applicable for any queue or subscription. Valid values are "deadLetter" and "transferDeadLetter". To learn more about dead letter queues, see https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Variables

Const logger

logger: any = createClientLogger("service-bus")

The @azure/logger configuration for this package. This will output logs using the azure:event-hubs namespace prefix.

Functions

isError

  • isError(err: Error | AmqpError | undefined): err is Error

toAmqpAnnotatedMessage

Generated using TypeDoc