Queues interface
Interface representing a Queues.
Methods
Method Details
createOrUpdate(string, string, string, SBQueue, QueuesCreateOrUpdateOptionalParams)
Creates or updates a Service Bus queue. This operation is idempotent.
function createOrUpdate(resourceGroupName: string, namespaceName: string, queueName: string, parameters: SBQueue, options?: QueuesCreateOrUpdateOptionalParams): Promise<SBQueue>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- queueName
-
string
The queue name.
- parameters
- SBQueue
Parameters supplied to create or update a queue resource.
The options parameters.
Returns
Promise<SBQueue>
createOrUpdateAuthorizationRule(string, string, string, string, SBAuthorizationRule, QueuesCreateOrUpdateAuthorizationRuleOptionalParams)
Creates an authorization rule for a queue.
function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, parameters: SBAuthorizationRule, options?: QueuesCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- queueName
-
string
The queue name.
- authorizationRuleName
-
string
The authorization rule name.
- parameters
- SBAuthorizationRule
The shared access authorization rule.
The options parameters.
Returns
Promise<SBAuthorizationRule>
delete(string, string, string, QueuesDeleteOptionalParams)
Deletes a queue from the specified namespace in a resource group.
function delete(resourceGroupName: string, namespaceName: string, queueName: string, options?: QueuesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- queueName
-
string
The queue name.
- options
- QueuesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
deleteAuthorizationRule(string, string, string, string, QueuesDeleteAuthorizationRuleOptionalParams)
Deletes a queue authorization rule.
function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, options?: QueuesDeleteAuthorizationRuleOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- queueName
-
string
The queue name.
- authorizationRuleName
-
string
The authorization rule name.
The options parameters.
Returns
Promise<void>
get(string, string, string, QueuesGetOptionalParams)
Returns a description for the specified queue.
function get(resourceGroupName: string, namespaceName: string, queueName: string, options?: QueuesGetOptionalParams): Promise<SBQueue>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- queueName
-
string
The queue name.
- options
- QueuesGetOptionalParams
The options parameters.
Returns
Promise<SBQueue>
getAuthorizationRule(string, string, string, string, QueuesGetAuthorizationRuleOptionalParams)
Gets an authorization rule for a queue by rule name.
function getAuthorizationRule(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, options?: QueuesGetAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- queueName
-
string
The queue name.
- authorizationRuleName
-
string
The authorization rule name.
The options parameters.
Returns
Promise<SBAuthorizationRule>
listAuthorizationRules(string, string, string, QueuesListAuthorizationRulesOptionalParams)
Gets all authorization rules for a queue.
function listAuthorizationRules(resourceGroupName: string, namespaceName: string, queueName: string, options?: QueuesListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SBAuthorizationRule, SBAuthorizationRule[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- queueName
-
string
The queue name.
The options parameters.
Returns
listByNamespace(string, string, QueuesListByNamespaceOptionalParams)
Gets the queues within a namespace.
function listByNamespace(resourceGroupName: string, namespaceName: string, options?: QueuesListByNamespaceOptionalParams): PagedAsyncIterableIterator<SBQueue, SBQueue[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
The options parameters.
Returns
listKeys(string, string, string, string, QueuesListKeysOptionalParams)
Primary and secondary connection strings to the queue.
function listKeys(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, options?: QueuesListKeysOptionalParams): Promise<AccessKeys>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- queueName
-
string
The queue name.
- authorizationRuleName
-
string
The authorization rule name.
- options
- QueuesListKeysOptionalParams
The options parameters.
Returns
Promise<AccessKeys>
regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, QueuesRegenerateKeysOptionalParams)
Regenerates the primary or secondary connection strings to the queue.
function regenerateKeys(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: QueuesRegenerateKeysOptionalParams): Promise<AccessKeys>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- queueName
-
string
The queue name.
- authorizationRuleName
-
string
The authorization rule name.
- parameters
- RegenerateAccessKeyParameters
Parameters supplied to regenerate the authorization rule.
The options parameters.
Returns
Promise<AccessKeys>