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

vw_broker_authentications

Name	Datatype	Description
authenticationName	text	field from the properties object
authentication_methods	text	field from the properties object
brokerName	text	field from the properties object
extended_location	text	field from the properties object
listener_ref	text	field from the properties object
location	text	The geo-location where the resource lives
mqName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

broker_authentications

Name	Datatype	Description
extendedLocation	object	ExtendedLocation properties
location	string	The geo-location where the resource lives
properties	object	Broker Resource properties
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	authenticationName, brokerName, mqName, resourceGroupName, subscriptionId	Get a BrokerAuthenticationResource
list_by_broker_resource	SELECT	brokerName, mqName, resourceGroupName, subscriptionId	List BrokerAuthenticationResource resources by BrokerResource
create_or_update	INSERT	authenticationName, brokerName, mqName, resourceGroupName, subscriptionId, data__extendedLocation	Create a BrokerAuthenticationResource
delete	DELETE	authenticationName, brokerName, mqName, resourceGroupName, subscriptionId	Delete a BrokerAuthenticationResource
update	UPDATE	authenticationName, brokerName, mqName, resourceGroupName, subscriptionId	Update a BrokerAuthenticationResource

SELECT examples

List BrokerAuthenticationResource resources by BrokerResource

vw_broker_authentications

SELECT
authenticationName,
authentication_methods,
brokerName,
extended_location,
listener_ref,
location,
mqName,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.iot_mq.vw_broker_authentications
WHERE brokerName = '{{ brokerName }}'
AND mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

broker_authentications

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

INSERT example

Use the following StackQL query and manifest file to create a new broker_authentications resource.

All Properties

/*+ create */
INSERT INTO azure.iot_mq.broker_authentications (
authenticationName,
brokerName,
mqName,
resourceGroupName,
subscriptionId,
data__extendedLocation,
properties,
extendedLocation,
tags,
location
)
SELECT 
'{{ authenticationName }}',
'{{ brokerName }}',
'{{ mqName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__extendedLocation }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: authenticationMethods
          value:
            - - name: custom
                value:
                  - name: auth
                    value:
                      - name: x509
                        value:
                          - name: keyVault
                            value:
                              - name: vault
                                value:
                                  - name: credentials
                                    value:
                                      - name: servicePrincipalLocalSecretName
                                        value: string
                                  - name: directoryId
                                    value: string
                                  - name: name
                                    value: string
                              - name: vaultCaChainSecret
                                value:
                                  - name: name
                                    value: string
                                  - name: version
                                    value: string
                          - name: secretName
                            value: string
                  - name: caCertConfigMap
                    value: string
                  - name: endpoint
                    value: string
                  - name: headers
                    value: object
              - name: sat
                value:
                  - name: audiences
                    value:
                      - string
              - name: svid
                value:
                  - name: agentSocketPath
                    value: string
                  - name: identityMaxRetry
                    value: integer
                  - name: identityWaitRetryMs
                    value: integer
              - name: usernamePassword
                value:
                  - name: keyVault
                    value: []
                  - name: secretName
                    value: string
              - name: x509
                value:
                  - name: attributes
                    value:
                      - name: secretName
                        value: string
                  - name: trustedClientCaCertConfigMap
                    value: string
        - name: listenerRef
          value:
            - string
        - name: provisioningState
          value: []
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a broker_authentications resource.

/*+ update */
UPDATE azure.iot_mq.broker_authentications
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
authenticationName = '{{ authenticationName }}'
AND brokerName = '{{ brokerName }}'
AND mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified broker_authentications resource.

/*+ delete */
DELETE FROM azure.iot_mq.broker_authentications
WHERE authenticationName = '{{ authenticationName }}'
AND brokerName = '{{ brokerName }}'
AND mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';