Radius Containers API

The Containers API from Radius — 2 operation(s) for containers.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 5 operations across 2 paths, and defines 32 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 32 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

Authentication & Security 1

Radius Containers 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.

Containers 5

GET

/{rootScope}/providers/Applications.Core/containers

List ContainerResource resources by Scope

Containers_ListByScope 2 params → 200default

GET

/{rootScope}/providers/Applications.Core/containers/{containerName}

Get a ContainerResource

Containers_Get 3 params → 200default

PUT

/{rootScope}/providers/Applications.Core/containers/{containerName}

Create a ContainerResource

Containers_CreateOrUpdate 4 params → 200201default

PATCH

/{rootScope}/providers/Applications.Core/containers/{containerName}

Update a ContainerResource

Containers_Update 4 params → 200202default

DELETE

/{rootScope}/providers/Applications.Core/containers/{containerName}

Delete a ContainerResource

Containers_Delete 3 params → 202204default

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are ContainerProperties (12 properties), Container (10 properties), HealthProbeProperties (5 properties), ContainerPortProperties (4 properties). Each schema is shown below with its type and property counts.

SecretReference

object

This secret is used within a recipe. Secrets are encrypted, often have fine-grained access control, auditing and are recommended to be used to hold sensitive d…

2 properties 2 required

Volume

object

Specifies a volume for a container

2 properties 1 required

IamProperties

object

IAM properties

2 properties 1 required

KubernetesPodSpec

object

A strategic merge patch that will be applied to the PodSpec object when this container is being deployed.

RecipeStatus

object

Recipe status at deployment time for a resource.

3 properties 2 required

EnvironmentVariableReference

object

The reference to the variable

1 property 1 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

IAMKind

string

The kind of IAM provider to configure

ContainerResourceListResult

object

The response of a ContainerResource list operation.

2 properties 1 required

ResourceStatus

object

Status of a resource.

3 properties

ContainerProperties

object

Container properties

12 properties 2 required

ImagePullPolicy

string

The image pull policy for the container

PortProtocol

string

The protocol in use by the port

RestartPolicy

string

Restart policy for the container

ACIRuntimeProperties

object

The runtime configuration properties for Kubernetes

1 property

ContainerResourceProvisioning

string

Specifies how the underlying service/resource is provisioned and managed. Available values are 'internal', where Radius manages the lifecycle of the resource i…

ContainerResource

object

Concrete tracked resource types can be created by aliasing this type using a specific property type.

1 property 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

EnvironmentVariable

object

Environment variables type

2 properties

Container

object

Definition of a container

10 properties 1 required

KubernetesRuntimeProperties

object

The runtime configuration properties for Kubernetes

2 properties

RuntimesProperties

object

The properties for runtime configuration

2 properties

HealthProbeProperties

object

Properties for readiness/liveness probe

5 properties 1 required

ResourceReference

object

Describes a reference to an existing resource

1 property 1 required

ContainerResourceUpdate

object

Concrete tracked resource types can be created by aliasing this type using a specific property type.

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

ContainerPortProperties

object

Specifies a listening port for the container

4 properties 1 required

Extension

object

Extension of a environment/application resource.

1 property 1 required

ConnectionProperties

object

Connection Properties

3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Radius publishes across the network.

Radius ApiVersions API

AE Profile APIs.io

Radius Applications API

AE Profile APIs.io

Radius AwsCredentials API

AE Profile APIs.io

Radius AwsPlanes API

AE Profile APIs.io

Radius AzureCredentials API

AE Profile APIs.io

Radius AzurePlanes API

AE Profile APIs.io

Radius ConfigurationStores API

AE Profile APIs.io

Radius Environments API

AE Profile APIs.io

Radius Extenders API

AE Profile APIs.io

Radius Gateways API

AE Profile APIs.io

Radius Locations API

AE Profile APIs.io

Radius MongoDatabases API

AE Profile APIs.io

#Containers

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Radius Containers API

Metadata

Authentication & Security 1

Paths & Operations 5

Schemas 32

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Radius Containers API

Metadata

Authentication & Security 1

Paths & Operations 5

Schemas 32

Specification

Source

More from Radius 12

API Details

Provider

Explore more