QueuesOperations interface

Package:

@azure/arm-servicebus

Interface representing a Queues operations.

Properties

createOrUpdate	Creates or updates a Service Bus queue. This operation is idempotent.
createOrUpdateAuthorizationRule	Creates an authorization rule for a queue.
delete	Deletes a queue from the specified namespace in a resource group.
deleteAuthorizationRule	Deletes a queue authorization rule.
get	Returns a description for the specified queue.
getAuthorizationRule	Gets an authorization rule for a queue by rule name.
listAuthorizationRules	Gets all authorization rules for a queue.
listByNamespace	Gets the queues within a namespace.
listKeys	Primary and secondary connection strings to the queue.
regenerateKeys	Regenerates the primary or secondary connection strings to the queue.

Property Details

createOrUpdate

Creates or updates a Service Bus queue. This operation is idempotent.

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

Property Value

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

createOrUpdateAuthorizationRule

Creates an authorization rule for a queue.

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

Property Value

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

delete

Deletes a queue from the specified namespace in a resource group.

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

Property Value

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

deleteAuthorizationRule

Deletes a queue authorization rule.

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

Property Value

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

get

Returns a description for the specified queue.

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

Property Value

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

getAuthorizationRule

Gets an authorization rule for a queue by rule name.

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

Property Value

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

listAuthorizationRules

Gets all authorization rules for a queue.

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

Property Value

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

listByNamespace

Gets the queues within a namespace.

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

Property Value

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

listKeys

Primary and secondary connection strings to the queue.

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

Property Value

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

regenerateKeys

Regenerates the primary or secondary connection strings to the queue.

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

Property Value

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