Package version:

Interface Queue

Interface representing a Queue.

interface Queue {
    create(resourceGroupName: string, accountName: string, queueName: string, queue: StorageQueue, options?: QueueCreateOptionalParams): Promise<StorageQueue>;
    delete(resourceGroupName: string, accountName: string, queueName: string, options?: QueueDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, accountName: string, queueName: string, options?: QueueGetOptionalParams): Promise<StorageQueue>;
    list(resourceGroupName: string, accountName: string, options?: QueueListOptionalParams): PagedAsyncIterableIterator<ListQueue>;
    update(resourceGroupName: string, accountName: string, queueName: string, queue: StorageQueue, options?: QueueUpdateOptionalParams): Promise<StorageQueue>;
}

Methods

create delete get list update

Methods

create

  • create(resourceGroupName, accountName, queueName, queue, options?): Promise<StorageQueue>

  • Creates a new queue with the specified queue name, under the specified account.

    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

    • Optionaloptions: QueueCreateOptionalParams

      The options parameters.

    Returns Promise<StorageQueue>

delete

  • delete(resourceGroupName, accountName, queueName, options?): Promise<void>

  • Deletes the queue with the specified queue name, under the specified account if it exists.

    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.

    • Optionaloptions: QueueDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

get

  • get(resourceGroupName, accountName, queueName, options?): Promise<StorageQueue>

  • Gets the queue with the specified queue name, under the specified account if it exists.

    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.

    • Optionaloptions: QueueGetOptionalParams

      The options parameters.

    Returns Promise<StorageQueue>

list

  • list(resourceGroupName, accountName, options?): PagedAsyncIterableIterator<ListQueue>

  • Gets a list of all the queues under the specified storage account

    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.

    • Optionaloptions: QueueListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ListQueue>

update

  • update(resourceGroupName, accountName, queueName, queue, options?): Promise<StorageQueue>

  • Creates a new queue with the specified queue name, under the specified account.

    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

    • Optionaloptions: QueueUpdateOptionalParams

      The options parameters.

    Returns Promise<StorageQueue>

Settings

Member Visibility