@azure/storage-queue

Index

Enumerations

Interfaces

Type aliases

Variables

Object literals

Type aliases

CredentialPolicyCreator

CredentialPolicyCreator: (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy

A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.

Type declaration

- (nextPolicy: RequestPolicy, options: RequestPolicyOptions): CredentialPolicy
- Parameters
  - nextPolicy: RequestPolicy
  - options: RequestPolicyOptions
  Returns CredentialPolicy

GeoReplicationStatusType

GeoReplicationStatusType: "live" | "bootstrap" | "unavailable"

Defines values for GeoReplicationStatusType.

ListQueuesIncludeType

ListQueuesIncludeType: "metadata"

Defines values for ListQueuesIncludeType. Possible values include: 'metadata'

readonly

MessageIdDeleteResponse

MessageIdDeleteResponse: MessageIdDeleteHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: MessageIdDeleteHeaders } }

Contains response data for the delete operation.

MessageIdUpdateResponse

MessageIdUpdateResponse: MessageIdUpdateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: MessageIdUpdateHeaders } }

Contains response data for the update operation.

MessagesClearResponse

MessagesClearResponse: MessagesClearHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: MessagesClearHeaders } }

Contains response data for the clear operation.

MessagesDequeueResponse

MessagesDequeueResponse: MessagesDequeueHeaders & DequeuedMessageItem[] & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DequeuedMessageItem[]; parsedHeaders: MessagesDequeueHeaders } }

Contains response data for the dequeue operation.

MessagesEnqueueResponse

MessagesEnqueueResponse: MessagesEnqueueHeaders & EnqueuedMessage[] & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: EnqueuedMessage[]; parsedHeaders: MessagesEnqueueHeaders } }

Contains response data for the enqueue operation.

MessagesPeekResponse

MessagesPeekResponse: MessagesPeekHeaders & PeekedMessageItem[] & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PeekedMessageItem[]; parsedHeaders: MessagesPeekHeaders } }

Contains response data for the peek operation.

QueueClearMessagesResponse

QueueClearMessagesResponse: MessagesClearResponse

Contains response data for the QueueClient.clearMessages operation.

QueueCreateResponse

QueueCreateResponse: QueueCreateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: QueueCreateHeaders } }

Contains response data for the create operation.

QueueDeleteMessageResponse

QueueDeleteMessageResponse: MessageIdDeleteResponse

Contains response data for the QueueClient.deleteMessage operation.

QueueDeleteResponse

QueueDeleteResponse: QueueDeleteHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: QueueDeleteHeaders } }

Contains response data for the delete operation.

QueueGetAccessPolicyResponse

QueueGetAccessPolicyResponse: { signedIdentifiers: SignedIdentifier[] } & QueueGetAccessPolicyHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: SignedIdentifierModel[]; parsedHeaders: QueueGetAccessPolicyHeaders } }

Contains response data for the getAccessPolicy operation. Contains response data for the QueueClient.getAccessPolicy operation.

QueueGetPropertiesResponse

QueueGetPropertiesResponse: QueueGetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: QueueGetPropertiesHeaders } }

Contains response data for the getProperties operation.

QueuePeekMessagesResponse

QueuePeekMessagesResponse: { peekedMessageItems: PeekedMessageItem[] } & MessagesPeekHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: PeekedMessageItem[]; parsedHeaders: MessagesPeekHeaders } }

Contains the response data for the QueueClient.peekMessages operation.

QueueReceiveMessageResponse

QueueReceiveMessageResponse: { receivedMessageItems: ReceivedMessageItem[] } & MessagesDequeueHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: ReceivedMessageItem[]; parsedHeaders: MessagesDequeueHeaders } }

Contains the response data for the QueueClient.receiveMessages operation.

QueueSendMessageResponse

QueueSendMessageResponse: { expiresOn: Date; insertedOn: Date; messageId: string; nextVisibleOn: Date; popReceipt: string } & MessagesEnqueueHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: EnqueuedMessage[]; parsedHeaders: MessagesEnqueueHeaders } }

Contains the response data for the QueueClient.sendMessage operation.

QueueSetAccessPolicyResponse

QueueSetAccessPolicyResponse: QueueSetAccessPolicyHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: QueueSetAccessPolicyHeaders } }

Contains response data for the setAccessPolicy operation.

QueueSetMetadataResponse

QueueSetMetadataResponse: QueueSetMetadataHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: QueueSetMetadataHeaders } }

Contains response data for the setMetadata operation.

QueueUpdateMessageResponse

QueueUpdateMessageResponse: MessageIdUpdateResponse

Contains response data for the QueueClient.updateMessage operation.

ReceivedMessageItem

ReceivedMessageItem: DequeuedMessageItem

The object returned in the receivedMessageItems array when calling QueueClient.receiveMessages.

See: QueueReceiveMessageResponse

ServiceGetPropertiesResponse

ServiceGetPropertiesResponse: ServiceGetPropertiesHeaders & QueueServiceProperties & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: QueueServiceProperties; parsedHeaders: ServiceGetPropertiesHeaders } }

Contains response data for the getProperties operation.

ServiceGetStatisticsResponse

ServiceGetStatisticsResponse: ServiceGetStatisticsHeaders & QueueServiceStatistics & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: QueueServiceStatistics; parsedHeaders: ServiceGetStatisticsHeaders } }

Contains response data for the getStatistics operation.

ServiceListQueuesSegmentResponse

ServiceListQueuesSegmentResponse: ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListQueuesSegmentResponse; parsedHeaders: ServiceListQueuesSegmentHeaders } }

Contains response data for the listQueuesSegment operation.

ServiceSetPropertiesResponse

ServiceSetPropertiesResponse: ServiceSetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ServiceSetPropertiesHeaders } }

Contains response data for the setProperties operation.

StorageErrorCode

StorageErrorCode: string

Defines values for StorageErrorCode.
KnownStorageErrorCode can be used interchangeably with StorageErrorCode, this enum contains the known values that the service supports.

Know values supported by the service

AccountAlreadyExists
AccountBeingCreated
AccountIsDisabled
AuthenticationFailed
AuthorizationFailure
ConditionHeadersNotSupported
ConditionNotMet
EmptyMetadataKey
InsufficientAccountPermissions
InternalError
InvalidAuthenticationInfo
InvalidHeaderValue
InvalidHttpVerb
InvalidInput
InvalidMd5
InvalidMetadata
InvalidQueryParameterValue
InvalidRange
InvalidResourceName
InvalidUri
InvalidXmlDocument
InvalidXmlNodeValue
Md5Mismatch
MetadataTooLarge
MissingContentLengthHeader
MissingRequiredQueryParameter
MissingRequiredHeader
MissingRequiredXmlNode
MultipleConditionHeadersNotSupported
OperationTimedOut
OutOfRangeInput
OutOfRangeQueryParameterValue
RequestBodyTooLarge
ResourceTypeMismatch
RequestUrlFailedToParse
ResourceAlreadyExists
ResourceNotFound
ServerBusy
UnsupportedHeader
UnsupportedXmlNode
UnsupportedQueryParameter
UnsupportedHttpVerb
InvalidMarker
MessageNotFound
MessageTooLarge
PopReceiptMismatch
QueueAlreadyExists
QueueBeingDeleted
QueueDisabled
QueueNotEmpty
QueueNotFound
AuthorizationSourceIPMismatch
AuthorizationProtocolMismatch
AuthorizationPermissionMismatch
AuthorizationServiceMismatch
AuthorizationResourceTypeMismatch
FeatureVersionMismatch

Variables

Const DevelopmentConnectionString

DevelopmentConnectionString: "DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;" = `DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;`

Const ETagAny

ETagAny: "*" = "*"

Const ETagNone

ETagNone: "" = ""

Const RETRY_ABORT_ERROR

RETRY_ABORT_ERROR: any = new AbortError("The operation was aborted.")

Const SDK_VERSION

SDK_VERSION: string = "12.8.0-beta.1"

Const SERVICE_VERSION

SERVICE_VERSION: string = "2020-12-06"

Const StorageOAuthScopes

StorageOAuthScopes: string | string[] = "https://storage.azure.com/.default"

The OAuth scope to use with Azure Storage.

Const StorageQueueLoggingAllowedHeaderNames

StorageQueueLoggingAllowedHeaderNames: string[] = ["Access-Control-Allow-Origin","Cache-Control","Content-Length","Content-Type","Date","Request-Id","traceparent","Transfer-Encoding","User-Agent","x-ms-client-request-id","x-ms-date","x-ms-error-code","x-ms-request-id","x-ms-return-client-request-id","x-ms-version","x-ms-approximate-messages-count","x-ms-popreceipt","x-ms-time-next-visible"]

Const StorageQueueLoggingAllowedQueryParameters

StorageQueueLoggingAllowedQueryParameters: string[] = ["comp","maxresults","rscc","rscd","rsce","rscl","rsct","se","si","sip","sp","spr","sr","srt","ss","st","sv","include","marker","prefix","messagettl","numofmessages","peekonly","popreceipt","visibilitytimeout"]

Const _defaultHttpClient

_defaultHttpClient: any = new DefaultHttpClient()

Const createSpan

createSpan: any = createSpanFunction({packagePrefix: "Azure.Storage.Queue",namespace: "Microsoft.Storage"})

Creates a span using the global tracer.

internal

Const logger

logger: any = createClientLogger("storage-queue")

The @azure/logger configuration for this package.

Const packageName

packageName: "azure-storage-queue" = "azure-storage-queue"

Const packageVersion

packageVersion: "12.8.0-beta.1" = "12.8.0-beta.1"

Functions

NewRetryPolicyFactory

NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

- Defined in policies/StorageRetryPolicy.ts:27
A factory method used to generated a RetryPolicy factory.

Parameters
- Optional retryOptions: StorageRetryOptions
  
  -
Returns RequestPolicyFactory

appendToURLPath

appendToURLPath(url: string, name: string): string

- Defined in utils/utils.common.ts:17
Append a string to URL path. Will remove duplicated "/" in front of the string when URL path ends with a "/".

Parameters
- url: string
  
  Source URL string
- name: string
  
  String to be appended to URL
Returns string

An updated URL string

appendToURLQuery

appendToURLQuery(url: string, queryParts: string): string

- Defined in utils/utils.common.ts:399
Append a string to URL query.

Parameters
- url: string
  
  Source URL string.
- queryParts: string
  
  String to be appended to the URL query.
Returns string

An updated URL string.

convertTracingToRequestOptionsBase

convertTracingToRequestOptionsBase(options?: OperationOptions): Pick<RequestOptionsBase, "spanOptions" | "tracingContext">

- Defined in utils/tracing.ts:23
internal

Adapt the tracing options from OperationOptions to what they need to be for RequestOptionsBase (when we update to later OpenTelemetry versions this is now two separate fields, not just one).

Parameters
- Optional options: OperationOptions
Returns Pick<RequestOptionsBase, "spanOptions" | "tracingContext">

delay

delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error): Promise<void>

- Defined in utils/utils.common.ts:270
Delay specified time interval.

Parameters
- timeInMs: number
  
  -
- Optional aborter: AbortSignalLike
  
  -
- Optional abortError: Error
  
  -
Returns Promise<void>

extractConnectionStringParts

extractConnectionStringParts(connectionString: string): ConnectionString

- Defined in utils/utils.common.ts:169
Extracts the parts of an Azure Storage account connection string.

Parameters
- connectionString: string
  
  Connection string.
Returns ConnectionString

String key value pairs of the storage account's url and credentials.

generateAccountSASQueryParameters

generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

- Defined in AccountSASSignatureValues.ts:84
ONLY AVAILABLE IN NODE.JS RUNTIME.

Generates a SASQueryParameters object which contains all SAS query parameters needed to make an actual REST request.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

Parameters
- accountSASSignatureValues: AccountSASSignatureValues
  
  SAS Signature values of the account
- sharedKeyCredential: StorageSharedKeyCredential
  
  Shared key credential.
Returns SASQueryParameters

generateQueueSASQueryParameters

generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

- Defined in QueueSASSignatureValues.ts:79
ONLY AVAILABLE IN NODE.JS RUNTIME.

Creates an instance of SASQueryParameters.

Only accepts required settings needed to create a SAS. For optional settings please set corresponding properties directly, such as permissions, startsOn and identifier.

WARNING: When identifier is not provided, permissions and expiresOn are required. You MUST assign value to identifier or expiresOn & permissions manually if you initial with this constructor.

Parameters
- queueSASSignatureValues: QueueSASSignatureValues
  
  -
- sharedKeyCredential: StorageSharedKeyCredential
  
  -
Returns SASQueryParameters

getAccountNameFromUrl

getAccountNameFromUrl(url: string): string

- Defined in utils/utils.common.ts:339
Extracts account name from the url

Parameters
- url: string
  
  url to extract the account name from
Returns string

with the account name

getCachedDefaultHttpClient

getCachedDefaultHttpClient(): IHttpClient

- Defined in utils/cache.ts:9
Returns IHttpClient

getCanonicalName

getCanonicalName(accountName: string, queueName: string): string

- Defined in QueueSASSignatureValues.ts:136
Parameters
- accountName: string
- queueName: string
Returns string

getProxyUriFromDevConnString

getProxyUriFromDevConnString(connectionString: string): string

- Defined in utils/utils.common.ts:122
Parameters
- connectionString: string
Returns string

getStorageClientContext

getStorageClientContext(url: string, pipeline: Pipeline): StorageClientContext

- Defined in utils/utils.common.ts:384
Gets a new StorageClientContext

Parameters
- url: string
  
  Url used for the StorageClientContext
- pipeline: Pipeline
  
  a pipeline containing HTTP request policies
Returns StorageClientContext

new StorageClientContext

getURLParameter

getURLParameter(url: string, name: string): string | string[] | undefined

- Defined in utils/utils.common.ts:49
Get URL parameter by name.

Parameters
- url: string
  
  URL string
- name: string
  
  Parameter name
Returns string | string[] | undefined

Parameter value(s) for the given parameter name.

getURLPath

getURLPath(url: string): string | undefined

- Defined in utils/utils.common.ts:73
Gets URL path from an URL string.

Parameters
- url: string
  
  Source URL string
Returns string | undefined

The path part of the given URL string.

getURLQueries

getURLQueries(url: string): {}

- Defined in utils/utils.common.ts:84
Gets URL query key value pairs from an URL string.

Parameters
- url: string
  
  -
Returns {}

query key value string pairs from the given URL string.
- [key: string]: string

getValueInConnString

getValueInConnString(connectionString: string, argument: "QueueEndpoint" | "AccountName" | "AccountKey" | "DefaultEndpointsProtocol" | "EndpointSuffix" | "SharedAccessSignature"): string

- Defined in utils/utils.common.ts:144
Parameters
- connectionString: string
  
  Account connection string.
- argument: "QueueEndpoint" | "AccountName" | "AccountKey" | "DefaultEndpointsProtocol" | "EndpointSuffix" | "SharedAccessSignature"
  
  property to get value from the connection string.
Returns string

Value of the property specified in argument.

ipRangeToString

ipRangeToString(ipRange: SasIPRange): string

- Defined in SasIPRange.ts:27
Generate SasIPRange format string. For example:

"8.8.8.8" or "1.1.1.1-255.255.255.255"

Parameters
- ipRange: SasIPRange
  
  -
Returns string

isIpEndpointStyle

isIpEndpointStyle(parsedUrl: URLBuilder): boolean

- Defined in utils/utils.common.ts:361
Parameters
- parsedUrl: URLBuilder
Returns boolean

newPipeline

newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

- Defined in Pipeline.ts:150
Creates a new Pipeline object with Credential provided.

Parameters
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
  
  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
- Default value pipelineOptions: StoragePipelineOptions = {}
  
  Options.
Returns Pipeline

A new Pipeline object.

sanitizeHeaders

sanitizeHeaders(originalHeader: HttpHeaders): HttpHeaders

- Defined in utils/utils.common.ts:319
Sanitize headers by removing sensitive values such as AUTHORIZATION and X_MS_COPY_SOURCE

Parameters
- originalHeader: HttpHeaders
  
  original headers
Returns HttpHeaders

sanitized headers

sanitizeURL

sanitizeURL(url: string): string

- Defined in utils/utils.common.ts:305
Sanitizes a url by removing the Signature parameter

Parameters
- url: string
  
  to sanitize
Returns string

sanitized string

setURLHost

setURLHost(url: string, host: string): string

- Defined in utils/utils.common.ts:61
Set URL host.

Parameters
- url: string
  
  Source URL string
- host: string
  
  New host string
Returns string

An updated URL string

setURLParameter

setURLParameter(url: string, name: string, value?: undefined | string): string

- Defined in utils/utils.common.ts:36
Set URL parameter name and value. If name exists in URL parameters, old value will be replaced by name key. If not provide value, the parameter will be deleted.

Parameters
- url: string
  
  Source URL string
- name: string
  
  Parameter name
- Optional value: undefined | string
  
  Parameter value
Returns string

An updated URL string

truncatedISO8061Date

truncatedISO8061Date(date: Date, withMilliseconds?: boolean): string

- Defined in utils/utils.common.ts:254
Rounds a date off to seconds.

Parameters
- date: Date
  
  -
- Default value withMilliseconds: boolean = true
  
  If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned; If false, YYYY-MM-DDThh:mm:ssZ will be returned.
Returns string

Date string in ISO8061 format, with or without 7 milliseconds component

Object literals

Const AccessPolicy

AccessPolicy: object

serializedName

serializedName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

modelProperties

modelProperties: object

expiresOn

expiresOn: object

serializedName

serializedName: string = "Expiry"

xmlName

xmlName: string = "Expiry"

type

type: object

name

permissions

permissions: object

serializedName

serializedName: string = "Permission"

xmlName

xmlName: string = "Permission"

type

type: object

name

startsOn

startsOn: object

serializedName

serializedName: string = "Start"

xmlName

xmlName: string = "Start"

type

type: object

name

Const CorsRule

CorsRule: object

serializedName

serializedName: string = "CorsRule"

type

type: object

className

className: string = "CorsRule"

name

modelProperties

modelProperties: object

allowedHeaders

allowedHeaders: object

required

required: boolean = true

serializedName

serializedName: string = "AllowedHeaders"

xmlName

xmlName: string = "AllowedHeaders"

type

type: object

name

allowedMethods

allowedMethods: object

required

required: boolean = true

serializedName

serializedName: string = "AllowedMethods"

xmlName

xmlName: string = "AllowedMethods"

type

type: object

name

allowedOrigins

allowedOrigins: object

required

required: boolean = true

serializedName

serializedName: string = "AllowedOrigins"

xmlName

xmlName: string = "AllowedOrigins"

type

type: object

name

exposedHeaders

exposedHeaders: object

required

required: boolean = true

serializedName

serializedName: string = "ExposedHeaders"

xmlName

xmlName: string = "ExposedHeaders"

type

type: object

name

maxAgeInSeconds

maxAgeInSeconds: object

required

required: boolean = true

serializedName

serializedName: string = "MaxAgeInSeconds"

xmlName

xmlName: string = "MaxAgeInSeconds"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const DEFAULT_RETRY_OPTIONS

DEFAULT_RETRY_OPTIONS: object

maxRetryDelayInMs

maxRetryDelayInMs: number = 120 * 1000

maxTries

maxTries: number = 4

retryDelayInMs

retryDelayInMs: number = 4 * 1000

retryPolicyType

retryPolicyType: EXPONENTIAL = StorageRetryPolicyType.EXPONENTIAL

secondaryHost

secondaryHost: string = ""

tryTimeoutInMs

tryTimeoutInMs: number = 30 * 1000

Const DequeuedMessageItem

DequeuedMessageItem: object

serializedName

serializedName: string = "DequeuedMessageItem"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "QueueMessage"

type

type: object

className

className: string = "DequeuedMessageItem"

name

modelProperties

modelProperties: object

dequeueCount

dequeueCount: object

required

required: boolean = true

serializedName

serializedName: string = "DequeueCount"

xmlName

xmlName: string = "DequeueCount"

type

type: object

name

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "ExpirationTime"

xmlName

xmlName: string = "ExpirationTime"

type

type: object

name

insertedOn

insertedOn: object

required

required: boolean = true

serializedName

serializedName: string = "InsertionTime"

xmlName

xmlName: string = "InsertionTime"

type

type: object

name

messageId

messageId: object

required

required: boolean = true

serializedName

serializedName: string = "MessageId"

xmlName

xmlName: string = "MessageId"

type

type: object

name

messageText

messageText: object

required

required: boolean = true

serializedName

serializedName: string = "MessageText"

xmlName

xmlName: string = "MessageText"

type

type: object

name

nextVisibleOn

nextVisibleOn: object

required

required: boolean = true

serializedName

serializedName: string = "TimeNextVisible"

xmlName

xmlName: string = "TimeNextVisible"

type

type: object

name

popReceipt

popReceipt: object

required

required: boolean = true

serializedName

serializedName: string = "PopReceipt"

xmlName

xmlName: string = "PopReceipt"

type

type: object

name

Const EnqueuedMessage

EnqueuedMessage: object

serializedName

serializedName: string = "EnqueuedMessage"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "QueueMessage"

type

type: object

className

className: string = "EnqueuedMessage"

name

modelProperties

modelProperties: object

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "ExpirationTime"

xmlName

xmlName: string = "ExpirationTime"

type

type: object

name

insertedOn

insertedOn: object

required

required: boolean = true

serializedName

serializedName: string = "InsertionTime"

xmlName

xmlName: string = "InsertionTime"

type

type: object

name

messageId

messageId: object

required

required: boolean = true

serializedName

serializedName: string = "MessageId"

xmlName

xmlName: string = "MessageId"

type

type: object

name

nextVisibleOn

nextVisibleOn: object

required

required: boolean = true

serializedName

serializedName: string = "TimeNextVisible"

xmlName

xmlName: string = "TimeNextVisible"

type

type: object

name

popReceipt

popReceipt: object

required

required: boolean = true

serializedName

serializedName: string = "PopReceipt"

xmlName

xmlName: string = "PopReceipt"

type

type: object

name

Const GeoReplication

GeoReplication: object

serializedName

serializedName: string = "GeoReplication"

type

type: object

className

className: string = "GeoReplication"

name

modelProperties

modelProperties: object

lastSyncOn

lastSyncOn: object

required

required: boolean = true

serializedName

serializedName: string = "LastSyncTime"

xmlName

xmlName: string = "LastSyncTime"

type

type: object

name

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "Status"

xmlName

xmlName: string = "Status"

type

type: object

allowedValues

allowedValues: string[] = ["live", "bootstrap", "unavailable"]

name

Const HeaderConstants

HeaderConstants: object

AUTHORIZATION

AUTHORIZATION: string = "authorization"

AUTHORIZATION_SCHEME

AUTHORIZATION_SCHEME: string = "Bearer"

CONTENT_ENCODING

CONTENT_ENCODING: string = "content-encoding"

CONTENT_LANGUAGE

CONTENT_LANGUAGE: string = "content-language"

CONTENT_LENGTH

CONTENT_LENGTH: string = "content-length"

CONTENT_MD5

CONTENT_MD5: string = "content-md5"

CONTENT_TYPE

CONTENT_TYPE: string = "content-type"

COOKIE

COOKIE: string = "Cookie"

DATE

DATE: string = "date"

IF_MATCH

IF_MATCH: string = "if-match"

IF_MODIFIED_SINCE

IF_MODIFIED_SINCE: string = "if-modified-since"

IF_NONE_MATCH

IF_NONE_MATCH: string = "if-none-match"

IF_UNMODIFIED_SINCE

IF_UNMODIFIED_SINCE: string = "if-unmodified-since"

PREFIX_FOR_STORAGE

PREFIX_FOR_STORAGE: string = "x-ms-"

RANGE

RANGE: string = "Range"

USER_AGENT

USER_AGENT: string = "User-Agent"

X_MS_CLIENT_REQUEST_ID

X_MS_CLIENT_REQUEST_ID: string = "x-ms-client-request-id"

X_MS_COPY_SOURCE

X_MS_COPY_SOURCE: string = "x-ms-copy-source"

X_MS_DATE

X_MS_DATE: string = "x-ms-date"

Const HttpUrlConnection

HttpUrlConnection: object

HTTP_CONFLICT

HTTP_CONFLICT: number = 409

HTTP_NOT_FOUND

HTTP_NOT_FOUND: number = 404

HTTP_PRECON_FAILED

HTTP_PRECON_FAILED: number = 412

HTTP_RANGE_NOT_SATISFIABLE

HTTP_RANGE_NOT_SATISFIABLE: number = 416

Const ListQueuesSegmentResponse

ListQueuesSegmentResponse: object

serializedName

serializedName: string = "ListQueuesSegmentResponse"

xmlName

xmlName: string = "EnumerationResults"

type

type: object

className

className: string = "ListQueuesSegmentResponse"

name

modelProperties

modelProperties: object

continuationToken

continuationToken: object

required

required: boolean = true

serializedName

serializedName: string = "NextMarker"

xmlName

xmlName: string = "NextMarker"

type

type: object

name

marker

marker: object

serializedName

serializedName: string = "Marker"

xmlName

xmlName: string = "Marker"

type

type: object

name

maxPageSize

maxPageSize: object

required

required: boolean = true

serializedName

serializedName: string = "MaxResults"

xmlName

xmlName: string = "MaxResults"

type

type: object

name

prefix

prefix: object

required

required: boolean = true

serializedName

serializedName: string = "Prefix"

xmlName

xmlName: string = "Prefix"

type

type: object

name

queueItems

queueItems: object

serializedName

serializedName: string = "QueueItems"

xmlElementName

xmlElementName: string = "Queue"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "Queues"

type

type: object

name

element

element: object

type

type: object

className

className: string = "QueueItem"

name

serviceEndpoint

serviceEndpoint: object

required

required: boolean = true

serializedName

serializedName: string = "ServiceEndpoint"

xmlIsAttribute

xmlIsAttribute: boolean = true

xmlName

xmlName: string = "ServiceEndpoint"

type

type: object

name

Const Logging

Logging: object

serializedName

serializedName: string = "Logging"

type

type: object

className

className: string = "Logging"

name

modelProperties

modelProperties: object

deleteProperty

deleteProperty: object

required

required: boolean = true

serializedName

serializedName: string = "Delete"

xmlName

xmlName: string = "Delete"

type

type: object

name

read

read: object

required

required: boolean = true

serializedName

serializedName: string = "Read"

xmlName

xmlName: string = "Read"

type

type: object

name

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "RetentionPolicy"

xmlName

xmlName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

version

version: object

required

required: boolean = true

serializedName

serializedName: string = "Version"

xmlName

xmlName: string = "Version"

type

type: object

name

write

write: object

required

required: boolean = true

serializedName

serializedName: string = "Write"

xmlName

xmlName: string = "Write"

type

type: object

name

Const MessageIdDeleteExceptionHeaders

MessageIdDeleteExceptionHeaders: object

serializedName

serializedName: string = "MessageId_deleteExceptionHeaders"

type

type: object

className

className: string = "MessageIdDeleteExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const MessageIdDeleteHeaders

MessageIdDeleteHeaders: object

serializedName

serializedName: string = "MessageId_deleteHeaders"

type

type: object

className

className: string = "MessageIdDeleteHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const MessageIdUpdateExceptionHeaders

MessageIdUpdateExceptionHeaders: object

serializedName

serializedName: string = "MessageId_updateExceptionHeaders"

type

type: object

className

className: string = "MessageIdUpdateExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const MessageIdUpdateHeaders

MessageIdUpdateHeaders: object

serializedName

serializedName: string = "MessageId_updateHeaders"

type

type: object

className

className: string = "MessageIdUpdateHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

nextVisibleOn

nextVisibleOn: object

serializedName

serializedName: string = "x-ms-time-next-visible"

xmlName

xmlName: string = "x-ms-time-next-visible"

type

type: object

name

popReceipt

popReceipt: object

serializedName

serializedName: string = "x-ms-popreceipt"

xmlName

xmlName: string = "x-ms-popreceipt"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const MessagesClearExceptionHeaders

MessagesClearExceptionHeaders: object

serializedName

serializedName: string = "Messages_clearExceptionHeaders"

type

type: object

className

className: string = "MessagesClearExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const MessagesClearHeaders

MessagesClearHeaders: object

serializedName

serializedName: string = "Messages_clearHeaders"

type

type: object

className

className: string = "MessagesClearHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const MessagesDequeueExceptionHeaders

MessagesDequeueExceptionHeaders: object

serializedName

serializedName: string = "Messages_dequeueExceptionHeaders"

type

type: object

className

className: string = "MessagesDequeueExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const MessagesDequeueHeaders

MessagesDequeueHeaders: object

serializedName

serializedName: string = "Messages_dequeueHeaders"

type

type: object

className

className: string = "MessagesDequeueHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const MessagesEnqueueExceptionHeaders

MessagesEnqueueExceptionHeaders: object

serializedName

serializedName: string = "Messages_enqueueExceptionHeaders"

type

type: object

className

className: string = "MessagesEnqueueExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const MessagesEnqueueHeaders

MessagesEnqueueHeaders: object

serializedName

serializedName: string = "Messages_enqueueHeaders"

type

type: object

className

className: string = "MessagesEnqueueHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const MessagesPeekExceptionHeaders

MessagesPeekExceptionHeaders: object

serializedName

serializedName: string = "Messages_peekExceptionHeaders"

type

type: object

className

className: string = "MessagesPeekExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const MessagesPeekHeaders

MessagesPeekHeaders: object

serializedName

serializedName: string = "Messages_peekHeaders"

type

type: object

className

className: string = "MessagesPeekHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const Metrics

Metrics: object

serializedName

serializedName: string = "Metrics"

type

type: object

className

className: string = "Metrics"

name

modelProperties

modelProperties: object

enabled

enabled: object

required

required: boolean = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

includeAPIs

includeAPIs: object

serializedName

serializedName: string = "IncludeAPIs"

xmlName

xmlName: string = "IncludeAPIs"

type

type: object

name

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "RetentionPolicy"

xmlName

xmlName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

version

version: object

serializedName

serializedName: string = "Version"

xmlName

xmlName: string = "Version"

type

type: object

name

Const PeekedMessageItem

PeekedMessageItem: object

serializedName

serializedName: string = "PeekedMessageItem"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "QueueMessage"

type

type: object

className

className: string = "PeekedMessageItem"

name

modelProperties

modelProperties: object

dequeueCount

dequeueCount: object

required

required: boolean = true

serializedName

serializedName: string = "DequeueCount"

xmlName

xmlName: string = "DequeueCount"

type

type: object

name

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "ExpirationTime"

xmlName

xmlName: string = "ExpirationTime"

type

type: object

name

insertedOn

insertedOn: object

required

required: boolean = true

serializedName

serializedName: string = "InsertionTime"

xmlName

xmlName: string = "InsertionTime"

type

type: object

name

messageId

messageId: object

required

required: boolean = true

serializedName

serializedName: string = "MessageId"

xmlName

xmlName: string = "MessageId"

type

type: object

name

messageText

messageText: object

required

required: boolean = true

serializedName

serializedName: string = "MessageText"

xmlName

xmlName: string = "MessageText"

type

type: object

name

Const QueueCreateExceptionHeaders

QueueCreateExceptionHeaders: object

serializedName

serializedName: string = "Queue_createExceptionHeaders"

type

type: object

className

className: string = "QueueCreateExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const QueueCreateHeaders

QueueCreateHeaders: object

serializedName

serializedName: string = "Queue_createHeaders"

type

type: object

className

className: string = "QueueCreateHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const QueueDeleteExceptionHeaders

QueueDeleteExceptionHeaders: object

serializedName

serializedName: string = "Queue_deleteExceptionHeaders"

type

type: object

className

className: string = "QueueDeleteExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const QueueDeleteHeaders

QueueDeleteHeaders: object

serializedName

serializedName: string = "Queue_deleteHeaders"

type

type: object

className

className: string = "QueueDeleteHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const QueueGetAccessPolicyExceptionHeaders

QueueGetAccessPolicyExceptionHeaders: object

serializedName

serializedName: string = "Queue_getAccessPolicyExceptionHeaders"

type

type: object

className

className: string = "QueueGetAccessPolicyExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const QueueGetAccessPolicyHeaders

QueueGetAccessPolicyHeaders: object

serializedName

serializedName: string = "Queue_getAccessPolicyHeaders"

type

type: object

className

className: string = "QueueGetAccessPolicyHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const QueueGetPropertiesExceptionHeaders

QueueGetPropertiesExceptionHeaders: object

serializedName

serializedName: string = "Queue_getPropertiesExceptionHeaders"

type

type: object

className

className: string = "QueueGetPropertiesExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const QueueGetPropertiesHeaders

QueueGetPropertiesHeaders: object

serializedName

serializedName: string = "Queue_getPropertiesHeaders"

type

type: object

className

className: string = "QueueGetPropertiesHeaders"

name

modelProperties

modelProperties: object

approximateMessagesCount

approximateMessagesCount: object

serializedName

serializedName: string = "x-ms-approximate-messages-count"

xmlName

xmlName: string = "x-ms-approximate-messages-count"

type

type: object

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

metadata

metadata: object

headerCollectionPrefix

headerCollectionPrefix: string = "x-ms-meta-"

serializedName

serializedName: string = "x-ms-meta"

xmlName

xmlName: string = "x-ms-meta"

type

type: object

name

value

value: object

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const QueueItem

QueueItem: object

serializedName

serializedName: string = "QueueItem"

xmlName

xmlName: string = "Queue"

type

type: object

className

className: string = "QueueItem"

name

modelProperties

modelProperties: object

metadata

metadata: object

serializedName

serializedName: string = "Metadata"

xmlName

xmlName: string = "Metadata"

type

type: object

name

value

value: object

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

Const QueueMessage

QueueMessage: object

serializedName

serializedName: string = "QueueMessage"

type

type: object

className

className: string = "QueueMessage"

name

modelProperties

modelProperties: object

messageText

messageText: object

required

required: boolean = true

serializedName

serializedName: string = "MessageText"

xmlName

xmlName: string = "MessageText"

type

type: object

name

Const QueueServiceProperties

QueueServiceProperties: object

serializedName

serializedName: string = "QueueServiceProperties"

xmlName

xmlName: string = "StorageServiceProperties"

type

type: object

className

className: string = "QueueServiceProperties"

name

modelProperties

modelProperties: object

cors

cors: object

serializedName

serializedName: string = "Cors"

xmlElementName

xmlElementName: string = "CorsRule"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "Cors"

type

type: object

name

element

element: object

type

type: object

className

className: string = "CorsRule"

name

hourMetrics

hourMetrics: object

serializedName

serializedName: string = "HourMetrics"

xmlName

xmlName: string = "HourMetrics"

type

type: object

className

className: string = "Metrics"

name

minuteMetrics

minuteMetrics: object

serializedName

serializedName: string = "MinuteMetrics"

xmlName

xmlName: string = "MinuteMetrics"

type

type: object

className

className: string = "Metrics"

name

queueAnalyticsLogging

queueAnalyticsLogging: object

serializedName

serializedName: string = "Logging"

xmlName

xmlName: string = "Logging"

type

type: object

className

className: string = "Logging"

name

Const QueueServiceStatistics

QueueServiceStatistics: object

serializedName

serializedName: string = "QueueServiceStatistics"

xmlName

xmlName: string = "StorageServiceStats"

type

type: object

className

className: string = "QueueServiceStatistics"

name

modelProperties

modelProperties: object

geoReplication

geoReplication: object

serializedName

serializedName: string = "GeoReplication"

xmlName

xmlName: string = "GeoReplication"

type

type: object

className

className: string = "GeoReplication"

name

Const QueueSetAccessPolicyExceptionHeaders

QueueSetAccessPolicyExceptionHeaders: object

serializedName

serializedName: string = "Queue_setAccessPolicyExceptionHeaders"

type

type: object

className

className: string = "QueueSetAccessPolicyExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const QueueSetAccessPolicyHeaders

QueueSetAccessPolicyHeaders: object

serializedName

serializedName: string = "Queue_setAccessPolicyHeaders"

type

type: object

className

className: string = "QueueSetAccessPolicyHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const QueueSetMetadataExceptionHeaders

QueueSetMetadataExceptionHeaders: object

serializedName

serializedName: string = "Queue_setMetadataExceptionHeaders"

type

type: object

className

className: string = "QueueSetMetadataExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const QueueSetMetadataHeaders

QueueSetMetadataHeaders: object

serializedName

serializedName: string = "Queue_setMetadataHeaders"

type

type: object

className

className: string = "QueueSetMetadataHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const RetentionPolicy

RetentionPolicy: object

serializedName

serializedName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

modelProperties

modelProperties: object

days

days: object

serializedName

serializedName: string = "Days"

xmlName

xmlName: string = "Days"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

enabled

enabled: object

required

required: boolean = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

Const ServiceGetPropertiesExceptionHeaders

ServiceGetPropertiesExceptionHeaders: object

serializedName

serializedName: string = "Service_getPropertiesExceptionHeaders"

type

type: object

className

className: string = "ServiceGetPropertiesExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const ServiceGetPropertiesHeaders

ServiceGetPropertiesHeaders: object

serializedName

serializedName: string = "Service_getPropertiesHeaders"

type

type: object

className

className: string = "ServiceGetPropertiesHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const ServiceGetStatisticsExceptionHeaders

ServiceGetStatisticsExceptionHeaders: object

serializedName

serializedName: string = "Service_getStatisticsExceptionHeaders"

type

type: object

className

className: string = "ServiceGetStatisticsExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const ServiceGetStatisticsHeaders

ServiceGetStatisticsHeaders: object

serializedName

serializedName: string = "Service_getStatisticsHeaders"

type

type: object

className

className: string = "ServiceGetStatisticsHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const ServiceListQueuesSegmentExceptionHeaders

ServiceListQueuesSegmentExceptionHeaders: object

serializedName

serializedName: string = "Service_listQueuesSegmentExceptionHeaders"

type

type: object

className

className: string = "ServiceListQueuesSegmentExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const ServiceListQueuesSegmentHeaders

ServiceListQueuesSegmentHeaders: object

serializedName

serializedName: string = "Service_listQueuesSegmentHeaders"

type

type: object

className

className: string = "ServiceListQueuesSegmentHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const ServiceSetPropertiesExceptionHeaders

ServiceSetPropertiesExceptionHeaders: object

serializedName

serializedName: string = "Service_setPropertiesExceptionHeaders"

type

type: object

className

className: string = "ServiceSetPropertiesExceptionHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const ServiceSetPropertiesHeaders

ServiceSetPropertiesHeaders: object

serializedName

serializedName: string = "Service_setPropertiesHeaders"

type

type: object

className

className: string = "ServiceSetPropertiesHeaders"

name

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

Const SignedIdentifier

SignedIdentifier: object

serializedName

serializedName: string = "SignedIdentifier"

type

type: object

className

className: string = "SignedIdentifier"

name

modelProperties

modelProperties: object

accessPolicy

accessPolicy: object

serializedName

serializedName: string = "AccessPolicy"

xmlName

xmlName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "Id"

xmlName

xmlName: string = "Id"

type

type: object

name

Const StorageError

StorageError: object

serializedName

serializedName: string = "StorageError"

type

type: object

className

className: string = "StorageError"

name

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "Code"

xmlName

xmlName: string = "Code"

type

type: object

name

message

message: object

serializedName

serializedName: string = "Message"

xmlName

xmlName: string = "Message"

type

type: object

name

Const URLConstants

URLConstants: object

Parameters

Parameters: object

FORCE_BROWSER_NO_CACHE

FORCE_BROWSER_NO_CACHE: string = "_"

SIGNATURE

SIGNATURE: string = "sig"

TIMEOUT

TIMEOUT: string = "timeout"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/xml"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

Const accept1

accept1: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/xml"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

Const comp

comp: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "properties"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp1

comp1: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "stats"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp2

comp2: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "list"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp3

comp3: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "metadata"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp4

comp4: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "acl"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/xml"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

Const include

include: object

collectionFormat

collectionFormat: any = QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options", "include"]

mapper

mapper: object

serializedName

serializedName: string = "include"

xmlElementName

xmlElementName: string = "ListQueuesIncludeType"

xmlName

xmlName: string = "include"

type

type: object

name

element

element: object

defaultValue

defaultValue: string = "metadata"

isConstant

isConstant: boolean = true

type

type: object

name

Const marker

marker: object

parameterPath

parameterPath: string[] = ["options", "marker"]

mapper

mapper: object

serializedName

serializedName: string = "marker"

xmlName

xmlName: string = "marker"

type

type: object

name

Const maxPageSize

maxPageSize: object

parameterPath

parameterPath: string[] = ["options", "maxPageSize"]

mapper

mapper: object

serializedName

serializedName: string = "maxresults"

xmlName

xmlName: string = "maxresults"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const messageTimeToLive

messageTimeToLive: object

parameterPath

parameterPath: string[] = ["options", "messageTimeToLive"]

mapper

mapper: object

serializedName

serializedName: string = "messagettl"

xmlName

xmlName: string = "messagettl"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = -1

type

type: object

name

Const metadata

metadata: object

parameterPath

parameterPath: string[] = ["options", "metadata"]

mapper

mapper: object

headerCollectionPrefix

headerCollectionPrefix: string = "x-ms-meta-"

serializedName

serializedName: string = "x-ms-meta"

xmlName

xmlName: string = "x-ms-meta"

type

type: object

name

value

value: object

type

type: object

name

Const numberOfMessages

numberOfMessages: object

parameterPath

parameterPath: string[] = ["options", "numberOfMessages"]

mapper

mapper: object

serializedName

serializedName: string = "numofmessages"

xmlName

xmlName: string = "numofmessages"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const peekonly

peekonly: object

parameterPath

parameterPath: string = "peekonly"

mapper

mapper: object

defaultValue

defaultValue: string = "true"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "peekonly"

type

type: object

name

Const popReceipt

popReceipt: object

parameterPath

parameterPath: string = "popReceipt"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "popreceipt"

xmlName

xmlName: string = "popreceipt"

type

type: object

name

Const prefix

prefix: object

parameterPath

parameterPath: string[] = ["options", "prefix"]

mapper

mapper: object

serializedName

serializedName: string = "prefix"

xmlName

xmlName: string = "prefix"

type

type: object

name

Const properties

properties: object

mapper

mapper: any = QueueServicePropertiesMapper

parameterPath

parameterPath: string = "properties"

Const queueAcl

queueAcl: object

parameterPath

parameterPath: string[] = ["options", "queueAcl"]

mapper

mapper: object

serializedName

serializedName: string = "queueAcl"

xmlElementName

xmlElementName: string = "SignedIdentifier"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "SignedIdentifiers"

type

type: object

name

element

element: object

type

type: object

className

className: string = "SignedIdentifier"

name

Const queueMessage

queueMessage: object

mapper

mapper: any = QueueMessageMapper

parameterPath

parameterPath: string = "queueMessage"

Const queueMessage1

queueMessage1: object

mapper

mapper: any = QueueMessageMapper

parameterPath

parameterPath: string[] = ["options", "queueMessage"]

Const requestId

requestId: object

parameterPath

parameterPath: string[] = ["options", "requestId"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

Const restype

restype: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "service"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "restype"

type

type: object

name

Const timeoutInSeconds

timeoutInSeconds: object

parameterPath

parameterPath: string[] = ["options", "timeoutInSeconds"]

mapper

mapper: object

serializedName

serializedName: string = "timeout"

xmlName

xmlName: string = "timeout"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const url

url: object

parameterPath

parameterPath: string = "url"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "url"

xmlName

xmlName: string = "url"

type

type: object

name

Const version

version: object

parameterPath

parameterPath: string = "version"

mapper

mapper: object

defaultValue

defaultValue: string = "2020-12-06"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

Const visibilityTimeout

visibilityTimeout: object

parameterPath

parameterPath: string[] = ["options", "visibilityTimeout"]

mapper

mapper: object

serializedName

serializedName: string = "visibilitytimeout"

xmlName

xmlName: string = "visibilitytimeout"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 604800

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const visibilityTimeout1

visibilityTimeout1: object

parameterPath

parameterPath: string = "visibilityTimeout"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "visibilitytimeout"

xmlName

xmlName: string = "visibilitytimeout"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 604800

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CredentialPolicyCreator

Type declaration

Parameters

nextPolicy: RequestPolicy

options: RequestPolicyOptions

Returns CredentialPolicy

GeoReplicationStatusType

ListQueuesIncludeType

MessageIdDeleteResponse

MessageIdUpdateResponse

MessagesClearResponse

MessagesDequeueResponse

MessagesEnqueueResponse

MessagesPeekResponse

QueueClearMessagesResponse

QueueCreateResponse

QueueDeleteMessageResponse

QueueDeleteResponse

QueueGetAccessPolicyResponse

QueueGetPropertiesResponse

QueuePeekMessagesResponse

QueueReceiveMessageResponse

QueueSendMessageResponse

QueueSetAccessPolicyResponse

QueueSetMetadataResponse

QueueUpdateMessageResponse

ReceivedMessageItem

ServiceGetPropertiesResponse

ServiceGetStatisticsResponse

ServiceListQueuesSegmentResponse

ServiceSetPropertiesResponse

StorageErrorCode

Know values supported by the service

Variables

Const DevelopmentConnectionString

Const ETagAny

Const ETagNone

Const RETRY_ABORT_ERROR

Const SDK_VERSION

Const SERVICE_VERSION

Const StorageOAuthScopes

Const StorageQueueLoggingAllowedHeaderNames

Const StorageQueueLoggingAllowedQueryParameters

Const _defaultHttpClient

Const createSpan

Const logger

Const packageName

Const packageVersion

Functions

NewRetryPolicyFactory

Parameters

Optional retryOptions: StorageRetryOptions

Returns RequestPolicyFactory

appendToURLPath

Parameters

url: string

name: string

Returns string

appendToURLQuery

Parameters

url: string

queryParts: string

Returns string

convertTracingToRequestOptionsBase

Parameters

Optional options: OperationOptions

Returns Pick<RequestOptionsBase, "spanOptions" | "tracingContext">

delay

Parameters

timeInMs: number

Optional aborter: AbortSignalLike