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

The MongoDatabases API from Radius — 3 operation(s) for mongodatabases.

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

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

This API exposes 6 operations across 3 paths, and defines 17 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.

6 operations 3 paths 17 schemas 1 DELETE2 GET1 PATCH1 POST1 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 MongoDatabases 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 6

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

MongoDatabases 6
GET
/{rootScope}/providers/Applications.Datastores/mongoDatabases
List MongoDatabaseResource resources by Scope
MongoDatabases_ListByScope 2 params → 200default
GET
/{rootScope}/providers/Applications.Datastores/mongoDatabases/{mongoDatabaseName}
Get a MongoDatabaseResource
MongoDatabases_Get 3 params → 200default
PUT
/{rootScope}/providers/Applications.Datastores/mongoDatabases/{mongoDatabaseName}
Create a MongoDatabaseResource
MongoDatabases_CreateOrUpdate 4 params → 200201default
PATCH
/{rootScope}/providers/Applications.Datastores/mongoDatabases/{mongoDatabaseName}
Update a MongoDatabaseResource
MongoDatabases_Update 4 params → 200202default
DELETE
/{rootScope}/providers/Applications.Datastores/mongoDatabases/{mongoDatabaseName}
Delete a MongoDatabaseResource
MongoDatabases_Delete 3 params → 202204default
POST
/{rootScope}/providers/Applications.Datastores/mongoDatabases/{mongoDatabaseName}/listSecrets
Lists secrets values for the specified MongoDatabases resource
MongoDatabases_ListSecrets 4 params → 200default

Schemas 17

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

MongoDatabaseResource
object
MongoDatabase 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…
IdentitySettingKind
string
IdentitySettingKind is the kind of supported external identity setting
Recipe
object
The recipe used to automatically deploy underlying infrastructure for a portable resource
2 properties 1 required
MongoDatabaseResourceUpdate
object
MongoDatabase portable resource
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
MongoDatabaseSecrets
object
The secret values for the given MongoDatabase resource
2 properties
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
RecipeStatus
object
Recipe status at deployment time for a resource.
3 properties 2 required
ResourceStatus
object
Status of a resource.
3 properties
OutputResource
object
Properties of an output resource.
3 properties
MongoDatabaseProperties
object
MongoDatabase portable resource properties
12 properties 1 required
EnvironmentCompute
object
Represents backing compute resource
3 properties 1 required
MongoDatabaseResourceListResult
object
The response of a MongoDatabaseResource list operation.
2 properties 1 required
MongoDatabaseListSecretsResult
object
The secret values for the given MongoDatabase resource
2 properties
ResourceReference
object
Describes a reference to an existing resource
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

radius-mongodatabases-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