Broker - Get

Service:

IoT MQ

API Version:

2023-10-04-preview

Get a BrokerResource

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}?api-version=2023-10-04-preview

URI Parameters

Name	In	Required	Type	Description
brokerName	path	True	string	Name of MQ broker resource Regex pattern: ^[a-zA-Z0-9-]{3,24}$
mqName	path	True	string	Name of MQ resource Regex pattern: ^[a-zA-Z0-9-]{3,24}$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	BrokerResource	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Broker_Get

Sample request

HTTP

GET https://management.azure.com/subscriptions/2408F1A7-C077-406C-814C-FBD93E129C00/resourceGroups/rgiotoperationsmq/providers/Microsoft.IoTOperationsMQ/mq/-94G43TOG-6ixsX-3IO-/broker/87k76OKEKCQhL?api-version=2023-10-04-preview

Sample response

Status code:

200

{
  "properties": {
    "authImage": {
      "pullPolicy": "imfuzvqxgbdwliqnn",
      "pullSecrets": "klnqimxqsrdwhcqldjvdtsrs",
      "repository": "m",
      "tag": "jygfdiamhhm"
    },
    "brokerImage": {
      "pullPolicy": "imfuzvqxgbdwliqnn",
      "pullSecrets": "klnqimxqsrdwhcqldjvdtsrs",
      "repository": "m",
      "tag": "jygfdiamhhm"
    },
    "brokerNodeTolerations": {
      "effect": "eeswvciblqmmaeesjoflyvxqbz",
      "key": "wbrstdwxgm",
      "operator": "lbegegneekwnyodtzraarivtwhmzep",
      "value": "sfafsjdcezdmkwibxeluukxgl"
    },
    "cardinality": {
      "backendChain": {
        "partitions": 34721,
        "redundancyFactor": 468,
        "temporaryDiskTransferEnabled": true,
        "temporaryDiskTransferHighWatermarkPercent": 79,
        "temporaryDiskTransferLowWatermarkPercent": 94,
        "temporaryMaxBackendMemUsagePercent": 54,
        "temporaryResourceLimits": {
          "maxInflightMessages": 33208,
          "maxInflightPatches": 3410,
          "maxInflightPatchesPerClient": 58933,
          "maxMessageExpirySecs": 2036532516,
          "maxQueuedMessages": 8083241696687839000,
          "maxQueuedQos0Messages": 6545343433569253000,
          "maxSessionExpirySecs": 2526293894
        },
        "workers": 15754
      },
      "frontend": {
        "replicas": 38165,
        "temporaryResourceLimits": {
          "maxInflightMessages": 33208,
          "maxInflightPatches": 3410,
          "maxInflightPatchesPerClient": 58933,
          "maxMessageExpirySecs": 2036532516,
          "maxQueuedMessages": 8083241696687839000,
          "maxQueuedQos0Messages": 6545343433569253000,
          "maxSessionExpirySecs": 2526293894
        },
        "workers": 38
      }
    },
    "diagnostics": {
      "diagnosticServiceEndpoint": "cdvelitwasofaaqhdb",
      "enableMetrics": true,
      "enableSelfCheck": true,
      "enableSelfTracing": true,
      "enableTracing": true,
      "logFormat": "tcivnlakxcajynypbz",
      "logLevel": "zdjh",
      "maxCellMapLifetime": 997099872515057700,
      "metricUpdateFrequencySeconds": 6156703238506293000,
      "probeImage": "uzizubdxsgcpjwly",
      "selfCheckFrequencySeconds": 579622483050303900,
      "selfCheckTimeoutSeconds": 7847246333600884000,
      "selfTraceFrequencySeconds": 6527612490765175000,
      "spanChannelCapacity": 5533451650716962000
    },
    "diskBackedMessageBufferSettings": {
      "ephemeralVolumeClaimSpec": {
        "accessModes": [
          "cly"
        ],
        "dataSource": {
          "apiGroup": "v",
          "kind": "pvzbnjebkoslzzucpaem",
          "name": "bgzdfwfpdrubbbnfwzyr"
        },
        "dataSourceRef": {
          "apiGroup": "e",
          "kind": "hjbktqbtg",
          "name": "losjjcujomepwhztzptrobavolc"
        },
        "resources": {
          "limits": {},
          "requests": {}
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "d",
              "operator": "fcfvoarytcdbtccjervsmdis",
              "values": [
                "y"
              ]
            }
          ],
          "matchLabels": {}
        },
        "storageClassName": "etajfhrtgatxi",
        "volumeMode": "mipdeutsgidkzpxelbrqggjheplvmx",
        "volumeName": "dacuvlvuullautxjxwdctvzlmd"
      },
      "maxSize": "gnwxgqjypylz",
      "persistentVolumeClaimSpec": {
        "accessModes": [
          "cly"
        ],
        "dataSource": {
          "apiGroup": "v",
          "kind": "pvzbnjebkoslzzucpaem",
          "name": "bgzdfwfpdrubbbnfwzyr"
        },
        "dataSourceRef": {
          "apiGroup": "e",
          "kind": "hjbktqbtg",
          "name": "losjjcujomepwhztzptrobavolc"
        },
        "resources": {
          "limits": {},
          "requests": {}
        },
        "selector": {
          "matchExpressions": [
            {
              "key": "d",
              "operator": "fcfvoarytcdbtccjervsmdis",
              "values": [
                "y"
              ]
            }
          ],
          "matchLabels": {}
        },
        "storageClassName": "etajfhrtgatxi",
        "volumeMode": "mipdeutsgidkzpxelbrqggjheplvmx",
        "volumeName": "dacuvlvuullautxjxwdctvzlmd"
      }
    },
    "healthManagerImage": {
      "pullPolicy": "imfuzvqxgbdwliqnn",
      "pullSecrets": "klnqimxqsrdwhcqldjvdtsrs",
      "repository": "m",
      "tag": "jygfdiamhhm"
    },
    "healthManagerNodeTolerations": {
      "effect": "eeswvciblqmmaeesjoflyvxqbz",
      "key": "wbrstdwxgm",
      "operator": "lbegegneekwnyodtzraarivtwhmzep",
      "value": "sfafsjdcezdmkwibxeluukxgl"
    },
    "internalCerts": {
      "duration": "xjjmzq",
      "privateKey": {
        "algorithm": "wwewfsddymjefuhxzqybwvay",
        "rotationPolicy": "jxmpyvfneckopjiakjtous",
        "size": 63427
      },
      "renewBefore": "zkajhllevrxkfmfyzasmbllvd"
    },
    "memoryProfile": "tiny",
    "mode": "auto",
    "provisioningState": "Succeeded",
    "encryptInternalTraffic": true
  },
  "extendedLocation": {
    "name": "an",
    "type": "CustomLocation"
  },
  "tags": {},
  "location": "ltzfwqzs",
  "id": "klgod",
  "name": "blyxqmvmwlzftkvi",
  "type": "xanpogmjzjzgvbpjiejhiotub",
  "systemData": {
    "createdBy": "lsch",
    "createdByType": "User",
    "createdAt": "2023-10-06T15:04:36.253Z",
    "lastModifiedBy": "moncedixbtiffwcevatm",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-10-06T15:04:36.256Z"
  }
}

Definitions

Name	Description
BackendChain	Desired properties of the Frontend Instances of the DMQTT Broker
BrokerDiagnostics	Diagnostics setting specific to Broker
BrokerMemoryProfile	The memory profile settings of the Broker
BrokerResource	MQ broker resource
Cardinality	Cardinality properties
CertManagerCertOptions	Cert Manager CA Cert properties
CertManagerPrivateKey	Cert Manager private key properties
ContainerImage	Defines the Docker image details
createdByType	The type of identity that created the resource.
DiskBackedMessageBufferSettings	DiskBackedMessageBufferSettings properties
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocationProperty	ExtendedLocation properties
ExtendedLocationType	The enum defining type of ExtendedLocation accepted.
Frontend	Desired properties of the Frontend Instances of the DMQTT Broker
NodeTolerations	Defines the Node Tolerations details
ProvisioningState	The enum defining status of resource.
RunMode	The enum defining run mode of the broker deployment
systemData	Metadata pertaining to creation and last modification of the resource.
TemporaryResourceLimitsConfig	Internal knobs of Resource Limits for FE and BE
VolumeClaimDataSource	VolumeClaimDataSource properties
VolumeClaimDataSourceRef	VolumeClaimDataSourceRef properties
VolumeClaimResourceRequirements	VolumeClaimResourceRequirements properties
VolumeClaimSpec	VolumeClaimSpec properties
VolumeClaimSpecSelector	VolumeClaimSpecSelector properties
VolumeClaimSpecSelectorMatchExpressions	VolumeClaimSpecSelectorMatchExpressions properties

BackendChain

Desired properties of the Frontend Instances of the DMQTT Broker

Name	Type	Default value	Description
partitions	integer		Partitions is desired number of physical backend chains of the given distributed MQTT broker.
redundancyFactor	integer		Redundancy Factor is desired numbers of broker instances in one chain.
temporaryDiskTransferEnabled	boolean		Defines whether disk transfer is enabled or not.
temporaryDiskTransferHighWatermarkPercent	integer		Defines the percentage usage of buffer pool above which disk transfer will start.
temporaryDiskTransferLowWatermarkPercent	integer		Defines the percentage usage of buffer pool below which disk transfer will stop.
temporaryMaxBackendMemUsagePercent	integer		Defines the limits for memory usage percent of the backend instances of the MQTT broker.
temporaryResourceLimits	TemporaryResourceLimitsConfig		Defines the limits for resources of the backend instances of the MQTT broker.
workers	integer	1	Number of logical backend workers per pod.

BrokerDiagnostics

Diagnostics setting specific to Broker

Name	Type	Default value	Description
diagnosticServiceEndpoint	string		Diagnostic Service endpoint
enableMetrics	boolean	True	Knob to enable/disable metrics. Default = true
enableSelfCheck	boolean	True	Enable self check on Broker via Probe.
enableSelfTracing	boolean	True	Enable self tracing on the Broker so that every selfCheckFrequencySeconds a random message is traced even if it didn't have trace context.
enableTracing	boolean	True	Knob to enable/disable entire tracing infrastructure.
logFormat	string	text	Format for the logs generated.
logLevel	string	info,hyper=off,kube_client=off,tower=off,conhash=off,h2=off	Log level for the Broker.
maxCellMapLifetime	integer	60	Maximum time for the CellMap to live.
metricUpdateFrequencySeconds	integer	30	Metric update frequency in seconds.
probeImage	string	sample.azurecr.io/diagnostics-probe:0.5.0	Probe Image to run.
selfCheckFrequencySeconds	integer	30	Frequency for the self check to run.
selfCheckTimeoutSeconds	integer	15	Time out period of the self check.
selfTraceFrequencySeconds	integer	30	The frequency at which selfTrace should run.
spanChannelCapacity	integer	1000	The number of the spans generated by the Tracing.

BrokerMemoryProfile

The memory profile settings of the Broker

Name	Type	Description
high	string	High memory profile.
low	string	Low memory profile.
medium	string	Medium memory profile.
tiny	string	Tiny memory profile.

BrokerResource

MQ broker resource

Name	Type	Default value	Description
extendedLocation	ExtendedLocationProperty		Extended Location
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.authImage	ContainerImage		The details of Authentication Docker Image.
properties.brokerImage	ContainerImage		The details of Broker Docker Image.
properties.brokerNodeTolerations	NodeTolerations		The details of Node Tolerations for Broker Pods.
properties.cardinality	Cardinality		The cardinality details of the broker.
properties.diagnostics	BrokerDiagnostics		The diagnostic details of the broker deployment.
properties.diskBackedMessageBufferSettings	DiskBackedMessageBufferSettings		The settings of the disk-backed message buffer.
properties.encryptInternalTraffic	boolean	True	The setting to enable or disable encryption of internal Traffic.
properties.healthManagerImage	ContainerImage		The details of Health Manager Docker Image.
properties.healthManagerNodeTolerations	NodeTolerations		The details of Node Tolerations for Health Manager Pods.
properties.internalCerts	CertManagerCertOptions		Details of the internal CA cert that will be used to secure communication between pods.
properties.memoryProfile	BrokerMemoryProfile	medium	Memory profile of broker.
properties.mode	RunMode		The Running Mode of the Broker Deployment.
properties.provisioningState	ProvisioningState		The status of the last operation.
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Cardinality

Cardinality properties

Name	Type	Description
backendChain	BackendChain	The backend broker desired properties
frontend	Frontend	The frontend broker desired properties

CertManagerCertOptions

Cert Manager CA Cert properties

Name	Type	Default value	Description
duration	string	720h	Duration of CA cert.
privateKey	CertManagerPrivateKey		Cert Manager private key.
renewBefore	string	240h	Renew before time of CA cert.

CertManagerPrivateKey

Cert Manager private key properties

Name	Type	Default value	Description
algorithm	string	ECDSA	algorithm for private key.
rotationPolicy	string	Always	cert-manager rotationPolicy.
size	integer	256	size of private key.

ContainerImage

Defines the Docker image details

Name	Type	Description
pullPolicy	string	Image pull policy.
pullSecrets	string	Image pull secrets.
repository	string	The Docker image name.
tag	string	The Docker image tag.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DiskBackedMessageBufferSettings

DiskBackedMessageBufferSettings properties

Name	Type	Description
ephemeralVolumeClaimSpec	VolumeClaimSpec	Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes for details.
maxSize	string	The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See https://kubernetes.io/docs/concepts/storage/volumes/#emptydir for details.
persistentVolumeClaimSpec	VolumeClaimSpec	Use the specified persistent volume claim template to mount a persistent volume for the message buffer.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExtendedLocationProperty

ExtendedLocation properties

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationType	Type of ExtendedLocation.

ExtendedLocationType

The enum defining type of ExtendedLocation accepted.

Name	Type	Description
CustomLocation	string	CustomLocation type

Frontend

Desired properties of the Frontend Instances of the DMQTT Broker

Name	Type	Default value	Description
replicas	integer		Replicas is desired number of frontend replicas of the given distributed MQTT broker.
temporaryResourceLimits	TemporaryResourceLimitsConfig		Defines the limits for resources of the frontend instances of the MQTT broker.
workers	integer	2	Number of logical frontend workers per pod.

NodeTolerations

Defines the Node Tolerations details

Name	Type	Description
effect	string	Toleration effect.
key	string	Toleration key.
operator	string	Toleration operator like 'Exists', 'Equal' etc.
value	string	Toleration Value.

ProvisioningState

The enum defining status of resource.

Name	Type	Description
Accepted	string	Resource has been Accepted.
Canceled	string	Resource creation was canceled.
Deleting	string	Resource is Deleting.
Failed	string	Resource creation failed.
Provisioning	string	Resource is getting provisioned.
Succeeded	string	Resource has been created.
Updating	string	Resource is Updating.

RunMode

The enum defining run mode of the broker deployment

Name	Type	Description
auto	string	Automatically provision Frontend and Backend pods.
distributed	string	Use Cardinality to set Frontend and Backend pods.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TemporaryResourceLimitsConfig

Internal knobs of Resource Limits for FE and BE

Name	Type	Description
maxInflightMessages	integer	Maximum number of messages a client can have inflight.
maxInflightPatches	integer	Maximum number of patch inflight per node.
maxInflightPatchesPerClient	integer	Maximum number of patch a client can have in flight.
maxMessageExpirySecs	integer	Maximum message expiry interval, in seconds.
maxQueuedMessages	integer	Maximum receive for external clients.
maxQueuedQos0Messages	integer	Maximum receive QoS0 for external clients.
maxSessionExpirySecs	integer	Maximum session expiry interval, in seconds.

VolumeClaimDataSource

VolumeClaimDataSource properties

Name	Type	Description
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind	string	Kind is the type of resource being referenced
name	string	Name is the name of resource being referenced

VolumeClaimDataSourceRef

VolumeClaimDataSourceRef properties

Name	Type	Description
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind	string	Kind is the type of resource being referenced
name	string	Name is the name of resource being referenced

VolumeClaimResourceRequirements

VolumeClaimResourceRequirements properties

Name	Type	Description
limits	object	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests	object	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

VolumeClaimSpec

VolumeClaimSpec properties

Name	Type	Description
accessModes	string[]	AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource	VolumeClaimDataSource	This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
dataSourceRef	VolumeClaimDataSourceRef	Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
resources	VolumeClaimResourceRequirements	Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector	VolumeClaimSpecSelector	A label query over volumes to consider for binding.
storageClassName	string	Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature.
volumeName	string	VolumeName is the binding reference to the PersistentVolume backing this claim.

VolumeClaimSpecSelector

VolumeClaimSpecSelector properties

Name	Type	Description
matchExpressions	VolumeClaimSpecSelectorMatchExpressions[]	MatchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	object	MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

VolumeClaimSpecSelectorMatchExpressions

VolumeClaimSpecSelectorMatchExpressions properties

Name	Type	Description
key	string	key is the label key that the selector applies to.
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	string[]	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.