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 BrokerAuthentication API

The BrokerAuthentication API from Microsoft Azure — 2 operation(s) for brokerauthentication.

Microsoft Azure BrokerAuthentication 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 BrokerAuthentication. 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 22 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

5 operations 2 paths 22 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.

BrokerAuthentication 5
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authentication
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authentication
microsoftAzureBrokerauthenticationListbybrokerresource 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authentication/{authenticationName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authentication Authenticationname
microsoftAzureBrokerauthenticationGet 6 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authentication/{authenticationName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authentication Authenticationname
microsoftAzureBrokerauthenticationCreateorupdate 6 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authentication/{authenticationName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authentication Authenticationname
microsoftAzureBrokerauthenticationUpdate 6 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authentication/{authenticationName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authentication Authenticationname
microsoftAzureBrokerauthenticationDelete 6 params → 202204default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are BrokerAuthenticatorMethods (5 properties), BrokerAuthenticatorMethodCustom (4 properties), KeyVaultCertificateProperties (3 properties), BrokerAuthenticatorMethodSvid (3 properties). Each schema is shown below with its type and property counts.

KeyVaultSecretObject
object
KeyVault secret object properties
2 properties 1 required
BrokerAuthenticatorMethodX509
object
X509 for BrokerAuthentication.
2 properties
BrokerAuthenticatorMethodSat
object
Service Account Token for BrokerAuthentication
1 property 1 required
BrokerAuthenticationResourceUpdate
object
The type used for update operations of the BrokerAuthenticationResource.
2 properties
BrokerAuthenticatorMethodCustom
object
Custom method for BrokerAuthentication
4 properties 1 required
BrokerAuthenticationResourceUpdateProperties
object
The updatable properties of the BrokerAuthenticationResource.
2 properties
BrokerAuthenticatorMethods
object
Collection of different CrdAuthenticator methods of Broker Resource. NOTE Enum - Only one method is supported for each entry.
5 properties
BrokerAuthenticatorMethodUsernamePassword
object
UsernamePassword for BrokerAuthentication
2 properties
BrokerAuthenticatorMethodX509Attributes
object
BrokerAuthenticatorMethodX509Attributes properties. NOTE - Enum only type supported at a time.
2 properties
BrokerAuthenticationResourceListResult
object
The response of a BrokerAuthenticationResource list operation.
2 properties 1 required
BrokerAuthenticatorCustomAuth
object
Custom Authentication properties
1 property 1 required
BrokerAuthenticationProperties
object
Broker Resource properties
3 properties 2 required
ProvisioningState
string
The enum defining status of resource.
KeyVaultSecretProperties
object
KeyVault secret properties
2 properties 2 required
BrokerAuthenticationResource
object
MQ broker/authentication resource
2 properties 1 required
ExtendedLocationType
string
The enum defining type of ExtendedLocation accepted.
BrokerAuthenticatorMethodSvid
object
SVID for BrokerAuthentication
3 properties 1 required
ExtendedLocationProperty
object
ExtendedLocation properties
2 properties 2 required
KeyVaultCredentialsProperties
object
KeyVault credentials properties. NOTE - Future this will be ENUM.
1 property 1 required
BrokerAuthenticatorCustomAuthX509
object
X509 Custom Authentication properties. NOTE - Enum only authenticator type supported at a time.
2 properties
KeyVaultCertificateProperties
object
KeyVault certificate properties
3 properties 2 required
KeyVaultConnectionProperties
object
KeyVault properties
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-brokerauthentication-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 BrokerAuthentication 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.