brokers

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

Overview

Name	brokers
Type	Resource
Id	azure.iotoperations.brokers

Fields

vw_brokers

Name	Datatype	Description
advanced	text	field from the properties object
brokerName	text	field from the properties object
cardinality	text	field from the properties object
diagnostics	text	field from the properties object
disk_backed_message_buffer	text	field from the properties object
extended_location	text	field from the properties object
generate_resource_limits	text	field from the properties object
instanceName	text	field from the properties object
memory_profile	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

brokers

Name	Datatype	Description
extendedLocation	object	Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.
properties	object	Broker Resource properties

Methods

Name	Accessible by	Required Params	Description
get	SELECT	brokerName, instanceName, resourceGroupName, subscriptionId	Get a BrokerResource
list_by_resource_group	SELECT	instanceName, resourceGroupName, subscriptionId	List BrokerResource resources by InstanceResource
create_or_update	INSERT	brokerName, instanceName, resourceGroupName, subscriptionId, data__extendedLocation	Create a BrokerResource
delete	DELETE	brokerName, instanceName, resourceGroupName, subscriptionId	Delete a BrokerResource

SELECT examples

List BrokerResource resources by InstanceResource

vw_brokers

SELECT
advanced,
brokerName,
cardinality,
diagnostics,
disk_backed_message_buffer,
extended_location,
generate_resource_limits,
instanceName,
memory_profile,
provisioning_state,
resourceGroupName,
subscriptionId
FROM azure.iotoperations.vw_brokers
WHERE instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

brokers

SELECT
extendedLocation,
properties
FROM azure.iotoperations.brokers
WHERE instanceName = '{{ instanceName }}'
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.iotoperations.brokers (
brokerName,
instanceName,
resourceGroupName,
subscriptionId,
data__extendedLocation,
properties,
extendedLocation
)
SELECT 
'{{ brokerName }}',
'{{ instanceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__extendedLocation }}',
'{{ properties }}',
'{{ extendedLocation }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: advanced
          value:
            - name: clients
              value:
                - name: maxSessionExpirySeconds
                  value: integer
                - name: maxMessageExpirySeconds
                  value: integer
                - name: maxPacketSizeBytes
                  value: integer
                - name: subscriberQueueLimit
                  value:
                    - name: length
                      value: integer
                    - name: strategy
                      value: string
                - name: maxReceiveMaximum
                  value: integer
                - name: maxKeepAliveSeconds
                  value: integer
            - name: encryptInternalTraffic
              value: string
            - name: internalCerts
              value:
                - name: duration
                  value: string
                - name: renewBefore
                  value: string
                - name: privateKey
                  value:
                    - name: algorithm
                      value: []
                    - name: rotationPolicy
                      value: []
        - name: cardinality
          value:
            - name: backendChain
              value:
                - name: partitions
                  value: integer
                - name: redundancyFactor
                  value: integer
                - name: workers
                  value: integer
            - name: frontend
              value:
                - name: replicas
                  value: integer
                - name: workers
                  value: integer
        - name: diagnostics
          value:
            - name: logs
              value:
                - name: opentelemetryExportConfig
                  value:
                    - name: otlpGrpcEndpoint
                      value: string
                    - name: intervalSeconds
                      value: integer
                    - name: level
                      value: string
                - name: level
                  value: string
            - name: metrics
              value:
                - name: opentelemetryExportConfig
                  value:
                    - name: otlpGrpcEndpoint
                      value: string
                    - name: intervalSeconds
                      value: integer
                - name: prometheusPort
                  value: integer
            - name: selfCheck
              value:
                - name: mode
                  value: string
                - name: intervalSeconds
                  value: integer
                - name: timeoutSeconds
                  value: integer
            - name: traces
              value:
                - name: mode
                  value: string
                - name: cacheSizeMegabytes
                  value: integer
                - name: selfTracing
                  value:
                    - name: mode
                      value: string
                    - name: intervalSeconds
                      value: integer
                - name: spanChannelCapacity
                  value: integer
        - name: diskBackedMessageBuffer
          value:
            - name: maxSize
              value: string
            - name: ephemeralVolumeClaimSpec
              value:
                - name: volumeName
                  value: string
                - name: volumeMode
                  value: string
                - name: storageClassName
                  value: string
                - 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: namespace
                      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: []
                          - name: values
                            value:
                              - string
                    - name: matchLabels
                      value: object
        - name: generateResourceLimits
          value:
            - name: cpu
              value: string
        - name: memoryProfile
          value: string
        - name: provisioningState
          value: []
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []

DELETE example

Deletes the specified brokers resource.

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