brokers

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

Overview

Name	brokers
Type	Resource
Id	azure.iot_mq.brokers

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

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

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

list_by_mq_resource

List BrokerResource resources by MqResource

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

INSERT examples

create_or_update

Create a BrokerResource

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

Manifest

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

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

DELETE examples

delete

Delete a BrokerResource

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