Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/storage-queue

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Authenticator

Authenticator: function

Type declaration

    • (challenge: object): Promise<string>

    • Parameters

      • challenge: object

      Returns Promise<string>

AzureClientLogger

AzureClientLogger: Debugger

An AzureClientLogger is a function that can log to an appropriate severity level.

AzureLogLevel

AzureLogLevel: "verbose" | "info" | "warning" | "error"

The log levels supported by the logger. The log levels in order of most verbose to least verbose are:

  • verbose
  • info
  • warning
  • error

CredentialPolicyCreator

CredentialPolicyCreator: function

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

Type declaration

GeoReplicationStatusType

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

Defines values for GeoReplicationStatusType. Possible values include: 'live', 'bootstrap', 'unavailable'

readonly
enum

{string}

HrTime

HrTime: [number, number]

High resolution HrTime: [seconds: number, nanoseconds: number]

HttpMethods

HttpMethods: "GET" | "PUT" | "POST" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE"

HttpRequestBody

HttpRequestBody: Blob | string | ArrayBuffer | ArrayBufferView | function

ListQueuesIncludeType

ListQueuesIncludeType: "metadata"

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

readonly
enum

{string}

Mapper

Mapper: BaseMapper | CompositeMapper | SequenceMapper | DictionaryMapper | EnumMapper

MapperType

MapperType: SimpleMapperType | CompositeMapperType | SequenceMapperType | DictionaryMapperType | EnumMapperType

MessageIdDeleteResponse

MessageIdDeleteResponse: MessageIdDeleteHeaders & object

Contains response data for the deleteMethod operation.

MessageIdUpdateResponse

MessageIdUpdateResponse: MessageIdUpdateHeaders & object

Contains response data for the update operation.

MessagesClearResponse

MessagesClearResponse: MessagesClearHeaders & object

Contains response data for the clear operation.

MessagesDequeueResponse

MessagesDequeueResponse: Array<DequeuedMessageItem> & MessagesDequeueHeaders & object

Contains response data for the dequeue operation.

MessagesEnqueueResponse

MessagesEnqueueResponse: Array<EnqueuedMessage> & MessagesEnqueueHeaders & object

Contains response data for the enqueue operation.

MessagesPeekResponse

MessagesPeekResponse: Array<PeekedMessageItem> & MessagesPeekHeaders & object

Contains response data for the peek operation.

ParameterPath

ParameterPath: string | string[] | object

PropertyParent

PropertyParent: object

Type declaration

  • [propertyName: string]: any

ProxyOptions

ProxyOptions: ProxySettings

QueueClearMessagesResponse

QueueClearMessagesResponse: MessagesClearResponse

Contains response data for the QueueClient.clearMessages operation.

QueueCreateResponse

QueueCreateResponse: QueueCreateHeaders & object

Contains response data for the create operation.

QueueDeleteMessageResponse

QueueDeleteMessageResponse: MessageIdDeleteResponse

Contains response data for the QueueClient.deleteMessage operation.

QueueDeleteResponse

QueueDeleteResponse: QueueDeleteHeaders & object

Contains response data for the deleteMethod operation.

QueueGetAccessPolicyResponse

QueueGetAccessPolicyResponse: object & QueueGetAccessPolicyHeaders & object

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

QueueGetPropertiesResponse

QueueGetPropertiesResponse: QueueGetPropertiesHeaders & object

Contains response data for the getProperties operation.

QueuePeekMessagesResponse

QueuePeekMessagesResponse: object & MessagesPeekHeaders & object

Contains the response data for the QueueClient.peekMessages operation.

QueueReceiveMessageResponse

QueueReceiveMessageResponse: object & MessagesDequeueHeaders & object

Contains the response data for the QueueClient.receiveMessages operation.

QueueSendMessageResponse

QueueSendMessageResponse: object & MessagesEnqueueHeaders & object

Contains the response data for the QueueClient.sendMessage operation.

QueueSetAccessPolicyResponse

QueueSetAccessPolicyResponse: QueueSetAccessPolicyHeaders & object

Contains response data for the setAccessPolicy operation.

QueueSetMetadataResponse

QueueSetMetadataResponse: QueueSetMetadataHeaders & object

Contains response data for the setMetadata operation.

QueueUpdateMessageResponse

QueueUpdateMessageResponse: MessageIdUpdateResponse

Contains response data for the QueueClient.updateMessage operation.

RawHttpHeaders

RawHttpHeaders: object

A HttpHeaders collection represented as a simple JSON object.

Type declaration

  • [headerName: string]: string

ReceivedMessageItem

ReceivedMessageItem: DequeuedMessageItem

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

See: QueueReceiveMessageResponse

RequestPolicyFactory

RequestPolicyFactory: object

Creates a new RequestPolicy per-request that uses the provided nextPolicy.

Type declaration

ServiceGetPropertiesResponse

ServiceGetPropertiesResponse: QueueServiceProperties & ServiceGetPropertiesHeaders & object

Contains response data for the getProperties operation.

ServiceGetStatisticsResponse

ServiceGetStatisticsResponse: QueueServiceStatistics & ServiceGetStatisticsHeaders & object

Contains response data for the getStatistics operation.

ServiceListQueuesSegmentResponse

ServiceListQueuesSegmentResponse: ListQueuesSegmentResponse & ServiceListQueuesSegmentHeaders & object

Contains response data for the listQueuesSegment operation.

ServiceSetPropertiesResponse

ServiceSetPropertiesResponse: ServiceSetPropertiesHeaders & object

Contains response data for the setProperties operation.

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"

Defines values for StorageErrorCode. Possible values include: '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'

readonly
enum

{string}

TelemetryInfo

TelemetryInfo: object

Type declaration

TimeInput

TimeInput: HrTime | number | Date

Defines TimeInput.

hrtime, expoch milliseconds, performance.now() or Date

TransferProgressEvent

TransferProgressEvent: object

Fired in response to upload or download progress.

Type declaration

Variables

Const AzureLogger

AzureLogger: AzureClientLogger

The AzureLogger provides a mechanism for overriding where logs are output to. By default, logs are sent to stderr. Override the log method to redirect logs to another location.

Const Constants

Constants: object

Type declaration

Const DefaultDeserializationOptions

DefaultDeserializationOptions: DeserializationOptions

Const DefaultKeepAliveOptions

DefaultKeepAliveOptions: KeepAliveOptions

Const DefaultRedirectOptions

DefaultRedirectOptions: RedirectOptions

Const DefaultRetryOptions

DefaultRetryOptions: RetryOptions

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 MapperType

MapperType: object

Type declaration

Const SDK_VERSION

SDK_VERSION: string = "12.0.0"

Const SERVICE_VERSION

SERVICE_VERSION: string = "2019-02-02"

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 TokenRefreshBufferMs

TokenRefreshBufferMs: number

Defines the default token refresh buffer duration.

Const defaultJsonContentTypes

defaultJsonContentTypes: string[]

Const defaultXmlContentTypes

defaultXmlContentTypes: string[]

Const getDefaultUserAgentHeaderName

getDefaultUserAgentHeaderName: getDefaultUserAgentKey

Const isNode

isNode: boolean

A constant that indicates whether the environment is node.js or browser based.

Const logger

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

The @azure/logger configuration for this package.

Functions

NewRetryPolicyFactory

appendToURLPath

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

  • Append a string to URL path. Will remove duplicated "/" in front of the string when URL path ends with a "/".

    export

    Parameters

    • url: string

      Source URL string

    • name: string

      String to be appended to URL

    Returns string

    An updated URL string

applyMixins

  • applyMixins(targetCtor: any, sourceCtors: any[]): void

  • Applies the properties on the prototype of sourceCtors to the prototype of targetCtor

    Parameters

    • targetCtor: any

      The target object on which the properties need to be applied.

    • sourceCtors: any[]

      An array of source objects from which the properties need to be taken.

    Returns void

bearerTokenAuthenticationPolicy

  • Creates a new BearerTokenAuthenticationPolicy factory.

    Parameters

    • credential: TokenCredential

      The TokenCredential implementation that can supply the bearer token.

    • scopes: string | string[]

      The scopes for which the bearer token applies.

    Returns RequestPolicyFactory

createPipelineFromOptions

createSpan

  • createSpan(operationName: string, tracingOptions?: OperationTracingOptions): object

  • Creates a span using the global tracer.

    Parameters

    • operationName: string

      The name of the operation being performed.

    • Default value tracingOptions: OperationTracingOptions = {}

    Returns object

delay

  • delay<T>(t: number, value?: T): Promise<T>

  • A wrapper for setTimeout that resolves a promise after t milliseconds.

    Type parameters

    • T

    Parameters

    • t: number

      The number of milliseconds to be delayed.

    • Optional value: T

      The value to be resolved with after a timeout of t milliseconds.

    Returns Promise<T>

    Resolved promise

deserializationPolicy

  • Create a new serialization RequestPolicyCreator that will serialized HTTP request bodies as they pass through the HTTP pipeline.

    Parameters

    Returns RequestPolicyFactory

deserializeResponseBody

encodeUri

  • encodeUri(uri: string): string

  • Encodes an URI.

    Parameters

    • uri: string

      The URI to be encoded.

    Returns string

    The encoded URI.

executePromisesSequentially

  • executePromisesSequentially(promiseFactories: Array<any>, kickstart: any): Promise<any>

  • Executes an array of promises sequentially. Inspiration of this method is here: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. An awesome blog on promises!

    Parameters

    • promiseFactories: Array<any>

      An array of promise factories(A function that return a promise)

    • kickstart: any

    Returns Promise<any>

    A chain of resolved or rejected promises

exponentialRetryPolicy

  • exponentialRetryPolicy(retryCount?: undefined | number, retryInterval?: undefined | number, maxRetryInterval?: undefined | number): RequestPolicyFactory

  • Parameters

    • Optional retryCount: undefined | number
    • Optional retryInterval: undefined | number
    • Optional maxRetryInterval: undefined | number

    Returns RequestPolicyFactory

extractConnectionStringParts

extractSpanContextFromTraceParentHeader

  • extractSpanContextFromTraceParentHeader(traceParentHeader: string): SpanContext | undefined

  • Generates a SpanContext given a traceparent header value.

    Parameters

    • traceParentHeader: string

    Returns SpanContext | undefined

    The SpanContext generated from the traceparent value.

flattenResponse

generateAccountSASQueryParameters

generateClientRequestIdPolicy

  • Parameters

    • Optional requestIdHeaderName: undefined | string

    Returns RequestPolicyFactory

generateQueueSASQueryParameters

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

    export

    Parameters

    Returns SASQueryParameters

generateUuid

  • generateUuid(): string

  • Generated UUID

    Returns string

    RFC4122 v4 UUID.

getAccountNameFromUrl

  • getAccountNameFromUrl(url: string): string

getDefaultProxySettings

  • getDefaultProxySettings(proxyUrl?: undefined | string): ProxySettings | undefined

  • Parameters

    • Optional proxyUrl: undefined | string

    Returns ProxySettings | undefined

getDefaultUserAgentKey

  • getDefaultUserAgentKey(): string

  • Returns string

getDefaultUserAgentValue

  • getDefaultUserAgentValue(): string

  • Returns string

getLogLevel

  • getLogLevel(): "verbose" | "info" | "warning" | "error" | undefined

  • Retrieves the currently specified log level.

    Returns "verbose" | "info" | "warning" | "error" | undefined

getOperationArgumentValueFromParameterPath

getPathStringFromParameter

  • Get the path to this parameter's value as a dotted string (a.b.c).

    Parameters

    Returns string

    The path to this parameter's value as a dotted string.

getPathStringFromParameterPath

  • Parameters

    Returns string

getPlatformSpecificData

  • Returns TelemetryInfo[]

getPropertyParent

  • Get the property parent for the property at the provided path when starting with the provided parent object.

    Parameters

    Returns PropertyParent

getStorageClientContext

getTraceParentHeader

  • getTraceParentHeader(spanContext: SpanContext): string | undefined

  • Generates a traceparent value given a span context.

    Parameters

    • spanContext: SpanContext

      Contains context for a specific span.

    Returns string | undefined

    The spanContext represented as a traceparent value.

getTracer

  • Retrieves the active tracer, or returns a no-op implementation if one is not set.

    Returns Tracer

getURLParameter

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

getURLPath

  • getURLPath(url: string): string | undefined

getURLQueries

  • getURLQueries(url: string): object

getValueInConnString

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

  • 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

isAlphaNumericCharacter

  • isAlphaNumericCharacter(character: string): boolean

  • Get whether or not the provided character (single character string) is an alphanumeric (letter or digit) character.

    Parameters

    • character: string

    Returns boolean

isDuration

  • isDuration(value: string): boolean

  • Indicates whether the given string is in ISO 8601 format.

    Parameters

    • value: string

      The value to be validated for ISO 8601 duration format.

    Returns boolean

    true if valid, false otherwise.

isPrimitiveType

  • isPrimitiveType(value: any): boolean

  • Determines whether the given entity is a basic/primitive type (string, number, boolean, null, undefined).

    Parameters

    • value: any

      Any entity

    Returns boolean

    • true is it is primitive type, false otherwise.

isStreamOperation

  • Parameters

    Returns boolean

isTokenCredential

  • isTokenCredential(credential: any): boolean

  • Tests an object to determine whether it implements TokenCredential.

    Parameters

    • credential: any

      The assumed TokenCredential to be tested.

    Returns boolean

isValidUuid

  • isValidUuid(uuid: string): boolean

  • Validates the given uuid as a string

    Parameters

    • uuid: string

      The uuid as a string that needs to be validated

    Returns boolean

    True if the uuid is valid; false otherwise.

keepAlivePolicy

  • Parameters

    Returns object

logPolicy

newPipeline

operationOptionsToRequestOptionsBase

  • Converts an OperationOptions to a RequestOptionsBase

    Type parameters

    • T: OperationOptions

    Parameters

    • opts: T

      OperationOptions object to convert to RequestOptionsBase

    Returns RequestOptionsBase

padStart

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

parseHeaders

  • Parameters

    • headers: Headers

    Returns HttpHeaders

parseXML

  • parseXML(str: string, opts?: undefined | object): Promise<any>

  • Converts given XML string into JSON

    Parameters

    • str: string

      String containing the XML content to be parsed into JSON

    • Optional opts: undefined | object

      Options that govern the parsing of given xml string includeRoot indicates whether the root element is to be included or not in the output

    Returns Promise<any>

prepareXMLRootList

  • prepareXMLRootList(obj: any, elementName: string): object

  • Parameters

    • obj: any
    • elementName: string

    Returns object

    • [x: string]: any

promiseToCallback

  • promiseToCallback(promise: Promise<any>): Function

  • Converts a Promise to a callback.

    deprecated

    generated code should instead depend on responseToBody

    Parameters

    • promise: Promise<any>

      The Promise to be converted to a callback

    Returns Function

    A function that takes the callback (cb: Function): void

promiseToServiceCallback

  • Converts a Promise to a service callback.

    Type parameters

    • T

    Parameters

    • promise: Promise<HttpOperationResponse>

      The Promise of HttpOperationResponse to be converted to a service callback

    Returns Function

    A function that takes the service callback (cb: ServiceCallback): void

proxyPolicy

redirectPolicy

  • Parameters

    • Optional maximumRetries: undefined | number

    Returns RequestPolicyFactory

replaceAll

  • replaceAll(value: string | undefined, searchValue: string, replaceValue: string): string | undefined

  • Replace all of the instances of searchValue in value with the provided replaceValue.

    Parameters

    • value: string | undefined

      The value to search and replace in.

    • searchValue: string

      The value to search for in the value argument.

    • replaceValue: string

      The value to replace searchValue with in the value argument.

    Returns string | undefined

    The value where each instance of searchValue was replaced with replacedValue.

sanitizeHeaders

sanitizeURL

  • sanitizeURL(url: string): string

serializeObject

  • serializeObject(toSerialize: any): any

  • Parameters

    • toSerialize: any

    Returns any

serializeRequestBody

setLogLevel

  • Immediately enables logging at the specified log level.

    Parameters

    • Optional level: AzureLogLevel

      The log level to enable for logging. Options from most verbose to least verbose are:

      • verbose
      • info
      • warning
      • error

    Returns void

setTracer

  • setTracer(tracer: Tracer): void

  • Sets the global tracer, enabling tracing for the Azure SDK.

    Parameters

    • tracer: Tracer

      An OpenTelemetry Tracer instance.

    Returns void

setURLHost

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

setURLParameter

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

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

    export

    Parameters

    • url: string

      Source URL string

    • name: string

      Parameter name

    • Optional value: undefined | string

    Returns string

    An updated URL string

signingPolicy

stringifyXML

  • stringifyXML(obj: any, opts?: undefined | object): string

  • Converts given JSON object to XML string

    Parameters

    • obj: any

      JSON object to be converted into XML string

    • Optional opts: undefined | object

      Options that govern the parsing of given JSON object rootName indicates the name of the root element in the resulting XML

    Returns string

stripRequest

  • Returns a stripped version of the Http Request that does not contain the Authorization header.

    Parameters

    Returns WebResource

    The stripped version of Http Request.

stripResponse

  • Returns a stripped version of the Http Response which only contains body, headers and the status.

    Parameters

    Returns any

    The stripped version of Http Response.

systemErrorRetryPolicy

  • systemErrorRetryPolicy(retryCount?: undefined | number, retryInterval?: undefined | number, minRetryInterval?: undefined | number, maxRetryInterval?: undefined | number): RequestPolicyFactory

  • Parameters

    • Optional retryCount: undefined | number
    • Optional retryInterval: undefined | number
    • Optional minRetryInterval: undefined | number
    • Optional maxRetryInterval: undefined | number

    Returns RequestPolicyFactory

throttlingRetryPolicy

  • Returns RequestPolicyFactory

tracingPolicy

truncatedISO8061Date

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

  • Rounds a date off to seconds.

    export

    Parameters

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

    Returns string

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

urlIsHTTPS

  • urlIsHTTPS(urlToCheck: object): boolean

  • Checks if a parsed URL is HTTPS

    Parameters

    • urlToCheck: object

      The url to check

    Returns boolean

    True if the URL is HTTPS; false otherwise.

userAgentPolicy

Object literals

Const AccessPolicy

AccessPolicy: object

serializedName

serializedName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiresOn

expiresOn: object

required

required: true = true

serializedName

serializedName: string = "Expiry"

xmlName

xmlName: string = "Expiry"

type

type: object

name

name: "String" = "String"

permissions

permissions: object

required

required: true = true

serializedName

serializedName: string = "Permission"

xmlName

xmlName: string = "Permission"

type

type: object

name

name: "String" = "String"

startsOn

startsOn: object

required

required: true = 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: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedHeaders

allowedHeaders: object

required

required: true = true

serializedName

serializedName: string = "AllowedHeaders"

xmlName

xmlName: string = "AllowedHeaders"

type

type: object

name

name: "String" = "String"

allowedMethods

allowedMethods: object

required

required: true = true

serializedName

serializedName: string = "AllowedMethods"

xmlName

xmlName: string = "AllowedMethods"

type

type: object

name

name: "String" = "String"

allowedOrigins

allowedOrigins: object

required

required: true = true

serializedName

serializedName: string = "AllowedOrigins"

xmlName

xmlName: string = "AllowedOrigins"

type

type: object

name

name: "String" = "String"

exposedHeaders

exposedHeaders: object

required

required: true = true

serializedName

serializedName: string = "ExposedHeaders"

xmlName

xmlName: string = "ExposedHeaders"

type

type: object

name

name: "String" = "String"

maxAgeInSeconds

maxAgeInSeconds: object

required

required: true = true

serializedName

serializedName: string = "MaxAgeInSeconds"

xmlName

xmlName: string = "MaxAgeInSeconds"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const DequeuedMessageItem

DequeuedMessageItem: object

serializedName

serializedName: string = "DequeuedMessageItem"

xmlName

xmlName: string = "QueueMessage"

type

type: object

className

className: string = "DequeuedMessageItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dequeueCount

dequeueCount: object

required

required: true = true

serializedName

serializedName: string = "DequeueCount"

xmlName

xmlName: string = "DequeueCount"

type

type: object

name

name: "Number" = "Number"

expiresOn

expiresOn: object

required

required: true = true

serializedName

serializedName: string = "ExpirationTime"

xmlName

xmlName: string = "ExpirationTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

insertedOn

insertedOn: object

required

required: true = true

serializedName

serializedName: string = "InsertionTime"

xmlName

xmlName: string = "InsertionTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "MessageId"

xmlName

xmlName: string = "MessageId"

type

type: object

name

name: "String" = "String"

messageText

messageText: object

required

required: true = true

serializedName

serializedName: string = "MessageText"

xmlName

xmlName: string = "MessageText"

type

type: object

name

name: "String" = "String"

nextVisibleOn

nextVisibleOn: object

required

required: true = true

serializedName

serializedName: string = "TimeNextVisible"

xmlName

xmlName: string = "TimeNextVisible"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

popReceipt

popReceipt: object

required

required: true = 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: "Composite" = "Composite"

modelProperties

modelProperties: object

expiresOn

expiresOn: object

required

required: true = true

serializedName

serializedName: string = "ExpirationTime"

xmlName

xmlName: string = "ExpirationTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

insertedOn

insertedOn: object

required

required: true = true

serializedName

serializedName: string = "InsertionTime"

xmlName

xmlName: string = "InsertionTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "MessageId"

xmlName

xmlName: string = "MessageId"

type

type: object

name

name: "String" = "String"

nextVisibleOn

nextVisibleOn: object

required

required: true = true

serializedName

serializedName: string = "TimeNextVisible"

xmlName

xmlName: string = "TimeNextVisible"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

popReceipt

popReceipt: object

required

required: true = 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: "Composite" = "Composite"

modelProperties

modelProperties: object

lastSyncOn

lastSyncOn: object

required

required: true = true

serializedName

serializedName: string = "LastSyncTime"

xmlName

xmlName: string = "LastSyncTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

status

status: object

required

required: true = 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: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

required

required: true = 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: true = true

serializedName

serializedName: string = "MaxResults"

xmlName

xmlName: string = "MaxResults"

type

type: object

name

name: "Number" = "Number"

prefix

prefix: object

required

required: true = 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: true = true

xmlName

xmlName: string = "Queues"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "QueueItem"

name

name: "Composite" = "Composite"

serviceEndpoint

serviceEndpoint: object

required

required: true = true

serializedName

serializedName: string = "ServiceEndpoint"

xmlIsAttribute

xmlIsAttribute: true = 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: "Composite" = "Composite"

modelProperties

modelProperties: object

deleteProperty

deleteProperty: object

required

required: true = true

serializedName

serializedName: string = "Delete"

xmlName

xmlName: string = "Delete"

type

type: object

name

name: "Boolean" = "Boolean"

read

read: object

required

required: true = true

serializedName

serializedName: string = "Read"

xmlName

xmlName: string = "Read"

type

type: object

name

name: "Boolean" = "Boolean"

retentionPolicy

retentionPolicy: object

required

required: true = true

serializedName

serializedName: string = "RetentionPolicy"

xmlName

xmlName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

version

version: object

required

required: true = true

serializedName

serializedName: string = "Version"

xmlName

xmlName: string = "Version"

type

type: object

name

name: "String" = "String"

write

write: object

required

required: true = true

serializedName

serializedName: string = "Write"

xmlName

xmlName: string = "Write"

type

type: object

name

name: "Boolean" = "Boolean"

Const MessageIdDeleteHeaders

MessageIdDeleteHeaders: object

serializedName

serializedName: string = "messageid-delete-headers"

type

type: object

className

className: string = "MessageIdDeleteHeaders"

name

name: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

name: "Boolean" = "Boolean"

includeAPIs

includeAPIs: object

serializedName

serializedName: string = "IncludeAPIs"

xmlName

xmlName: string = "IncludeAPIs"

type

type: object

name

name: "Boolean" = "Boolean"

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "RetentionPolicy"

xmlName

xmlName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "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: "Composite" = "Composite"

modelProperties

modelProperties: object

dequeueCount

dequeueCount: object

required

required: true = true

serializedName

serializedName: string = "DequeueCount"

xmlName

xmlName: string = "DequeueCount"

type

type: object

name

name: "Number" = "Number"

expiresOn

expiresOn: object

required

required: true = true

serializedName

serializedName: string = "ExpirationTime"

xmlName

xmlName: string = "ExpirationTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

insertedOn

insertedOn: object

required

required: true = true

serializedName

serializedName: string = "InsertionTime"

xmlName

xmlName: string = "InsertionTime"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "MessageId"

xmlName

xmlName: string = "MessageId"

type

type: object

name

name: "String" = "String"

messageText

messageText: object

required

required: true = 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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "Composite"

modelProperties

modelProperties: object

approximateMessagesCount

approximateMessagesCount: object

serializedName

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

type

type: object

name

name: "Number" = "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: "DateTimeRfc1123" = "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: "Dictionary" = "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: "Composite" = "Composite"

modelProperties

modelProperties: object

metadata

metadata: object

serializedName

serializedName: string = "Metadata"

xmlName

xmlName: string = "Metadata"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = 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: "Composite" = "Composite"

modelProperties

modelProperties: object

messageText

messageText: object

required

required: true = 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: "Composite" = "Composite"

modelProperties

modelProperties: object

cors

cors: object

serializedName

serializedName: string = "Cors"

xmlElementName

xmlElementName: string = "CorsRule"

xmlIsWrapped

xmlIsWrapped: true = true

xmlName

xmlName: string = "Cors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CorsRule"

name

name: "Composite" = "Composite"

hourMetrics

hourMetrics: object

serializedName

serializedName: string = "HourMetrics"

xmlName

xmlName: string = "HourMetrics"

type

type: object

className

className: string = "Metrics"

name

name: "Composite" = "Composite"

minuteMetrics

minuteMetrics: object

serializedName

serializedName: string = "MinuteMetrics"

xmlName

xmlName: string = "MinuteMetrics"

type

type: object

className

className: string = "Metrics"

name

name: "Composite" = "Composite"

queueAnalyticsLogging

queueAnalyticsLogging: object

serializedName

serializedName: string = "Logging"

xmlName

xmlName: string = "Logging"

type

type: object

className

className: string = "Logging"

name

name: "Composite" = "Composite"

Const QueueServiceStatistics

QueueServiceStatistics: object

serializedName

serializedName: string = "QueueServiceStatistics"

xmlName

xmlName: string = "StorageServiceStats"

type

type: object

className

className: string = "QueueServiceStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

geoReplication

geoReplication: object

serializedName

serializedName: string = "GeoReplication"

xmlName

xmlName: string = "GeoReplication"

type

type: object

className

className: string = "GeoReplication"

name

name: "Composite" = "Composite"

Const QueueSetAccessPolicyHeaders

QueueSetAccessPolicyHeaders: object

serializedName

serializedName: string = "queue-setaccesspolicy-headers"

type

type: object

className

className: string = "QueueSetAccessPolicyHeaders"

name

name: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "Number" = "Number"

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const ServiceGetPropertiesHeaders

ServiceGetPropertiesHeaders: object

serializedName

serializedName: string = "service-getproperties-headers"

type

type: object

className

className: string = "ServiceGetPropertiesHeaders"

name

name: "Composite" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "DateTimeRfc1123" = "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: "Composite" = "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: "Composite" = "Composite"

modelProperties

modelProperties: object

accessPolicy

accessPolicy: object

required

required: true = true

serializedName

serializedName: string = "AccessPolicy"

xmlName

xmlName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

name: "Composite" = "Composite"

id

id: object

required

required: true = 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: "Composite" = "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: true = true

required

required: true = 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: true = true

required

required: true = 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: true = true

required

required: true = 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: true = true

required

required: true = 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: true = true

required

required: true = true

serializedName

serializedName: string = "comp"

type

type: object

name

name: "String" = "String"

Const include

include: object

collectionFormat

collectionFormat: Csv = coreHttp.QueryCollectionFormat.Csv

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "include"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["metadata"]

name

name: "Enum" = "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: "Number" = "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: "Number" = "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: "Dictionary" = "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: "Number" = "Number"

Const peekonly

peekonly: object

parameterPath

parameterPath: string = "peekonly"

mapper

mapper: object

defaultValue

defaultValue: string = "true"

isConstant

isConstant: true = true

required

required: true = 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: true = 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: true = true

required

required: true = 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: "Number" = "Number"

Const url

url: object

parameterPath

parameterPath: string = "url"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: true = 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: true = true

required

required: true = 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: "Number" = "Number"

Const visibilityTimeout1

visibilityTimeout1: object

parameterPath

parameterPath: string = "visibilityTimeout"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "visibilitytimeout"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 604800

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Generated using TypeDoc