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

Queues interface

表示队列的接口。

方法

createOrUpdate(string, string, string, SBQueue, QueuesCreateOrUpdateOptionalParams)

创建或更新服务总线队列。 此操作是幂等的。

createOrUpdateAuthorizationRule(string, string, string, string, SBAuthorizationRule, QueuesCreateOrUpdateAuthorizationRuleOptionalParams)

为队列创建授权规则。

delete(string, string, string, QueuesDeleteOptionalParams)

从资源组中的指定命名空间中删除队列。

deleteAuthorizationRule(string, string, string, string, QueuesDeleteAuthorizationRuleOptionalParams)

删除队列授权规则。

get(string, string, string, QueuesGetOptionalParams)

返回指定队列的说明。

getAuthorizationRule(string, string, string, string, QueuesGetAuthorizationRuleOptionalParams)

按规则名称获取队列的授权规则。

listAuthorizationRules(string, string, string, QueuesListAuthorizationRulesOptionalParams)

获取队列的所有授权规则。

listByNamespace(string, string, QueuesListByNamespaceOptionalParams)

获取命名空间中的队列。

listKeys(string, string, string, string, QueuesListKeysOptionalParams)

队列的主连接字符串和辅助连接字符串。

regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, QueuesRegenerateKeysOptionalParams)

将主连接字符串或辅助连接字符串重新生成到队列。

方法详细信息

createOrUpdate(string, string, string, SBQueue, QueuesCreateOrUpdateOptionalParams)

创建或更新服务总线队列。 此操作是幂等的。

function createOrUpdate(resourceGroupName: string, namespaceName: string, queueName: string, parameters: SBQueue, options?: QueuesCreateOrUpdateOptionalParams): Promise<SBQueue>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

queueName

string

队列名称。

parameters
SBQueue

为创建或更新队列资源提供的参数。

options
QueuesCreateOrUpdateOptionalParams

选项参数。

返回

Promise<SBQueue>

createOrUpdateAuthorizationRule(string, string, string, string, SBAuthorizationRule, QueuesCreateOrUpdateAuthorizationRuleOptionalParams)

为队列创建授权规则。

function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, parameters: SBAuthorizationRule, options?: QueuesCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

queueName

string

队列名称。

authorizationRuleName

string

授权规则名称。

parameters
SBAuthorizationRule

共享访问授权规则。

返回

delete(string, string, string, QueuesDeleteOptionalParams)

从资源组中的指定命名空间中删除队列。

function delete(resourceGroupName: string, namespaceName: string, queueName: string, options?: QueuesDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

queueName

string

队列名称。

options
QueuesDeleteOptionalParams

选项参数。

返回

Promise<void>

deleteAuthorizationRule(string, string, string, string, QueuesDeleteAuthorizationRuleOptionalParams)

删除队列授权规则。

function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, options?: QueuesDeleteAuthorizationRuleOptionalParams): Promise<void>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

queueName

string

队列名称。

authorizationRuleName

string

授权规则名称。

返回

Promise<void>

get(string, string, string, QueuesGetOptionalParams)

返回指定队列的说明。

function get(resourceGroupName: string, namespaceName: string, queueName: string, options?: QueuesGetOptionalParams): Promise<SBQueue>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

queueName

string

队列名称。

options
QueuesGetOptionalParams

选项参数。

返回

Promise<SBQueue>

getAuthorizationRule(string, string, string, string, QueuesGetAuthorizationRuleOptionalParams)

按规则名称获取队列的授权规则。

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, options?: QueuesGetAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

queueName

string

队列名称。

authorizationRuleName

string

授权规则名称。

返回

listAuthorizationRules(string, string, string, QueuesListAuthorizationRulesOptionalParams)

获取队列的所有授权规则。

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, queueName: string, options?: QueuesListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SBAuthorizationRule, SBAuthorizationRule[], PageSettings>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

queueName

string

队列名称。

返回

listByNamespace(string, string, QueuesListByNamespaceOptionalParams)

获取命名空间中的队列。

function listByNamespace(resourceGroupName: string, namespaceName: string, options?: QueuesListByNamespaceOptionalParams): PagedAsyncIterableIterator<SBQueue, SBQueue[], PageSettings>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

options
QueuesListByNamespaceOptionalParams

选项参数。

返回

listKeys(string, string, string, string, QueuesListKeysOptionalParams)

队列的主连接字符串和辅助连接字符串。

function listKeys(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, options?: QueuesListKeysOptionalParams): Promise<AccessKeys>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

queueName

string

队列名称。

authorizationRuleName

string

授权规则名称。

options
QueuesListKeysOptionalParams

选项参数。

返回

Promise<AccessKeys>

regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, QueuesRegenerateKeysOptionalParams)

将主连接字符串或辅助连接字符串重新生成到队列。

function regenerateKeys(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: QueuesRegenerateKeysOptionalParams): Promise<AccessKeys>

参数

resourceGroupName

string

Azure 订阅中的资源组的名称。

namespaceName

string

命名空间名称

queueName

string

队列名称。

authorizationRuleName

string

授权规则名称。

parameters
RegenerateAccessKeyParameters

用于重新生成授权规则的参数。

options
QueuesRegenerateKeysOptionalParams

选项参数。

返回

Promise<AccessKeys>