Reference: applications.core/containers@2023-10-01-preview

Detailed reference documentation for applications.core/containers@2023-10-01-preview

Schema

Top-Level Resource

Properties

Property	Type	Description
apiVersion	‘2023-10-01-preview’	The resource api version (ReadOnly, DeployTimeConstant)
id	string	The resource id (ReadOnly, DeployTimeConstant)
location	string	The geo-location where the resource lives
name	string	The resource name (Required, DeployTimeConstant, Identifier)
properties	ContainerProperties	Container properties (Required)
systemData	SystemData	Metadata pertaining to creation and last modification of the resource. (ReadOnly)
tags	TrackedResourceTags	Resource tags.
type	‘Applications.Core/containers’	The resource type (ReadOnly, DeployTimeConstant)

ContainerProperties

Properties

Property	Type	Description
application	string	Fully qualified resource ID for the application (Required)
connections	ContainerPropertiesConnections	Specifies a connection to another resource.
container	Container	Definition of a container (Required)
environment	string	Fully qualified resource ID for the environment that the application is linked to
extensions	Extension[]	Extensions spec of the resource
identity	IdentitySettings	IdentitySettings is the external identity setting.
provisioningState	‘Accepted’	‘Canceled’
resourceProvisioning	‘internal’	‘manual’
resources	ResourceReference[]	A collection of references to resources associated with the container
restartPolicy	‘Always’	‘Never’
runtimes	RuntimesProperties	The properties for runtime configuration
status	ResourceStatus	Status of a resource. (ReadOnly)

ContainerPropertiesConnections

Properties

none

Additional Properties

Additional Properties Type: ConnectionProperties

ConnectionProperties

Properties

Property	Type	Description
disableDefaultEnvVars	bool	default environment variable override
iam	IamProperties	IAM properties
source	string	The source of the connection (Required)

IamProperties

Properties

Property	Type	Description
kind	‘azure’	‘string’
roles	string[]	RBAC permissions to be assigned on the source resource

Container

Properties

Property	Type	Description
args	string[]	Arguments to the entrypoint. Overrides the container image’s CMD
command	string[]	Entrypoint array. Overrides the container image’s ENTRYPOINT
env	ContainerEnv	environment
image	string	The registry and image to download and run in your container (Required)
imagePullPolicy	‘Always’	‘IfNotPresent’
livenessProbe	HealthProbeProperties	Properties for readiness/liveness probe
ports	ContainerPorts	container ports
readinessProbe	HealthProbeProperties	Properties for readiness/liveness probe
volumes	ContainerVolumes	container volumes
workingDir	string	Working directory for the container

ContainerEnv

Properties

none

Additional Properties

Additional Properties Type: EnvironmentVariable

EnvironmentVariable

Properties

Property	Type	Description
value	string	The value of the environment variable
valueFrom	EnvironmentVariableReference	The reference to the variable

EnvironmentVariableReference

Properties

Property	Type	Description
secretRef	SecretReference	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 data. (Required)

SecretReference

Properties

Property	Type	Description
key	string	The key for the secret in the secret store. (Required)
source	string	The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution. (Required)

HealthProbeProperties

Discriminator: kind

Base Properties

Property	Type	Description
failureThreshold	int	Threshold number of times the probe fails after which a failure would be reported
initialDelaySeconds	int	Initial delay in seconds before probing for readiness/liveness
periodSeconds	int	Interval for the readiness/liveness probe in seconds
timeoutSeconds	int	Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds

ExecHealthProbeProperties

Properties

Property	Type	Description
command	string	Command to execute to probe readiness/liveness (Required)
kind	’exec'	Discriminator property for HealthProbeProperties. (Required)

HttpGetHealthProbeProperties

Properties

Property	Type	Description
containerPort	int	The listening port number (Required)
headers	HttpGetHealthProbePropertiesHeaders	Custom HTTP headers to add to the get request
kind	‘httpGet’	Discriminator property for HealthProbeProperties. (Required)
path	string	The route to make the HTTP request on (Required)

TcpHealthProbeProperties

Properties

Property	Type	Description
containerPort	int	The listening port number (Required)
kind	’tcp'	Discriminator property for HealthProbeProperties. (Required)

HttpGetHealthProbePropertiesHeaders

Properties

none

Additional Properties

Additional Properties Type: string

ContainerPorts

Properties

none

Additional Properties

Additional Properties Type: ContainerPortProperties

ContainerPortProperties

Properties

Property	Type	Description
containerPort	int	The listening port number (Required)
port	int	Specifies the port that will be exposed by this container. Must be set when value different from containerPort is desired
protocol	‘TCP’	‘UDP’
scheme	string	Specifies the URL scheme of the communication protocol. Consumers can use the scheme to construct a URL. The value defaults to ‘http’ or ‘https’ depending on the port value

ContainerVolumes

Properties

none

Additional Properties

Additional Properties Type: Volume

Volume

Discriminator: kind

Base Properties

Property	Type	Description
mountPath	string	The path where the volume is mounted

EphemeralVolume

Properties

Property	Type	Description
kind	’ephemeral’	Discriminator property for Volume. (Required)
managedStore	‘disk’	‘memory’

PersistentVolume

Properties

Property	Type	Description
kind	‘persistent’	Discriminator property for Volume. (Required)
permission	‘read’	‘write’
source	string	The source of the volume (Required)

Extension

Discriminator: kind

Base Properties

none

AzureContainerInstanceExtension

Properties

Property	Type	Description
kind	‘aci’	Discriminator property for Extension. (Required)
resourceGroup	string	The resource group of the application environment. (Required)

DaprSidecarExtension

Properties

Property	Type	Description
appId	string	The Dapr appId. Specifies the identifier used by Dapr for service invocation. (Required)
appPort	int	The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar.
config	string	Specifies the Dapr configuration to use for the resource.
kind	‘daprSidecar’	Discriminator property for Extension. (Required)
protocol	‘grpc’	‘http’

KubernetesMetadataExtension

Properties

Property	Type	Description
annotations	KubernetesMetadataExtensionAnnotations	Annotations to be applied to the Kubernetes resources output by the resource
kind	‘kubernetesMetadata’	Discriminator property for Extension. (Required)
labels	KubernetesMetadataExtensionLabels	Labels to be applied to the Kubernetes resources output by the resource

KubernetesNamespaceExtension

Properties

Property	Type	Description
kind	‘kubernetesNamespace’	Discriminator property for Extension. (Required)
namespace	string	The namespace of the application environment. (Required)

ManualScalingExtension

Properties

Property	Type	Description
kind	‘manualScaling’	Discriminator property for Extension. (Required)
replicas	int	Replica count. (Required)

KubernetesMetadataExtensionAnnotations

Properties

none

Additional Properties

Additional Properties Type: string

KubernetesMetadataExtensionLabels

Properties

none

Additional Properties

Additional Properties Type: string

IdentitySettings

Properties

Property	Type	Description
kind	‘azure.com.workload’	‘systemAssigned’
managedIdentity	string[]	The list of user assigned managed identities
oidcIssuer	string	The URI for your compute platform’s OIDC issuer
resource	string	The resource ID of the provisioned identity

ResourceReference

Properties

Property	Type	Description
id	string	Resource id of an existing resource (Required)

RuntimesProperties

Properties

Property	Type	Description
aci	ACIRuntimeProperties	The runtime configuration properties for Kubernetes
kubernetes	KubernetesRuntimeProperties	The runtime configuration properties for Kubernetes

ACIRuntimeProperties

Properties

Property	Type	Description
gatewayID	string	The ID of the gateway that is providing L7 traffic for the container

KubernetesRuntimeProperties

Properties

Property	Type	Description
base	string	The serialized YAML manifest which represents the base Kubernetes resources to deploy, such as Deployment, Service, ServiceAccount, Secrets, and ConfigMaps.
pod	KubernetesPodSpec	A strategic merge patch that will be applied to the PodSpec object when this container is being deployed.

KubernetesPodSpec

Properties

none

Additional Properties

Additional Properties Type: any

ResourceStatus

Properties

Property	Type	Description
compute	EnvironmentCompute	Represents backing compute resource
outputResources	OutputResource[]	Properties of an output resource
recipe	RecipeStatus	Recipe status at deployment time for a resource. (ReadOnly)

EnvironmentCompute

Discriminator: kind

Base Properties

Property	Type	Description
identity	IdentitySettings	IdentitySettings is the external identity setting.
resourceId	string	The resource id of the compute resource for application environment.

AzureContainerInstanceCompute

Properties

Property	Type	Description
kind	‘aci’	Discriminator property for EnvironmentCompute. (Required)
resourceGroup	string	The resource group to use for the environment.

KubernetesCompute

Properties

Property	Type	Description
kind	‘kubernetes’	Discriminator property for EnvironmentCompute. (Required)
namespace	string	The namespace to use for the environment. (Required)

OutputResource

Properties

Property	Type	Description
id	string	The UCP resource ID of the underlying resource.
localId	string	The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships.
radiusManaged	bool	Determines whether Radius manages the lifecycle of the underlying resource.

RecipeStatus

Properties

Property	Type	Description
templateKind	string	TemplateKind is the kind of the recipe template used by the portable resource upon deployment. (Required)
templatePath	string	TemplatePath is the path of the recipe consumed by the portable resource upon deployment. (Required)
templateVersion	string	TemplateVersion is the version number of the template.

SystemData

Properties

Property	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	‘Application’	‘Key’
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	‘Application’	‘Key’

TrackedResourceTags

Properties

none

Additional Properties

Additional Properties Type: string

Feedback

Was this page helpful?

Glad to hear it! Please feel free to star our repo and join our Discord server to stay up to date with the project.

Sorry to hear that. If you would like to also contribute a suggestion visit and tell us how we can improve.