brokers

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

Overview

Name	brokers
Type	Resource
Id	azure.iot_mq.brokers

Fields

vw_brokers

Name	Datatype	Description
auth_image	text	field from the properties object
brokerName	text	field from the properties object
broker_image	text	field from the properties object
broker_node_tolerations	text	field from the properties object
cardinality	text	field from the properties object
diagnostics	text	field from the properties object
disk_backed_message_buffer_settings	text	field from the properties object
encrypt_internal_traffic	text	field from the properties object
extended_location	text	field from the properties object
health_manager_image	text	field from the properties object
health_manager_node_tolerations	text	field from the properties object
internal_certs	text	field from the properties object
location	text	The geo-location where the resource lives
memory_profile	text	field from the properties object
mode	text	field from the properties object
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.

brokers

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

SELECT examples

List BrokerResource resources by MqResource

vw_brokers

SELECT
auth_image,
brokerName,
broker_image,
broker_node_tolerations,
cardinality,
diagnostics,
disk_backed_message_buffer_settings,
encrypt_internal_traffic,
extended_location,
health_manager_image,
health_manager_node_tolerations,
internal_certs,
location,
memory_profile,
mode,
mqName,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.iot_mq.vw_brokers
WHERE mqName = '{{ mqName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

brokers

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: authImage
          value:
            - name: pullPolicy
              value: string
            - name: pullSecrets
              value: string
            - name: repository
              value: string
            - name: tag
              value: string
        - name: brokerNodeTolerations
          value:
            - name: effect
              value: string
            - name: key
              value: string
            - name: operator
              value: string
            - name: value
              value: string
        - name: cardinality
          value:
            - name: backendChain
              value:
                - name: partitions
                  value: integer
                - name: redundancyFactor
                  value: integer
                - name: temporaryDiskTransferEnabled
                  value: boolean
                - name: temporaryDiskTransferHighWatermarkPercent
                  value: integer
                - name: temporaryDiskTransferLowWatermarkPercent
                  value: integer
                - name: temporaryMaxBackendMemUsagePercent
                  value: integer
                - name: temporaryResourceLimits
                  value:
                    - name: maxInflightMessages
                      value: integer
                    - name: maxInflightPatches
                      value: integer
                    - name: maxInflightPatchesPerClient
                      value: integer
                    - name: maxMessageExpirySecs
                      value: integer
                    - name: maxQueuedMessages
                      value: integer
                    - name: maxQueuedQos0Messages
                      value: integer
                    - name: maxSessionExpirySecs
                      value: integer
                - name: workers
                  value: integer
            - name: frontend
              value:
                - name: replicas
                  value: integer
                - name: workers
                  value: integer
        - name: diagnostics
          value:
            - name: diagnosticServiceEndpoint
              value: string
            - name: enableMetrics
              value: boolean
            - name: enableSelfCheck
              value: boolean
            - name: enableSelfTracing
              value: boolean
            - name: enableTracing
              value: boolean
            - name: logFormat
              value: string
            - name: logLevel
              value: string
            - name: maxCellMapLifetime
              value: integer
            - name: metricUpdateFrequencySeconds
              value: integer
            - name: probeImage
              value: string
            - name: selfCheckFrequencySeconds
              value: integer
            - name: selfCheckTimeoutSeconds
              value: integer
            - name: selfTraceFrequencySeconds
              value: integer
            - name: spanChannelCapacity
              value: integer
        - name: diskBackedMessageBufferSettings
          value:
            - name: ephemeralVolumeClaimSpec
              value:
                - name: accessModes
                  value:
                    - string
                - name: dataSource
                  value:
                    - name: apiGroup
                      value: string
                    - name: kind
                      value: string
                    - name: name
                      value: string
                - name: dataSourceRef
                  value:
                    - name: apiGroup
                      value: string
                    - name: kind
                      value: string
                    - name: name
                      value: string
                - name: resources
                  value:
                    - name: limits
                      value: object
                    - name: requests
                      value: object
                - name: selector
                  value:
                    - name: matchExpressions
                      value:
                        - - name: key
                            value: string
                          - name: operator
                            value: string
                          - name: values
                            value:
                              - string
                    - name: matchLabels
                      value: object
                - name: storageClassName
                  value: string
                - name: volumeMode
                  value: string
                - name: volumeName
                  value: string
            - name: maxSize
              value: string
        - name: encryptInternalTraffic
          value: boolean
        - name: internalCerts
          value:
            - name: duration
              value: string
            - name: privateKey
              value:
                - name: algorithm
                  value: string
                - name: rotationPolicy
                  value: string
                - name: size
                  value: integer
            - name: renewBefore
              value: string
        - name: memoryProfile
          value: string
        - name: mode
          value: []
        - 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 brokers resource.

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

DELETE example

Deletes the specified brokers resource.

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