QueueURL class
A QueueURL represents a URL to the Azure Storage queue.
- Extends
Constructors
| QueueURL(string, Pipeline) | Creates an instance of QueueURL. |
Methods
| create(Aborter, IQueue |
Creates a new queue under the specified account. |
| delete(Aborter) | Deletes the specified queue permanently. |
| from |
Creates a QueueURL object from ServiceURL |
| get |
Gets details about any stored access policies specified on the queue that may be used with Shared Access Signatures. WARNING: JavaScript Date will potential lost precision when parsing start and expiry string. For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z". |
| get |
Gets all user-defined metadata and system properties for the specified queue. Metadata is associated with the queue as name-values pairs. |
| new |
A static method used to create a new Pipeline object with Credential provided. |
| set |
Sets stored access policies for the queue that may be used with Shared Access Signatures. |
| set |
Sets one or more user-defined name-value pairs for the specified queue. If no option provided, or no metadata defined in the option parameter, the queue metadata will be removed. |
| with |
Creates a new QueueURL object identical to the source but with the specified request policy pipeline. |
Constructor Details
QueueURL(string, Pipeline)
Creates an instance of QueueURL.
new QueueURL(url: string, pipeline: Pipeline)Parameters
- url
-
string
A URL string pointing to Azure Storage queue, such as "https://myaccount.queue.core.windows.net/myqueue". You can append a SAS if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net/myqueue?sasString".
- pipeline
- Pipeline
Call StorageURL.newPipeline() to create a default pipeline, or provide a customized pipeline.
Property Details
pipeline
url
URL string value.
url: stringProperty Value
string
Method Details
create(Aborter, IQueueCreateOptions)
Creates a new queue under the specified account.
function create(aborter: Aborter, options?: IQueueCreateOptions)Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
- options
- IQueueCreateOptions
Returns
Promise<Models.QueueCreateResponse>
delete(Aborter)
Deletes the specified queue permanently.
function delete(aborter: Aborter)Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
Returns
Promise<Models.QueueDeleteResponse>
fromServiceURL(ServiceURL, string)
Creates a QueueURL object from ServiceURL
static function fromServiceURL(serviceURL: ServiceURL, queueName: string)Parameters
- serviceURL
- ServiceURL
- queueName
-
string
Returns
getAccessPolicy(Aborter)
Gets details about any stored access policies specified on the queue that may be used with Shared Access Signatures. WARNING: JavaScript Date will potential lost precision when parsing start and expiry string. For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
function getAccessPolicy(aborter: Aborter)Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
Returns
Promise<QueueGetAccessPolicyResponse>
getProperties(Aborter)
Gets all user-defined metadata and system properties for the specified queue. Metadata is associated with the queue as name-values pairs.
function getProperties(aborter: Aborter)Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
Returns
Promise<Models.QueueGetPropertiesResponse>
newPipeline(Credential, INewPipelineOptions)
A static method used to create a new Pipeline object with Credential provided.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)Parameters
- credential
- Credential
Such as AnonymousCredential, SharedKeyCredential or TokenCredential.
- pipelineOptions
- INewPipelineOptions
Returns
A new Pipeline object.
setAccessPolicy(Aborter, ISignedIdentifier[])
Sets stored access policies for the queue that may be used with Shared Access Signatures.
function setAccessPolicy(aborter: Aborter, queueAcl?: ISignedIdentifier[])Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
- queueAcl
Returns
Promise<Models.QueueSetAccessPolicyResponse>
setMetadata(Aborter, IMetadata)
Sets one or more user-defined name-value pairs for the specified queue. If no option provided, or no metadata defined in the option parameter, the queue metadata will be removed.
function setMetadata(aborter: Aborter, metadata?: IMetadata)Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
- metadata
- IMetadata
Returns
Promise<Models.QueueSetMetadataResponse>
