rules

Creates, updates, deletes, gets or lists a rules resource.

Overview

Name	rules
Type	Resource
Id	azure.service_bus.rules

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved rule description.

Name	Datatype	Description
properties	object	Properties of Rule resource
systemData	object	The system meta data relating to this resource.

list_by_subscriptions

Successfully retrieved list of Rules.

Name	Datatype	Description
properties	object	Properties of Rule resource
systemData	object	The system meta data relating to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, topicName, subscriptionName, ruleName, subscriptionId		Retrieves the description for the specified rule.
list_by_subscriptions	select	resourceGroupName, namespaceName, topicName, subscriptionName, subscriptionId	$skip, $top	List all the rules within given topic-subscription
create_or_update	insert	resourceGroupName, namespaceName, topicName, subscriptionName, ruleName, subscriptionId		Creates a new rule and updates an existing rule
delete	delete	resourceGroupName, namespaceName, topicName, subscriptionName, ruleName, subscriptionId		Deletes an existing rule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
namespaceName	string	The namespace name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
ruleName	string	The rule name.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
subscriptionName	string	The subscription name.
topicName	string	The topic name.
$skip	integer	Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
$top	integer	May be used to limit the number of results to the most recent N usageDetails.

SELECT examples

get

Retrieves the description for the specified rule.

SELECT
properties,
systemData
FROM azure.service_bus.rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND topicName = '{{ topicName }}' -- required
AND subscriptionName = '{{ subscriptionName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscriptions

List all the rules within given topic-subscription

SELECT
properties,
systemData
FROM azure.service_bus.rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND topicName = '{{ topicName }}' -- required
AND subscriptionName = '{{ subscriptionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates a new rule and updates an existing rule

INSERT INTO azure.service_bus.rules (
data__properties,
resourceGroupName,
namespaceName,
topicName,
subscriptionName,
ruleName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ topicName }}',
'{{ subscriptionName }}',
'{{ ruleName }}',
'{{ subscriptionId }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the rules resource.
    - name: namespaceName
      value: string
      description: Required parameter for the rules resource.
    - name: topicName
      value: string
      description: Required parameter for the rules resource.
    - name: subscriptionName
      value: string
      description: Required parameter for the rules resource.
    - name: ruleName
      value: string
      description: Required parameter for the rules resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the rules resource.
    - name: properties
      value: object
      description: |
        Properties of Rule resource

DELETE examples

delete

Deletes an existing rule.

DELETE FROM azure.service_bus.rules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND topicName = '{{ topicName }}' --required
AND subscriptionName = '{{ subscriptionName }}' --required
AND ruleName = '{{ ruleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;