mqs

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

Overview

Name	mqs
Type	Resource
Id	azure.iot_mq.mqs

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_resource_group

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_subscription

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		Get a MqResource
list_by_resource_group	select	subscriptionId, resourceGroupName		List MqResource resources by resource group
list_by_subscription	select	subscriptionId		List MqResource resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, mqName, data__extendedLocation		Create a MqResource
update	update	subscriptionId, resourceGroupName, mqName		Update a MqResource
delete	delete	subscriptionId, resourceGroupName, mqName		Delete a MqResource

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

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

list_by_resource_group

List MqResource resources by resource group

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

list_by_subscription

List MqResource resources by subscription ID

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.iot_mq.mqs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a MqResource

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

Manifest

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

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

DELETE examples

delete

Delete a MqResource

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