subscriptions

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

Overview

Name	subscriptions
Type	Resource
Id	azure.service_bus.subscriptions

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved subscription description.

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

list_by_topic

Successfully retrieved list of subscriptions.

Name	Datatype	Description
properties	object	Properties of subscriptions 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, subscriptionId		Returns a subscription description for the specified topic.
list_by_topic	select	resourceGroupName, namespaceName, topicName, subscriptionId	$skip, $top	List all the subscriptions under a specified topic.
create_or_update	insert	resourceGroupName, namespaceName, topicName, subscriptionName, subscriptionId		Creates a topic subscription.
delete	delete	resourceGroupName, namespaceName, topicName, subscriptionName, subscriptionId		Deletes a subscription from the specified topic.

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.
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

Returns a subscription description for the specified topic.

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

list_by_topic

List all the subscriptions under a specified topic.

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

INSERT examples

create_or_update

Creates a topic subscription.

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

Manifest

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

DELETE examples

delete

Deletes a subscription from the specified topic.

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