broker_listeners

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

Overview

Name	broker_listeners
Type	Resource
Id	azure.iot_mq.broker_listeners

Fields

vw_broker_listeners

Name	Datatype	Description
authentication_enabled	text	field from the properties object
authorization_enabled	text	field from the properties object
brokerName	text	field from the properties object
broker_ref	text	field from the properties object
extended_location	text	field from the properties object
listenerName	text	field from the properties object
location	text	The geo-location where the resource lives
mqName	text	field from the properties object
node_port	text	field from the properties object
port	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
service_name	text	field from the properties object
service_type	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
tls	text	field from the properties object

broker_listeners

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

Methods

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

SELECT examples

List BrokerListenerResource resources by BrokerResource

vw_broker_listeners

SELECT
authentication_enabled,
authorization_enabled,
brokerName,
broker_ref,
extended_location,
listenerName,
location,
mqName,
node_port,
port,
provisioning_state,
resourceGroupName,
service_name,
service_type,
subscriptionId,
tags,
tls
FROM azure.iot_mq.vw_broker_listeners
WHERE brokerName = '{{ brokerName }}'
AND mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

broker_listeners

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.iot_mq.broker_listeners
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_listeners resource.

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: authenticationEnabled
          value: boolean
        - name: authorizationEnabled
          value: boolean
        - name: brokerRef
          value: string
        - name: nodePort
          value: integer
        - name: port
          value: integer
        - name: serviceName
          value: string
        - name: serviceType
          value: string
        - name: tls
          value:
            - name: automatic
              value:
                - name: duration
                  value: string
                - name: issuerRef
                  value:
                    - name: group
                      value: string
                    - name: kind
                      value: string
                    - name: name
                      value: string
                - name: privateKey
                  value:
                    - name: algorithm
                      value: string
                    - name: rotationPolicy
                      value: string
                    - name: size
                      value: integer
                - name: renewBefore
                  value: string
                - name: san
                  value:
                    - name: dns
                      value:
                        - string
                    - name: ip
                      value:
                        - string
                - name: secretName
                  value: string
                - name: secretNamespace
                  value: string
            - name: manual
              value:
                - name: secretName
                  value: string
                - name: secretNamespace
                  value: string
            - 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: 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_listeners resource.

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

DELETE example

Deletes the specified broker_listeners resource.

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