你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Queue interface

表示队列的接口。

方法

create(string, string, string, StorageQueue, QueueCreateOptionalParams)

在指定的帐户下创建具有指定队列名称的新队列。

delete(string, string, string, QueueDeleteOptionalParams)

删除指定帐户下具有指定队列名称的队列(如果存在)。

get(string, string, string, QueueGetOptionalParams)

获取具有指定队列名称的队列,该队列位于指定的帐户下(如果存在)。

list(string, string, QueueListOptionalParams)

获取指定存储帐户下的所有队列的列表

update(string, string, string, StorageQueue, QueueUpdateOptionalParams)

在指定的帐户下创建具有指定队列名称的新队列。

方法详细信息

create(string, string, string, StorageQueue, QueueCreateOptionalParams)

在指定的帐户下创建具有指定队列名称的新队列。

function create(resourceGroupName: string, accountName: string, queueName: string, queue: StorageQueue, options?: QueueCreateOptionalParams): Promise<StorageQueue>

参数

resourceGroupName

string

用户订阅中的资源组的名称。 此名称不区分大小写。

accountName

string

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。

queueName

string

队列名称在存储帐户中必须唯一,并且必须介于 3 到 63 个字符之间。名称必须仅包含小写字母数字和短划线 () 字符,它应以字母数字字符开头和结尾,并且不能有两个连续的短划线 () 字符。

queue
StorageQueue

要创建的队列属性和元数据

options
QueueCreateOptionalParams

选项参数。

返回

Promise<StorageQueue>

delete(string, string, string, QueueDeleteOptionalParams)

删除指定帐户下具有指定队列名称的队列(如果存在)。

function delete(resourceGroupName: string, accountName: string, queueName: string, options?: QueueDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

用户订阅中的资源组的名称。 此名称不区分大小写。

accountName

string

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。

queueName

string

队列名称在存储帐户中必须唯一,并且必须介于 3 到 63 个字符之间。名称必须仅包含小写字母数字和短划线 () 字符,它应以字母数字字符开头和结尾,并且不能有两个连续的短划线 () 字符。

options
QueueDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, string, QueueGetOptionalParams)

获取具有指定队列名称的队列,该队列位于指定的帐户下(如果存在)。

function get(resourceGroupName: string, accountName: string, queueName: string, options?: QueueGetOptionalParams): Promise<StorageQueue>

参数

resourceGroupName

string

用户订阅中的资源组的名称。 此名称不区分大小写。

accountName

string

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。

queueName

string

队列名称在存储帐户中必须唯一,并且必须介于 3 到 63 个字符之间。名称必须仅包含小写字母数字和短划线 () 字符,它应以字母数字字符开头和结尾,并且不能有两个连续的短划线 () 字符。

options
QueueGetOptionalParams

选项参数。

返回

Promise<StorageQueue>

list(string, string, QueueListOptionalParams)

获取指定存储帐户下的所有队列的列表

function list(resourceGroupName: string, accountName: string, options?: QueueListOptionalParams): PagedAsyncIterableIterator<ListQueue, ListQueue[], PageSettings>

参数

resourceGroupName

string

用户订阅中的资源组的名称。 此名称不区分大小写。

accountName

string

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。

options
QueueListOptionalParams

选项参数。

返回

update(string, string, string, StorageQueue, QueueUpdateOptionalParams)

在指定的帐户下创建具有指定队列名称的新队列。

function update(resourceGroupName: string, accountName: string, queueName: string, queue: StorageQueue, options?: QueueUpdateOptionalParams): Promise<StorageQueue>

参数

resourceGroupName

string

用户订阅中的资源组的名称。 此名称不区分大小写。

accountName

string

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。

queueName

string

队列名称在存储帐户中必须唯一,并且必须介于 3 到 63 个字符之间。名称必须仅包含小写字母数字和短划线 () 字符,它应以字母数字字符开头和结尾,并且不能有两个连续的短划线 () 字符。

queue
StorageQueue

要创建的队列属性和元数据

options
QueueUpdateOptionalParams

选项参数。

返回

Promise<StorageQueue>