Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/storage-queue

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CredentialPolicyCreator

CredentialPolicyCreator: function

Type declaration

    • Parameters

      • nextPolicy: RequestPolicy
      • options: RequestPolicyOptions

      Returns CredentialPolicy

GeoReplicationStatusType

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

ListQueuesIncludeType

ListQueuesIncludeType: "metadata"

MessageIdDeleteResponse

MessageIdDeleteResponse: MessageIdDeleteHeaders & object

MessageIdUpdateResponse

MessageIdUpdateResponse: MessageIdUpdateHeaders & object

MessagesClearResponse

MessagesClearResponse: MessagesClearHeaders & object

MessagesDequeueResponse

MessagesDequeueResponse: Array<DequeuedMessageItem> & MessagesDequeueHeaders & object

MessagesEnqueueResponse

MessagesEnqueueResponse: Array<EnqueuedMessage> & MessagesEnqueueHeaders & object

MessagesPeekResponse

MessagesPeekResponse: Array<PeekedMessageItem> & MessagesPeekHeaders & object

QueueClearMessagesResponse

QueueClearMessagesResponse: MessagesClearResponse

QueueCreateResponse

QueueCreateResponse: QueueCreateHeaders & object

QueueDeleteMessageResponse

QueueDeleteMessageResponse: MessageIdDeleteResponse

QueueDeleteResponse

QueueDeleteResponse: QueueDeleteHeaders & object

QueueGetAccessPolicyResponse

QueueGetAccessPolicyResponse: object & QueueGetAccessPolicyHeaders & object

QueueGetPropertiesResponse

QueueGetPropertiesResponse: QueueGetPropertiesHeaders & object

QueuePeekMessagesResponse

QueuePeekMessagesResponse: object & MessagesPeekHeaders & object

QueueReceiveMessageResponse

QueueReceiveMessageResponse: object & MessagesDequeueHeaders & object

QueueSendMessageResponse

QueueSendMessageResponse: object & MessagesEnqueueHeaders & object

QueueSetAccessPolicyResponse

QueueSetAccessPolicyResponse: QueueSetAccessPolicyHeaders & object

QueueSetMetadataResponse

QueueSetMetadataResponse: QueueSetMetadataHeaders & object

QueueUpdateMessageResponse

QueueUpdateMessageResponse: MessageIdUpdateResponse

ReceivedMessageItem

ReceivedMessageItem: DequeuedMessageItem

ServiceGetPropertiesResponse

ServiceGetPropertiesResponse: QueueServiceProperties & ServiceGetPropertiesHeaders & object

ServiceGetStatisticsResponse

ServiceGetStatisticsResponse: QueueServiceStatistics & ServiceGetStatisticsHeaders & object

ServiceListQueuesSegmentResponse

ServiceListQueuesSegmentResponse: ListQueuesSegmentResponse & ServiceListQueuesSegmentHeaders & object

ServiceSetPropertiesResponse

ServiceSetPropertiesResponse: ServiceSetPropertiesHeaders & object

StorageErrorCode

StorageErrorCode: "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 SDK_VERSION

SDK_VERSION: string = "12.0.2"

Const SERVICE_VERSION

SERVICE_VERSION: string = "2019-02-02"

Const StorageOAuthScopes

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

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 logger

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

Functions

NewRetryPolicyFactory

appendToURLPath

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

createSpan

delay

  • delay(timeInMs: number, aborter: AbortSignalLike, abortError: Error): Promise<unknown>
  • Parameters

    • timeInMs: number
    • Optional aborter: AbortSignalLike
    • Optional abortError: Error

    Returns Promise<unknown>

extractConnectionStringParts

generateAccountSASQueryParameters

generateQueueSASQueryParameters

getAccountNameFromUrl

  • getAccountNameFromUrl(url: string): string

getCachedDefaultHttpClient

  • getCachedDefaultHttpClient(): any

getStorageClientContext

getURLParameter

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

    • url: string
    • name: string

    Returns string | string[] | undefined

    Parameter value(s) for the given parameter name.

getURLPath

  • getURLPath(url: string): string | undefined
  • Parameters

    • url: string

    Returns string | undefined

    The path part of the given URL string.

getURLQueries

  • getURLQueries(url: string): object
  • Parameters

    • url: string

    Returns object

    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
  • Parameters

    • connectionString: string
    • argument: "QueueEndpoint" | "AccountName" | "AccountKey" | "DefaultEndpointsProtocol" | "EndpointSuffix" | "SharedAccessSignature"

    Returns string

    Value of the property specified in argument.

ipRangeToString

newPipeline

padStart

  • padStart(currentString: string, targetLength: number, padString?: string): string
  • Parameters

    • currentString: string
    • targetLength: number
    • Default value padString: string = " "

    Returns string

sanitizeHeaders

  • sanitizeHeaders(originalHeader: HttpHeaders): HttpHeaders

sanitizeURL

  • sanitizeURL(url: string): string

setURLHost

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

setURLParameter

  • setURLParameter(url: string, name: string, value: undefined | string): string
  • Parameters

    • url: string
    • name: string
    • Optional value: undefined | string

    Returns string

    An updated URL string

truncatedISO8061Date

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

    • date: Date
    • Default value withMilliseconds: boolean = true

    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

name: string = "Composite"

modelProperties

modelProperties: object

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "Expiry"

xmlName

xmlName: string = "Expiry"

type

type: object

name

name: string = "String"

permissions

permissions: object

required

required: boolean = true

serializedName

serializedName: string = "Permission"

xmlName

xmlName: string = "Permission"

type

type: object

name

name: string = "String"

startsOn

startsOn: object

required

required: boolean = true

serializedName

serializedName: string = "Start"

xmlName

xmlName: string = "Start"

type

type: object

name

name: string = "String"

Const CorsRule

CorsRule: object

serializedName

serializedName: string = "CorsRule"

type

type: object

className

className: string = "CorsRule"

name

name: string = "Composite"

modelProperties

modelProperties: object

allowedHeaders

allowedHeaders: object

required

required: boolean = true

serializedName

serializedName: string = "AllowedHeaders"

xmlName

xmlName: string = "AllowedHeaders"

type

type: object

name

name: string = "String"

allowedMethods

allowedMethods: object

required

required: boolean = true

serializedName

serializedName: string = "AllowedMethods"

xmlName

xmlName: string = "AllowedMethods"

type

type: object

name

name: string = "String"

allowedOrigins

allowedOrigins: object

required

required: boolean = true

serializedName

serializedName: string = "AllowedOrigins"

xmlName

xmlName: string = "AllowedOrigins"

type

type: object

name

name: string = "String"

exposedHeaders

exposedHeaders: object

required

required: boolean = true

serializedName

serializedName: string = "ExposedHeaders"

xmlName

xmlName: string = "ExposedHeaders"

type

type: object

name

name: string = "String"

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

name: string = "Number"

Const DequeuedMessageItem

DequeuedMessageItem: object

serializedName

serializedName: string = "DequeuedMessageItem"

xmlName

xmlName: string = "QueueMessage"

type

type: object

className

className: string = "DequeuedMessageItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

dequeueCount

dequeueCount: object

required

required: boolean = true

serializedName

serializedName: string = "DequeueCount"

xmlName

xmlName: string = "DequeueCount"

type

type: object

name

name: string = "Number"

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "ExpirationTime"

xmlName

xmlName: string = "ExpirationTime"

type

type: object

name

name: string = "DateTimeRfc1123"

insertedOn

insertedOn: object

required

required: boolean = true

serializedName

serializedName: string = "InsertionTime"

xmlName

xmlName: string = "InsertionTime"

type

type: object

name

name: string = "DateTimeRfc1123"

messageId

messageId: object

required

required: boolean = true

serializedName

serializedName: string = "MessageId"

xmlName

xmlName: string = "MessageId"

type

type: object

name

name: string = "String"

messageText

messageText: object

required

required: boolean = true

serializedName

serializedName: string = "MessageText"

xmlName

xmlName: string = "MessageText"

type

type: object

name

name: string = "String"

nextVisibleOn

nextVisibleOn: object

required

required: boolean = true

serializedName

serializedName: string = "TimeNextVisible"

xmlName

xmlName: string = "TimeNextVisible"

type

type: object

name

name: string = "DateTimeRfc1123"

popReceipt

popReceipt: object

required

required: boolean = true

serializedName

serializedName: string = "PopReceipt"

xmlName

xmlName: string = "PopReceipt"

type

type: object

name

name: string = "String"

Const EnqueuedMessage

EnqueuedMessage: object

serializedName

serializedName: string = "EnqueuedMessage"

xmlName

xmlName: string = "QueueMessage"

type

type: object

className

className: string = "EnqueuedMessage"

name

name: string = "Composite"

modelProperties

modelProperties: object

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "ExpirationTime"

xmlName

xmlName: string = "ExpirationTime"

type

type: object

name

name: string = "DateTimeRfc1123"

insertedOn

insertedOn: object

required

required: boolean = true

serializedName

serializedName: string = "InsertionTime"

xmlName

xmlName: string = "InsertionTime"

type

type: object

name

name: string = "DateTimeRfc1123"

messageId

messageId: object

required

required: boolean = true

serializedName

serializedName: string = "MessageId"

xmlName

xmlName: string = "MessageId"

type

type: object

name

name: string = "String"

nextVisibleOn

nextVisibleOn: object

required

required: boolean = true

serializedName

serializedName: string = "TimeNextVisible"

xmlName

xmlName: string = "TimeNextVisible"

type

type: object

name

name: string = "DateTimeRfc1123"

popReceipt

popReceipt: object

required

required: boolean = true

serializedName

serializedName: string = "PopReceipt"

xmlName

xmlName: string = "PopReceipt"

type

type: object

name

name: string = "String"

Const GeoReplication

GeoReplication: object

serializedName

serializedName: string = "GeoReplication"

type

type: object

className

className: string = "GeoReplication"

name

name: string = "Composite"

modelProperties

modelProperties: object

lastSyncOn

lastSyncOn: object

required

required: boolean = true

serializedName

serializedName: string = "LastSyncTime"

xmlName

xmlName: string = "LastSyncTime"

type

type: object

name

name: string = "DateTimeRfc1123"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "Status"

xmlName

xmlName: string = "Status"

type

type: object

name

name: string = "String"

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

name: string = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

required

required: boolean = true

serializedName

serializedName: string = "NextMarker"

xmlName

xmlName: string = "NextMarker"

type

type: object

name

name: string = "String"

marker

marker: object

serializedName

serializedName: string = "Marker"

xmlName

xmlName: string = "Marker"

type

type: object

name

name: string = "String"

maxPageSize

maxPageSize: object

required

required: boolean = true

serializedName

serializedName: string = "MaxResults"

xmlName

xmlName: string = "MaxResults"

type

type: object

name

name: string = "Number"

prefix

prefix: object

required

required: boolean = true

serializedName

serializedName: string = "Prefix"

xmlName

xmlName: string = "Prefix"

type

type: object

name

name: string = "String"

queueItems

queueItems: object

serializedName

serializedName: string = "QueueItems"

xmlElementName

xmlElementName: string = "Queue"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "Queues"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "QueueItem"

name

name: string = "Composite"

serviceEndpoint

serviceEndpoint: object

required

required: boolean = true

serializedName

serializedName: string = "ServiceEndpoint"

xmlIsAttribute

xmlIsAttribute: boolean = true

xmlName

xmlName: string = "ServiceEndpoint"

type

type: object

name

name: string = "String"

Const Logging

Logging: object

serializedName

serializedName: string = "Logging"

type

type: object

className

className: string = "Logging"

name

name: string = "Composite"

modelProperties

modelProperties: object

deleteProperty

deleteProperty: object

required

required: boolean = true

serializedName

serializedName: string = "Delete"

xmlName

xmlName: string = "Delete"

type

type: object

name

name: string = "Boolean"

read

read: object

required

required: boolean = true

serializedName

serializedName: string = "Read"

xmlName

xmlName: string = "Read"

type

type: object

name

name: string = "Boolean"

retentionPolicy

retentionPolicy: object

required

required: boolean = true

serializedName

serializedName: string = "RetentionPolicy"

xmlName

xmlName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: string = "Composite"

version

version: object

required

required: boolean = true

serializedName

serializedName: string = "Version"

xmlName

xmlName: string = "Version"

type

type: object

name

name: string = "String"

write

write: object

required

required: boolean = true

serializedName

serializedName: string = "Write"

xmlName

xmlName: string = "Write"

type

type: object

name

name: string = "Boolean"

Const MessageIdDeleteHeaders

MessageIdDeleteHeaders: object

serializedName

serializedName: string = "messageid-delete-headers"

type

type: object

className

className: string = "MessageIdDeleteHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const MessageIdUpdateHeaders

MessageIdUpdateHeaders: object

serializedName

serializedName: string = "messageid-update-headers"

type

type: object

className

className: string = "MessageIdUpdateHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

nextVisibleOn

nextVisibleOn: object

serializedName

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

type

type: object

name

name: string = "DateTimeRfc1123"

popReceipt

popReceipt: object

serializedName

serializedName: string = "x-ms-popreceipt"

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const MessagesClearHeaders

MessagesClearHeaders: object

serializedName

serializedName: string = "messages-clear-headers"

type

type: object

className

className: string = "MessagesClearHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const MessagesDequeueHeaders

MessagesDequeueHeaders: object

serializedName

serializedName: string = "messages-dequeue-headers"

type

type: object

className

className: string = "MessagesDequeueHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const MessagesEnqueueHeaders

MessagesEnqueueHeaders: object

serializedName

serializedName: string = "messages-enqueue-headers"

type

type: object

className

className: string = "MessagesEnqueueHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const MessagesPeekHeaders

MessagesPeekHeaders: object

serializedName

serializedName: string = "messages-peek-headers"

type

type: object

className

className: string = "MessagesPeekHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const Metrics

Metrics: object

serializedName

serializedName: string = "Metrics"

type

type: object

className

className: string = "Metrics"

name

name: string = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

required

required: boolean = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

name: string = "Boolean"

includeAPIs

includeAPIs: object

serializedName

serializedName: string = "IncludeAPIs"

xmlName

xmlName: string = "IncludeAPIs"

type

type: object

name

name: string = "Boolean"

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "RetentionPolicy"

xmlName

xmlName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: string = "Composite"

version

version: object

serializedName

serializedName: string = "Version"

xmlName

xmlName: string = "Version"

type

type: object

name

name: string = "String"

Const PeekedMessageItem

PeekedMessageItem: object

serializedName

serializedName: string = "PeekedMessageItem"

xmlName

xmlName: string = "QueueMessage"

type

type: object

className

className: string = "PeekedMessageItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

dequeueCount

dequeueCount: object

required

required: boolean = true

serializedName

serializedName: string = "DequeueCount"

xmlName

xmlName: string = "DequeueCount"

type

type: object

name

name: string = "Number"

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "ExpirationTime"

xmlName

xmlName: string = "ExpirationTime"

type

type: object

name

name: string = "DateTimeRfc1123"

insertedOn

insertedOn: object

required

required: boolean = true

serializedName

serializedName: string = "InsertionTime"

xmlName

xmlName: string = "InsertionTime"

type

type: object

name

name: string = "DateTimeRfc1123"

messageId

messageId: object

required

required: boolean = true

serializedName

serializedName: string = "MessageId"

xmlName

xmlName: string = "MessageId"

type

type: object

name

name: string = "String"

messageText

messageText: object

required

required: boolean = true

serializedName

serializedName: string = "MessageText"

xmlName

xmlName: string = "MessageText"

type

type: object

name

name: string = "String"

Const QueueCreateHeaders

QueueCreateHeaders: object

serializedName

serializedName: string = "queue-create-headers"

type

type: object

className

className: string = "QueueCreateHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const QueueDeleteHeaders

QueueDeleteHeaders: object

serializedName

serializedName: string = "queue-delete-headers"

type

type: object

className

className: string = "QueueDeleteHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const QueueGetAccessPolicyHeaders

QueueGetAccessPolicyHeaders: object

serializedName

serializedName: string = "queue-getaccesspolicy-headers"

type

type: object

className

className: string = "QueueGetAccessPolicyHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const QueueGetPropertiesHeaders

QueueGetPropertiesHeaders: object

serializedName

serializedName: string = "queue-getproperties-headers"

type

type: object

className

className: string = "QueueGetPropertiesHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

approximateMessagesCount

approximateMessagesCount: object

serializedName

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

type

type: object

name

name: string = "Number"

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

metadata

metadata: object

headerCollectionPrefix

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

serializedName

serializedName: string = "x-ms-meta"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const QueueItem

QueueItem: object

serializedName

serializedName: string = "QueueItem"

xmlName

xmlName: string = "Queue"

type

type: object

className

className: string = "QueueItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

metadata

metadata: object

serializedName

serializedName: string = "Metadata"

xmlName

xmlName: string = "Metadata"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

name: string = "String"

Const QueueMessage

QueueMessage: object

serializedName

serializedName: string = "QueueMessage"

type

type: object

className

className: string = "QueueMessage"

name

name: string = "Composite"

modelProperties

modelProperties: object

messageText

messageText: object

required

required: boolean = true

serializedName

serializedName: string = "MessageText"

xmlName

xmlName: string = "MessageText"

type

type: object

name

name: string = "String"

Const QueueServiceProperties

QueueServiceProperties: object

serializedName

serializedName: string = "QueueServiceProperties"

xmlName

xmlName: string = "StorageServiceProperties"

type

type: object

className

className: string = "QueueServiceProperties"

name

name: string = "Composite"

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

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CorsRule"

name

name: string = "Composite"

hourMetrics

hourMetrics: object

serializedName

serializedName: string = "HourMetrics"

xmlName

xmlName: string = "HourMetrics"

type

type: object

className

className: string = "Metrics"

name

name: string = "Composite"

minuteMetrics

minuteMetrics: object

serializedName

serializedName: string = "MinuteMetrics"

xmlName

xmlName: string = "MinuteMetrics"

type

type: object

className

className: string = "Metrics"

name

name: string = "Composite"

queueAnalyticsLogging

queueAnalyticsLogging: object

serializedName

serializedName: string = "Logging"

xmlName

xmlName: string = "Logging"

type

type: object

className

className: string = "Logging"

name

name: string = "Composite"

Const QueueServiceStatistics

QueueServiceStatistics: object

serializedName

serializedName: string = "QueueServiceStatistics"

xmlName

xmlName: string = "StorageServiceStats"

type

type: object

className

className: string = "QueueServiceStatistics"

name

name: string = "Composite"

modelProperties

modelProperties: object

geoReplication

geoReplication: object

serializedName

serializedName: string = "GeoReplication"

xmlName

xmlName: string = "GeoReplication"

type

type: object

className

className: string = "GeoReplication"

name

name: string = "Composite"

Const QueueSetAccessPolicyHeaders

QueueSetAccessPolicyHeaders: object

serializedName

serializedName: string = "queue-setaccesspolicy-headers"

type

type: object

className

className: string = "QueueSetAccessPolicyHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const QueueSetMetadataHeaders

QueueSetMetadataHeaders: object

serializedName

serializedName: string = "queue-setmetadata-headers"

type

type: object

className

className: string = "QueueSetMetadataHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const RetentionPolicy

RetentionPolicy: object

serializedName

serializedName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: string = "Composite"

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

name: string = "Number"

enabled

enabled: object

required

required: boolean = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

name: string = "Boolean"

Const ServiceGetPropertiesHeaders

ServiceGetPropertiesHeaders: object

serializedName

serializedName: string = "service-getproperties-headers"

type

type: object

className

className: string = "ServiceGetPropertiesHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const ServiceGetStatisticsHeaders

ServiceGetStatisticsHeaders: object

serializedName

serializedName: string = "service-getstatistics-headers"

type

type: object

className

className: string = "ServiceGetStatisticsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const ServiceListQueuesSegmentHeaders

ServiceListQueuesSegmentHeaders: object

serializedName

serializedName: string = "service-listqueuessegment-headers"

type

type: object

className

className: string = "ServiceListQueuesSegmentHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const ServiceSetPropertiesHeaders

ServiceSetPropertiesHeaders: object

serializedName

serializedName: string = "service-setproperties-headers"

type

type: object

className

className: string = "ServiceSetPropertiesHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

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

type

type: object

name

name: string = "String"

errorCode

errorCode: object

serializedName

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

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

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

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const SignedIdentifier

SignedIdentifier: object

serializedName

serializedName: string = "SignedIdentifier"

type

type: object

className

className: string = "SignedIdentifier"

name

name: string = "Composite"

modelProperties

modelProperties: object

accessPolicy

accessPolicy: object

required

required: boolean = true

serializedName

serializedName: string = "AccessPolicy"

xmlName

xmlName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "Id"

xmlName

xmlName: string = "Id"

type

type: object

name

name: string = "String"

Const StorageError

StorageError: object

serializedName

serializedName: string = "StorageError"

type

type: object

className

className: string = "StorageError"

name

name: string = "Composite"

modelProperties

modelProperties: object

message

message: object

serializedName

serializedName: string = "Message"

xmlName

xmlName: string = "Message"

type

type: object

name

name: string = "String"

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 comp0

comp0: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "properties"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: string = "String"

Const comp1

comp1: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "stats"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: string = "String"

Const comp2

comp2: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "list"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: string = "String"

Const comp3

comp3: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "metadata"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: string = "String"

Const comp4

comp4: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "acl"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: string = "String"

Const include

include: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "include"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["metadata"]

name

name: string = "Enum"

Const marker

marker: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "marker"

type

type: object

name

name: string = "String"

Const maxPageSize

maxPageSize: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const messageTimeToLive

messageTimeToLive: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "messagettl"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = -1

type

type: object

name

name: string = "Number"

Const metadata

metadata: object

parameterPath

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

mapper

mapper: object

headerCollectionPrefix

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

serializedName

serializedName: string = "x-ms-meta"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const numberOfMessages

numberOfMessages: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "numofmessages"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const peekonly

peekonly: object

parameterPath

parameterPath: string = "peekonly"

mapper

mapper: object

defaultValue

defaultValue: string = "true"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "peekonly"

type

type: object

name

name: string = "String"

Const popReceipt

popReceipt: object

parameterPath

parameterPath: string = "popReceipt"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "popreceipt"

type

type: object

name

name: string = "String"

Const prefix

prefix: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "prefix"

type

type: object

name

name: string = "String"

Const requestId

requestId: object

parameterPath

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

mapper

mapper: object

serializedName

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

type

type: object

name

name: string = "String"

Const restype

restype: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "service"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "restype"

type

type: object

name

name: string = "String"

Const timeoutInSeconds

timeoutInSeconds: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "timeout"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

Const url

url: object

parameterPath

parameterPath: string = "url"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: boolean = true

serializedName

serializedName: string = "url"

type

type: object

name

name: string = "String"

Const version

version: object

parameterPath

parameterPath: string = "version"

mapper

mapper: object

defaultValue

defaultValue: string = "2019-02-02"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const visibilityTimeout0

visibilityTimeout0: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "visibilitytimeout"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 604800

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

Const visibilityTimeout1

visibilityTimeout1: object

parameterPath

parameterPath: string = "visibilityTimeout"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "visibilitytimeout"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 604800

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

Generated using TypeDoc