broker_authentications

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

Overview

Name	broker_authentications
Type	Resource
Id	azure.iot_mq.broker_authentications

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

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
authenticationName	string	Name of MQ broker/authentication resource
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 BrokerAuthenticationResource

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

list_by_broker_resource

List BrokerAuthenticationResource resources by BrokerResource

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

INSERT examples

create_or_update

Create a BrokerAuthenticationResource

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

Manifest

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

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

DELETE examples

delete

Delete a BrokerAuthenticationResource

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