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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
action	object	Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
correlationFilter	object	Properties of correlationFilter.
filterType	string	Filter type that is evaluated against a BrokeredMessage. Known values are: "SqlFilter" and "CorrelationFilter".
location	string	The geo-location where the resource lives.
sqlFilter	object	Properties of sqlFilter.
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".

list_by_subscriptions

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
action	object	Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
correlationFilter	object	Properties of correlationFilter.
filterType	string	Filter type that is evaluated against a BrokeredMessage. Known values are: "SqlFilter" and "CorrelationFilter".
location	string	The geo-location where the resource lives.
sqlFilter	object	Properties of sqlFilter.
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, namespace_name, topic_name, subscription_name, rule_name, subscription_id		Retrieves the description for the specified rule.
list_by_subscriptions	select	resource_group_name, namespace_name, topic_name, subscription_name, subscription_id	$skip, $top	List all the rules within given topic-subscription.
create_or_update	insert	resource_group_name, namespace_name, topic_name, subscription_name, rule_name, subscription_id		Creates a new rule and updates an existing rule.
create_or_update	replace	resource_group_name, namespace_name, topic_name, subscription_name, rule_name, subscription_id		Creates a new rule and updates an existing rule.
delete	delete	resource_group_name, namespace_name, topic_name, subscription_name, rule_name, subscription_id		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
namespace_name	string	The namespace name. Required.
resource_group_name	string	Name of the Resource group within the Azure subscription. Required.
rule_name	string	The rule name. Required.
subscription_id	string
subscription_name	string	The subscription name. Required.
topic_name	string	The topic name. Required.
$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. Default value is None.
$top	integer	May be used to limit the number of results to the most recent N usageDetails. Default value is None.

SELECT examples

get

Retrieves the description for the specified rule.

SELECT
id,
name,
action,
correlationFilter,
filterType,
location,
sqlFilter,
systemData,
type
FROM azure.service_bus.rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND subscription_name = '{{ subscription_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscriptions

List all the rules within given topic-subscription.

SELECT
id,
name,
action,
correlationFilter,
filterType,
location,
sqlFilter,
systemData,
type
FROM azure.service_bus.rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND subscription_name = '{{ subscription_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
resource_group_name,
namespace_name,
topic_name,
subscription_name,
rule_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ topic_name }}',
'{{ subscription_name }}',
'{{ rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the rules resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the rules resource.
  - name: topic_name
    value: "{{ topic_name }}"
    description: Required parameter for the rules resource.
  - name: subscription_name
    value: "{{ subscription_name }}"
    description: Required parameter for the rules resource.
  - name: rule_name
    value: "{{ rule_name }}"
    description: Required parameter for the rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the rules resource.
  - name: properties
    value:
      action:
        sqlExpression: "{{ sqlExpression }}"
        compatibilityLevel: {{ compatibilityLevel }}
        requiresPreprocessing: {{ requiresPreprocessing }}
      filterType: "{{ filterType }}"
      sqlFilter:
        sqlExpression: "{{ sqlExpression }}"
        compatibilityLevel: {{ compatibilityLevel }}
        requiresPreprocessing: {{ requiresPreprocessing }}
      correlationFilter:
        properties: "{{ properties }}"
        correlationId: "{{ correlationId }}"
        messageId: "{{ messageId }}"
        to: "{{ to }}"
        replyTo: "{{ replyTo }}"
        label: "{{ label }}"
        sessionId: "{{ sessionId }}"
        replyToSessionId: "{{ replyToSessionId }}"
        contentType: "{{ contentType }}"
        requiresPreprocessing: {{ requiresPreprocessing }}

REPLACE examples

create_or_update

Creates a new rule and updates an existing rule.

REPLACE azure.service_bus.rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND topic_name = '{{ topic_name }}' --required
AND subscription_name = '{{ subscription_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Deletes an existing rule.

DELETE FROM azure.service_bus.rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND topic_name = '{{ topic_name }}' --required
AND subscription_name = '{{ subscription_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;