Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/service-bus

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ConnectionContextMethods

ConnectionContextMethods: Omit<FunctionProperties<ConnectionContextInternalMembers>, FunctionPropertyNames<ConnectionContextBase>> & ThisType<ConnectionContextInternalMembers>

Helper type to get the types of all the functions on ConnectionContext and the internal methods from ConnectionContextInternalMembers. Note that this excludes the functions that ConnectionContext inherits. Each function also has its this type set as ConnectionContext.

FunctionProperties

FunctionProperties<T>: Pick<T, FunctionPropertyNames<T>>

Helper type to get the types of all the functions on an object.

Type parameters

  • T

FunctionPropertyNames

FunctionPropertyNames<T>: {}[keyof T]

Helper type to get the names of all the functions on an object.

Type parameters

  • T

Variables

Const ACCESSED_AT

ACCESSED_AT: "AccessedAt" = "AccessedAt"

Accessed at field

Const API_VERSION_QUERY_KEY

API_VERSION_QUERY_KEY: "api-version" = "api-version"

Query string parameter to set Service Bus API version

Const ATOM_METADATA_MARKER

ATOM_METADATA_MARKER: "_" = "_"

Constant representing the property where the atom default elements are stored.

const

Const AUTHORIZATION_RULES

AUTHORIZATION_RULES: "AuthorizationRules" = "AuthorizationRules"

Authorization rules on the entity

Const AUTO_DELETE_ON_IDLE

AUTO_DELETE_ON_IDLE: "AutoDeleteOnIdle" = "AutoDeleteOnIdle"

Max idle time before entity is deleted. This is specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

Const COUNT_DETAILS

COUNT_DETAILS: "CountDetails" = "CountDetails"

The topic / subscription's count details.

Const CREATED_AT

CREATED_AT: "CreatedAt" = "CreatedAt"

Created at field

Const CURRENT_API_VERSION

CURRENT_API_VERSION: "2017-04" = "2017-04"

Current API version being sent to service bus

Const DEAD_LETTERING_ON_FILTER_EVALUATION_EXCEPTIONS

DEAD_LETTERING_ON_FILTER_EVALUATION_EXCEPTIONS: "DeadLetteringOnFilterEvaluationExceptions" = "DeadLetteringOnFilterEvaluationExceptions"

The indication if dead lettering on filter evaluation exceptions.

Const DEAD_LETTERING_ON_MESSAGE_EXPIRATION

DEAD_LETTERING_ON_MESSAGE_EXPIRATION: "DeadLetteringOnMessageExpiration" = "DeadLetteringOnMessageExpiration"

The indication if dead lettering on message expiration. If it is enabled and a message expires, the Service Bus moves the message from the queue into the entity dead-letter sub-queue. If disabled, message will be permanently deleted from the main entity. Settable only at entity creation time.

Const DEFAULT_MESSAGE_TIME_TO_LIVE

DEFAULT_MESSAGE_TIME_TO_LIVE: "DefaultMessageTimeToLive" = "DefaultMessageTimeToLive"

The default message time to live. This is specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

Const DEFAULT_RULE_DESCRIPTION

DEFAULT_RULE_DESCRIPTION: "DefaultRuleDescription" = "DefaultRuleDescription"

Indicates the default rule description.

Const DEFAULT_RULE_NAME

DEFAULT_RULE_NAME: "$Default" = "$Default"

The default rule name.

Const DUPLICATE_DETECTION_HISTORY_TIME_WINDOW

DUPLICATE_DETECTION_HISTORY_TIME_WINDOW: "DuplicateDetectionHistoryTimeWindow" = "DuplicateDetectionHistoryTimeWindow"

The history time window for duplicate detection. This is specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

Const ENABLE_BATCHED_OPERATIONS

ENABLE_BATCHED_OPERATIONS: "EnableBatchedOperations" = "EnableBatchedOperations"

Indicates if the queue has enabled batch operations.

Const ENABLE_EXPRESS

ENABLE_EXPRESS: "EnableExpress" = "EnableExpress"

Enable express option

Const ENABLE_PARTITIONING

ENABLE_PARTITIONING: "EnablePartitioning" = "EnablePartitioning"

Indicates whether the topic/queue should be split across multiple partitions

Const ENABLE_SUBSCRIPTION_PARTITIONING

ENABLE_SUBSCRIPTION_PARTITIONING: "EnableSubscriptionPartitioning" = "EnableSubscriptionPartitioning"

Enable Subscription Partitioning option

Const ENTITY_AVAILABILITY_STATUS

ENTITY_AVAILABILITY_STATUS: "EntityAvailabilityStatus" = "EntityAvailabilityStatus"

Entity Availability Status field

Const FILTER_MESSAGES_BEFORE_PUBLISHING

FILTER_MESSAGES_BEFORE_PUBLISHING: "FilteringMessagesBeforePublishing" = "FilteringMessagesBeforePublishing"

Filtering Messages Before Publishing option

Const FORWARD_DEADLETTERED_MESSAGES_TO

FORWARD_DEADLETTERED_MESSAGES_TO: "ForwardDeadLetteredMessagesTo" = "ForwardDeadLetteredMessagesTo"

The URL of Service Bus entity to forward deadlettered messages to.

Const FORWARD_TO

FORWARD_TO: "ForwardTo" = "ForwardTo"

The URL of Service Bus entity to forward messages to.

Const IS_ANONYMOUS_ACCESSIBLE

IS_ANONYMOUS_ACCESSIBLE: "IsAnonymousAccessible" = "IsAnonymousAccessible"

Is Anonymous Accessible field

Const IS_EXPRESS

IS_EXPRESS: "IsExpress" = "IsExpress"

Is express option

Const LOCK_DURATION

LOCK_DURATION: "LockDuration" = "LockDuration"

The lock duration. This is specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

Const MAX_DELIVERY_COUNT

MAX_DELIVERY_COUNT: "MaxDeliveryCount" = "MaxDeliveryCount"

The maximum delivery count of messages after which if it is still not settled, gets moved to the dead-letter sub-queue.

Const MAX_SIZE_IN_MEGABYTES

MAX_SIZE_IN_MEGABYTES: "MaxSizeInMegabytes" = "MaxSizeInMegabytes"

The maximum size in megabytes.

Const MESSAGE_COUNT

MESSAGE_COUNT: "MessageCount" = "MessageCount"

The entity's message count.

Const ODATA_ERROR_MESSAGE

ODATA_ERROR_MESSAGE: "message" = "message"

Constant representing the Odata Error 'message' property

const

Const ODATA_ERROR_MESSAGE_VALUE

ODATA_ERROR_MESSAGE_VALUE: "value" = "value"

Constant representing the 'value' property of Odata Error 'message' property

const

Const QUEUE_NAME

QUEUE_NAME: "QueueName" = "QueueName"

Queue name identifier

Const REQUIRES_DUPLICATE_DETECTION

REQUIRES_DUPLICATE_DETECTION: "RequiresDuplicateDetection" = "RequiresDuplicateDetection"

The indication if duplicate detection is required or not.

Const REQUIRES_SESSION

REQUIRES_SESSION: "RequiresSession" = "RequiresSession"

The indication if session is required or not.

Const RULE_NAME

RULE_NAME: "RuleName" = "RuleName"

Rule name identifier

Const SIZE_IN_BYTES

SIZE_IN_BYTES: "SizeInBytes" = "SizeInBytes"

The entity's size in bytes.

Const STATUS

STATUS: "Status" = "Status"

The status information on response

Const SUBSCRIPTION_COUNT

SUBSCRIPTION_COUNT: "SubscriptionCount" = "SubscriptionCount"

The topic's subscription count.

Const SUBSCRIPTION_NAME

SUBSCRIPTION_NAME: "SubscriptionName" = "SubscriptionName"

Subscription name identifier

Const SUPPORT_ORDERING

SUPPORT_ORDERING: "SupportOrdering" = "SupportOrdering"

Indicates whether the topic can be ordered

Const TOPIC_NAME

TOPIC_NAME: "TopicName" = "TopicName"

Topic name identifier

Const UPDATED_AT

UPDATED_AT: "UpdatedAt" = "UpdatedAt"

Updated at field

Const USER_METADATA

USER_METADATA: "UserMetadata" = "UserMetadata"

The user meta data information

Const XML_METADATA_MARKER

XML_METADATA_MARKER: "$" = "$"

Marker for atom metadata.

const

Const XML_VALUE_MARKER

XML_VALUE_MARKER: "_" = "_"

Marker for atom value.

const

Const correlationProperties

correlationProperties: string[] = ["correlationId","messageId","to","replyTo","label","sessionId","replyToSessionId","contentType","userProperties"]

Const max32BitNumber

max32BitNumber: number = Math.pow(2, 31) - 1

Const messageDispositionTimeout

messageDispositionTimeout: 20000 = 20000

Const navigator

navigator: Navigator

Const url

url: any = require("url")

Functions

convertToUint8Array

  • convertToUint8Array(value: string): Uint8Array

encodeByteArray

  • encodeByteArray(value: Uint8Array): string

generateKey

  • generateKey(secret: string, stringToSign: string): Promise<string>

getDispositionType

  • getDispositionType(dispositionStatus: DispositionStatus): DispositionType | undefined

getManagementClient

  • getManagementClient(clients: Dictionary<ClientEntityContext>, entityPath: string): ManagementClient | undefined

isKnownResponseCode

  • isKnownResponseCode(statusCode: number): statusCode is keyof typeof HttpResponseCodes

Const parseURL

  • parseURL(rawUrl: string): any
  • parseURL(rawUrl: string): URL

Object literals

Const HttpResponseCodes

HttpResponseCodes: object

Known HTTP status codes as documented and referenced in ATOM based management API feature https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

100

100: string = "Continue"

101

101: string = "SwitchingProtocols"

200

200: string = "Ok"

201

201: string = "Created"

202

202: string = "Accepted"

203

203: string = "NonAuthoritativeInformation"

204

204: string = "NoContent"

205

205: string = "ResetContent"

206

206: string = "PartialContent"

300

300: string = "MultipleChoices"

301

301: string = "Moved"

302

302: string = "Redirect"

303

303: string = "RedirectMethod"

304

304: string = "NotModified"

305

305: string = "UseProxy"

306

306: string = "Unused"

400

400: string = "BadRequest"

401

401: string = "Unauthorized"

402

402: string = "PaymentRequired"

403

403: string = "Forbidden"

404

404: string = "NotFound"

405

405: string = "MethodNotAllowed"

406

406: string = "NotAcceptable"

407

407: string = "ProxyAuthenticationRequired"

409

409: string = "Conflict"

410

410: string = "Gone"

411

411: string = "LengthRequired"

412

412: string = "PreconditionFailed"

413

413: string = "RequestEntityTooLarge"

414

414: string = "RequestUriTooLong"

415

415: string = "UnsupportedMediaType"

416

416: string = "RequestRangeNotSatisfiable"

417

417: string = "ExpectationFailed"

426

426: string = "UpgradeRequired"

500

500: string = "InternalServerError"

501

501: string = "NotImplemented"

502

502: string = "BadGateway"

503

503: string = "ServiceUnavailable"

504

504: string = "GatewayTimeout"

505

505: string = "HttpVersionNotSupported"

Const packageJsonInfo

packageJsonInfo: object

name

name: string = "@azure/service-bus"

version

version: string = "1.1.8"

Generated using TypeDoc