mqtt_bridge_topic_maps

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

Overview

Name	mqtt_bridge_topic_maps
Type	Resource
Id	azure.iot_mq.mqtt_bridge_topic_maps

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_mqtt_bridge_connector_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, mqttBridgeConnectorName, topicMapName		Get a MqttBridgeTopicMapResource
list_by_mqtt_bridge_connector_resource	select	subscriptionId, resourceGroupName, mqName, mqttBridgeConnectorName		List MqttBridgeTopicMapResource resources by MqttBridgeConnectorResource
create_or_update	insert	subscriptionId, resourceGroupName, mqName, mqttBridgeConnectorName, topicMapName, data__extendedLocation		Create a MqttBridgeTopicMapResource
update	update	subscriptionId, resourceGroupName, mqName, mqttBridgeConnectorName, topicMapName		Update a MqttBridgeTopicMapResource
delete	delete	subscriptionId, resourceGroupName, mqName, mqttBridgeConnectorName, topicMapName		Delete a MqttBridgeTopicMapResource

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
mqName	string	Name of MQ resource
mqttBridgeConnectorName	string	Name of MQ mqttBridgeConnector resource
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
topicMapName	string	Name of MQ mqttBridgeTopicMap resource

SELECT examples

get

Get a MqttBridgeTopicMapResource

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

list_by_mqtt_bridge_connector_resource

List MqttBridgeTopicMapResource resources by MqttBridgeConnectorResource

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

INSERT examples

create_or_update

Create a MqttBridgeTopicMapResource

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

Manifest

# Description fields are for documentation purposes
- name: mqtt_bridge_topic_maps
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the mqtt_bridge_topic_maps resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the mqtt_bridge_topic_maps resource.
    - name: mqName
      value: string
      description: Required parameter for the mqtt_bridge_topic_maps resource.
    - name: mqttBridgeConnectorName
      value: string
      description: Required parameter for the mqtt_bridge_topic_maps resource.
    - name: topicMapName
      value: string
      description: Required parameter for the mqtt_bridge_topic_maps 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 MqttBridgeTopicMapResource

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

DELETE examples

delete

Delete a MqttBridgeTopicMapResource

DELETE FROM azure.iot_mq.mqtt_bridge_topic_maps
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND mqName = '{{ mqName }}' --required
AND mqttBridgeConnectorName = '{{ mqttBridgeConnectorName }}' --required
AND topicMapName = '{{ topicMapName }}' --required
;