broker_listeners

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

Overview

Name	broker_listeners
Type	Resource
Id	azure.iot_mq.broker_listeners

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Extended Location
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_broker_resource

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Extended Location
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, mqName, brokerName, listenerName		Get a BrokerListenerResource
list_by_broker_resource	select	subscriptionId, resourceGroupName, mqName, brokerName		List BrokerListenerResource resources by BrokerResource
create_or_update	insert	subscriptionId, resourceGroupName, mqName, brokerName, listenerName, data__extendedLocation		Create a BrokerListenerResource
update	update	subscriptionId, resourceGroupName, mqName, brokerName, listenerName		Update a BrokerListenerResource
delete	delete	subscriptionId, resourceGroupName, mqName, brokerName, listenerName		Delete a BrokerListenerResource

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
brokerName	string	Name of MQ broker resource
listenerName	string	Name of MQ broker/listener resource
mqName	string	Name of MQ resource
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a BrokerListenerResource

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.iot_mq.broker_listeners
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mqName = '{{ mqName }}' -- required
AND brokerName = '{{ brokerName }}' -- required
AND listenerName = '{{ listenerName }}' -- required
;

list_by_broker_resource

List BrokerListenerResource resources by BrokerResource

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.iot_mq.broker_listeners
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mqName = '{{ mqName }}' -- required
AND brokerName = '{{ brokerName }}' -- required
;

INSERT examples

create_or_update

Create a BrokerListenerResource

INSERT INTO azure.iot_mq.broker_listeners (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
mqName,
brokerName,
listenerName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ mqName }}',
'{{ brokerName }}',
'{{ listenerName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: broker_listeners
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the broker_listeners resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the broker_listeners resource.
    - name: mqName
      value: string
      description: Required parameter for the broker_listeners resource.
    - name: brokerName
      value: string
      description: Required parameter for the broker_listeners resource.
    - name: listenerName
      value: string
      description: Required parameter for the broker_listeners resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        Extended Location
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a BrokerListenerResource

UPDATE azure.iot_mq.broker_listeners
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND mqName = '{{ mqName }}' --required
AND brokerName = '{{ brokerName }}' --required
AND listenerName = '{{ listenerName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete a BrokerListenerResource

DELETE FROM azure.iot_mq.broker_listeners
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND mqName = '{{ mqName }}' --required
AND brokerName = '{{ brokerName }}' --required
AND listenerName = '{{ listenerName }}' --required
;