Queue interface
Interface representing a Queue.
Methods
| create(string, string, string, Storage |
Creates a new queue with the specified queue name, under the specified account. |
| delete(string, string, string, Queue |
Deletes the queue with the specified queue name, under the specified account if it exists. |
| get(string, string, string, Queue |
Gets the queue with the specified queue name, under the specified account if it exists. |
| list(string, string, Queue |
Gets a list of all the queues under the specified storage account |
| update(string, string, string, Storage |
Creates a new queue with the specified queue name, under the specified account. |
Method Details
create(string, string, string, StorageQueue, QueueCreateOptionalParams)
Creates a new queue with the specified queue name, under the specified account.
function create(resourceGroupName: string, accountName: string, queueName: string, queue: StorageQueue, options?: QueueCreateOptionalParams): Promise<StorageQueue>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
-
string
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- queueName
-
string
A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
- queue
- StorageQueue
Queue properties and metadata to be created with
- options
- QueueCreateOptionalParams
The options parameters.
Returns
Promise<StorageQueue>
delete(string, string, string, QueueDeleteOptionalParams)
Deletes the queue with the specified queue name, under the specified account if it exists.
function delete(resourceGroupName: string, accountName: string, queueName: string, options?: QueueDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
-
string
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- queueName
-
string
A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
- options
- QueueDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, QueueGetOptionalParams)
Gets the queue with the specified queue name, under the specified account if it exists.
function get(resourceGroupName: string, accountName: string, queueName: string, options?: QueueGetOptionalParams): Promise<StorageQueue>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
-
string
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- queueName
-
string
A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
- options
- QueueGetOptionalParams
The options parameters.
Returns
Promise<StorageQueue>
list(string, string, QueueListOptionalParams)
Gets a list of all the queues under the specified storage account
function list(resourceGroupName: string, accountName: string, options?: QueueListOptionalParams): PagedAsyncIterableIterator<ListQueue, ListQueue[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
-
string
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- options
- QueueListOptionalParams
The options parameters.
Returns
update(string, string, string, StorageQueue, QueueUpdateOptionalParams)
Creates a new queue with the specified queue name, under the specified account.
function update(resourceGroupName: string, accountName: string, queueName: string, queue: StorageQueue, options?: QueueUpdateOptionalParams): Promise<StorageQueue>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
-
string
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- queueName
-
string
A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
- queue
- StorageQueue
Queue properties and metadata to be created with
- options
- QueueUpdateOptionalParams
The options parameters.
Returns
Promise<StorageQueue>