@azure/service-bus

Index

Classes

Interfaces

Type aliases

Functions

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

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-client OperationOptions

Options for configuring tracing and the abortSignal.

RawHttpHeaders

RawHttpHeaders: {}

A HttpHeaders collection represented as a simple JSON object.

Type declaration

[headerName: string]: string

ServiceBusErrorCode

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.

TransferProgressEvent

TransferProgressEvent: { loadedBytes: number }

Fired in response to upload or download progress.

Type declaration

loadedBytes: number

The number of bytes loaded so far.

WithResponse

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

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

Type parameters

T: object

Functions

applyRequestOptions

applyRequestOptions(request: PipelineRequest, options: { abortSignal?: AbortSignalLike; headers?: Record<string, string>; onDownloadProgress?: undefined | ((progress: TransferProgressEvent) => void); onUploadProgress?: undefined | ((progress: TransferProgressEvent) => void); timeout: number; tracingOptions?: OperationTracingOptions }): void

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/atomXmlHelper.ts:41
applies options to the pipeline request.

Parameters
- request: PipelineRequest
- options: { abortSignal?: AbortSignalLike; headers?: Record<string, string>; onDownloadProgress?: undefined | ((progress: TransferProgressEvent) => void); onUploadProgress?: undefined | ((progress: TransferProgressEvent) => void); timeout: number; tracingOptions?: OperationTracingOptions }
  - Optional abortSignal?: AbortSignalLike
  - Optional headers?: Record<string, string>
  - Optional onDownloadProgress?: undefined | ((progress: TransferProgressEvent) => void)
  - Optional onUploadProgress?: undefined | ((progress: TransferProgressEvent) => void)
  - timeout: number
  - Optional tracingOptions?: OperationTracingOptions
Returns void

calculateDelay

calculateDelay(attemptCount: number, retryDelayInMs: number, maxRetryDelayInMs: number, mode: RetryMode): number

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/receivers/receiverCommon.ts:290
Calculates delay between retries, in milliseconds.

Parameters
- attemptCount: number
- retryDelayInMs: number
- maxRetryDelayInMs: number
- mode: RetryMode
Returns number

getHeaderKey

getHeaderKey(headerName: string): string

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:7
A collection of HttpHeaders that can be sent with a HTTP request.

Parameters
- headerName: string
Returns string

isHttpHeadersLike

isHttpHeadersLike(object?: unknown): object is HttpHeadersLike

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/httpHeaders.ts:85
Parameters
- Optional object: unknown
Returns object is HttpHeadersLike

isServiceBusError

isServiceBusError(err: unknown): err is ServiceBusError

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/serviceBusError.ts:185
Determines if an error is of type ServiceBusError

Parameters
- err: unknown
  
  An error to check to see if it's of type ServiceBusError
Returns err is ServiceBusError

isSpan

isSpan(possibleSpan: Span | SpanContext | undefined): possibleSpan is Span

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/diagnostics/tracing.ts:235
Parameters
- possibleSpan: Span | SpanContext | undefined
Returns possibleSpan is Span

parseServiceBusConnectionString

parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/connectionStringUtils.ts:53
Parses given connection string into the different properties applicable to Azure Service Bus. The properties are useful to then construct a ServiceBusClient.

Parameters
- connectionString: string
  
  The connection string associated with the Shared Access Policy created for the Service Bus namespace, queue or topic.
Returns ServiceBusConnectionStringProperties

setCustomEndpointAddress

setCustomEndpointAddress(config: ConnectionConfig, customEndpointAddress: string): void

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/constructorHelpers.ts:89
Updates the provided ConnectionConfig to use the custom endpoint address.

Parameters
- config: ConnectionConfig
  
  An existing connection configuration to be updated.
- customEndpointAddress: string
  
  The custom endpoint address to use.
Returns void

signingPolicy

signingPolicy(credentials: { signRequest: any }): PipelinePolicy

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:137
Parameters
- credentials: { signRequest: any }
  - signRequest: function
    - signRequest(request: PipelineRequest): Promise<PipelineRequest>
    - Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:138
      Parameters
      - request: PipelineRequest
      Returns Promise<PipelineRequest>
Returns PipelinePolicy

toHttpHeaderLike

toHttpHeaderLike(headers: HttpHeaders): HttpHeadersLike

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/compatibility.ts:121
Parameters
- headers: HttpHeaders
Returns HttpHeadersLike

toHttpResponse

toHttpResponse(response: PipelineResponse): HttpResponse

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/compatibility.ts:139
Helper to transform PipelineResponse to slimmed-down HttpResponse used in Service Bus.

Parameters
- response: PipelineResponse
Returns HttpResponse

toWebResourceLike

toWebResourceLike(request: PipelineRequest): WebResourceLike

- Defined in mnt/vss/_work/1/s/sdk/servicebus/service-bus/src/util/compat/compatibility.ts:125
Parameters
- request: PipelineRequest
Returns WebResourceLike

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

EntitiesResponse

Type parameters

T: object

EntityAvailabilityStatus

EntityStatus

OperationOptionsBase

RawHttpHeaders

Type declaration

[headerName: string]: string

ServiceBusErrorCode

SqlRuleAction

Type declaration

Optional sqlExpression?: undefined | string

Optional sqlParameters?: undefined | {}

TransferProgressEvent

Type declaration

loadedBytes: number

WithResponse

Type parameters

T: object

Functions

applyRequestOptions

Parameters

request: PipelineRequest

options: { abortSignal?: AbortSignalLike; headers?: Record<string, string>; onDownloadProgress?: undefined | ((progress: TransferProgressEvent) => void); onUploadProgress?: undefined | ((progress: TransferProgressEvent) => void); timeout: number; tracingOptions?: OperationTracingOptions }

Optional abortSignal?: AbortSignalLike

Optional headers?: Record<string, string>

Optional onDownloadProgress?: undefined | ((progress: TransferProgressEvent) => void)

Optional onUploadProgress?: undefined | ((progress: TransferProgressEvent) => void)

timeout: number

Optional tracingOptions?: OperationTracingOptions

Returns void

calculateDelay

Parameters

attemptCount: number

retryDelayInMs: number

maxRetryDelayInMs: number

mode: RetryMode

Returns number

getHeaderKey

Parameters

headerName: string

Returns string

isHttpHeadersLike

Parameters

Optional object: unknown

Returns object is HttpHeadersLike

isServiceBusError

Parameters

err: unknown

Returns err is ServiceBusError

isSpan

Parameters

possibleSpan: Span | SpanContext | undefined

Returns possibleSpan is Span

parseServiceBusConnectionString

Parameters

connectionString: string

Returns ServiceBusConnectionStringProperties

setCustomEndpointAddress

Parameters

config: ConnectionConfig

customEndpointAddress: string

Returns void

signingPolicy

Parameters

credentials: { signRequest: any }

signRequest: function

Parameters

request: PipelineRequest

Returns Promise<PipelineRequest>

Returns PipelinePolicy

toHttpHeaderLike

Parameters