Queue class
Class representing a Queue.
Constructors
| Queue(Storage |
Create a Queue. |
Methods
Constructor Details
Queue(StorageClientContext)
Create a Queue.
new Queue(client: StorageClientContext)Parameters
- client
- StorageClientContext
Reference to the service client.
Method Details
create(Models.QueueCreateOptionalParams)
creates a new queue under the given account.
function create(options?: Models.QueueCreateOptionalParams)Parameters
- options
- Models.QueueCreateOptionalParams
Returns
Promise<Models.QueueCreateResponse>
Promise<Models.QueueCreateResponse>
create(QueueCreateOptionalParams, ServiceCallback<void>)
function create(options: QueueCreateOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- QueueCreateOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
create(ServiceCallback<void>)
function create(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(Models.QueueDeleteMethodOptionalParams)
operation permanently deletes the specified queue
function deleteMethod(options?: Models.QueueDeleteMethodOptionalParams)Parameters
- options
- Models.QueueDeleteMethodOptionalParams
Returns
Promise<Models.QueueDeleteResponse>
Promise<Models.QueueDeleteResponse>
deleteMethod(QueueDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(options: QueueDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- QueueDeleteMethodOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(ServiceCallback<void>)
function deleteMethod(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
getAccessPolicy(Models.QueueGetAccessPolicyOptionalParams)
returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures.
function getAccessPolicy(options?: Models.QueueGetAccessPolicyOptionalParams)Parameters
- options
- Models.QueueGetAccessPolicyOptionalParams
Returns
Promise<Models.QueueGetAccessPolicyResponse>
Promise<Models.QueueGetAccessPolicyResponse>
getAccessPolicy(QueueGetAccessPolicyOptionalParams, ServiceCallback<SignedIdentifier[]>)
function getAccessPolicy(options: QueueGetAccessPolicyOptionalParams, callback: ServiceCallback<SignedIdentifier[]>)Parameters
The optional parameters
- callback
-
ServiceCallback<SignedIdentifier[]>
The callback
getAccessPolicy(ServiceCallback<SignedIdentifier[]>)
function getAccessPolicy(callback: ServiceCallback<SignedIdentifier[]>)Parameters
- callback
-
ServiceCallback<SignedIdentifier[]>
The callback
getProperties(Models.QueueGetPropertiesOptionalParams)
Retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated with the queue as name-values pairs.
function getProperties(options?: Models.QueueGetPropertiesOptionalParams)Parameters
- options
- Models.QueueGetPropertiesOptionalParams
Returns
Promise<Models.QueueGetPropertiesResponse>
Promise<Models.QueueGetPropertiesResponse>
getProperties(QueueGetPropertiesOptionalParams, ServiceCallback<void>)
function getProperties(options: QueueGetPropertiesOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- QueueGetPropertiesOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getProperties(ServiceCallback<void>)
function getProperties(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
setAccessPolicy(Models.QueueSetAccessPolicyOptionalParams)
sets stored access policies for the queue that may be used with Shared Access Signatures
function setAccessPolicy(options?: Models.QueueSetAccessPolicyOptionalParams)Parameters
- options
- Models.QueueSetAccessPolicyOptionalParams
Returns
Promise<Models.QueueSetAccessPolicyResponse>
Promise<Models.QueueSetAccessPolicyResponse>
setAccessPolicy(QueueSetAccessPolicyOptionalParams, ServiceCallback<void>)
function setAccessPolicy(options: QueueSetAccessPolicyOptionalParams, callback: ServiceCallback<void>)Parameters
The optional parameters
- callback
-
ServiceCallback<void>
The callback
setAccessPolicy(ServiceCallback<void>)
function setAccessPolicy(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
setMetadata(Models.QueueSetMetadataOptionalParams)
sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs.
function setMetadata(options?: Models.QueueSetMetadataOptionalParams)Parameters
- options
- Models.QueueSetMetadataOptionalParams
Returns
Promise<Models.QueueSetMetadataResponse>
Promise<Models.QueueSetMetadataResponse>
setMetadata(QueueSetMetadataOptionalParams, ServiceCallback<void>)
function setMetadata(options: QueueSetMetadataOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- QueueSetMetadataOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
setMetadata(ServiceCallback<void>)
function setMetadata(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
