Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Radius PubSubBrokers API

The PubSubBrokers API from Radius — 2 operation(s) for pubsubbrokers.

Radius PubSubBrokers API is one of 27 APIs that Radius publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PubSubBrokers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 2.0, at version 2023-10-01-preview.

Requests are made against the base URL https://management.azure.com.

5 operations 2 paths 18 schemas 1 DELETE2 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-10-01-preview
Base URL
https://management.azure.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Radius PubSubBrokers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (azure_auth) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

  • azure_auth — Azure Active Directory OAuth2 Flow.

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.

PubSubBrokers 5
GET
/{rootScope}/providers/Applications.Dapr/pubSubBrokers
List DaprPubSubBrokerResource resources by Scope
PubSubBrokers_ListByScope 2 params → 200default
GET
/{rootScope}/providers/Applications.Dapr/pubSubBrokers/{pubSubBrokerName}
Get a DaprPubSubBrokerResource
PubSubBrokers_Get 3 params → 200default
PUT
/{rootScope}/providers/Applications.Dapr/pubSubBrokers/{pubSubBrokerName}
Create a DaprPubSubBrokerResource
PubSubBrokers_CreateOrUpdate 4 params → 200201default
PATCH
/{rootScope}/providers/Applications.Dapr/pubSubBrokers/{pubSubBrokerName}
Update a DaprPubSubBrokerResource
PubSubBrokers_Update 4 params → 200202default
DELETE
/{rootScope}/providers/Applications.Dapr/pubSubBrokers/{pubSubBrokerName}
Delete a DaprPubSubBrokerResource
PubSubBrokers_Delete 3 params → 202204default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are DaprPubSubBrokerProperties (12 properties), IdentitySettings (4 properties), EnvironmentCompute (3 properties), ResourceStatus (3 properties). Each schema is shown below with its type and property counts.

DaprPubSubBrokerResourceListResult
object
The response of a DaprPubSubBrokerResource list operation.
2 properties 1 required
DaprPubSubBrokerProperties
object
Dapr PubSubBroker portable resource properties
12 properties 1 required
RecipeStatus
object
Recipe status at deployment time for a resource.
3 properties 2 required
OutputResource
object
Properties of an output resource.
3 properties
EnvironmentCompute
object
Represents backing compute resource
3 properties 1 required
IdentitySettingKind
string
IdentitySettingKind is the kind of supported external identity setting
MetadataValueFromSecret
object
A reference of a value in a secret store component.
2 properties 2 required
DaprPubSubBrokerResourceUpdate
object
Dapr PubSubBroker portable resource
ResourceStatus
object
Status of a resource.
3 properties
DaprPubSubBrokerResource
object
Dapr PubSubBroker portable resource
1 property 1 required
ResourceProvisioning
string
Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource thr…
DaprResourceAuth
object
Authentication properties for a Dapr component object
1 property
Recipe
object
The recipe used to automatically deploy underlying infrastructure for a portable resource
2 properties 1 required
Azure.ResourceManager.CommonTypes.TrackedResourceUpdate
object
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
1 property
ResourceReference
object
Describes a reference to an existing resource
1 property 1 required
ProvisioningState
string
Provisioning state of the resource at the time the operation was called
IdentitySettings
object
IdentitySettings is the external identity setting.
4 properties 1 required
MetadataValue
object
A single metadata for a Dapr component object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

radius-pubsubbrokers-api-openapi.yml Raw ↑

Other APIs Radius publishes across the network.

Radius ApiVersions API
Radius Applications API
Radius AwsCredentials API
Radius AwsPlanes API
Radius AzureCredentials API
Radius AzurePlanes API
Radius ConfigurationStores API
Radius Containers API
Radius Environments API
Radius Extenders API
Radius Gateways API
Radius Locations API