broker

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

Overview

Name	broker
Type	Resource
Id	azure.iot_operations.broker

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
advanced	object	Advanced settings of Broker.
cardinality	object	The cardinality details of the broker.
diagnostics	object	Spec defines the desired identities of Broker diagnostics settings.
diskBackedMessageBuffer	object	Settings of Disk Backed Message Buffer.
extendedLocation	object	Edge location of the resource.
generateResourceLimits	object	This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
memoryProfile	string	Memory profile of Broker. Known values are: "Tiny", "Low", "Medium", and "High". (Tiny, Low, Medium, High)
persistence	object	The persistence settings of the Broker.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
status	object	The status for the broker.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
advanced	object	Advanced settings of Broker.
cardinality	object	The cardinality details of the broker.
diagnostics	object	Spec defines the desired identities of Broker diagnostics settings.
diskBackedMessageBuffer	object	Settings of Disk Backed Message Buffer.
extendedLocation	object	Edge location of the resource.
generateResourceLimits	object	This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
memoryProfile	string	Memory profile of Broker. Known values are: "Tiny", "Low", "Medium", and "High". (Tiny, Low, Medium, High)
persistence	object	The persistence settings of the Broker.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
status	object	The status for the broker.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, instance_name, broker_name, subscription_id		Get a BrokerResource.
list_by_resource_group	select	resource_group_name, instance_name, subscription_id		List BrokerResource resources by InstanceResource.
create_or_update	insert	resource_group_name, instance_name, broker_name, subscription_id		Create a BrokerResource.
create_or_update	replace	resource_group_name, instance_name, broker_name, subscription_id		Create a BrokerResource.
delete	delete	resource_group_name, instance_name, broker_name, subscription_id		Delete a BrokerResource.

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
broker_name	string	Name of broker. Required.
instance_name	string	Name of instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a BrokerResource.

SELECT
id,
name,
advanced,
cardinality,
diagnostics,
diskBackedMessageBuffer,
extendedLocation,
generateResourceLimits,
healthState,
memoryProfile,
persistence,
provisioningState,
status,
systemData,
type
FROM azure.iot_operations.broker
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND broker_name = '{{ broker_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List BrokerResource resources by InstanceResource.

SELECT
id,
name,
advanced,
cardinality,
diagnostics,
diskBackedMessageBuffer,
extendedLocation,
generateResourceLimits,
healthState,
memoryProfile,
persistence,
provisioningState,
status,
systemData,
type
FROM azure.iot_operations.broker
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a BrokerResource.

INSERT INTO azure.iot_operations.broker (
properties,
extendedLocation,
resource_group_name,
instance_name,
broker_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ instance_name }}',
'{{ broker_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: broker
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the broker resource.
  - name: instance_name
    value: "{{ instance_name }}"
    description: Required parameter for the broker resource.
  - name: broker_name
    value: "{{ broker_name }}"
    description: Required parameter for the broker resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the broker resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      advanced:
        clients:
          maxSessionExpirySeconds: {{ maxSessionExpirySeconds }}
          maxMessageExpirySeconds: {{ maxMessageExpirySeconds }}
          maxPacketSizeBytes: {{ maxPacketSizeBytes }}
          subscriberQueueLimit:
            length: {{ length }}
            strategy: "{{ strategy }}"
          maxReceiveMaximum: {{ maxReceiveMaximum }}
          maxKeepAliveSeconds: {{ maxKeepAliveSeconds }}
        encryptInternalTraffic: "{{ encryptInternalTraffic }}"
        internalCerts:
          duration: "{{ duration }}"
          renewBefore: "{{ renewBefore }}"
          privateKey:
            algorithm: "{{ algorithm }}"
            rotationPolicy: "{{ rotationPolicy }}"
      cardinality:
        backendChain:
          partitions: {{ partitions }}
          redundancyFactor: {{ redundancyFactor }}
          workers: {{ workers }}
        frontend:
          replicas: {{ replicas }}
          workers: {{ workers }}
      diagnostics:
        logs:
          level: "{{ level }}"
        metrics:
          prometheusPort: {{ prometheusPort }}
        selfCheck:
          mode: "{{ mode }}"
          intervalSeconds: {{ intervalSeconds }}
          timeoutSeconds: {{ timeoutSeconds }}
        traces:
          mode: "{{ mode }}"
          cacheSizeMegabytes: {{ cacheSizeMegabytes }}
          selfTracing:
            mode: "{{ mode }}"
            intervalSeconds: {{ intervalSeconds }}
          spanChannelCapacity: {{ spanChannelCapacity }}
      diskBackedMessageBuffer:
        maxSize: "{{ maxSize }}"
        ephemeralVolumeClaimSpec:
          volumeName: "{{ volumeName }}"
          volumeMode: "{{ volumeMode }}"
          storageClassName: "{{ storageClassName }}"
          accessModes:
            - "{{ accessModes }}"
          dataSource:
            apiGroup: "{{ apiGroup }}"
            kind: "{{ kind }}"
            name: "{{ name }}"
          dataSourceRef:
            apiGroup: "{{ apiGroup }}"
            kind: "{{ kind }}"
            name: "{{ name }}"
            namespace: "{{ namespace }}"
          resources:
            limits: "{{ limits }}"
            requests: "{{ requests }}"
            claims:
              - name: "{{ name }}"
          selector:
            matchExpressions:
              - key: "{{ key }}"
                operator: "{{ operator }}"
                values: "{{ values }}"
            matchLabels: "{{ matchLabels }}"
        persistentVolumeClaimSpec:
          volumeName: "{{ volumeName }}"
          volumeMode: "{{ volumeMode }}"
          storageClassName: "{{ storageClassName }}"
          accessModes:
            - "{{ accessModes }}"
          dataSource:
            apiGroup: "{{ apiGroup }}"
            kind: "{{ kind }}"
            name: "{{ name }}"
          dataSourceRef:
            apiGroup: "{{ apiGroup }}"
            kind: "{{ kind }}"
            name: "{{ name }}"
            namespace: "{{ namespace }}"
          resources:
            limits: "{{ limits }}"
            requests: "{{ requests }}"
            claims:
              - name: "{{ name }}"
          selector:
            matchExpressions:
              - key: "{{ key }}"
                operator: "{{ operator }}"
                values: "{{ values }}"
            matchLabels: "{{ matchLabels }}"
      generateResourceLimits:
        cpu: "{{ cpu }}"
      memoryProfile: "{{ memoryProfile }}"
      persistence:
        maxSize: "{{ maxSize }}"
        persistentVolumeClaimSpec:
          volumeName: "{{ volumeName }}"
          volumeMode: "{{ volumeMode }}"
          storageClassName: "{{ storageClassName }}"
          accessModes:
            - "{{ accessModes }}"
          dataSource:
            apiGroup: "{{ apiGroup }}"
            kind: "{{ kind }}"
            name: "{{ name }}"
          dataSourceRef:
            apiGroup: "{{ apiGroup }}"
            kind: "{{ kind }}"
            name: "{{ name }}"
            namespace: "{{ namespace }}"
          resources:
            limits: "{{ limits }}"
            requests: "{{ requests }}"
            claims:
              - name: "{{ name }}"
          selector:
            matchExpressions:
              - key: "{{ key }}"
                operator: "{{ operator }}"
                values: "{{ values }}"
            matchLabels: "{{ matchLabels }}"
        retain:
          mode: "{{ mode }}"
        stateStore:
          mode: "{{ mode }}"
        subscriberQueue:
          mode: "{{ mode }}"
        encryption:
          mode: "{{ mode }}"
      provisioningState: "{{ provisioningState }}"
      status:
        healthState:
          status: "{{ status }}"
          lastTransitionTime: "{{ lastTransitionTime }}"
          lastUpdateTime: "{{ lastUpdateTime }}"
          message: "{{ message }}"
          reasonCode: "{{ reasonCode }}"
      healthState: "{{ healthState }}"
  - name: extendedLocation
    description: |
      Edge location of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

REPLACE examples

create_or_update

Create a BrokerResource.

REPLACE azure.iot_operations.broker
SET 
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND broker_name = '{{ broker_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete a BrokerResource.

DELETE FROM azure.iot_operations.broker
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND broker_name = '{{ broker_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;