@azure/storage-queue package

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on an AccountSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that resource type. Once all the values are set, this should be serialized with toString and set as the resources field on an AccountSASSignatureValues object. It is possible to construct the resources string without this class, but the order of the resources is particular and this class guarantees correctness.

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that service. Once all the values are set, this should be serialized with toString and set as the services field on an AccountSASSignatureValues object. It is possible to construct the services string without this class, but the order of the services is particular and this class guarantees correctness.

AnonymousCredential provides a credentialPolicyCreator member used to create AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources or for use with Shared Access Signatures (SAS).

AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources or for use with Shared Access Signatures (SAS).

The base class from which all request policies derive.

Credential is an abstract class for Azure Storage HTTP requests signing. This class will host an credentialPolicyCreator factory which generates CredentialPolicy.

Credential policy used to sign HTTP(S) requests before sending. This is an abstract class.

A Pipeline class containing HTTP request policies. You can create a default Pipeline by calling newPipeline. Or you can create a Pipeline with your own policies by the constructor of Pipeline.

Refer to newPipeline and provided policies before implementing your customized Pipeline.

A QueueClient represents a URL to an Azure Storage Queue's messages allowing you to manipulate its messages.

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a Queue. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on a QueueSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.

A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you to manipulate queues.

A custom error type for failed pipeline requests.

Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly by the user; it is only generated by the AccountSASSignatureValues and QueueSASSignatureValues types. Once generated, it can be encoded into a toString() and appended to a URL directly (though caution should be taken here in case there are existing query parameters, which might affect the appropriate means of appending these query parameters).

NOTE: Instances of this class are immutable.

StorageBrowserPolicy will handle differences between Node.js and browser runtime, including:

1. Browsers cache GET/HEAD requests by adding conditional headers such as 'IF_MODIFIED_SINCE'. StorageBrowserPolicy is a policy used to add a timestamp query to GET/HEAD request URL thus avoid the browser cache.

2. Remove cookie header for security

3. Remove content-length header to avoid browsers warning

StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.

Retry policy with exponential retry and linear retry implemented.

StorageRetryPolicyFactory is a factory class helping generating StorageRetryPolicy objects.

ONLY AVAILABLE IN NODE.JS RUNTIME.

StorageSharedKeyCredential for account key authorization of Azure Storage service.

StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key.

An Access policy

ONLY AVAILABLE IN NODE.JS RUNTIME.

AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set appropriately, call generateSASQueryParameters() to obtain a representation of the SAS which can actually be applied to queue urls. Note: that both this class and SASQueryParameters exist because the former is mutable and a logical representation while the latter is immutable and used to generate actual REST requests.

See https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 for more conceptual information on SAS See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas for descriptions of the parameters, including which are required

An interface for options common to every remote operation.

CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain

The object returned in the QueueMessageList array when calling Get Messages on a Queue.

The object returned in the QueueMessageList array when calling Put Message on a Queue

Geo-Replication information for the Secondary Storage Service

A collection of HTTP header key/value pairs.

Http Response that is compatible with the core-v1(core-http).

A representation of an HTTP response that includes a reference to the request that originated it.

A compatible interface for core-http request policies

The object returned when calling List Queues on a Queue Service.

Azure Analytics Logging settings.

Defines headers for MessageId_delete operation.

Defines headers for MessageId_update operation.

Defines headers for Messages_clear operation.

Defines headers for Messages_dequeue operation.

Optional parameters.

Defines headers for Messages_enqueue operation.

Optional parameters.

Defines headers for Messages_peek operation.

Optional parameters.

A collection of key-value string pairs.

An interface representing Metrics.

The object returned in the QueueMessageList array when calling Peek Messages on a Queue

An interface for the Pipeline class containing HTTP request policies. You can create a default Pipeline by calling newPipeline. Or you can create a Pipeline with your own policies by the constructor of Pipeline.

Refer to newPipeline and provided policies before implementing your customized Pipeline.

Option interface for Pipeline constructor.

Options to configure clearMessages operation

Defines headers for Queue_create operation.

Contains response data for the createIfNotExists operation.

Options to configure create operation

Defines headers for Queue_delete operation.

Contains response data for the deleteIfExists operation.

Options to configure the deleteMessage operation

Options to configure delete operation

Options to configure exists operation

Options to configure generateSasUrl operation.

Defines headers for Queue_getAccessPolicy operation.

Options to configure getAccessPolicy operation

Defines headers for Queue_getProperties operation.

Options to configure getProperties operation

An Azure Storage Queue.

Options to configure peekMessages operation

Options to configure receiveMessages operation

ONLY AVAILABLE IN NODE.JS RUNTIME.

QueueSASSignatureValues is used to help generating Queue service SAS tokens for queues.

Options to configure sendMessage operation

Storage Service Properties.

Stats for the storage service.

Defines headers for Queue_setAccessPolicy operation.

Options to configure setAccessPolicy operation

Defines headers for Queue_setMetadata operation.

Options to configure setMetadata operation

Options to configure updateMessage operation

An interface for compatibility with core-http's RequestPolicyFactory

An interface for compatibility with RequestPolicy

An object with a simple _response property.

An object with a _response property that has body and headers already parsed into known types.

An object with a _response property that has headers already parsed into a typed object.

the retention policy

Allowed IP range for a SAS.

A subset of @azure/core-http ServiceClientOptions

Options to configure generateAccountSasUrl operation.

Defines headers for Service_getProperties operation.

Options to configure getProperties operation

Defines headers for Service_getStatistics operation.

Options to configure getStatistics operation

Options to configure listQueues operation

Defines headers for Service_listQueuesSegment operation.

Defines headers for Service_setProperties operation.

Options to configure setProperties operation

Signed identifier.

signed identifier

Options interface for the newPipeline function.

Storage Blob retry options interface.

A description of a HTTP request to be made to a remote server.

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

Defines values for GeoReplicationStatusType.

Types of bodies supported on the request. NodeJS.ReadableStream and () => NodeJS.ReadableStream is Node only. Blob, ReadableStream, and () => ReadableStream are browser only.

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

Contains response data for the delete operation.

Contains response data for the update operation.

Contains response data for the clear operation.

Contains response data for the clearMessages operation.

Contains response data for the create operation.

Contains response data for the deleteMessage operation.

Contains response data for the delete operation.

Contains response data for the getAccessPolicy operation.

Contains response data for the getProperties operation.

Contains the response data for the peekMessages operation.

Contains the response data for the receiveMessages operation.

Contains the response data for the sendMessage operation.

Contains response data for the setAccessPolicy operation.

Contains response data for the setMetadata operation.

Contains response data for the updateMessage operation.

The object returned in the receivedMessageItems array when calling receiveMessages.

See: QueueReceiveMessageResponse

Contains response data for the getProperties operation.

Contains response data for the getStatistics operation.

Contains response data for the listQueuesSegment operation.

Contains response data for the setProperties operation.

A type that represents an operation result with a known _response property.

Protocols for generated SAS.

Defines the known cloud audiences for Storage.

RetryPolicy types.

ONLY AVAILABLE IN NODE.JS RUNTIME.

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

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

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.

To get OAuth audience for a storage account for queue service.

A helper to decide if a given argument satisfies the Pipeline contract

Creates a new Pipeline object with Credential provided.