How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Broker API

The Broker API from Microsoft Azure — 2 operation(s) for broker.

Microsoft Azure Broker API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Brokers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 5 operations across 2 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

5 operations 2 paths 37 schemas 1 DELETE2 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Broker 5
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker
microsoftAzureBrokerListbymqresource 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername
microsoftAzureBrokerGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername
microsoftAzureBrokerCreateorupdate 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername
microsoftAzureBrokerUpdate 5 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername
microsoftAzureBrokerDelete 5 params → 202204default

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are BrokerDiagnostics (14 properties), BrokerProperties (13 properties), BrokerResourceUpdateProperties (12 properties), BackendChain (8 properties). Each schema is shown below with its type and property counts.

BrokerResourceUpdate
object
The type used for update operations of the BrokerResource.
2 properties
VolumeClaimSpec
object
VolumeClaimSpec properties
8 properties
RunMode
string
The enum defining run mode of the broker deployment
DiskBackedMessageBufferSettings
object
DiskBackedMessageBufferSettings properties
3 properties 1 required
CertManagerPrivateKeyUpdate
object
Cert Manager private key properties
3 properties
NodeTolerations
object
Defines the Node Tolerations details
4 properties 4 required
NodeTolerationsUpdate
object
Defines the Node Tolerations details
4 properties
CardinalityUpdate
object
Cardinality properties
2 properties
DiskBackedMessageBufferSettingsUpdate
object
DiskBackedMessageBufferSettings properties
3 properties
BrokerDiagnostics
object
Diagnostics setting specific to Broker
14 properties
VolumeClaimResourceRequirements
object
VolumeClaimResourceRequirements properties
2 properties
BackendChain
object
Desired properties of the Frontend Instances of the DMQTT Broker
8 properties 2 required
BrokerResourceListResult
object
The response of a BrokerResource list operation.
2 properties 1 required
BrokerResourceUpdateProperties
object
The updatable properties of the BrokerResource.
12 properties
CertManagerCertOptionsUpdate
object
Cert Manager CA Cert properties
3 properties
TemporaryResourceLimitsConfigUpdate
object
Internal knobs of Resource Limits for FE and BE
7 properties
BrokerResource
object
MQ broker resource
2 properties 1 required
ContainerImage
object
Defines the Docker image details
4 properties 2 required
ProvisioningState
string
The enum defining status of resource.
VolumeClaimSpecSelectorMatchExpressions
object
VolumeClaimSpecSelectorMatchExpressions properties
3 properties 2 required
VolumeClaimDataSourceRefUpdate
object
VolumeClaimDataSourceRef properties
3 properties
BackendChainUpdate
object
Desired properties of the Frontend Instances of the DMQTT Broker
8 properties
BrokerProperties
object
Broker Resource properties
13 properties 4 required
ContainerImageUpdate
object
Defines the Docker image details
4 properties
TemporaryResourceLimitsConfig
object
Internal knobs of Resource Limits for FE and BE
7 properties 6 required
ExtendedLocationType
string
The enum defining type of ExtendedLocation accepted.
CertManagerCertOptions
object
Cert Manager CA Cert properties
3 properties 3 required
VolumeClaimDataSourceUpdate
object
VolumeClaimDataSource properties
3 properties
VolumeClaimDataSourceRef
object
VolumeClaimDataSourceRef properties
3 properties 2 required
VolumeClaimSpecSelector
object
VolumeClaimSpecSelector properties
2 properties
ExtendedLocationProperty
object
ExtendedLocation properties
2 properties 2 required
VolumeClaimSpecUpdate
object
VolumeClaimSpec properties
8 properties
Cardinality
object
Cardinality properties
2 properties 2 required
FrontendUpdate
object
Desired properties of the Frontend Instances of the DMQTT Broker
3 properties
CertManagerPrivateKey
object
Cert Manager private key properties
3 properties 3 required
Frontend
object
Desired properties of the Frontend Instances of the DMQTT Broker
3 properties 1 required
VolumeClaimDataSource
object
VolumeClaimDataSource properties
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-broker-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Broker API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.