mqtt_bridge_connectors

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

Overview

Name	mqtt_bridge_connectors
Type	Resource
Id	azure.iot_mq.mqtt_bridge_connectors

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

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.

SELECT examples

get

Get a MqttBridgeConnectorResource

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

list_by_mq_resource

List MqttBridgeConnectorResource resources by MqResource

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

INSERT examples

create_or_update

Create a MqttBridgeConnectorResource

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

Manifest

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

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

DELETE examples

delete

Delete a MqttBridgeConnectorResource

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