Share via

ServiceBusError class

  • Reference
Package:
@azure/service-bus

Errors that occur within Service Bus.

Extends
MessagingError

Constructors

ServiceBusError(MessagingError)
ServiceBusError(string, ServiceBusErrorCode)

Properties

code

The reason for the failure.

  • GeneralError: The exception was the result of a general error within the client library.
  • MessagingEntityNotFound: A Service Bus resource cannot be found by the Service Bus service.
  • MessageLockLost: The lock on the message is lost. Callers should attempt to receive and process the message again.
  • MessageNotFound: The requested message was not found.
  • MessageSizeExceeded: A message is larger than the maximum size allowed for its transport.
  • MessagingEntityAlreadyExists: An entity with the same name exists under the same namespace.
  • MessagingEntityDisabled: The Messaging Entity is disabled. Enable the entity again using Portal.
  • QuotaExceeded: The quota applied to an Service Bus resource has been exceeded while interacting with the Azure Service Bus service.
  • ServiceBusy: The Azure Service Bus service reports that it is busy in response to a client request to perform an operation.
  • ServiceTimeout: An operation or other request timed out while interacting with the Azure Service Bus service.
  • ServiceCommunicationProblem: There was a general communications error encountered when interacting with the Azure Service Bus service.
  • SessionCannotBeLocked: The requested session cannot be locked.
  • SessionLockLost: The lock on the session has expired. Callers should request the session again.
  • UnauthorizedAccess": The user doesn't have access to the entity.

Inherited Properties

address

Address to which the network connection failed. Only present if the MessagingError was instantiated with a Node.js SystemError.
errno

System-provided error number. Only present if the MessagingError was instantiated with a Node.js SystemError.
info

Extra details about the error.
message
name

The error name. Default value: "MessagingError".
port

The unavailable network connection port. Only present if the MessagingError was instantiated with a Node.js SystemError.
retryable

Describes whether the error is retryable. Default: true.
stack
stackTraceLimit

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
syscall

Name of the system call that triggered the error. Only present if the MessagingError was instantiated with a Node.js SystemError.

Inherited Methods

captureStackTrace(object, Function)

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
prepareStackTrace(Error, CallSite[])

See https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Constructor Details

ServiceBusError(MessagingError) 

new ServiceBusError(messagingError: MessagingError)

Parameters

messagingError
MessagingError

An error whose properties will be copied to the ServiceBusError.

ServiceBusError(string, ServiceBusErrorCode) 

new ServiceBusError(message: string, code: ServiceBusErrorCode)

Parameters

message

string

The error message that provides more information about the error.

code
ServiceBusErrorCode

The reason for the failure.

Property Details

code

The reason for the failure.

  • GeneralError: The exception was the result of a general error within the client library.
  • MessagingEntityNotFound: A Service Bus resource cannot be found by the Service Bus service.
  • MessageLockLost: The lock on the message is lost. Callers should attempt to receive and process the message again.
  • MessageNotFound: The requested message was not found.
  • MessageSizeExceeded: A message is larger than the maximum size allowed for its transport.
  • MessagingEntityAlreadyExists: An entity with the same name exists under the same namespace.
  • MessagingEntityDisabled: The Messaging Entity is disabled. Enable the entity again using Portal.
  • QuotaExceeded: The quota applied to an Service Bus resource has been exceeded while interacting with the Azure Service Bus service.
  • ServiceBusy: The Azure Service Bus service reports that it is busy in response to a client request to perform an operation.
  • ServiceTimeout: An operation or other request timed out while interacting with the Azure Service Bus service.
  • ServiceCommunicationProblem: There was a general communications error encountered when interacting with the Azure Service Bus service.
  • SessionCannotBeLocked: The requested session cannot be locked.
  • SessionLockLost: The lock on the session has expired. Callers should request the session again.
  • UnauthorizedAccess": The user doesn't have access to the entity.
code: ServiceBusErrorCode

Property Value

ServiceBusErrorCode

Inherited Property Details

address

Address to which the network connection failed. Only present if the MessagingError was instantiated with a Node.js SystemError.

address?: string

Property Value

string

Inherited From MessagingError.address

errno

System-provided error number. Only present if the MessagingError was instantiated with a Node.js SystemError.

errno?: string | number

Property Value

string | number

Inherited From MessagingError.errno

info

Extra details about the error.

info?: any

Property Value

any

Inherited From MessagingError.info

message 

message: string

Property Value

string

Inherited From MessagingError.message

name

The error name. Default value: "MessagingError".

name: string

Property Value

string

Inherited From MessagingError.name

port

The unavailable network connection port. Only present if the MessagingError was instantiated with a Node.js SystemError.

port?: number

Property Value

number

Inherited From MessagingError.port

retryable

Describes whether the error is retryable. Default: true.

retryable: boolean

Property Value

boolean

Inherited From MessagingError.retryable

stack 

stack?: string

Property Value

string

Inherited From MessagingError.stack

stackTraceLimit

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

static stackTraceLimit: number

Property Value

number

Inherited From MessagingError.stackTraceLimit

syscall

Name of the system call that triggered the error. Only present if the MessagingError was instantiated with a Node.js SystemError.

syscall?: string

Property Value

string

Inherited From MessagingError.syscall

Inherited Method Details

captureStackTrace(object, Function)

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

static function captureStackTrace(targetObject: object, constructorOpt?: Function)

Parameters

targetObject

object

constructorOpt

Function

Inherited From MessagingError.captureStackTrace

prepareStackTrace(Error, CallSite[])

See https://v8.dev/docs/stack-trace-api#customizing-stack-traces

static function prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

Inherited From MessagingError.prepareStackTrace