Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/service-bus

Package version

Index

Type aliases

EntitiesResponse

EntitiesResponse<T>: WithResponse<Array<T>> & Pick<PageSettings, "continuationToken">

Represents the result of list operation on entities which also contains the continuationToken to start iterating over from.

Type parameters

  • T: object

EntityAvailabilityStatus

EntityAvailabilityStatus: "Available" | "Limited" | "Renaming" | "Restoring" | "Unknown"

Possible values for availabilityStatus of the Service Bus messaging entities.

EntityStatus

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

Possible values for status of the Service Bus messaging entities.

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.

ServiceBusErrorCode

ServiceBusErrorCode: "GeneralError" | "MessagingEntityNotFound" | "MessageLockLost" | "MessageNotFound" | "MessageSizeExceeded" | "MessagingEntityAlreadyExists" | "MessagingEntityDisabled" | "QuotaExceeded" | "ServiceBusy" | "ServiceTimeout" | "ServiceCommunicationProblem" | "SessionCannotBeLocked" | "SessionLockLost" | "UnauthorizedAccess"

Service Bus failure codes.

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.

WithResponse

WithResponse<T>: T & { _response: HttpResponse }

Represents the returned response of the operation along with the raw response.

Type parameters

  • T: object

Functions

isServiceBusError

  • isServiceBusError(err: any): err is ServiceBusError

parseServiceBusConnectionString

Generated using TypeDoc