From 50b0b361611be7097cae9191f83bbbdab0a3f81c Mon Sep 17 00:00:00 2001 From: "radius-docs[bot]" <291938785+radius-docs[bot]@users.noreply.github.com> Date: Tue, 4 Aug 2026 21:18:18 +0000 Subject: [PATCH 1/3] docs: synced local 'docs/content/reference/resources/' with remote 'docs/docs/content/reference/resources/' Signed-off-by: radius-docs[bot] <291938785+radius-docs[bot]@users.noreply.github.com> --- .../2023-10-01-preview/applications/index.md | 250 +++---- .../2023-10-01-preview/containers/index.md | 634 +++++++----------- .../2023-10-01-preview/environments/index.md | 503 ++++---------- .../2023-10-01-preview/extenders/index.md | 209 ++---- .../2023-10-01-preview/gateways/index.md | 226 +++---- .../2023-10-01-preview/secretstores/index.md | 193 ++---- .../2023-10-01-preview/volumes/index.md | 252 +++---- .../configurationstores/index.md | 243 +++---- .../2023-10-01-preview/pubsubbrokers/index.md | 243 +++---- .../2023-10-01-preview/secretstores/index.md | 219 ++---- .../2023-10-01-preview/statestores/index.md | 243 +++---- .../mongodatabases/index.md | 223 ++---- .../2023-10-01-preview/rediscaches/index.md | 225 ++----- .../2023-10-01-preview/sqldatabases/index.md | 223 ++---- .../rabbitmqqueues/index.md | 229 ++----- .../2025-08-01-preview/models/index.md | 90 +++ .../2025-08-01-preview/search/index.md | 85 +++ .../containerimages/index.md | 91 +++ .../2025-08-01-preview/containers/index.md | 335 +++++++++ .../persistentvolumes/index.md | 118 ++++ .../2025-08-01-preview/routes/index.md | 180 +++++ .../2025-08-01-preview/applications/index.md | 175 +++-- .../2025-08-01-preview/bicepsettings/index.md | 127 ++-- .../2025-08-01-preview/environments/index.md | 224 ++++--- .../2025-08-01-preview/recipepacks/index.md | 209 +++--- .../terraformsettings/index.md | 279 ++++---- .../mongodatabases/index.md | 95 +++ .../mysqldatabases/index.md | 86 +++ .../postgresqldatabases/index.md | 87 +++ .../2025-08-01-preview/rediscaches/index.md | 92 +++ .../sqlserverdatabases/index.md | 90 +++ .../2025-08-01-preview/kafka/index.md | 96 +++ .../2025-08-01-preview/rabbitmq/index.md | 68 ++ .../2025-08-01-preview/secrets/index.md | 79 +++ .../2025-08-01-preview/objectstorage/index.md | 100 +++ 35 files changed, 3527 insertions(+), 3294 deletions(-) create mode 100644 docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/models/index.md create mode 100644 docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/search/index.md create mode 100644 docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containerimages/index.md create mode 100644 docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containers/index.md create mode 100644 docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/persistentvolumes/index.md create mode 100644 docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/routes/index.md create mode 100644 docs/content/reference/resources/radius/radius.data/2025-08-01-preview/mongodatabases/index.md create mode 100644 docs/content/reference/resources/radius/radius.data/2025-08-01-preview/mysqldatabases/index.md create mode 100644 docs/content/reference/resources/radius/radius.data/2025-08-01-preview/postgresqldatabases/index.md create mode 100644 docs/content/reference/resources/radius/radius.data/2025-08-01-preview/rediscaches/index.md create mode 100644 docs/content/reference/resources/radius/radius.data/2025-08-01-preview/sqlserverdatabases/index.md create mode 100644 docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/kafka/index.md create mode 100644 docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/rabbitmq/index.md create mode 100644 docs/content/reference/resources/radius/radius.security/2025-08-01-preview/secrets/index.md create mode 100644 docs/content/reference/resources/radius/radius.storage/2025-08-01-preview/objectstorage/index.md diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md index e67c6f168..78aa41abd 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md @@ -9,206 +9,110 @@ description: "Detailed reference documentation for applications.core/application ## Schema -### Top-Level Resource +## Description -#### Properties +Radius Application resource -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | -| **extensions** | [Extension](#extension)[] | The application extension.
_(ReadOnly)_ | -| **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** | [ApplicationProperties](#applicationproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/applications' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Top-Level Properties -### Extension +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `environment` | string | true | false | Fully qualified resource ID for the environment that the application is linked to | +| `extensions` | [object](#extensions)[] | false | false | The application extension. | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `status` | [object](#status) | false | true | Status of a resource. | -* **Discriminator**: kind +## Object Properties -#### Base Properties +### `extensions` {#extensions} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#extensions-aci), [`daprSidecar`](#extensions-daprsidecar), [`kubernetesMetadata`](#extensions-kubernetesmetadata), [`kubernetesNamespace`](#extensions-kubernetesnamespace), [`manualScaling`](#extensions-manualscaling). | +### `status` {#status} -#### AzureContainerInstanceExtension +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -##### Properties +### `extensions.aci` {#extensions-aci} -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The kind of the resource.
_(Required)_ | -| **resourceGroup** | string | The resource group of the application environment.
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | true | false | The resource group of the application environment. | -#### DaprSidecarExtension +### `extensions.daprSidecar` {#extensions-daprsidecar} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `appId` | string | true | false | The Dapr appId. Specifies the identifier used by Dapr for service invocation. | +| `appPort` | integer | false | false | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | +| `config` | string | false | false | Specifies the Dapr configuration to use for the resource. | +| `protocol` | string | false | false | Specifies the Dapr app-protocol to use for the resource.
Allowed values: `grpc`, `http`. | -| 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' | Specifies the extension of the resource
_(Required)_ | -| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. | +### `extensions.kubernetesMetadata` {#extensions-kubernetesmetadata} -#### KubernetesMetadataExtension +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `annotations` | object | false | false | Annotations to be applied to the Kubernetes resources output by the resource | +| `labels` | object | false | false | Labels to be applied to the Kubernetes resources output by the resource | -##### Properties +### `extensions.kubernetesNamespace` {#extensions-kubernetesnamespace} -| Property | Type | Description | -|----------|------|-------------| -| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource | -| **kind** | 'kubernetesMetadata' | The kind of the resource.
_(Required)_ | -| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace of the application environment. | -#### KubernetesNamespaceExtension +### `extensions.manualScaling` {#extensions-manualscaling} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `replicas` | integer | true | false | Replica count. | -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetesNamespace' | The kind of the resource.
_(Required)_ | -| **namespace** | string | The namespace of the application environment.
_(Required)_ | +### `status.compute` {#status-compute} -#### ManualScalingExtension +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -##### Properties +### `status.outputResources` {#status-outputresources} -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'manualScaling' | Specifies the extension of the resource
_(Required)_ | -| **replicas** | int | Replica count.
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | +### `status.recipe` {#status-recipe} -### Record +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -#### Properties +### `status.compute.identity` {#status-compute-identity} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -#### Additional Properties +### `status.compute.aci` {#status-compute-aci} -* **Additional Properties Type**: string +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### ApplicationProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(Required)_ | -| **extensions** | [Extension](#extension)[] | The application extension. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md index 4785a1ef5..86fe672d4 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md @@ -9,472 +9,292 @@ description: "Detailed reference documentation for applications.core/containers@ ## Schema -### Top-Level Resource +## Description + +Concrete tracked resource types can be created by aliasing this type using a specific property type. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | true | false | Fully qualified resource ID for the application | +| `connections` | [object](#connections) | false | false | Specifies a connection to another resource. | +| `container` | [object](#container) | true | false | Definition of a container. | +| `environment` | string | false | false | Fully qualified resource ID for the environment that the application is linked to | +| `extensions` | [object](#extensions)[] | false | false | Extensions spec of the resource | +| `identity` | [object](#identity) | false | false | Configuration for supported external identity providers | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `resourceProvisioning` | string | false | false | Specifies how the underlying container resource is provisioned and managed.
Allowed values: `internal`, `manual`. | +| `resources` | [object](#resources)[] | false | false | A collection of references to resources associated with the container | +| `restartPolicy` | string | false | false | The restart policy for the underlying container
Allowed values: `Always`, `Never`, `OnFailure`. | +| `runtimes` | [object](#runtimes) | false | false | Specifies Runtime-specific functionality | +| `status` | [object](#status) | false | true | Status of a resource. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | default environment variable override | +| `iam` | [object](#connections-iam) | false | false | iam properties | +| `source` | string | true | false | The source of the connection | + +### `container` {#container} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `args` | string array | false | false | Arguments to the entrypoint. Overrides the container image's CMD | +| `command` | string array | false | false | Entrypoint array. Overrides the container image's ENTRYPOINT | +| `env` | [object](#container-env) | false | false | environment | +| `image` | string | true | false | The registry and image to download and run in your container | +| `imagePullPolicy` | string | false | false | The pull policy for the container image
Allowed values: `Always`, `IfNotPresent`, `Never`. | +| `livenessProbe` | [object](#container-livenessprobe) | false | false | liveness probe properties | +| `ports` | [object](#container-ports) | false | false | container ports | +| `readinessProbe` | [object](#container-readinessprobe) | false | false | readiness probe properties | +| `volumes` | [object](#container-volumes) | false | false | container volumes | +| `workingDir` | string | false | false | Working directory for the container | + +### `extensions` {#extensions} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#extensions-aci), [`daprSidecar`](#extensions-daprsidecar), [`kubernetesMetadata`](#extensions-kubernetesmetadata), [`kubernetesNamespace`](#extensions-kubernetesnamespace), [`manualScaling`](#extensions-manualscaling). | + +### `identity` {#identity} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | + +### `resources` {#resources} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | true | false | Resource id of an existing resource | -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application
_(ReadOnly)_ | -| **connections** | [Record](#record) | Specifies a connection to another resource.
_(ReadOnly)_ | -| **container** | [Container](#container) | Definition of a container.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | -| **extensions** | [Extension](#extension)[] | Extensions spec of the resource
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers
_(ReadOnly)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [ContainerProperties](#containerproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **resourceProvisioning** | 'internal' | 'manual' | Specifies how the underlying container resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the container
_(ReadOnly)_ | -| **restartPolicy** | 'Always' | 'Never' | 'OnFailure' | The restart policy for the underlying container
_(ReadOnly)_ | -| **runtimes** | [RuntimesProperties](#runtimesproperties) | Specifies Runtime-specific functionality
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/containers' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +### `runtimes` {#runtimes} -### Record +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `aci` | [object](#runtimes-aci) | false | false | The runtime configuration properties for ACI | +| `kubernetes` | [object](#runtimes-kubernetes) | false | false | The runtime configuration properties for Kubernetes | -#### Properties +### `status` {#status} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -#### Additional Properties +### `connections.iam` {#connections-iam} -* **Additional Properties Type**: [ConnectionProperties](#connectionproperties) +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | The kind of IAM provider to configure
Allowed values: `azure`, `string`. | +| `roles` | string array | false | false | RBAC permissions to be assigned on the source resource | -### ConnectionProperties +### `container.env` {#container-env} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `value` | string | false | false | The value of the environment variable | +| `valueFrom` | [object](#container-env-valuefrom) | false | false | The reference to the variable | -| Property | Type | Description | -|----------|------|-------------| -| **disableDefaultEnvVars** | bool | default environment variable override | -| **iam** | [IamProperties](#iamproperties) | iam properties | -| **source** | string | The source of the connection
_(Required)_ | +### `container.livenessProbe` {#container-livenessprobe} -### IamProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`exec`](#container-livenessprobe-exec), [`httpGet`](#container-livenessprobe-httpget), [`tcp`](#container-livenessprobe-tcp). | +| `failureThreshold` | integer | false | false | Threshold number of times the probe fails after which a failure would be reported | +| `initialDelaySeconds` | integer | false | false | Initial delay in seconds before probing for readiness/liveness | +| `periodSeconds` | integer | false | false | Interval for the readiness/liveness probe in seconds | +| `timeoutSeconds` | integer | false | false | Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds | -#### Properties +### `container.ports` {#container-ports} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `containerPort` | integer | true | false | The listening port number | +| `port` | integer | false | false | Specifies the port that will be exposed by this container. Must be set when value different from containerPort is desired | +| `protocol` | string | false | false | Protocol in use by the port
Allowed values: `TCP`, `UDP`. | +| `scheme` | string | false | false | 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 | -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure' | 'string' | The kind of IAM provider to configure
_(Required)_ | -| **roles** | string[] | RBAC permissions to be assigned on the source resource | +### `container.readinessProbe` {#container-readinessprobe} -### Container +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`exec`](#container-readinessprobe-exec), [`httpGet`](#container-readinessprobe-httpget), [`tcp`](#container-readinessprobe-tcp). | +| `failureThreshold` | integer | false | false | Threshold number of times the probe fails after which a failure would be reported | +| `initialDelaySeconds` | integer | false | false | Initial delay in seconds before probing for readiness/liveness | +| `periodSeconds` | integer | false | false | Interval for the readiness/liveness probe in seconds | +| `timeoutSeconds` | integer | false | false | Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds | -#### Properties +### `container.volumes` {#container-volumes} -| 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** | [Record](#record) | environment | -| **image** | string | The registry and image to download and run in your container
_(Required)_ | -| **imagePullPolicy** | 'Always' | 'IfNotPresent' | 'Never' | The pull policy for the container image | -| **livenessProbe** | [HealthProbeProperties](#healthprobeproperties) | liveness probe properties | -| **ports** | [Record](#record) | container ports | -| **readinessProbe** | [HealthProbeProperties](#healthprobeproperties) | readiness probe properties | -| **volumes** | [Record](#record) | container volumes | -| **workingDir** | string | Working directory for the container | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`ephemeral`](#container-volumes-ephemeral), [`persistent`](#container-volumes-persistent). | +| `mountPath` | string | false | false | The path where the volume is mounted | -### Record +### `extensions.aci` {#extensions-aci} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | true | false | The resource group of the application environment. | -* **none** +### `extensions.daprSidecar` {#extensions-daprsidecar} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `appId` | string | true | false | The Dapr appId. Specifies the identifier used by Dapr for service invocation. | +| `appPort` | integer | false | false | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | +| `config` | string | false | false | Specifies the Dapr configuration to use for the resource. | +| `protocol` | string | false | false | Specifies the Dapr app-protocol to use for the resource.
Allowed values: `grpc`, `http`. | -* **Additional Properties Type**: [EnvironmentVariable](#environmentvariable) +### `extensions.kubernetesMetadata` {#extensions-kubernetesmetadata} -### EnvironmentVariable +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `annotations` | object | false | false | Annotations to be applied to the Kubernetes resources output by the resource | +| `labels` | object | false | false | Labels to be applied to the Kubernetes resources output by the resource | -#### Properties +### `extensions.kubernetesNamespace` {#extensions-kubernetesnamespace} -| Property | Type | Description | -|----------|------|-------------| -| **value** | string | The value of the environment variable | -| **valueFrom** | [EnvironmentVariableReference](#environmentvariablereference) | The reference to the variable | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace of the application environment. | -### EnvironmentVariableReference +### `extensions.manualScaling` {#extensions-manualscaling} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `replicas` | integer | true | false | Replica count. | -| Property | Type | Description | -|----------|------|-------------| -| **secretRef** | [SecretReference](#secretreference) | The secret reference
_(Required)_ | +### `runtimes.aci` {#runtimes-aci} -### SecretReference +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `gatewayID` | string | false | false | The ID of the gateway that is providing L7 traffic for the container | -#### Properties +### `runtimes.kubernetes` {#runtimes-kubernetes} -| 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)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `base` | string | false | false | The serialized YAML manifest which represents the base Kubernetes resources to deploy, such as Deployment, Service, ServiceAccount, Secrets, and ConfigMaps. | +| `pod` | object | false | false | A strategic merge patch that will be applied to the PodSpec object when this container is being deployed. | -### HealthProbeProperties +### `status.compute` {#status-compute} -* **Discriminator**: kind +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -#### Base Properties +### `status.outputResources` {#status-outputresources} -| 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 | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -#### ExecHealthProbeProperties +### `status.recipe` {#status-recipe} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -| Property | Type | Description | -|----------|------|-------------| -| **command** | string | Command to execute to probe readiness/liveness
_(Required)_ | -| **kind** | 'exec' | The HealthProbeProperties kind
_(Required)_ | +### `container.env.valueFrom` {#container-env-valuefrom} -#### HttpGetHealthProbeProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secretRef` | [object](#container-env-valuefrom-secretref) | true | false | The secret reference | -##### Properties +### `container.livenessProbe.exec` {#container-livenessprobe-exec} -| Property | Type | Description | -|----------|------|-------------| -| **containerPort** | int | The listening port number
_(Required)_ | -| **headers** | [Record](#record) | Custom HTTP headers to add to the get request | -| **kind** | 'httpGet' | The HealthProbeProperties kind
_(Required)_ | -| **path** | string | The route to make the HTTP request on
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `command` | string | true | false | Command to execute to probe readiness/liveness | -#### TcpHealthProbeProperties +### `container.livenessProbe.httpGet` {#container-livenessprobe-httpget} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `containerPort` | integer | true | false | The listening port number | +| `headers` | object | false | false | Custom HTTP headers to add to the get request | +| `path` | string | true | false | The route to make the HTTP request on | -| Property | Type | Description | -|----------|------|-------------| -| **containerPort** | int | The listening port number
_(Required)_ | -| **kind** | 'tcp' | The HealthProbeProperties kind
_(Required)_ | +### `container.livenessProbe.tcp` {#container-livenessprobe-tcp} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `containerPort` | integer | true | false | The listening port number | -### Record +### `container.readinessProbe.exec` {#container-readinessprobe-exec} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `command` | string | true | false | Command to execute to probe readiness/liveness | -* **none** +### `container.readinessProbe.httpGet` {#container-readinessprobe-httpget} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `containerPort` | integer | true | false | The listening port number | +| `headers` | object | false | false | Custom HTTP headers to add to the get request | +| `path` | string | true | false | The route to make the HTTP request on | -* **Additional Properties Type**: string +### `container.readinessProbe.tcp` {#container-readinessprobe-tcp} -### Record +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `containerPort` | integer | true | false | The listening port number | -#### Properties +### `container.volumes.ephemeral` {#container-volumes-ephemeral} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `managedStore` | string | true | false | Backing store for the ephemeral volume
Allowed values: `disk`, `memory`. | -#### Additional Properties +### `container.volumes.persistent` {#container-volumes-persistent} -* **Additional Properties Type**: [ContainerPortProperties](#containerportproperties) +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `permission` | string | false | false | Container read/write access to the volume
Allowed values: `read`, `write`. | +| `source` | string | true | false | The source of the volume | -### ContainerPortProperties +### `status.compute.identity` {#status-compute-identity} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -| 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' | Protocol in use by the port | -| **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 | +### `status.compute.aci` {#status-compute-aci} -### Record +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -#### Properties +### `status.compute.kubernetes` {#status-compute-kubernetes} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | -#### Additional Properties - -* **Additional Properties Type**: [Volume](#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' | The Volume kind
_(Required)_ | -| **managedStore** | 'disk' | 'memory' | Backing store for the ephemeral volume
_(Required)_ | - -#### PersistentVolume - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'persistent' | The Volume kind
_(Required)_ | -| **permission** | 'read' | 'write' | Container read/write access to the volume | -| **source** | string | The source of the volume
_(Required)_ | - - -### Extension - -* **Discriminator**: kind - -#### Base Properties - -* **none** - - -#### AzureContainerInstanceExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The kind of the resource.
_(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' | Specifies the extension of the resource
_(Required)_ | -| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. | - -#### KubernetesMetadataExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource | -| **kind** | 'kubernetesMetadata' | The kind of the resource.
_(Required)_ | -| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource | - -#### KubernetesNamespaceExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetesNamespace' | The kind of the resource.
_(Required)_ | -| **namespace** | string | The namespace of the application environment.
_(Required)_ | - -#### ManualScalingExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'manualScaling' | Specifies the extension of the resource
_(Required)_ | -| **replicas** | int | Replica count.
_(Required)_ | - - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### ContainerProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(Required)_ | -| **connections** | [Record](#record) | Specifies a connection to another resource. | -| **container** | [Container](#container) | Definition of a container.
_(Required)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **extensions** | [Extension](#extension)[] | Extensions spec of the resource | -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **resourceProvisioning** | 'internal' | 'manual' | Specifies how the underlying container resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the container | -| **restartPolicy** | 'Always' | 'Never' | 'OnFailure' | The restart policy for the underlying container | -| **runtimes** | [RuntimesProperties](#runtimesproperties) | Specifies Runtime-specific functionality | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [ConnectionProperties](#connectionproperties) - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### RuntimesProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **aci** | [ACIRuntimeProperties](#aciruntimeproperties) | The runtime configuration properties for ACI | -| **kubernetes** | [KubernetesRuntimeProperties](#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](#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](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `container.env.valueFrom.secretRef` {#container-env-valuefrom-secretref} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `key` | string | true | false | The key for the secret in the secret store. | +| `source` | string | true | false | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution. | diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md index 384f60c41..8dbabda54 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md @@ -9,427 +9,194 @@ description: "Detailed reference documentation for applications.core/environment ## Schema -### Top-Level Resource +## Description -#### Properties +The environment resource -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource used by application environment.
_(ReadOnly)_ | -| **extensions** | [Extension](#extension)[] | The environment extension.
_(ReadOnly)_ | -| **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** | [EnvironmentProperties](#environmentproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **providers** | [Providers](#providers) | Cloud providers configuration for the environment.
_(ReadOnly)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipeConfig** | [RecipeConfigProperties](#recipeconfigproperties) | Configuration for Recipes. Defines how each type of Recipe should be configured and run.
_(ReadOnly)_ | -| **recipes** | [Record](#record) | Specifies Recipes linked to the Environment.
_(ReadOnly)_ | -| **simulated** | bool | Simulated environment.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/environments' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Top-Level Properties -### EnvironmentCompute +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#compute) | true | false | The compute resource used by application environment. | +| `extensions` | [object](#extensions)[] | false | false | The environment extension. | +| `providers` | [object](#providers) | false | false | Cloud providers configuration for the environment. | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipeConfig` | [object](#recipeconfig) | false | false | Configuration for Recipes. Defines how each type of Recipe should be configured and run. | +| `recipes` | [object](#recipes) | false | false | Specifies Recipes linked to the Environment. | +| `simulated` | boolean | false | false | Simulated environment. | -* **Discriminator**: kind +## Object Properties -#### Base Properties +### `compute` {#compute} -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#compute-aci), [`kubernetes`](#compute-kubernetes). | +| `identity` | [object](#compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -#### AzureContainerInstanceCompute +### `extensions` {#extensions} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#extensions-aci), [`daprSidecar`](#extensions-daprsidecar), [`kubernetesMetadata`](#extensions-kubernetesmetadata), [`kubernetesNamespace`](#extensions-kubernetesnamespace), [`manualScaling`](#extensions-manualscaling). | -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | +### `providers` {#providers} -#### KubernetesCompute +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `aws` | [object](#providers-aws) | false | false | The AWS cloud provider configuration. | +| `azure` | [object](#providers-azure) | false | false | The Azure cloud provider configuration. | -##### Properties +### `recipeConfig` {#recipeconfig} -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `bicep` | [object](#recipeconfig-bicep) | false | false | Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment. | +| `env` | object | false | false | Environment variables injected during recipe execution for the recipes in the environment, currently supported for Terraform recipes. | +| `envSecrets` | [object](#recipeconfig-envsecrets) | false | false | Environment variables containing sensitive information can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. | +| `terraform` | [object](#recipeconfig-terraform) | false | false | Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment. | +### `recipes` {#recipes} -### IdentitySettings +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`bicep`](#recipes-bicep), [`terraform`](#recipes-terraform). | +| `parameters` | object | false | false | Key/value parameters to pass to the recipe template at deployment. | +| `templatePath` | string | true | false | Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported. | -#### Properties +### `compute.identity` {#compute-identity} -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -### Extension +### `compute.aci` {#compute-aci} -* **Discriminator**: kind +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -#### Base Properties +### `compute.kubernetes` {#compute-kubernetes} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | +### `extensions.aci` {#extensions-aci} -#### AzureContainerInstanceExtension +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | true | false | The resource group of the application environment. | -##### Properties +### `extensions.daprSidecar` {#extensions-daprsidecar} -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The kind of the resource.
_(Required)_ | -| **resourceGroup** | string | The resource group of the application environment.
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `appId` | string | true | false | The Dapr appId. Specifies the identifier used by Dapr for service invocation. | +| `appPort` | integer | false | false | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | +| `config` | string | false | false | Specifies the Dapr configuration to use for the resource. | +| `protocol` | string | false | false | Specifies the Dapr app-protocol to use for the resource.
Allowed values: `grpc`, `http`. | -#### DaprSidecarExtension +### `extensions.kubernetesMetadata` {#extensions-kubernetesmetadata} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `annotations` | object | false | false | Annotations to be applied to the Kubernetes resources output by the resource | +| `labels` | object | false | false | Labels to be applied to the Kubernetes resources output by the resource | -| 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' | Specifies the extension of the resource
_(Required)_ | -| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. | +### `extensions.kubernetesNamespace` {#extensions-kubernetesnamespace} -#### KubernetesMetadataExtension +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace of the application environment. | -##### Properties +### `extensions.manualScaling` {#extensions-manualscaling} -| Property | Type | Description | -|----------|------|-------------| -| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource | -| **kind** | 'kubernetesMetadata' | The kind of the resource.
_(Required)_ | -| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `replicas` | integer | true | false | Replica count. | -#### KubernetesNamespaceExtension +### `providers.aws` {#providers-aws} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `scope` | string | true | false | Target scope for AWS resources to be deployed into. For example: '/planes/aws/aws/accounts/000000000000/regions/us-west-2'. | -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetesNamespace' | The kind of the resource.
_(Required)_ | -| **namespace** | string | The namespace of the application environment.
_(Required)_ | +### `providers.azure` {#providers-azure} -#### ManualScalingExtension +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `scope` | string | true | false | Target scope for Azure resources to be deployed into. For example: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup'. | -##### Properties +### `recipeConfig.bicep` {#recipeconfig-bicep} -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'manualScaling' | Specifies the extension of the resource
_(Required)_ | -| **replicas** | int | Replica count.
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `authentication` | [object](#recipeconfig-bicep-authentication) | false | false | Authentication information used to access private bicep registries, which is a map of registry hostname to secret config that contains credential information. | +### `recipeConfig.envSecrets` {#recipeconfig-envsecrets} -### Record +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `key` | string | true | false | The key for the secret in the secret store. | +| `source` | string | true | false | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution. | -#### Properties +### `recipeConfig.terraform` {#recipeconfig-terraform} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `authentication` | [object](#recipeconfig-terraform-authentication) | false | false | Authentication information used to access private Terraform module sources. Supported module sources: Git. | +| `providers` | [object](#recipeconfig-terraform-providers) | false | false | Configuration for Terraform Recipe Providers. Controls how Terraform interacts with cloud providers, SaaS providers, and other APIs. For more information, please see: https://developer.hashicorp.com/terraform/language/providers/configuration. | -#### Additional Properties +### `recipes.bicep` {#recipes-bicep} -* **Additional Properties Type**: string +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `plainHttp` | boolean | false | false | Connect to the Bicep registry using HTTP (not-HTTPS). This should be used when the registry is known not to support HTTPS, for example in a locally-hosted registry. Defaults to false (use HTTPS/TLS). | -### Record +### `recipes.terraform` {#recipes-terraform} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateVersion` | string | false | false | Version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted for other module sources. | -* **none** +### `recipeConfig.bicep.authentication` {#recipeconfig-bicep-authentication} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secret` | string | false | false | The ID of an Applications.Core/SecretStore resource containing credential information used to authenticate private container registry.The keys in the secretstore depends on the type. | -* **Additional Properties Type**: string +### `recipeConfig.terraform.authentication` {#recipeconfig-terraform-authentication} -### EnvironmentProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `git` | [object](#recipeconfig-terraform-authentication-git) | false | false | Authentication information used to access private Terraform modules from Git repository sources. | -#### Properties +### `recipeConfig.terraform.providers` {#recipeconfig-terraform-providers} -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource used by application environment.
_(Required)_ | -| **extensions** | [Extension](#extension)[] | The environment extension. | -| **providers** | [Providers](#providers) | Cloud providers configuration for the environment. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipeConfig** | [RecipeConfigProperties](#recipeconfigproperties) | Configuration for Recipes. Defines how each type of Recipe should be configured and run. | -| **recipes** | [Record](#record) | Specifies Recipes linked to the Environment. | -| **simulated** | bool | Simulated environment. | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secrets` | [object](#recipeconfig-terraform-providers-secrets) | false | false | Sensitive data in provider configuration can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. | -### Providers +### `recipeConfig.terraform.authentication.git` {#recipeconfig-terraform-authentication-git} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `pat` | [object](#recipeconfig-terraform-authentication-git-pat) | false | false | Personal Access Token (PAT) configuration used to authenticate to Git platforms. | -| Property | Type | Description | -|----------|------|-------------| -| **aws** | [ProvidersAws](#providersaws) | The AWS cloud provider configuration. | -| **azure** | [ProvidersAzure](#providersazure) | The Azure cloud provider configuration. | +### `recipeConfig.terraform.providers.secrets` {#recipeconfig-terraform-providers-secrets} -### ProvidersAws +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `key` | string | true | false | The key for the secret in the secret store. | +| `source` | string | true | false | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution. | -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **scope** | string | Target scope for AWS resources to be deployed into. For example: '/planes/aws/aws/accounts/000000000000/regions/us-west-2'.
_(Required)_ | - -### ProvidersAzure - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **scope** | string | Target scope for Azure resources to be deployed into. For example: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup'.
_(Required)_ | - -### RecipeConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **bicep** | [BicepConfigProperties](#bicepconfigproperties) | Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment. | -| **env** | [EnvironmentVariables](#environmentvariables) | Environment variables injected during recipe execution for the recipes in the environment, currently supported for Terraform recipes. | -| **envSecrets** | [Record](#record) | Environment variables containing sensitive information can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. | -| **terraform** | [TerraformConfigProperties](#terraformconfigproperties) | Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment. | - -### BicepConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **authentication** | [Record](#record) | Authentication information used to access private bicep registries, which is a map of registry hostname to secret config that contains credential information. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RegistrySecretConfig](#registrysecretconfig) - -### RegistrySecretConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secret** | string | The ID of an Applications.Core/SecretStore resource containing credential information used to authenticate private container registry.The keys in the secretstore depends on the type. | - -### EnvironmentVariables - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretReference](#secretreference) - -### 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)_ | - -### TerraformConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **authentication** | [AuthConfig](#authconfig) | Authentication information used to access private Terraform module sources. Supported module sources: Git. | -| **providers** | [Record](#record) | Configuration for Terraform Recipe Providers. Controls how Terraform interacts with cloud providers, SaaS providers, and other APIs. For more information, please see: https://developer.hashicorp.com/terraform/language/providers/configuration. | - -### AuthConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **git** | [GitAuthConfig](#gitauthconfig) | Authentication information used to access private Terraform modules from Git repository sources. | - -### GitAuthConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **pat** | [Record](#record) | Personal Access Token (PAT) configuration used to authenticate to Git platforms. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretConfig](#secretconfig) - -### SecretConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secret** | string | The ID of an Applications.Core/SecretStore resource containing the Git platform personal access token (PAT). The secret store must have a secret named 'pat', containing the PAT value. A secret named 'username' is optional, containing the username associated with the pat. By default no username is specified. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [ProviderConfigProperties](#providerconfigproperties)[] - -### ProviderConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secrets** | [Record](#record) | Sensitive data in provider configuration can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. | -#### Additional Properties - -* **Additional Properties Type**: any - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretReference](#secretreference) - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [Record](#record) - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeProperties](#recipeproperties) - -### RecipeProperties - -* **Discriminator**: templateKind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **parameters** | [Record](#record) | Key/value parameters to pass to the recipe template at deployment. | -| **templatePath** | string | Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
_(Required)_ | - -#### BicepRecipeProperties - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **plainHttp** | bool | Connect to the Bicep registry using HTTP (not-HTTPS). This should be used when the registry is known not to support HTTPS, for example in a locally-hosted registry. Defaults to false (use HTTPS/TLS). | -| **templateKind** | 'bicep' | The Bicep template kind.
_(Required)_ | - -#### TerraformRecipeProperties - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | 'terraform' | The Terraform template kind.
_(Required)_ | -| **templateVersion** | string | Version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted for other module sources. | - - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [Record](#record) - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeProperties](#recipeproperties) - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `recipeConfig.terraform.authentication.git.pat` {#recipeconfig-terraform-authentication-git-pat} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secret` | string | false | false | The ID of an Applications.Core/SecretStore resource containing the Git platform personal access token (PAT). The secret store must have a secret named 'pat', containing the PAT value. A secret named 'username' is optional, containing the username associated with the pat. By default no username is specified. | diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md index d3e23d39a..65d3ecd91 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md @@ -9,175 +9,80 @@ description: "Detailed reference documentation for applications.core/extenders@2 ## Schema -### Top-Level Resource +## Description -#### Properties +ExtenderResource portable resource -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **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** | [ExtenderProperties](#extenderproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the extender portable resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **secrets** | [Record](#record) | The secrets for referenced resource
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/extenders' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Top-Level Properties -### ExtenderProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| `environment` | string | true | false | Fully qualified resource ID for the environment that the portable resource is linked to | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipe` | [object](#recipe) | false | false | The recipe used to automatically deploy underlying infrastructure for the extender portable resource | +| `resourceProvisioning` | string | false | false | Specifies how the underlying service/resource is provisioned and managed.
Allowed values: `manual`, `recipe`. | +| `secrets` | object | false | false | The secrets for referenced resource | +| `status` | [object](#status) | false | true | Status of a resource. | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the extender portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **secrets** | [Record](#record) | The secrets for referenced resource | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -#### Additional Properties +### `recipe` {#recipe} -* **Additional Properties Type**: any +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the recipe within the environment to use | +| `parameters` | object | false | false | Key/value parameters to pass into the recipe at deployment | -### Recipe +### `status` {#status} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | +### `status.compute` {#status-compute} -### Record +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -#### Properties +### `status.outputResources` {#status-outputresources} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -#### Additional Properties +### `status.recipe` {#status-recipe} -* **Additional Properties Type**: any +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -### Record +### `status.compute.identity` {#status-compute-identity} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -* **none** +### `status.compute.aci` {#status-compute-aci} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -* **Additional Properties Type**: any - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md index 1bc233411..c953fa213 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md @@ -9,177 +9,107 @@ description: "Detailed reference documentation for applications.core/gateways@20 ## Schema -### Top-Level Resource +## Description -#### Properties +Concrete tracked resource types can be created by aliasing this type using a specific property type. -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | -| **hostname** | [GatewayHostname](#gatewayhostname) | Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io.
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **internal** | bool | Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet).
_(ReadOnly)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [GatewayProperties](#gatewayproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **routes** | [GatewayRoute](#gatewayroute)[] | Routes attached to this Gateway
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **tls** | [GatewayTls](#gatewaytls) | TLS configuration for the Gateway.
_(ReadOnly)_ | -| **type** | 'Applications.Core/gateways' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **url** | string | URL of the gateway resource. Readonly
_(ReadOnly)_ | +## Top-Level Properties -### GatewayHostname +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | true | false | Fully qualified resource ID for the application | +| `environment` | string | false | false | Fully qualified resource ID for the environment that the application is linked to | +| `hostname` | [object](#hostname) | false | false | Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io. | +| `internal` | boolean | false | false | Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet). | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `routes` | [object](#routes)[] | true | false | Routes attached to this Gateway | +| `status` | [object](#status) | false | true | Status of a resource. | +| `tls` | [object](#tls) | false | false | TLS configuration for the Gateway. | +| `url` | string | false | true | URL of the gateway resource. Readonly | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **fullyQualifiedHostname** | string | Specify a fully-qualified domain name: myapp.mydomain.com. Mutually exclusive with 'prefix' and will take priority if both are defined. | -| **prefix** | string | Specify a prefix for the hostname: myhostname.myapp.PUBLICHOSTNAMEORIP.nip.io. Mutually exclusive with 'fullyQualifiedHostname' and will be overridden if both are defined. | +### `hostname` {#hostname} -### GatewayProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `fullyQualifiedHostname` | string | false | false | Specify a fully-qualified domain name: myapp.mydomain.com. Mutually exclusive with 'prefix' and will take priority if both are defined. | +| `prefix` | string | false | false | Specify a prefix for the hostname: myhostname.myapp.PUBLICHOSTNAMEORIP.nip.io. Mutually exclusive with 'fullyQualifiedHostname' and will be overridden if both are defined. | -#### Properties +### `routes` {#routes} -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(Required)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **hostname** | [GatewayHostname](#gatewayhostname) | Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io. | -| **internal** | bool | Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet). | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **routes** | [GatewayRoute](#gatewayroute)[] | Routes attached to this Gateway
_(Required)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **tls** | [GatewayTls](#gatewaytls) | TLS configuration for the Gateway. | -| **url** | string | URL of the gateway resource. Readonly
_(ReadOnly)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `destination` | string | false | false | The URL or id of the service to route to. Ex - 'http://myservice'. | +| `enableWebsockets` | boolean | false | false | Enables websocket support for the route. Defaults to false. | +| `path` | string | false | false | The path to match the incoming request path on. Ex - /myservice. | +| `replacePrefix` | string | false | false | Optionally update the prefix when sending the request to the service. Ex - replacePrefix: '/' and path: '/myservice' will transform '/myservice/myroute' to '/myroute' | +| `timeoutPolicy` | [object](#routes-timeoutpolicy) | false | false | The timeout policy for the route. | -### GatewayRoute +### `status` {#status} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -| Property | Type | Description | -|----------|------|-------------| -| **destination** | string | The URL or id of the service to route to. Ex - 'http://myservice'. | -| **enableWebsockets** | bool | Enables websocket support for the route. Defaults to false. | -| **path** | string | The path to match the incoming request path on. Ex - /myservice. | -| **replacePrefix** | string | Optionally update the prefix when sending the request to the service. Ex - replacePrefix: '/' and path: '/myservice' will transform '/myservice/myroute' to '/myroute' | -| **timeoutPolicy** | [GatewayRouteTimeoutPolicy](#gatewayroutetimeoutpolicy) | The timeout policy for the route. | +### `tls` {#tls} -### GatewayRouteTimeoutPolicy +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `certificateFrom` | string | false | false | The resource id for the secret containing the TLS certificate and key for the gateway. | +| `minimumProtocolVersion` | string | false | false | TLS minimum protocol version (defaults to 1.2).
Allowed values: `1.2`, `1.3`. | +| `sslPassthrough` | boolean | false | false | If true, gateway lets the https traffic sslPassthrough to the backend servers for decryption. | -#### Properties +### `routes.timeoutPolicy` {#routes-timeoutpolicy} -| Property | Type | Description | -|----------|------|-------------| -| **backendRequest** | string | The backend request timeout in duration for the route. Cannot be greater than the request timeout. | -| **request** | string | The request timeout in duration for the route. Defaults to 15 seconds. | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `backendRequest` | string | false | false | The backend request timeout in duration for the route. Cannot be greater than the request timeout. | +| `request` | string | false | false | The request timeout in duration for the route. Defaults to 15 seconds. | -### ResourceStatus +### `status.compute` {#status-compute} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | +### `status.outputResources` {#status-outputresources} -### EnvironmentCompute +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -* **Discriminator**: kind +### `status.recipe` {#status-recipe} -#### Base Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | +### `status.compute.identity` {#status-compute-identity} -#### AzureContainerInstanceCompute +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -##### Properties +### `status.compute.aci` {#status-compute-aci} -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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. | - -### GatewayTls - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **certificateFrom** | string | The resource id for the secret containing the TLS certificate and key for the gateway. | -| **minimumProtocolVersion** | '1.2' | '1.3' | TLS minimum protocol version (defaults to 1.2). | -| **sslPassthrough** | bool | If true, gateway lets the https traffic sslPassthrough to the backend servers for decryption. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md index f58038865..4be2fab82 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md @@ -9,155 +9,88 @@ description: "Detailed reference documentation for applications.core/secretstore ## Schema -### Top-Level Resource +## Description -#### Properties +Concrete tracked resource types can be created by aliasing this type using a specific property type. -| 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** | [SecretStoreProperties](#secretstoreproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/secretStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Top-Level Properties -### SecretStoreProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application | +| `data` | [object](#data) | true | false | An object to represent key-value type secrets | +| `environment` | string | false | false | Fully qualified resource ID for the environment that the application is linked to | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `resource` | string | false | false | The resource id of external secret store. | +| `status` | [object](#status) | false | true | Status of a resource. | +| `type` | string | false | false | The type of secret store data
Allowed values: `awsIRSA`, `azureWorkloadIdentity`, `basicAuthentication`, `certificate`, `generic`. | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application | -| **data** | [Record](#record) | An object to represent key-value type secrets
_(Required)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **resource** | string | The resource id of external secret store. | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | 'awsIRSA' | 'azureWorkloadIdentity' | 'basicAuthentication' | 'certificate' | 'generic' | The type of secret store data | +### `data` {#data} -### Record +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `encoding` | string | false | false | The encoding of value
Allowed values: `base64`, `raw`. | +| `value` | string | false | false | The value of secret. | +| `valueFrom` | [object](#data-valuefrom) | false | false | The referenced secret in properties.resource | -#### Properties +### `status` {#status} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -#### Additional Properties +### `data.valueFrom` {#data-valuefrom} -* **Additional Properties Type**: [SecretValueProperties](#secretvalueproperties) +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the referenced secret. | +| `version` | string | false | false | The version of the referenced secret. | -### SecretValueProperties +### `status.compute` {#status-compute} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -| Property | Type | Description | -|----------|------|-------------| -| **encoding** | 'base64' | 'raw' | The encoding of value | -| **value** | string | The value of secret. | -| **valueFrom** | [ValueFromProperties](#valuefromproperties) | The referenced secret in properties.resource | +### `status.outputResources` {#status-outputresources} -### ValueFromProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -#### Properties +### `status.recipe` {#status-recipe} -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the referenced secret.
_(Required)_ | -| **version** | string | The version of the referenced secret. | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -### ResourceStatus +### `status.compute.identity` {#status-compute-identity} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | +### `status.compute.aci` {#status-compute-aci} -### EnvironmentCompute +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md index 15a9744e9..aeaf44db6 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md @@ -9,202 +9,108 @@ description: "Detailed reference documentation for applications.core/volumes@202 ## Schema -### Top-Level Resource +## Description -#### Properties +Radius Volume resource. -| 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** | [VolumeProperties](#volumeproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/volumes' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Top-Level Properties -### VolumeProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`azure.com.keyvault`](#azure-com-keyvault). | +| `application` | string | true | false | Fully qualified resource ID for the application | +| `environment` | string | false | false | Fully qualified resource ID for the environment that the application is linked to | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `status` | [object](#status) | false | true | Status of a resource. | -* **Discriminator**: kind +## Object Properties -#### Base Properties +### `status` {#status} -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(Required)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -#### AzureKeyVaultVolumeProperties +### `azure.com.keyvault` {#azure-com-keyvault} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `certificates` | [object](#azure-com-keyvault-certificates) | false | false | The KeyVault certificates that this volume exposes | +| `keys` | [object](#azure-com-keyvault-keys) | false | false | The KeyVault keys that this volume exposes | +| `resource` | string | true | false | The ID of the keyvault to use for this volume resource | +| `secrets` | [object](#azure-com-keyvault-secrets) | false | false | The KeyVault secrets that this volume exposes | -| Property | Type | Description | -|----------|------|-------------| -| **certificates** | [Record](#record) | The KeyVault certificates that this volume exposes | -| **keys** | [Record](#record) | The KeyVault keys that this volume exposes | -| **kind** | 'azure.com.keyvault' | The Azure Key Vault Volume kind
_(Required)_ | -| **resource** | string | The ID of the keyvault to use for this volume resource
_(Required)_ | -| **secrets** | [Record](#record) | The KeyVault secrets that this volume exposes | +### `status.compute` {#status-compute} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -### ResourceStatus +### `status.outputResources` {#status-outputresources} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | +### `status.recipe` {#status-recipe} -### EnvironmentCompute +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -* **Discriminator**: kind +### `azure.com.keyvault.certificates` {#azure-com-keyvault-certificates} -#### Base Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `alias` | string | false | false | File name when written to disk | +| `certType` | string | false | false | Certificate object type to be downloaded - the certificate itself, private key or public key of the certificate
Allowed values: `certificate`, `privatekey`, `publickey`. | +| `encoding` | string | false | false | Encoding format. Default utf-8
Allowed values: `base64`, `hex`, `utf-8`. | +| `format` | string | false | false | Certificate format. Default pem
Allowed values: `pem`, `pfx`. | +| `name` | string | true | false | The name of the certificate | +| `version` | string | false | false | Certificate version | -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | +### `azure.com.keyvault.keys` {#azure-com-keyvault-keys} -#### AzureContainerInstanceCompute +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `alias` | string | false | false | File name when written to disk | +| `name` | string | true | false | The name of the key | +| `version` | string | false | false | Key version | -##### Properties +### `azure.com.keyvault.secrets` {#azure-com-keyvault-secrets} -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `alias` | string | false | false | File name when written to disk | +| `encoding` | string | false | false | Encoding format. Default utf-8
Allowed values: `base64`, `hex`, `utf-8`. | +| `name` | string | true | false | The name of the secret | +| `version` | string | false | false | secret version | -#### KubernetesCompute +### `status.compute.identity` {#status-compute-identity} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | +### `status.compute.aci` {#status-compute-aci} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [CertificateObjectProperties](#certificateobjectproperties) - -### CertificateObjectProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **alias** | string | File name when written to disk | -| **certType** | 'certificate' | 'privatekey' | 'publickey' | Certificate object type to be downloaded - the certificate itself, private key or public key of the certificate | -| **encoding** | 'base64' | 'hex' | 'utf-8' | Encoding format. Default utf-8 | -| **format** | 'pem' | 'pfx' | Certificate format. Default pem | -| **name** | string | The name of the certificate
_(Required)_ | -| **version** | string | Certificate version | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [KeyObjectProperties](#keyobjectproperties) - -### KeyObjectProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **alias** | string | File name when written to disk | -| **name** | string | The name of the key
_(Required)_ | -| **version** | string | Key version | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretObjectProperties](#secretobjectproperties) - -### SecretObjectProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **alias** | string | File name when written to disk | -| **encoding** | 'base64' | 'hex' | 'utf-8' | Encoding format. Default utf-8 | -| **name** | string | The name of the secret
_(Required)_ | -| **version** | string | secret version | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md index 64215d401..0ab48472b 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md @@ -9,194 +9,111 @@ description: "Detailed reference documentation for applications.dapr/configurati ## Schema -### Top-Level Resource +## Description -#### Properties +Dapr configuration store portable resource -| 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** | [DaprConfigurationStoreProperties](#daprconfigurationstoreproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Dapr/configurationStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Top-Level Properties -### DaprConfigurationStoreProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| `auth` | [object](#auth) | false | false | The name of the Dapr component to be used as a secret store | +| `componentName` | string | false | true | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component. | +| `environment` | string | true | false | Fully qualified resource ID for the environment that the portable resource is linked to | +| `metadata` | [object](#metadata) | false | false | The metadata for Dapr resource which must match the values specified in Dapr component spec | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipe` | [object](#recipe) | false | false | The recipe used to automatically deploy underlying infrastructure for the resource | +| `resourceProvisioning` | string | false | false | Specifies how the underlying service/resource is provisioned and managed.
Allowed values: `manual`, `recipe`. | +| `resources` | [object](#resources)[] | false | false | A collection of references to resources associated with the configuration store | +| `status` | [object](#status) | false | true | Status of a resource. | +| `type` | string | false | false | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | +| `version` | string | false | false | Dapr component version | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **auth** | [DaprResourceAuth](#daprresourceauth) | The name of the Dapr component to be used as a secret store | -| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the configuration store | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | -| **version** | string | Dapr component version | +### `auth` {#auth} -### DaprResourceAuth +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secretStore` | string | false | false | Secret store to fetch secrets from | -#### Properties +### `metadata` {#metadata} -| Property | Type | Description | -|----------|------|-------------| -| **secretStore** | string | Secret store to fetch secrets from | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secretKeyRef` | [object](#metadata-secretkeyref) | false | false | A reference of a value in a secret store component | +| `value` | string | false | false | The plain text value of the metadata | -### Record +### `recipe` {#recipe} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the recipe within the environment to use | +| `parameters` | object | false | false | Key/value parameters to pass into the recipe at deployment | -* **none** +### `resources` {#resources} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | true | false | Resource id of an existing resource | -* **Additional Properties Type**: [MetadataValue](#metadatavalue) +### `status` {#status} -### MetadataValue +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -#### Properties +### `metadata.secretKeyRef` {#metadata-secretkeyref} -| Property | Type | Description | -|----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | -| **value** | string | The plain text value of the metadata | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `key` | string | true | false | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name | +| `name` | string | true | false | Secret name in the secret store component | -### MetadataValueFromSecret +### `status.compute` {#status-compute} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name
_(Required)_ | -| **name** | string | Secret name in the secret store component
_(Required)_ | +### `status.outputResources` {#status-outputresources} -### Recipe +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -#### Properties +### `status.recipe` {#status-recipe} -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -### Record +### `status.compute.identity` {#status-compute-identity} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -* **none** +### `status.compute.aci` {#status-compute-aci} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md index 309bbe037..85233bb9f 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md @@ -9,194 +9,111 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke ## Schema -### Top-Level Resource +## Description -#### Properties +Dapr PubSubBroker portable resource -| 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** | [DaprPubSubBrokerProperties](#daprpubsubbrokerproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Dapr/pubSubBrokers' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Top-Level Properties -### DaprPubSubBrokerProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| `auth` | [object](#auth) | false | false | The name of the Dapr component to be used as a secret store | +| `componentName` | string | false | true | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component. | +| `environment` | string | true | false | Fully qualified resource ID for the environment that the portable resource is linked to | +| `metadata` | [object](#metadata) | false | false | The metadata for Dapr resource which must match the values specified in Dapr component spec | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipe` | [object](#recipe) | false | false | The recipe used to automatically deploy underlying infrastructure for the resource | +| `resourceProvisioning` | string | false | false | Specifies how the underlying service/resource is provisioned and managed.
Allowed values: `manual`, `recipe`. | +| `resources` | [object](#resources)[] | false | false | A collection of references to resources associated with the pubSubBroker | +| `status` | [object](#status) | false | true | Status of a resource. | +| `type` | string | false | false | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | +| `version` | string | false | false | Dapr component version | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **auth** | [DaprResourceAuth](#daprresourceauth) | The name of the Dapr component to be used as a secret store | -| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the pubSubBroker | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | -| **version** | string | Dapr component version | +### `auth` {#auth} -### DaprResourceAuth +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secretStore` | string | false | false | Secret store to fetch secrets from | -#### Properties +### `metadata` {#metadata} -| Property | Type | Description | -|----------|------|-------------| -| **secretStore** | string | Secret store to fetch secrets from | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secretKeyRef` | [object](#metadata-secretkeyref) | false | false | A reference of a value in a secret store component | +| `value` | string | false | false | The plain text value of the metadata | -### Record +### `recipe` {#recipe} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the recipe within the environment to use | +| `parameters` | object | false | false | Key/value parameters to pass into the recipe at deployment | -* **none** +### `resources` {#resources} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | true | false | Resource id of an existing resource | -* **Additional Properties Type**: [MetadataValue](#metadatavalue) +### `status` {#status} -### MetadataValue +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -#### Properties +### `metadata.secretKeyRef` {#metadata-secretkeyref} -| Property | Type | Description | -|----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | -| **value** | string | The plain text value of the metadata | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `key` | string | true | false | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name | +| `name` | string | true | false | Secret name in the secret store component | -### MetadataValueFromSecret +### `status.compute` {#status-compute} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name
_(Required)_ | -| **name** | string | Secret name in the secret store component
_(Required)_ | +### `status.outputResources` {#status-outputresources} -### Recipe +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -#### Properties +### `status.recipe` {#status-recipe} -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -### Record +### `status.compute.identity` {#status-compute-identity} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -* **none** +### `status.compute.aci` {#status-compute-aci} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md index 0cfb61b65..e78d0ea08 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md @@ -9,176 +9,97 @@ description: "Detailed reference documentation for applications.dapr/secretstore ## Schema -### Top-Level Resource +## Description -#### Properties +Dapr SecretStore portable resource -| 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** | [DaprSecretStoreProperties](#daprsecretstoreproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Dapr/secretStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Top-Level Properties -### DaprSecretStoreProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| `componentName` | string | false | true | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component. | +| `environment` | string | true | false | Fully qualified resource ID for the environment that the portable resource is linked to | +| `metadata` | [object](#metadata) | false | false | The metadata for Dapr resource which must match the values specified in Dapr component spec | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipe` | [object](#recipe) | false | false | The recipe used to automatically deploy underlying infrastructure for the resource | +| `resourceProvisioning` | string | false | false | Specifies how the underlying service/resource is provisioned and managed.
Allowed values: `manual`, `recipe`. | +| `status` | [object](#status) | false | true | Status of a resource. | +| `type` | string | false | false | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | +| `version` | string | false | false | Dapr component version | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | -| **version** | string | Dapr component version | +### `metadata` {#metadata} -### Record +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secretKeyRef` | [object](#metadata-secretkeyref) | false | false | A reference of a value in a secret store component | +| `value` | string | false | false | The plain text value of the metadata | -#### Properties +### `recipe` {#recipe} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the recipe within the environment to use | +| `parameters` | object | false | false | Key/value parameters to pass into the recipe at deployment | -#### Additional Properties +### `status` {#status} -* **Additional Properties Type**: [MetadataValue](#metadatavalue) +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -### MetadataValue +### `metadata.secretKeyRef` {#metadata-secretkeyref} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `key` | string | true | false | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name | +| `name` | string | true | false | Secret name in the secret store component | -| Property | Type | Description | -|----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | -| **value** | string | The plain text value of the metadata | +### `status.compute` {#status-compute} -### MetadataValueFromSecret +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -#### Properties +### `status.outputResources` {#status-outputresources} -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name
_(Required)_ | -| **name** | string | Secret name in the secret store component
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -### Recipe +### `status.recipe` {#status-recipe} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | +### `status.compute.identity` {#status-compute-identity} -### Record +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -#### Properties +### `status.compute.aci` {#status-compute-aci} -* **none** +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md index e5d0c5acd..de723444f 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md @@ -9,194 +9,111 @@ description: "Detailed reference documentation for applications.dapr/statestores ## Schema -### Top-Level Resource +## Description -#### Properties +Dapr StateStore portable resource -| 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** | [DaprStateStoreProperties](#daprstatestoreproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Dapr/stateStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Top-Level Properties -### DaprStateStoreProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| `auth` | [object](#auth) | false | false | The name of the Dapr component to be used as a secret store | +| `componentName` | string | false | true | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component. | +| `environment` | string | true | false | Fully qualified resource ID for the environment that the portable resource is linked to | +| `metadata` | [object](#metadata) | false | false | The metadata for Dapr resource which must match the values specified in Dapr component spec | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipe` | [object](#recipe) | false | false | The recipe used to automatically deploy underlying infrastructure for the resource | +| `resourceProvisioning` | string | false | false | Specifies how the underlying service/resource is provisioned and managed.
Allowed values: `manual`, `recipe`. | +| `resources` | [object](#resources)[] | false | false | A collection of references to resources associated with the state store | +| `status` | [object](#status) | false | true | Status of a resource. | +| `type` | string | false | false | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | +| `version` | string | false | false | Dapr component version | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **auth** | [DaprResourceAuth](#daprresourceauth) | The name of the Dapr component to be used as a secret store | -| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the state store | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | -| **version** | string | Dapr component version | +### `auth` {#auth} -### DaprResourceAuth +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secretStore` | string | false | false | Secret store to fetch secrets from | -#### Properties +### `metadata` {#metadata} -| Property | Type | Description | -|----------|------|-------------| -| **secretStore** | string | Secret store to fetch secrets from | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secretKeyRef` | [object](#metadata-secretkeyref) | false | false | A reference of a value in a secret store component | +| `value` | string | false | false | The plain text value of the metadata | -### Record +### `recipe` {#recipe} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the recipe within the environment to use | +| `parameters` | object | false | false | Key/value parameters to pass into the recipe at deployment | -* **none** +### `resources` {#resources} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | true | false | Resource id of an existing resource | -* **Additional Properties Type**: [MetadataValue](#metadatavalue) +### `status` {#status} -### MetadataValue +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -#### Properties +### `metadata.secretKeyRef` {#metadata-secretkeyref} -| Property | Type | Description | -|----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | -| **value** | string | The plain text value of the metadata | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `key` | string | true | false | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name | +| `name` | string | true | false | Secret name in the secret store component | -### MetadataValueFromSecret +### `status.compute` {#status-compute} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name
_(Required)_ | -| **name** | string | Secret name in the secret store component
_(Required)_ | +### `status.outputResources` {#status-outputresources} -### Recipe +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -#### Properties +### `status.recipe` {#status-recipe} -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -### Record +### `status.compute.identity` {#status-compute-identity} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -* **none** +### `status.compute.aci` {#status-compute-aci} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md index 006680c03..a943e8778 100644 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md @@ -9,179 +9,98 @@ description: "Detailed reference documentation for applications.datastores/mongo ## Schema -### Top-Level Resource +## Description -#### Properties +MongoDatabase portable resource -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **database** | string | Database name of the target Mongo database
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **host** | string | Host name of the target Mongo database
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **port** | int | Port value of the target Mongo database
_(ReadOnly)_ | -| **properties** | [MongoDatabaseProperties](#mongodatabaseproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the MongoDB resource
_(ReadOnly)_ | -| **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | Secret values provided for the resource
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Datastores/mongoDatabases' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **username** | string | Username to use when connecting to the target Mongo database
_(ReadOnly)_ | +## Top-Level Properties -### MongoDatabaseProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| `database` | string | false | false | Database name of the target Mongo database | +| `environment` | string | true | false | Fully qualified resource ID for the environment that the portable resource is linked to | +| `host` | string | false | false | Host name of the target Mongo database | +| `port` | integer | false | false | Port value of the target Mongo database | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipe` | [object](#recipe) | false | false | The recipe used to automatically deploy underlying infrastructure for the resource | +| `resourceProvisioning` | string | false | false | Specifies how the underlying service/resource is provisioned and managed.
Allowed values: `manual`, `recipe`. | +| `resources` | [object](#resources)[] | false | false | List of the resource IDs that support the MongoDB resource | +| `secrets` | [object](#secrets) | false | false | Secret values provided for the resource | +| `status` | [object](#status) | false | true | Status of a resource. | +| `username` | string | false | false | Username to use when connecting to the target Mongo database | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **database** | string | Database name of the target Mongo database | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **host** | string | Host name of the target Mongo database | -| **port** | int | Port value of the target Mongo database | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the MongoDB resource | -| **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | Secret values provided for the resource | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **username** | string | Username to use when connecting to the target Mongo database | +### `recipe` {#recipe} -### Recipe +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the recipe within the environment to use | +| `parameters` | object | false | false | Key/value parameters to pass into the recipe at deployment | -#### Properties +### `resources` {#resources} -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | true | false | Resource id of an existing resource | -### Record +### `secrets` {#secrets} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `connectionString` | string | false | false | Connection string used to connect to the target Mongo database | +| `password` | string | false | false | Password to use when connecting to the target Mongo database | -* **none** +### `status` {#status} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -* **Additional Properties Type**: any +### `status.compute` {#status-compute} -### ResourceReference +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -#### Properties +### `status.outputResources` {#status-outputresources} -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -### MongoDatabaseSecrets +### `status.recipe` {#status-recipe} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -| Property | Type | Description | -|----------|------|-------------| -| **connectionString** | string | Connection string used to connect to the target Mongo database | -| **password** | string | Password to use when connecting to the target Mongo database | +### `status.compute.identity` {#status-compute-identity} -### ResourceStatus +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -#### Properties +### `status.compute.aci` {#status-compute-aci} -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md index 3cc824f1b..3248480fa 100644 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md @@ -9,180 +9,99 @@ description: "Detailed reference documentation for applications.datastores/redis ## Schema -### Top-Level Resource +## Description -#### Properties +RedisCache portable resource -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **host** | string | The host name of the target Redis cache
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **port** | int | The port value of the target Redis cache
_(ReadOnly)_ | -| **properties** | [RedisCacheProperties](#rediscacheproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the Redis resource
_(ReadOnly)_ | -| **secrets** | [RedisCacheSecrets](#rediscachesecrets) | Secrets provided by resource
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **tls** | bool | Specifies whether to enable SSL connections to the Redis cache
_(ReadOnly)_ | -| **type** | 'Applications.Datastores/redisCaches' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **username** | string | The username for Redis cache
_(ReadOnly)_ | +## Top-Level Properties -### RedisCacheProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| `environment` | string | true | false | Fully qualified resource ID for the environment that the portable resource is linked to | +| `host` | string | false | false | The host name of the target Redis cache | +| `port` | integer | false | false | The port value of the target Redis cache | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipe` | [object](#recipe) | false | false | The recipe used to automatically deploy underlying infrastructure for the resource | +| `resourceProvisioning` | string | false | false | Specifies how the underlying service/resource is provisioned and managed.
Allowed values: `manual`, `recipe`. | +| `resources` | [object](#resources)[] | false | false | List of the resource IDs that support the Redis resource | +| `secrets` | [object](#secrets) | false | false | Secrets provided by resource | +| `status` | [object](#status) | false | true | Status of a resource. | +| `tls` | boolean | false | false | Specifies whether to enable SSL connections to the Redis cache | +| `username` | string | false | false | The username for Redis cache | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **host** | string | The host name of the target Redis cache | -| **port** | int | The port value of the target Redis cache | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the Redis resource | -| **secrets** | [RedisCacheSecrets](#rediscachesecrets) | Secrets provided by resource | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **tls** | bool | Specifies whether to enable SSL connections to the Redis cache | -| **username** | string | The username for Redis cache | +### `recipe` {#recipe} -### Recipe +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the recipe within the environment to use | +| `parameters` | object | false | false | Key/value parameters to pass into the recipe at deployment | -#### Properties +### `resources` {#resources} -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | true | false | Resource id of an existing resource | -### Record +### `secrets` {#secrets} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `connectionString` | string | false | false | The connection string used to connect to the Redis cache | +| `password` | string | false | false | The password for this Redis cache instance | +| `url` | string | false | false | The URL used to connect to the Redis cache | -* **none** +### `status` {#status} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -* **Additional Properties Type**: any +### `status.compute` {#status-compute} -### ResourceReference +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -#### Properties +### `status.outputResources` {#status-outputresources} -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -### RedisCacheSecrets +### `status.recipe` {#status-recipe} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -| Property | Type | Description | -|----------|------|-------------| -| **connectionString** | string | The connection string used to connect to the Redis cache | -| **password** | string | The password for this Redis cache instance | -| **url** | string | The URL used to connect to the Redis cache | +### `status.compute.identity` {#status-compute-identity} -### ResourceStatus +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -#### Properties +### `status.compute.aci` {#status-compute-aci} -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md index 119939474..95be136f5 100644 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md @@ -9,179 +9,98 @@ description: "Detailed reference documentation for applications.datastores/sqlda ## Schema -### Top-Level Resource +## Description -#### Properties +SqlDatabase portable resource -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **database** | string | The name of the Sql database.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **port** | int | Port value of the target Sql database
_(ReadOnly)_ | -| **properties** | [SqlDatabaseProperties](#sqldatabaseproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the SqlDatabase resource
_(ReadOnly)_ | -| **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | Secret values provided for the resource
_(ReadOnly)_ | -| **server** | string | The fully qualified domain name of the Sql database.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Datastores/sqlDatabases' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **username** | string | Username to use when connecting to the target Sql database
_(ReadOnly)_ | +## Top-Level Properties -### SqlDatabaseProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| `database` | string | false | false | The name of the Sql database. | +| `environment` | string | true | false | Fully qualified resource ID for the environment that the portable resource is linked to | +| `port` | integer | false | false | Port value of the target Sql database | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipe` | [object](#recipe) | false | false | The recipe used to automatically deploy underlying infrastructure for the resource | +| `resourceProvisioning` | string | false | false | Specifies how the underlying service/resource is provisioned and managed.
Allowed values: `manual`, `recipe`. | +| `resources` | [object](#resources)[] | false | false | List of the resource IDs that support the SqlDatabase resource | +| `secrets` | [object](#secrets) | false | false | Secret values provided for the resource | +| `server` | string | false | false | The fully qualified domain name of the Sql database. | +| `status` | [object](#status) | false | true | Status of a resource. | +| `username` | string | false | false | Username to use when connecting to the target Sql database | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **database** | string | The name of the Sql database. | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **port** | int | Port value of the target Sql database | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the SqlDatabase resource | -| **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | Secret values provided for the resource | -| **server** | string | The fully qualified domain name of the Sql database. | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **username** | string | Username to use when connecting to the target Sql database | +### `recipe` {#recipe} -### Recipe +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the recipe within the environment to use | +| `parameters` | object | false | false | Key/value parameters to pass into the recipe at deployment | -#### Properties +### `resources` {#resources} -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | true | false | Resource id of an existing resource | -### Record +### `secrets` {#secrets} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `connectionString` | string | false | false | Connection string used to connect to the target Sql database | +| `password` | string | false | false | Password to use when connecting to the target Sql database | -* **none** +### `status` {#status} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -* **Additional Properties Type**: any +### `status.compute` {#status-compute} -### ResourceReference +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -#### Properties +### `status.outputResources` {#status-outputresources} -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -### SqlDatabaseSecrets +### `status.recipe` {#status-recipe} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -| Property | Type | Description | -|----------|------|-------------| -| **connectionString** | string | Connection string used to connect to the target Sql database | -| **password** | string | Password to use when connecting to the target Sql database | +### `status.compute.identity` {#status-compute-identity} -### ResourceStatus +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -#### Properties +### `status.compute.aci` {#status-compute-aci} -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md index 08a912ac3..4b0af3521 100644 --- a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md +++ b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md @@ -9,183 +9,100 @@ description: "Detailed reference documentation for applications.messaging/rabbit ## Schema -### Top-Level Resource +## Description -#### Properties +RabbitMQQueue portable resource -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **host** | string | The hostname of the RabbitMQ instance
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **port** | int | The port of the RabbitMQ instance. Defaults to 5672
_(ReadOnly)_ | -| **properties** | [RabbitMQQueueProperties](#rabbitmqqueueproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **queue** | string | The name of the queue
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the rabbitMQ resource
_(ReadOnly)_ | -| **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The secrets to connect to the RabbitMQ instance
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **tls** | bool | Specifies whether to use SSL when connecting to the RabbitMQ instance
_(ReadOnly)_ | -| **type** | 'Applications.Messaging/rabbitMQQueues' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **username** | string | The username to use when connecting to the RabbitMQ instance
_(ReadOnly)_ | -| **vHost** | string | The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost.
_(ReadOnly)_ | +## Top-Level Properties -### RabbitMQQueueProperties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| `environment` | string | true | false | Fully qualified resource ID for the environment that the portable resource is linked to | +| `host` | string | false | false | The hostname of the RabbitMQ instance | +| `port` | integer | false | false | The port of the RabbitMQ instance. Defaults to 5672 | +| `provisioningState` | string | false | true | The status of the asynchronous operation.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `queue` | string | false | false | The name of the queue | +| `recipe` | [object](#recipe) | false | false | The recipe used to automatically deploy underlying infrastructure for the resource | +| `resourceProvisioning` | string | false | false | Specifies how the underlying service/resource is provisioned and managed.
Allowed values: `manual`, `recipe`. | +| `resources` | [object](#resources)[] | false | false | List of the resource IDs that support the rabbitMQ resource | +| `secrets` | [object](#secrets) | false | false | The secrets to connect to the RabbitMQ instance | +| `status` | [object](#status) | false | true | Status of a resource. | +| `tls` | boolean | false | false | Specifies whether to use SSL when connecting to the RabbitMQ instance | +| `username` | string | false | false | The username to use when connecting to the RabbitMQ instance | +| `vHost` | string | false | false | The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost. | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **host** | string | The hostname of the RabbitMQ instance | -| **port** | int | The port of the RabbitMQ instance. Defaults to 5672 | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **queue** | string | The name of the queue | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the rabbitMQ resource | -| **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The secrets to connect to the RabbitMQ instance | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **tls** | bool | Specifies whether to use SSL when connecting to the RabbitMQ instance | -| **username** | string | The username to use when connecting to the RabbitMQ instance | -| **vHost** | string | The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost. | +### `recipe` {#recipe} -### Recipe +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | The name of the recipe within the environment to use | +| `parameters` | object | false | false | Key/value parameters to pass into the recipe at deployment | -#### Properties +### `resources` {#resources} -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | true | false | Resource id of an existing resource | -### Record +### `secrets` {#secrets} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `password` | string | false | false | The password used to connect to the RabbitMQ instance | +| `uri` | string | false | false | The connection URI of the RabbitMQ instance. Generated automatically from host, port, SSL, username, password, and vhost. Can be overridden with a custom value | -* **none** +### `status` {#status} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -* **Additional Properties Type**: any +### `status.compute` {#status-compute} -### ResourceReference +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -#### Properties +### `status.outputResources` {#status-outputresources} -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -### RabbitMQSecrets +### `status.recipe` {#status-recipe} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -| Property | Type | Description | -|----------|------|-------------| -| **password** | string | The password used to connect to the RabbitMQ instance | -| **uri** | string | The connection URI of the RabbitMQ instance. Generated automatically from host, port, SSL, username, password, and vhost. Can be overridden with a custom value | +### `status.compute.identity` {#status-compute-identity} -### ResourceStatus +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -#### Properties +### `status.compute.aci` {#status-compute-aci} -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | - -### 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/models/index.md b/docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/models/index.md new file mode 100644 index 000000000..a39f1544f --- /dev/null +++ b/docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/models/index.md @@ -0,0 +1,90 @@ +--- +type: docs +title: "Reference: radius.ai/models@2025-08-01-preview" +linkTitle: "models" +description: "Detailed reference documentation for radius.ai/models@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.AI/models Resource Type deploys an LLM inference model endpoint. +To deploy a model, add a models resource to the application definition Bicep +file. The platform-engineer recipe binds this developer-facing contract to a +managed cloud model service without exposing any module details to the app. +```bicep +resource model 'Radius.AI/models@2025-08-01-preview' = { + name: 'model' + properties: { + environment: environment + application: myApplication.id + model: 'gpt-5-mini' + } +} +``` + +To connect your container to the model, create a connection from the +Container resource to the model as shown below. +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + application: myApplication.id + environment: environment + containers: { + frontend: { + image: 'frontend:1.25' + } + } + connections: { + llm: { + source: model.id + } + } + } +} +``` + +The connection automatically injects environment variables into the +container for all properties from the model. The environment variables are +named `CONNECTION__`. In this example the +connection name is `llm` so the environment variables will be: + +- CONNECTION_LLM_MODEL +- CONNECTION_LLM_ENDPOINT + +The `apiKey` secret is NOT injected via the connection — it is materialized +into a managed `Radius.Security/secrets` resource. Bind it into a container +env var with a `secretKeyRef`, using `model.properties.secrets.name` as the +`secretName` and key `apiKey` (see the `secrets` property). + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `endpoint` | string | false | true | (Read Only) The base URL used to call the model inference endpoint. Mapped from the recipe module's output. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `model` | string | false | false | (Optional) The model deployment to provision. Defaults to `gpt-5-mini` if not provided. | +| `secrets` | [object](#secrets) | false | false | (Read-only) Recipe secrets. The reserved `name` sub-property references the managed Radius.Security/secrets resource Radius materializes from the recipe's `outputs.secrets`; the other sub-properties declare secret keys whose values are written only into that managed secret (never onto this resource). Consumers bind a key into a container env var via `secretKeyRef`, using `.properties.secrets.name` as `secretName`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | + +### `secrets` {#secrets} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `apiKey` | string | false | true | (Read Only) The API key used to call the model inference endpoint. Mapped from the recipe module's `primaryKey` output; delivered via the managed secret. | +| `name` | string | false | true | (Reserved) Name of the managed Radius.Security/secrets resource. Use as `secretName` in a container `secretKeyRef`. | diff --git a/docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/search/index.md b/docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/search/index.md new file mode 100644 index 000000000..43b92de2f --- /dev/null +++ b/docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/search/index.md @@ -0,0 +1,85 @@ +--- +type: docs +title: "Reference: radius.ai/search@2025-08-01-preview" +linkTitle: "search" +description: "Detailed reference documentation for radius.ai/search@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.AI/search Resource Type deploys a search service. To +deploy a search service, add a search resource to the application +definition Bicep file. The platform-engineer recipe provisions the concrete +backend and maps its endpoint and API key outputs back onto this resource. +```bicep +resource search 'Radius.AI/search@2025-08-01-preview' = { + name: 'search' + properties: { + environment: environment + application: myApplication.id + } +} +``` + +To connect your container to the service, create a connection from the +Container resource to the search service as shown below. +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + application: myApplication.id + environment: environment + container: { + image: 'frontend:1.25' + } + connections: { + search: { + source: search.id + } + } + } +} +``` + +The connection automatically injects environment variables into the +container for all properties from the search service. The environment +variables are named `CONNECTION__`. In this +example the connection name is `search` so the environment variables will be: + +- CONNECTION_SEARCH_ENDPOINT + +The `apiKey` secret is NOT injected via the connection — it is materialized +into a managed `Radius.Security/secrets` resource. Bind it into a container +env var with a `secretKeyRef`, using `search.properties.secrets.name` as the +`secretName` and key `apiKey` (see the `secrets` property). + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `endpoint` | string | false | true | The endpoint used to connect to the search service. Mapped from the recipe module's output. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `secrets` | [object](#secrets) | false | false | (Read-only) Recipe secrets. The reserved `name` sub-property references the managed Radius.Security/secrets resource Radius materializes from the recipe's `outputs.secrets`; the other sub-properties declare secret keys whose values are written only into that managed secret (never onto this resource). Consumers bind a key into a container env var via `secretKeyRef`, using `.properties.secrets.name` as `secretName`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | + +### `secrets` {#secrets} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `apiKey` | string | false | true | The admin API key used to connect to the search service. Mapped from the recipe module's output; delivered via the managed secret. | +| `name` | string | false | true | (Reserved) Name of the managed Radius.Security/secrets resource. Use as `secretName` in a container `secretKeyRef`. | diff --git a/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containerimages/index.md b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containerimages/index.md new file mode 100644 index 000000000..4f25e5e5b --- /dev/null +++ b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containerimages/index.md @@ -0,0 +1,91 @@ +--- +type: docs +title: "Reference: radius.compute/containerimages@2025-08-01-preview" +linkTitle: "containerimages" +description: "Detailed reference documentation for radius.compute/containerimages@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Compute/containerImages Resource Type builds a container image from source and pushes it to an OCI registry. Builds run inside the Radius control plane. + +To use a containerImages resource in your application, add a containerImages resource to the application definition Bicep file, then reference the `containerImages.imageReference` property in the containers resource. For example: + +```bicep +extension radius + +param environment string + +resource myApp 'Radius.Core/applications@2025-08-01-preview' = { + name: 'myApp' + properties: { + environment: environment + } +} + +resource myImage 'Radius.Compute/containerImages@2025-08-01-preview' = { + name: 'myImage' + properties: { + environment: environment + application: myApp.id + tag: 'v1.2.3' + build: { + source: 'git::https://github.com/myorg/myapp.git//frontend?ref=v1.2.3' + } + } +} + +resource myContainer 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'myContainer' + properties: { + environment: environment + application: myApp.id + containers: { + app: { + image: myImage.properties.imageReference + ports: { + web: { + containerPort: 3000 + } + } + } + } + } +} +``` + +Multi-architecture builds (e.g. `platforms: ["linux/amd64", "linux/arm64"]`) require a Dockerfile that supports cross-compilation via `FROM --platform=$BUILDPLATFORM` and `TARGETARCH`. Dockerfiles that execute target-arch binaries during the build will fail with `exec format error`. There is no QEMU/binfmt fallback in this design. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | true | false | (Required) The Radius Application ID. `myApplication.id` for example. | +| `build` | [object](#build) | true | false | (Required) Build configuration for the container image. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typical value should be `environment`. | +| `imageReference` | string | false | true | (Read Only) The full image reference produced by the recipe in the form `/:`. Reference this from `Radius.Compute/containers` to consume the built image. | +| `tag` | string | false | false | (Optional) Tag for the produced image. When omitted, the recipe computes a deterministic tag (`sha256-`) from the build inputs. A present tag must be a valid non-empty string. For git sources, pin to a commit SHA or immutable tag (e.g. `?ref=`); with a moving ref like `?ref=main`, the computed tag does not change when the upstream branch advances even though a later build can replace the content behind that tag. | + +## Object Properties + +### `build` {#build} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `args` | object | false | false | (Optional) Map of `--build-arg` values passed to the build, e.g. `{ VERSION: 'v1.2.3' }`. Argument names must match `[A-Za-z_][A-Za-z0-9_]*`. Values must not contain shell metacharacters. | +| `dockerfile` | string | false | false | (Optional) Path to the Dockerfile relative to the build source. Defaults to `Dockerfile`. | +| `platforms` | string array | false | false | (Optional) Target platforms to build for (e.g. `["linux/amd64"]`, `["linux/amd64", "linux/arm64"]`). When omitted, defaults to `["linux/amd64", "linux/arm64"]`. Multi-platform builds use cross-compilation; the Dockerfile must use `FROM --platform=$BUILDPLATFORM` and `TARGETARCH`. | +| `source` | string | true | false | (Required) Source location for the build. Use a git URL of the form `git::https://...`, which BuildKit clones inside the cluster, or an operator-managed local directory. Radius does not upload workstation source. The default Bicep Recipe accepts local sources only beneath `/var/radius/build-contexts` and rejects symbolic links. The stock Radius Helm chart does not mount this directory; platform engineers using local sources must add a read-only mount by customizing or post-rendering the dynamic-rp Deployment. Git sources require no mount. The Terraform Recipe retains its existing local-path behavior. For git URLs, select a subdirectory with `//` and a ref with `?ref=`, in that order. Example: `git::https://github.com/myorg/myapp.git//frontend?ref=v1.2.3`. | + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | diff --git a/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containers/index.md b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containers/index.md new file mode 100644 index 000000000..f328265c8 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containers/index.md @@ -0,0 +1,335 @@ +--- +type: docs +title: "Reference: radius.compute/containers@2025-08-01-preview" +linkTitle: "containers" +description: "Detailed reference documentation for radius.compute/containers@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Compute/containers Resource Type is the primary resource type for running one or more containers. It is always part of a Radius Application. To deploy a Container add a resource to the application definition Bicep file. + +```bicep +extension radius +param environment string + +resource myApplication 'Radius.Core/applications@2025-08-01-preview' = { ... } + +resource myContainer 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'myContainer' + properties: { + environment: environment + application: myApplication.id + containers: { + demo: { + image: 'ghcr.io/radius-project/samples/demo:latest' + } + } + } +} +``` + +By default, Containers deploys to Kubernetes. In this case, a Kubernetes Deployment named myContainer is deployed which includes a Pod named myContainer. Your Radius environment may deploy to other container platforms such as Azure Container Instances. + +To accept network connections, expose a port on the container. + +```bicep +resource myContainer 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'myContainer' + properties: { + environment: environment + application: myApplication.id + containers: { + demo: { + image: 'ghcr.io/radius-project/samples/demo:latest' + ports: { + web: { + containerPort: 3000 + } + } + } + } + } +} +``` + +When a port is included, a Kubernetes Service named demo with the type ClusterIP is created. + +To create an ephemeral emptyDir shared between two containers add a Containers.properties.volumes. + +```bicep +resource myContainer 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'myContainer' + properties: { + environment: environment + application: myApplication.id + containers: { + frontend: { + image: 'frontend:latest' + volumeMounts: [ + { + volumeName: 'shared' + mountPath: '/var/shared' + } + ] + } + backend: { + image: 'backend:latest' + volumeMounts: [ + { + volumeName: 'shared' + mountPath: '/var/shared' + } + ] + } + } + volumes: { + shared: { + emptyDir: {} + } + } + } +} +``` + +To mount a persistent volume or secret see the PersistentVolumes and Secrets Resource Types. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | true | false | (Required) The Radius Application ID. `myApplication.id` for example. | +| `autoScaling` | [object](#autoscaling) | false | false | | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | (Optional) Map of resources this container is dependent upon. `db: { source: db.id } for example. | +| `containers` | [object](#containers) | true | false | | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `extensions` | [object](#extensions) | false | false | (Optional) Properties for additional functionality. daprSidecar is the only available option. | +| `platformOptions` | object | false | false | (Optional) If enabled by the platform engineer, properties to be passed to the Recipe for the specified platform. | +| `replicas` | integer | false | false | (Optional) The minimum number of replicas for the set of containers. | +| `restartPolicy` | string | false | false | (Optional) Defines how a containers behave when they terminate. `Always` will restart containers regardless of their exit status. `OnFailure` will restart containers if they return a non-zero exit code.
Allowed values: `Always`, `Never`, `OnFailure`. | +| `volumes` | [object](#volumes) | false | false | (Optional) List of volumes that can be mounted by a container. | + +## Object Properties + +### `autoScaling` {#autoscaling} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `maxReplicas` | integer | false | false | (Optional) The maximum number of replicas for the autoscaler. | +| `metrics` | [object](#autoscaling-metrics)[] | true | false | (Required) The metric to measure and target used to autoscale. | + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | (Optional) Disables the automatic injection of environment variables from connected resource properties. | +| `source` | string | true | false | (Required) The resource ID of the resource this container is dependent upon. | + +### `containers` {#containers} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `args` | string array | false | false | (Optional) Arguments for the command. Overrides the container image CMD. `["echo Hello", "&&", "echo World"]` for example. | +| `command` | string array | false | false | (Optional) Command the container runs. Overrides the container image ENTRYPOINT. `["/bin/sh", "-c"]` for example. | +| `env` | [object](#containers-env) | false | false | (Optional) Environment variables injected into the container. | +| `image` | string | true | false | (Required) The container image. `ghcr.io/radius-project/samples/demo:latest` for example. | +| `initContainer` | boolean | false | false | (Optional) Set to true if container should run and succeed prior to other containers starting. | +| `livenessProbe` | [object](#containers-livenessprobe) | false | false | (Optional) A liveness probe defines a check (a probe) to determine if a container is healthy. | +| `ports` | [object](#containers-ports) | false | false | (Optional) Network ports exposed by the container. A network endpoint is created for each port. For L7 ingress create a Routes resource. | +| `readinessProbe` | [object](#containers-readinessprobe) | false | false | (Optional) A readiness probe defines a check (a probe) to determine when a container is ready to begin accepting traffic. | +| `resources` | [object](#containers-resources) | false | false | (Optional) Compute resource requirements for the container. | +| `volumeMounts` | [object](#containers-volumemounts)[] | false | false | (Optional) Volumes to mount in the container. | +| `workingDir` | string | false | false | (Optional) The working directory inside the container. `/usr/share` for example. | + +### `extensions` {#extensions} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `daprSidecar` | [object](#extensions-daprsidecar) | false | false | (Optional) When set the daprSidecar container is configured. | + +### `volumes` {#volumes} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `emptyDir` | [object](#volumes-emptydir) | false | false | (Optional) An empty directory. | +| `persistentVolume` | [object](#volumes-persistentvolume) | false | false | (Optional) Mount an existing Radius PersistentVolume resource. | +| `secretName` | string | false | false | (Optional) The Radius Secret resource name. | + +### `autoScaling.metrics` {#autoscaling-metrics} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `customMetric` | string | false | false | (Optional) The custom metric exposed by the application. Implementation specific. See platform engineer for further guidance. | +| `kind` | string | true | false | (Required) The metric to measure.
Allowed values: `cpu`, `custom`, `memory`. | +| `target` | [object](#autoscaling-metrics-target) | true | false | (Required) When the metric exceeds the target value specified, autoscaling is triggered. Only one target value can be specified dependent upon the type. | + +### `containers.env` {#containers-env} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `value` | string | false | false | (Optional) String value of the environment variable. | +| `valueFrom` | [object](#containers-env-valuefrom) | false | false | | + +### `containers.livenessProbe` {#containers-livenessprobe} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `exec` | [object](#containers-livenessprobe-exec) | false | false | (Optional) An exec probe runs a command within a container. If the command succeeds and returns 0 the probe is healthy. | +| `failureThreshold` | integer | false | false | (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Assumed to be 3 if not specified. | +| `httpGet` | [object](#containers-livenessprobe-httpget) | false | false | (Optional) A httpGet probe performs a HTTP GET against the container on the specified port. If the HTTP server returns a code greater than or equal to 200 and less than 400 the probe is healthy. | +| `initialDelaySeconds` | integer | false | false | (Optional) Number of seconds after the container has started before probes are initiated. | +| `periodSeconds` | integer | false | false | (Optional) How often to perform the probe. Assumed to be 10 seconds if not specified. | +| `successThreshold` | integer | false | false | (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Assumed to be 1 if not specified. | +| `tcpSocket` | [object](#containers-livenessprobe-tcpsocket) | false | false | (Optional) A TCP socket probe establishes a TCP connection to the container on the specified port. If a connection is established the probe is healthy. | +| `terminationGracePeriodSeconds` | integer | false | false | (Optional) Number of seconds the container needs to terminate gracefully upon probe failure. The grace period amount of time between when a container is sent a termination signal and the time when the processes are forcibly halted with a kill signal. | +| `timeoutSeconds` | integer | false | false | (Optional) Number of seconds after which the probe times out. Assumed to be 1 second if not specified. | + +### `containers.ports` {#containers-ports} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `containerPort` | integer | true | false | (Required) The network port the container is listening on. `443` for example. | +| `protocol` | string | false | false | (Optional) The protocol. If not specified, `TCP` is assumed.
Allowed values: `TCP`, `UDP`. | + +### `containers.readinessProbe` {#containers-readinessprobe} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `exec` | [object](#containers-readinessprobe-exec) | false | false | (Optional) An exec probe runs a command within a container. If the command succeeds and returns 0 the probe is healthy. | +| `failureThreshold` | integer | false | false | (Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Assumed to be 3 if not specified. | +| `httpGet` | [object](#containers-readinessprobe-httpget) | false | false | (Optional) A httpGet probe performs a HTTP GET against the container on the specified port. If the HTTP server returns a code greater than or equal to 200 and less than 400 the probe is healthy. | +| `initialDelaySeconds` | integer | false | false | (Optional) Number of seconds after the container has started before probes are initiated. | +| `periodSeconds` | integer | false | false | (Optional) How often to perform the probe. Assumed to be 10 seconds if not specified. | +| `successThreshold` | integer | false | false | (Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Assumed to be 1 if not specified. | +| `tcpSocket` | [object](#containers-readinessprobe-tcpsocket) | false | false | (Optional) A TCP socket probe establishes a TCP connection to the container on the specified port. If a connection is established the probe is healthy. | +| `terminationGracePeriodSeconds` | integer | false | false | (Optional) Number of seconds the container needs to terminate gracefully upon probe failure. The grace period amount of time between when a container is sent a termination signal and the time when the processes are forcibly halted with a kill signal. | +| `timeoutSeconds` | integer | false | false | (Optional) Number of seconds after which the probe times out. Assumed to be 1 second if not specified. | + +### `containers.resources` {#containers-resources} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `limits` | [object](#containers-resources-limits) | false | false | (Optional) Limits define the maximum amount of CPU or memory the container can consume. | +| `requests` | [object](#containers-resources-requests) | false | false | (Optional) Requests define the minimum amount of CPU or memory that is required by the container. | + +### `containers.volumeMounts` {#containers-volumemounts} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `mountPath` | string | true | false | (Required) The path to mount the volume in the container file system. | +| `volumeName` | string | true | false | (Required) The name of the volume defined in Containers.properties.volumes. | + +### `extensions.daprSidecar` {#extensions-daprsidecar} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `appId` | string | false | false | (Optional) The unique ID of the Dapr application. Used for service discovery, state encapsulation and the pub/sub consumer ID. | +| `appPort` | integer | false | false | (Optional) The port your application is listening on. | +| `config` | string | false | false | (Optional) The Dapr Configuration resource name. | + +### `volumes.emptyDir` {#volumes-emptydir} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `medium` | string | false | false | (Optional) Set to `memory` for a tmpfs (RAM backed filesystem). Note that while tmpfs is very fast storage counts against the memory limit of the container.
Allowed values: `disk`, `memory`. | + +### `volumes.persistentVolume` {#volumes-persistentvolume} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `accessMode` | string | false | false | (Optional) Set to `ReadWriteOnce` if no other Containers can mount in read/write mode. Set to `ReadOnlyMany` to enable other Containers to mount in read-only mode. Set to `ReadWriteMany` to allow multiple containers to mount in read/write mode. Assumed to be `ReadWriteOnce` if not specified.
Allowed values: `ReadOnlyMany`, `ReadWriteMany`, `ReadWriteOnce`. | +| `resourceId` | string | false | false | (Required) The Radius PersistentVolume resource ID. | + +### `autoScaling.metrics.target` {#autoscaling-metrics-target} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `averageUtilization` | integer | false | false | (Optional) The average CPU or memory utilization across all containers expressed as a percentage. Kind must be CPU or memory. | +| `averageValue` | integer | false | false | (Optional) The average value of the metric as a quantity. | +| `value` | integer | false | false | (Optional) The absolute value of the metric as a quantity. | + +### `containers.env.valueFrom` {#containers-env-valuefrom} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secretKeyRef` | [object](#containers-env-valuefrom-secretkeyref) | false | false | (Optional) Set the environment variable value based on a Radius Secrets resource. | + +### `containers.livenessProbe.exec` {#containers-livenessprobe-exec} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `command` | string array | true | false | (Required) The command to run inside the container. `["cat", "/tmp/healthy"]` for example. | + +### `containers.livenessProbe.httpGet` {#containers-livenessprobe-httpget} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `httpHeaders` | [object](#containers-livenessprobe-httpget-httpheaders)[] | false | false | (Optional) Custom HTTP headers to be included in the GET request. | +| `path` | string | true | false | (Required) The path to access on the HTTP server. | +| `port` | integer | true | false | (Required) The TCP port connect to on the container. | +| `scheme` | string | false | false | (Optional) HTTP or HTTPS. Assumes HTTP is not specified.
Allowed values: `http`, `https`. | + +### `containers.livenessProbe.tcpSocket` {#containers-livenessprobe-tcpsocket} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `port` | integer | true | false | (Required) The TCP port to connect to. | + +### `containers.readinessProbe.exec` {#containers-readinessprobe-exec} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `command` | string array | true | false | | + +### `containers.readinessProbe.httpGet` {#containers-readinessprobe-httpget} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `httpHeaders` | [object](#containers-readinessprobe-httpget-httpheaders)[] | false | false | (Optional) Custom HTTP headers to be included in the GET request. | +| `path` | string | true | false | (Required) The path to access on the HTTP server. | +| `port` | integer | true | false | (Required) The TCP port connect to on the container. | +| `scheme` | string | false | false | (Optional) HTTP or HTTPS. Assumes HTTP is not specified.
Allowed values: `http`, `https`. | + +### `containers.readinessProbe.tcpSocket` {#containers-readinessprobe-tcpsocket} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `port` | integer | true | false | (Required) The TCP port to connect to. | + +### `containers.resources.limits` {#containers-resources-limits} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `cpu` | string | false | false | (Optional) The maximum number of vCPUs which can be used by the container. | +| `memoryInMib` | integer | false | false | (Optional) The maximum amount of memory which can be used by the container in MiB. | + +### `containers.resources.requests` {#containers-resources-requests} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `cpu` | string | false | false | (Optional) The minimum number of vCPUs required by the container. `0.1` results in one tenth of a vCPU being reserved. | +| `memoryInMib` | integer | false | false | (Optional) The minimum amount of memory required by the container in MiB. `1024` results in 1 GiB of memory being reserved. | + +### `containers.env.valueFrom.secretKeyRef` {#containers-env-valuefrom-secretkeyref} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `key` | string | false | false | (Optional) The key of the Radius Secrets resource. The value of the key will be used as the environment variable value. | +| `secretName` | string | false | false | (Optional) The name of the Radius Secrets resource. | + +### `containers.livenessProbe.httpGet.httpHeaders` {#containers-livenessprobe-httpget-httpheaders} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `value` | string | true | false | (Required) The header field value. | + +### `containers.readinessProbe.httpGet.httpHeaders` {#containers-readinessprobe-httpget-httpheaders} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `value` | string | true | false | (Required) The header field value. | diff --git a/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/persistentvolumes/index.md b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/persistentvolumes/index.md new file mode 100644 index 000000000..118acf8a3 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/persistentvolumes/index.md @@ -0,0 +1,118 @@ +--- +type: docs +title: "Reference: radius.compute/persistentvolumes@2025-08-01-preview" +linkTitle: "persistentvolumes" +description: "Detailed reference documentation for radius.compute/persistentvolumes@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Compute/persistentVolumes Resource Type represents a persistent storage volume. A PersistentVolume can be referenced in the volumes property of a Container. +To deploy, first add a PersistentVolume resource to the application definition Bicep file. +```bicep +extension radius +param environment string + +resource myApplication 'Radius.Core/applications@2025-08-01-preview' = { ... } + +resource myPersistentVolume 'Radius.Compute/persistentVolumes@2025-08-01-preview' = { + name: 'myPersistentVolume' + properties: { + environment: environment + application: myApplication.id + sizeInGib: 1 + } +} +``` + +Then reference the PersistentVolume by ID in the volumes property of the Container. Finally, set the mountPath in the container referencing the volumeName. +```bicep +resource myContainer 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'myContainer' + properties: { + environment: environment + application: myApplication.id + containers: { + demo: { + image: 'ghcr.io/radius-project/samples/demo:latest' + volumeMounts: [ + { + volumeName: 'data' + mountPath: '/app/data' + } + ] + } + } + volumes: { + data: { + persistentVolume: { + resourceId: myPersistentVolume.id + } + } + } + } +} +``` + +PersistentVolumes may be shared across multiple Containers. To mount an existing PersistentVolume in read-only mode, reference the PersistentVolume by name using the `existing` Bicep keyword. For example: +```bicep +resource existingPersistentVolume 'Radius.Compute/persistentVolumes@2025-08-01-preview' existing = { + name: 'existingPersistentVolume' +} +``` + +Then add the existing PersistentVolume to the volumes property of a Container with accessMode set to `ReadOnlyMany`. +```bicep +resource myContainer 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'myContainer' + properties: { + environment: environment + application: myApplication.id + containers: { + demo: { + image: 'ghcr.io/radius-project/samples/demo:latest' + volumeMounts: [ + { + volumeName: 'readOnlyData' + mountPath: '/app/data' + } + ] + } + } + volumes: { + readOnlyData: { + persistentVolume: { + resourceId: existingPersistentVolume.id + accessMode: 'ReadOnlyMany' + } + } + } + } +} +``` + +A PersistentVolume may be shared between multiple Containers in read/write mode if the PersistentVolume was created with `accessMode: ReadWriteMany` and the volume is set to ReadWriteMany as well. Note that not all infrastructures support this mode. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `allowedAccessModes` | string | false | false | (Optional) The access modes which are permitted to be requested by a Container. Assumed to be all modes if not specified.
Allowed values: `ReadOnlyMany`, `ReadWriteMany`, `ReadWriteOnce`. | +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `sizeInGib` | integer | true | false | (Required) The size of the volume in gibibytes. `1` represents 1024 MiB. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | diff --git a/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/routes/index.md b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/routes/index.md new file mode 100644 index 000000000..bd62278a1 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/routes/index.md @@ -0,0 +1,180 @@ +--- +type: docs +title: "Reference: radius.compute/routes@2025-08-01-preview" +linkTitle: "routes" +description: "Detailed reference documentation for radius.compute/routes@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Compute/routes Resource Type defines network routes for responding to external clients. Note that a Routes resource is not required for service-to-service communication. To use Routes, define a Container and ensure a `containerPort` is specified. +```bicep +extension radius +param environment string + +resource myApplication 'Radius.Core/applications@2025-08-01-preview' = { ... } + +resource myContainer 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'myContainer' + properties: { + environment: environment + application: myApplication.id + containers: { + frontend: { + image: 'frontend:1.25' + ports: { + web: { + containerPort: 8080 + } + } + } + accounts: { + image: 'accounts:1.25' + ports: { + web: { + containerPort: 8080 + } + } + } + } + } +} +``` + +Then define a Routes resource. +```bicep +resource ingressRule 'Radius.Compute/routes@2025-08-01-preview' = { + name: 'ingressRule' + properties: { + application: myApplication.id + environment: environment + kind: 'HTTP' + rules: [ + { + matches: [ + { + httpPath: '/' + } + ] + destinationContainer: { + resourceId: myContainer.id + containerName: 'frontend' + containerPort: myContainer.properties.containers.frontend.ports.web.containerPort + } + } + ] + } +} +``` + +The hostname is determined by the Recipe. + +Multiple rules can be included in Routes. +```bicep +resource ingressRule 'Radius.Compute/routes@2025-08-01-preview' = { + name: 'ingressRule' + properties: { + application: myApplication.id + environment: environment + kind: 'HTTP' + rules: [ + { + matches: [ + { + httpPath: '/' + } + ] + destinationContainer: { + resourceId: myContainer.id + containerName: 'frontend' + containerPort: myContainer.properties.containers.frontend.ports.web.containerPort + } + } + { + matches: [ + { + httpPath: '/accounts' + } + ] + destinationContainer: { + resourceId: myContainer.id + containerName: 'accounts' + containerPort: myContainer.properties.containers.accounts.ports.web.containerPort + } + } + ] + } +} +``` + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | true | false | (Required) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `hostnames` | string array | false | false | (Optional) Use only when kind is HTTP or TLS. When HTTP, match against the HTTP Host header. When using TLS, match against the SNI attribute of TLS ClientHello message. Hostname may be preceded by a * wildcard. | +| `kind` | string | false | false | (Optional) The type of rule. If not specified, `HTTPRoute` is assumed. `HTTPRoute` provides L7 ingress with support for matching based on the hostname and HTTP header. `TCPRoute` provides L4 ingress with no support for matching (all traffic is forwarded to the Container). `TLSRoute` provides L4 ingress with the ability to match based on Server Name Indication (SNI) which is equivalent to hostname in TLS. `UDPRoute` is similar to TCPRoutes but uses UDP.
Allowed values: `HTTP`, `TCP`, `TLS`, `UDP`. | +| `listener` | [object](#listener) | false | true | (Read Only) The Gateway Listener the route is assigned to. | +| `rules` | [object](#rules)[] | true | false | (Required) Rules define semantics for matching a network connection request based on conditions and forwarding the request to a Container. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | + +### `listener` {#listener} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `hostname` | string | false | false | | +| `port` | integer | false | false | | +| `protocol` | string | false | false | Allowed values: `HTTP`, `HTTPS`, `TCP`, `TLS`, `UDP`. | + +### `rules` {#rules} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `destinationContainer` | [object](#rules-destinationcontainer) | true | false | | +| `matches` | [object](#rules-matches)[] | true | false | (Required) Matches define conditions used for matching a request. | + +### `rules.destinationContainer` {#rules-destinationcontainer} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `containerName` | string | true | false | (Required) The specific container to target within the Container resource. | +| `containerPort` | integer | true | false | (Required) The port to target from the container. | +| `resourceId` | string | true | false | (Required) The Radius Container resource ID. | + +### `rules.matches` {#rules-matches} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `httpHeaders` | [object](#rules-matches-httpheaders)[] | false | false | (Optional) HTTP headers to match. Specify only when kind is HTTP. Multiple match values are ANDed together. A request must match all the specified headers to match. | +| `httpMethod` | string | false | false | (Optional) The HTTP method to match. Specify only when kind is HTTP.
Allowed values: `CONNECT`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT`, `TRACE`. | +| `httpPath` | string | false | false | (Optional) The HTTP request path to match. Trailing space is ignored. Requests for `/abc`, `/abc/`, and ``/abc/def/` will all match `/abc`. | +| `httpQueryParams` | [object](#rules-matches-httpqueryparams)[] | false | false | (Optional) HTTP query parameters to match. Specify only when kind is HTTP. | + +### `rules.matches.httpHeaders` {#rules-matches-httpheaders} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | (Required) The name of the HTTP Header to be matched. Must be exact. | +| `value` | string | true | false | (Required) Value of HTTP Header to be matched. | + +### `rules.matches.httpQueryParams` {#rules-matches-httpqueryparams} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | true | false | (Required) Name of the HTTP query parameter to be matched. Specify only when kind is HTTP. | +| `value` | string | true | false | (Required) Value of the HTTP query parameter to be matched. | diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md index ac0850131..0250799e0 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md @@ -9,125 +9,114 @@ description: "Detailed reference documentation for radius.core/applications@2025 ## Schema -### Top-Level Resource +## Description -#### Properties +The `Radius.Core/applications` Resource Type represents a Radius Application: a logical grouping of the resources that make up a single Application, such as containers, databases, and message queues, along with the connections between them. Radius uses the Application to build the application graph, apply shared configuration, and manage its resources together throughout their lifecycle. -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | -| **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** | [ApplicationProperties](#applicationproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Radius.Core/applications' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +## Defining an Application -### ApplicationProperties +An Application is always deployed to a Radius Environment, which is supplied through the `environment` property. To define an Application, add a `Radius.Core/applications` resource to your application definition Bicep file. -#### Properties +```bicep +extension radius -| Property | Type | Description | -|----------|------|-------------| -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string -### ResourceStatus +resource myApp 'Radius.Core/applications@2025-08-01-preview' = { + name: 'my-app' + properties: { + environment: environment + } +} +``` -#### Properties +## Deploying an Application -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | +An Application is deployed with the `rad deploy` command, which deploys the Application together with the resources that belong to it: -### EnvironmentCompute +```bash +rad deploy ./app.bicep +``` -* **Discriminator**: kind +## Adding resources to an Application -#### Base Properties +Resources are composed into an Application by setting their `application` property to the Application's ID. For example, to add a Container to this Application, add the following to the application definition Bicep file and set `application: myApp.id`: -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + environment: environment + application: myApp.id + containers: { + frontend: { + image: 'ghcr.io/my-org/frontend:latest' + } + } + } +} +``` -#### AzureContainerInstanceCompute +## Top-Level Properties -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `environment` | string | true | false | (Required) Fully qualified resource ID of the environment the application is deployed to | +| `provisioningState` | string | false | true | (Read Only) The status of the Application resource within the Radius control plane. Does not include the other resources that compose the Application.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `status` | [object](#status) | false | true | (Read Only) Deployment details for the Application, including any output resources Radius created for it. | -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | +## Object Properties -#### KubernetesCompute +### `status` {#status} -##### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `compute` | [object](#status-compute) | false | false | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | false | false | Properties of an output resource | +| `recipe` | [object](#status-recipe) | false | true | The recipe data at the time of deployment | -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | +### `status.compute` {#status-compute} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | Discriminator property that selects the variant. Allowed values: [`aci`](#status-compute-aci), [`kubernetes`](#status-compute-kubernetes). | +| `identity` | [object](#status-compute-identity) | false | false | Configuration for supported external identity providers | +| `resourceId` | string | false | false | The resource id of the compute resource for application environment. | -### IdentitySettings +### `status.outputResources` {#status-outputresources} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `id` | string | false | false | The UCP resource ID of the underlying resource. | +| `localId` | string | false | false | 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` | boolean | false | false | Determines whether Radius manages the lifecycle of the underlying resource. | -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | +### `status.recipe` {#status-recipe} -### OutputResource +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `templateKind` | string | true | false | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | true | false | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | false | false | TemplateVersion is the version number of the template. | -#### Properties +### `status.compute.identity` {#status-compute-identity} -| 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. | +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | -### RecipeStatus +### `status.compute.aci` {#status-compute-aci} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `resourceGroup` | string | false | false | The resource group to use for the environment. | -| 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' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `status.compute.kubernetes` {#status-compute-kubernetes} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | The namespace to use for the environment. | diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepsettings/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepsettings/index.md index becbd6314..47f7915b1 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepsettings/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepsettings/index.md @@ -9,86 +9,91 @@ description: "Detailed reference documentation for radius.core/bicepsettings@202 ## Schema -### Top-Level Resource +## Description -#### Properties +The `Radius.Core/bicepSettings` Resource Type holds reusable Bicep engine settings that Environments apply when running Bicep Recipes. Its primary use is authenticating to private Bicep registries: OCI registries, such as Azure Container Registry, that host the Recipe templates referenced by a Recipe Pack. -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-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** | [BicepSettingsProperties](#bicepsettingsproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Bicep configuration.
_(ReadOnly)_ | -| **registryAuthentications** | [Record](#record) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Radius.Core/bicepSettings' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +Platform engineers define a `Radius.Core/bicepSettings` resource once and reference it from any Environment whose Recipes pull templates from a private registry. -### BicepSettingsProperties +## Defining Bicep settings -#### Properties +Configure `registryAuthentications`, keyed by registry hostname. When a Recipe template is pulled from a matching host, Radius authenticates using the configured method. The example below uses basic authentication, reading the username and password from a secret: -| Property | Type | Description | -|----------|------|-------------| -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Bicep configuration.
_(ReadOnly)_ | -| **registryAuthentications** | [Record](#record) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path. | +```bicep +extension radius -### Record +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string -#### Properties +resource registrySecret 'Radius.Security/secrets@2025-08-01-preview' = { + name: 'registry-credentials' + properties: { + environment: environment + data: { + username: { value: 'my-username' } + password: { value: 'my-password' } + } + } +} -* **none** +resource bicepRegistry 'Radius.Core/bicepSettings@2025-08-01-preview' = { + name: 'private-registry' + properties: { + registryAuthentications: { + 'corp.azurecr.io': { + authenticationMethod: 'BasicAuth' + basicAuthSecretId: registrySecret.id + } + } + } +} +``` -#### Additional Properties +Basic authentication is supported via `BasicAuth` (username and password from a secret). `AwsIrsa` and `AzureWI` will be implemented in the future. -* **Additional Properties Type**: [BicepRegistryAuthentication](#bicepregistryauthentication) +## Deploying Bicep settings -### BicepRegistryAuthentication +Deploy the settings resource with the `rad deploy` command: -#### Properties +```bash +rad deploy ./bicep-settings.bicep +``` -| Property | Type | Description | -|----------|------|-------------| -| **authenticationMethod** | 'AwsIrsa' | 'AzureWI' | 'BasicAuth' | The authentication method to use. Supported values: BasicAuth, AzureWI, AwsIrsa. | -| **awsIamRoleArn** | string | AWS IAM Role ARN for IRSA authentication. Required when authenticationMethod is 'AwsIrsa'. | -| **azureWiClientId** | string | Azure Workload Identity client ID. Required when authenticationMethod is 'AzureWI'. | -| **azureWiTenantId** | string | Azure Workload Identity tenant ID. Required when authenticationMethod is 'AzureWI'. | -| **basicAuthSecretId** | string | The ID of a secret resource containing username and password for BasicAuth. Supported types: Radius.Security/secrets (recommended) or Applications.Core/secretStores. Required when authenticationMethod is 'BasicAuth'. | +## Referencing Bicep settings from an Environment -### Record +Reference the settings from an Environment by setting its `bicepSettings` property to the resource ID. Every Bicep Recipe run in that Environment then uses the configured registry authentication: -#### Properties +```bicep +extension radius -* **none** +resource bicepRegistry 'Radius.Core/bicepSettings@2025-08-01-preview' existing = { + name: 'private-registry' +} -#### Additional Properties +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + bicepSettings: bicepRegistry.id + } +} +``` -* **Additional Properties Type**: [BicepRegistryAuthentication](#bicepregistryauthentication) +## Top-Level Properties -### SystemData +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `provisioningState` | string | false | true | (Read Only) The status of the Bicep settings resource within the Radius control plane.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `referencedBy` | string array | false | true | (Read Only) Resource IDs of the Environments that reference this Bicep settings resource. | +| `registryAuthentications` | [object](#registryauthentications) | false | false | (Optional) Authentication for private Bicep registries that host Recipe templates, keyed by registry hostname such as `corp.acr.io`. Radius matches a registry by the hostname in the Recipe source. | -#### Properties +## Object Properties -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `registryAuthentications` {#registryauthentications} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `authenticationMethod` | string | false | false | (Optional) How Radius authenticates to the registry.
Allowed values: `AwsIrsa`, `AzureWI`, `BasicAuth`. | +| `awsIamRoleArn` | string | false | false | (Optional) AWS IAM Role ARN for IRSA authentication. Required when `authenticationMethod` is `AwsIrsa`. | +| `azureWiClientId` | string | false | false | (Optional) Azure Workload Identity client ID. Required when `authenticationMethod` is `AzureWI`. | +| `azureWiTenantId` | string | false | false | (Optional) Azure Workload Identity tenant ID. Required when `authenticationMethod` is `AzureWI`. | +| `basicAuthSecretId` | string | false | false | (Optional) The ID of a `Radius.Security/secrets` resource containing the username and password. Required when `authenticationMethod` is `BasicAuth`. | diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md index 5056899ea..6bc21c630 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md @@ -9,150 +9,156 @@ description: "Detailed reference documentation for radius.core/environments@2025 ## Schema -### Top-Level Resource +## Description -#### Properties +The `Radius.Core/environments` Resource Type represents a Radius Environment: the deployment target that platform engineers configure for their developers. Every Radius Application is deployed to an Environment through its `environment` property. -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **bicepSettings** | string | Resource ID of a Radius.Core/bicepSettings resource providing Bicep recipe settings.
_(ReadOnly)_ | -| **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** | [EnvironmentProperties](#environmentproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **providers** | [Providers](#providers) | Cloud provider configuration for the environment.
_(ReadOnly)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipePacks** | string[] | List of Recipe Pack resource IDs linked to this environment.
_(ReadOnly)_ | -| **recipeParameters** | [Record](#record) | Recipe specific parameters that apply to all resources of a given type in this environment.
_(ReadOnly)_ | -| **simulated** | bool | Simulated environment.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **terraformSettings** | string | Resource ID of a Radius.Core/terraformSettings resource providing Terraform recipe settings.
_(ReadOnly)_ | -| **type** | 'Radius.Core/environments' | The resource type
_(ReadOnly, DeployTimeConstant)_ | +An Environment defines three things for the Applications deployed to it: -### EnvironmentProperties +- **Where resources are deployed**: the target compute platform and cloud provider accounts, set through the `providers` property. +- **Which Recipes are used**: the Recipe Packs whose Recipes provision the infrastructure backing application resources, set through the `recipePacks` property. +- **Advanced Terraform and Bicep settings**: environment-wide Recipe parameters and Terraform or Bicep engine configuration applied when Recipes run. -#### Properties +## Defining an Environment -| Property | Type | Description | -|----------|------|-------------| -| **bicepSettings** | string | Resource ID of a Radius.Core/bicepSettings resource providing Bicep recipe settings. | -| **providers** | [Providers](#providers) | Cloud provider configuration for the environment. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipePacks** | string[] | List of Recipe Pack resource IDs linked to this environment. | -| **recipeParameters** | [Record](#record) | Recipe specific parameters that apply to all resources of a given type in this environment. | -| **simulated** | bool | Simulated environment. | -| **terraformSettings** | string | Resource ID of a Radius.Core/terraformSettings resource providing Terraform recipe settings. | +The simplest Environment can be created directly with the `rad environment create` command, without a Bicep file: -### Providers +```bash +rad environment create my-environment +``` -#### Properties +For more advanced configurations, define an Environment as a `Radius.Core/environments` resource in a Bicep file. For example: -| Property | Type | Description | -|----------|------|-------------| -| **aws** | [ProvidersAws](#providersaws) | The AWS cloud provider configuration. | -| **azure** | [ProvidersAzure](#providersazure) | The Azure cloud provider configuration. | -| **kubernetes** | [ProvidersKubernetes](#providerskubernetes) | The Kubernetes provider configuration. | +```bicep +extension radius -### ProvidersAws +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + recipePacks: [ + myRecipePack.id + ] + providers: { + kubernetes: { + namespace: 'my-namespace' + } + } + } +} -#### Properties +resource myRecipePack 'Radius.Core/recipePacks@2025-08-01-preview' existing = { + name: 'my-recipe-pack' +} +``` -| Property | Type | Description | -|----------|------|-------------| -| **accountId** | string | AWS account ID for AWS resources to be deployed into.
_(Required)_ | -| **region** | string | AWS region for AWS resources to be deployed into.
_(Required)_ | +Both properties are optional. When you create an Environment with the Radius CLI, an omitted `providers` defaults to Kubernetes in the `default` namespace, and an omitted `recipePacks` defaults to the `default` Recipe Pack in the `default` resource group. -### ProvidersAzure +## Deploying an Environment -#### Properties +Deploy a defined Environment with the `rad deploy` command: -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | External identity settings (moved from compute). | -| **resourceGroupName** | string | Optional resource group name. | -| **subscriptionId** | string | Azure subscription ID hosting deployed resources.
_(Required)_ | +```bash +rad deploy ./environment.bicep +``` -### IdentitySettings +## Cloud providers -#### Properties +To use Recipes that provision resources in a cloud provider, you must configure that provider's account details on the Environment by setting the `providers` property. For AWS, set the account ID and the region resources are deployed to: -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **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 | +```bicep +extension radius -### ProvidersKubernetes +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + providers: { + aws: { + accountId: '123456789012' + region: 'us-west-2' + } + } + } +} +``` -#### Properties +For Azure, set the subscription ID and the name of the resource group that resources are deployed to: -| Property | Type | Description | -|----------|------|-------------| -| **namespace** | string | Kubernetes namespace to deploy workloads into.
_(Required)_ | +```bicep +extension radius -### Record +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + providers: { + azure: { + subscriptionId: '00000000-0000-0000-0000-000000000000' + resourceGroupName: 'my-resource-group' + } + } + } +} +``` -#### Properties +The `providers` property selects the target account, but the credentials Radius uses to authenticate to AWS and Azure are configured separately with the `rad credential register` command. -* **none** +## Recipe Packs -#### Additional Properties +A Recipe Pack is a collection of Recipes, defined as a separate `Radius.Core/recipePacks` resource. A Recipe is an infrastructure-as-code module, a Terraform module or Bicep template, that provisions the infrastructure backing an application resource. Reference one or more Recipe Packs by their resource IDs in the `recipePacks` property to control which Recipes are used. See the `Radius.Core/recipePacks` documentation for details. -* **Additional Properties Type**: [RecipeParameterValue](#recipeparametervalue) +Use `recipeParameters` to pass environment-specific parameters to the Recipes defined in the referenced Recipe Packs, for example to standardize configuration such as SKUs or instance sizes across an Environment. -### RecipeParameterValue +## Advanced Terraform and Bicep settings -#### Properties +For advanced Terraform and Bicep settings, such as private module sources and registry authentication, reference a `Radius.Core/terraformSettings` or `Radius.Core/bicepSettings` resource from the `terraformSettings` and `bicepSettings` properties. -* **none** +## Top-Level Properties -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `bicepSettings` | string | false | false | (Optional) Resource ID of a `Radius.Core/bicepSettings` resource that supplies Bicep engine settings, such as private registry authentication, used when running Bicep Recipes in this Environment. | +| `providers` | [object](#providers) | false | false | (Optional) Target compute platform and cloud provider accounts that resources are deployed into. When created with the Radius CLI, defaults to Kubernetes in the `default` namespace. | +| `provisioningState` | string | false | true | (Read Only) The status of the Environment resource within the Radius control plane. Does not include the resources deployed to the Environment.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipePacks` | string array | false | false | (Optional) Resource IDs of the Recipe Packs this Environment uses to provision infrastructure for application resources. When created with the Radius CLI, defaults to the `default` Recipe Pack in the `default` resource group. | +| `recipeParameters` | object | false | false | (Optional) Parameters passed to Recipes when they run, keyed by resource type. Values here override the default parameters defined in the Recipe Pack for every resource of that type deployed to this Environment. | +| `simulated` | boolean | false | false | (Optional) When true, the Environment is simulated and does not deploy real infrastructure. Recipes are evaluated but no resources are provisioned, which is useful for validating application definitions. Defaults to `false` if not specified. | +| `terraformSettings` | string | false | false | (Optional) Resource ID of a `Radius.Core/terraformSettings` resource that supplies Terraform CLI settings, such as private registry credentials, used when running Terraform Recipes in this Environment. | -* **Additional Properties Type**: any +## Object Properties -### Record +### `providers` {#providers} -#### Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `aws` | [object](#providers-aws) | false | false | (Optional) Configuration for deploying resources to AWS. | +| `azure` | [object](#providers-azure) | false | false | (Optional) Configuration for deploying resources to Azure. | +| `kubernetes` | [object](#providers-kubernetes) | false | false | (Optional) Configuration for deploying resources to Kubernetes. | + +### `providers.aws` {#providers-aws} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `accountId` | string | true | false | (Required) ID of the AWS account that resources are deployed into. | +| `region` | string | true | false | (Required) AWS region that resources are deployed into. | -* **none** +### `providers.azure` {#providers-azure} -#### Additional Properties +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `identity` | [object](#providers-azure-identity) | false | false | (Optional) Managed or workload identity Radius uses to authenticate to Azure when deploying resources. | +| `resourceGroupName` | string | false | false | (Optional) Name of the Azure resource group that resources are deployed into. Most Bicep and Terraform Recipes expect a resource group in the deployment context, so set this whenever deploying Azure resources. | +| `subscriptionId` | string | true | false | (Required) ID of the Azure subscription that resources are deployed into. | -* **Additional Properties Type**: [RecipeParameterValue](#recipeparametervalue) +### `providers.kubernetes` {#providers-kubernetes} -### RecipeParameterValue +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `namespace` | string | true | false | (Required) Kubernetes namespace that workloads are deployed into. | -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +### `providers.azure.identity` {#providers-azure-identity} +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | false | false | The list of user assigned managed identities | +| `oidcIssuer` | string | false | false | The URI for your compute platform's OIDC issuer | +| `resource` | string | false | false | The resource ID of the provisioned identity | diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md index c32badd05..cc56f63e4 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md @@ -9,106 +9,111 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- ## Schema -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-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** | [RecipePackProperties](#recipepackproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation
_(ReadOnly)_ | -| **recipes** | [Record](#record) | Map of resource types to their recipe configurations
_(ReadOnly)_ | -| **referencedBy** | string[] | List of environment IDs that reference this recipe pack
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Radius.Core/recipePacks' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### RecipePackProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation
_(ReadOnly)_ | -| **recipes** | [Record](#record) | Map of resource types to their recipe configurations
_(Required)_ | -| **referencedBy** | string[] | List of environment IDs that reference this recipe pack
_(ReadOnly)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeDefinition](#recipedefinition) - -### RecipeDefinition - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'bicep' | 'terraform' | The type of recipe (e.g., Terraform, Bicep)
_(Required)_ | -| **outputs** | [Record](#record) | Map of resource type property names to module output names. Used for recipes that point directly at a Bicep or Terraform module to map the module's outputs onto the resource's properties. | -| **parameters** | [Record](#record) | Parameters to pass to the recipe | -| **plainHttp** | bool | Connect to the source using HTTP (not HTTPS). This should be used when the source is known not to support HTTPS, for example in a locally hosted registry for Bicep recipes. Defaults to false (use HTTPS/TLS) | -| **source** | string | The source of the recipe. For Bicep recipes this is the OCI registry reference. For Terraform recipes this is the module source.
_(Required)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeDefinition](#recipedefinition) - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +## Description +The `Radius.Core/recipePacks` Resource Type represents a Recipe Pack: a named collection of Recipes that platform engineers assign to an Environment. A Recipe maps a resource type (such as `Radius.Data/redisCaches`) to an infrastructure-as-code module, a Terraform module or Bicep template, that provisions the infrastructure backing that resource when a developer deploys it. + +A Recipe Pack is defined as its own resource and referenced from an Environment's `recipePacks` property, so one Recipe Pack can be shared across many Environments. + +## Defining a Recipe Pack + +Each entry in the `recipes` map is keyed by resource type. Set the recipe `kind` (`bicep` or `terraform`) and its `source` (an OCI registry reference for Bicep recipes, or a module source for Terraform recipes). + +```bicep +extension radius + +resource dataRecipes 'Radius.Core/recipePacks@2025-08-01-preview' = { + name: 'data-recipes' + properties: { + recipes: { + 'Radius.Data/redisCaches': { + kind: 'bicep' + source: 'ghcr.io/my-org/recipes/redis:latest' + } + 'Radius.Data/postgreSqlDatabases': { + kind: 'terraform' + source: 'git::https://github.com/my-org/recipes//postgresql' + } + } + } +} +``` + +## Recipe parameters + +Each Recipe can declare default `parameters` that are passed to its module. Platform engineers set baseline values here, and developers get them automatically. An Environment can override these values per resource type through its `recipeParameters` property. + +```bicep +resource dataRecipes 'Radius.Core/recipePacks@2025-08-01-preview' = { + name: 'data-recipes' + properties: { + recipes: { + 'Radius.Data/redisCaches': { + kind: 'bicep' + source: 'ghcr.io/my-org/recipes/redis:latest' + parameters: { + sku: 'Standard' + capacity: 1 + } + } + } + } +} +``` + +## Deploying a Recipe Pack + +Deploy the Bicep file with `rad deploy` to create the Recipe Pack resource. Once deployed, list and inspect Recipe Packs with the `rad recipe-pack list` and `rad recipe-pack show` commands. + +## Referencing a Recipe Pack from an Environment + +An Environment references a Recipe Pack through its `recipePacks` property. When the Recipe Pack and the Environment are deployed to the same resource group, declare it as an `existing` resource and reference its `.id`: + +```bicep +extension radius + +resource dataRecipes 'Radius.Core/recipePacks@2025-08-01-preview' existing = { + name: 'data-recipes' +} + +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + recipePacks: [ + dataRecipes.id + ] + } +} +``` + +To reference a Recipe Pack in a different resource group, use its full resource ID instead: + +```bicep +recipePacks: [ + '/planes/radius/local/resourceGroups/shared/providers/Radius.Core/recipePacks/data-recipes' +] +``` + +Radius is installed with a `default` Recipe Pack in the `default` resource group. When you create an Environment with the Radius CLI and do not set `recipePacks`, the Environment uses this `default` Recipe Pack. + +Prebuilt Recipe Packs and the Recipes they reference are published in the [resource-types-contrib](https://github.com/radius-project/resource-types-contrib) repository. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `provisioningState` | string | false | true | (Read Only) The status of the Recipe Pack resource within the Radius control plane.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipes` | [object](#recipes) | true | false | (Required) The Recipes in this pack, keyed by the resource type each Recipe provisions. Each key is a resource type such as `Radius.Data/redisCaches`. | +| `referencedBy` | string array | false | true | (Read Only) Resource IDs of the Environments that reference this Recipe Pack. | + +## Object Properties + +### `recipes` {#recipes} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `kind` | string | true | false | (Required) The kind of Recipe, which determines how Radius runs it.
Allowed values: `bicep`, `terraform`. | +| `outputs` | object | false | false | (Optional) Maps the module outputs onto the resource type properties for recipes that point directly at a Bicep or Terraform module. Each value is the module output name for a non-secret property. Under the reserved `secrets` key a nested object maps secret property names to module output names and always routes those outputs to the resource secret outputs. | +| `parameters` | object | false | false | (Optional) Default parameter values passed to the Recipe when it runs. An Environment can override these per resource type through its `recipeParameters` property. | +| `plainHttp` | boolean | false | false | (Optional) Connect to the source using HTTP instead of HTTPS. Use this only when the source does not support HTTPS such as a locally hosted registry for Bicep recipes. Defaults to `false` if not specified. | +| `source` | string | true | false | (Required) Location of the Recipe. For Bicep Recipes this is an OCI registry reference. For Terraform Recipes this is the module source such as a Git URL or a Terraform registry module. | diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformsettings/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformsettings/index.md index 8e180e31c..6babf5a45 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformsettings/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformsettings/index.md @@ -9,131 +9,156 @@ description: "Detailed reference documentation for radius.core/terraformsettings ## Schema -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **env** | [Record](#record) | Environment variables injected during Terraform recipe execution.
_(ReadOnly)_ | -| **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** | [TerraformSettingsProperties](#terraformsettingsproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Terraform configuration.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file settings. Maps directly to the Terraform CLI configuration file (.terraformrc).
_(ReadOnly)_ | -| **type** | 'Radius.Core/terraformSettings' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### TerraformSettingsProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **env** | [Record](#record) | Environment variables injected during Terraform recipe execution. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Terraform configuration.
_(ReadOnly)_ | -| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file settings. Maps directly to the Terraform CLI configuration file (.terraformrc). | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### TerraformrcConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **credentials** | [Record](#record) | Credentials for authenticating to private Terraform registries (HTTP-based, e.g. app.terraform.io). Map of registry hostname to credential configuration. Rendered as native `credentials "hostname" {}` blocks in the generated .terraformrc. Note: this is for Terraform CLI registry auth (HTTP), not for Git-based module sources; Git auth is a separate mechanism. | -| **providerInstallation** | [TerraformProviderInstallation](#terraformproviderinstallation) | Provider installation configuration. Specifies the location of providers via network mirrors or direct downloads. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [TerraformCredentialConfig](#terraformcredentialconfig) - -### TerraformCredentialConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secret** | string | The ID of a secret resource containing the authentication token. Supported types: Radius.Security/secrets (recommended) or Applications.Core/secretStores. The secret must have a key named 'token'. | - -### TerraformProviderInstallation - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **direct** | [TerraformProviderDirect](#terraformproviderdirect) | Direct provider installation configuration. | -| **networkMirror** | [TerraformProviderMirror](#terraformprovidermirror) | Network mirror configuration for downloading providers. | - -### TerraformProviderDirect - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **exclude** | string[] | Provider address patterns to exclude from direct installation. | -| **include** | string[] | Provider address patterns to include for direct installation. | - -### TerraformProviderMirror - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **exclude** | string[] | Provider address patterns to exclude from this mirror. | -| **include** | string[] | Provider address patterns to include from this mirror. | -| **url** | string | The URL of the provider mirror. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string +## Description + +The `Radius.Core/terraformSettings` Resource Type holds reusable Terraform CLI settings that Environments apply when running Terraform Recipes. Its primary use is authenticating to private Terraform registries that host the modules referenced by a Recipe Pack, along with configuring provider installation and injecting environment variables during Recipe execution. + +Platform engineers define a `Radius.Core/terraformSettings` resource once and reference it from any Environment whose Recipes pull modules from a private registry. + +## Defining Terraform settings + +Configure `terraformrc.credentials`, keyed by registry hostname, to authenticate to a private Terraform registry. Each entry points to a secret whose `token` key holds the registry token: + +```bicep +extension radius + +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string + +resource registrySecret 'Radius.Security/secrets@2025-08-01-preview' = { + name: 'terraform-registry-token' + properties: { + environment: environment + data: { + token: { value: 'my-registry-token' } + } + } +} + +resource terraformRegistry 'Radius.Core/terraformSettings@2025-08-01-preview' = { + name: 'private-registry' + properties: { + terraformrc: { + credentials: { + 'app.terraform.io': { + secret: registrySecret.id + } + } + } + } +} +``` + +Two other settings are available: provider installation and environment variables. + +### Provider installation + +In air-gapped or internal environments, use `terraformrc.providerInstallation` to install providers from a network mirror instead of the public registry. Set the mirror `url`, optionally narrow it with `include` or `exclude` provider address patterns, and use `direct` to control which providers are still downloaded directly: + +```bicep +resource providerMirror 'Radius.Core/terraformSettings@2025-08-01-preview' = { + name: 'internal-mirror' + properties: { + terraformrc: { + providerInstallation: { + networkMirror: { + url: 'https://terraform.corp.example.com/providers/' + include: ['*'] + } + direct: { + exclude: ['*'] + } + } + } + } +} +``` + +### Environment variables + +Use `env` to inject environment variables into every Terraform Recipe run, for example to raise the Terraform log level for troubleshooting or to tune CLI behavior: + +```bicep +resource terraformLogging 'Radius.Core/terraformSettings@2025-08-01-preview' = { + name: 'terraform-logging' + properties: { + env: { + TF_LOG: 'TRACE' + TF_REGISTRY_CLIENT_TIMEOUT: '15' + } + } +} +``` + +## Deploying Terraform settings + +Deploy the settings resource with the `rad deploy` command: + +```bash +rad deploy ./terraform-settings.bicep +``` + +## Referencing Terraform settings from an Environment + +Reference the settings from an Environment by setting its `terraformSettings` property to the resource ID. Every Terraform Recipe run in that Environment then uses the configured registry credentials: + +```bicep +extension radius + +resource terraformRegistry 'Radius.Core/terraformSettings@2025-08-01-preview' existing = { + name: 'private-registry' +} + +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + terraformSettings: terraformRegistry.id + } +} +``` + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `env` | object | false | false | (Optional) Environment variables injected into the Terraform process during Recipe execution. | +| `provisioningState` | string | false | true | (Read Only) The status of the Terraform settings resource within the Radius control plane.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `referencedBy` | string array | false | true | (Read Only) Resource IDs of the Environments that reference this Terraform settings resource. | +| `terraformrc` | [object](#terraformrc) | false | false | (Optional) Settings for the Terraform CLI configuration file. Radius renders these into a `.terraformrc` file used when running Terraform Recipes. | + +## Object Properties + +### `terraformrc` {#terraformrc} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `credentials` | [object](#terraformrc-credentials) | false | false | (Optional) Credentials for authenticating to private Terraform registries such as `app.terraform.io`. Maps a registry hostname to its credential configuration. This authenticates to Terraform CLI registries over HTTP and does not authenticate Git-based module sources, which use a separate mechanism. | +| `providerInstallation` | [object](#terraformrc-providerinstallation) | false | false | (Optional) Controls where Terraform installs providers from, such as a network mirror instead of the public registry. | + +### `terraformrc.credentials` {#terraformrc-credentials} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `secret` | string | false | false | (Optional) The ID of a `Radius.Security/secrets` resource containing the authentication token. The secret must have a key named `token`. | + +### `terraformrc.providerInstallation` {#terraformrc-providerinstallation} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `direct` | [object](#terraformrc-providerinstallation-direct) | false | false | (Optional) Providers to install directly from the public registry rather than a mirror. | +| `networkMirror` | [object](#terraformrc-providerinstallation-networkmirror) | false | false | (Optional) A network mirror to install providers from instead of the public registry. | +### `terraformrc.providerInstallation.direct` {#terraformrc-providerinstallation-direct} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `exclude` | string array | false | false | (Optional) Provider address patterns to exclude from direct installation. | +| `include` | string array | false | false | (Optional) Provider address patterns to include for direct installation. | + +### `terraformrc.providerInstallation.networkMirror` {#terraformrc-providerinstallation-networkmirror} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `exclude` | string array | false | false | (Optional) Provider address patterns to exclude from this mirror. | +| `include` | string array | false | false | (Optional) Provider address patterns to include from this mirror. | +| `url` | string | false | false | (Optional) The URL of the provider mirror. | diff --git a/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/mongodatabases/index.md b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/mongodatabases/index.md new file mode 100644 index 000000000..4a51d0557 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/mongodatabases/index.md @@ -0,0 +1,95 @@ +--- +type: docs +title: "Reference: radius.data/mongodatabases@2025-08-01-preview" +linkTitle: "mongodatabases" +description: "Detailed reference documentation for radius.data/mongodatabases@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Data/mongoDatabases Resource Type deploys a Mongo-compatible +database. To deploy a Mongo database, add a mongoDatabases resource to the +application definition Bicep file. The Azure recipe uses Cosmos DB for +MongoDB and exposes its endpoint and connection string as resource +properties. +```bicep +resource database 'Radius.Data/mongoDatabases@2025-08-01-preview' = { + name: 'mongo' + properties: { + environment: environment + application: myApplication.id + database: 'mongo_db' + } +} +``` + +To connect your container to the database, create a connection from the +Container resource to the database as shown below. +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + application: myApplication.id + environment: environment + container: { + image: 'frontend:1.25' + } + connections: { + mongo: { + source: database.id + } + } + } +} +``` + +The connection automatically injects environment variables into the +container for all properties from the database. The environment variables +are named `CONNECTION__`. In this example +the connection name is `mongo` so the environment variables will be: + +- CONNECTION_MONGO_DATABASE +- CONNECTION_MONGO_ENDPOINT + +The `connectionString` secret is NOT injected via the connection — it is +materialized into a managed `Radius.Security/secrets` resource. Bind it into +a container env var with a `secretKeyRef`, using `mongo.properties.secrets.name` +as the `secretName` and key `connectionString` (see the `secrets` property). + +Portability note: this schema is platform-neutral so the same resource +type works with Azure AVM, AWS Terraform modules, and Kubernetes recipes. +Only the recipePack source plus parameters/outputs mapping change per +platform; the developer-facing database knob and read-only connection +surface stay identical. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `database` | string | false | false | (Optional) The Mongo database name. Defaults to `mongo_db` if not provided. | +| `endpoint` | string | false | true | The endpoint used to connect to the database. Mapped from the recipe module's output. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `secrets` | [object](#secrets) | false | false | (Read-only) Recipe secrets. The reserved `name` sub-property references the managed Radius.Security/secrets resource Radius materializes from the recipe's `outputs.secrets`; the other sub-properties declare secret keys whose values are written only into that managed secret (never onto this resource). Consumers bind a key into a container env var via `secretKeyRef`, using `.properties.secrets.name` as `secretName`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | + +### `secrets` {#secrets} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `connectionString` | string | false | true | The connection string used to connect to the database. Mapped from the recipe module's output; delivered via the managed secret. | +| `name` | string | false | true | (Reserved) Name of the managed Radius.Security/secrets resource. Use as `secretName` in a container `secretKeyRef`. | diff --git a/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/mysqldatabases/index.md b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/mysqldatabases/index.md new file mode 100644 index 000000000..38b599ccc --- /dev/null +++ b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/mysqldatabases/index.md @@ -0,0 +1,86 @@ +--- +type: docs +title: "Reference: radius.data/mysqldatabases@2025-08-01-preview" +linkTitle: "mysqldatabases" +description: "Detailed reference documentation for radius.data/mysqldatabases@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Data/mySqlDatabases Resource Type deploys a MySQL database. Provide the administrator `username` and `password` directly on the resource. The `password` property is marked `x-radius-sensitive`, so Radius encrypts it at rest, redacts it on reads, and exposes it (decrypted) only to the platform-engineer recipe that provisions the database. +```bicep +resource mysql 'Radius.Data/mySqlDatabases@2025-08-01-preview' = { + name: 'mysql' + properties: { + environment: environment + application: myApplication.id + version: '8.0' + database: 'appdb' + username: 'myadmin' + // From a @secure() password parameter passed in via the CLI + password: password + } +} +``` + +When deploying the application definition, provide the database password value as a parameter. It is recommended to use a password generator such as `openssl` or equivalent. For example, `rad deploy app.bicep -p ****** rand -hex 16)`. + +To connect your container to the database, create a connection from the Container resource to the database as shown below. +```bicep +resource myApplication 'Radius.Core/Applications@2025-08-01-preview' = { ... } + +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + application: myApplication.id + environment: environment + container: { + image: 'frontend:1.25' + ports: { + web: { + containerPort: 8080 + } + } + } + connections: { + mysqldb: { + source: database.id + } + } + } +} +``` + +The connection automatically injects environment variables into the container for all properties from the database. The environment variables are named `CONNECTION__`. In this example, the connection name is `mysqldb` so the environment variables will be: + +- CONNECTION_MYSQLDB_DATABASE +- CONNECTION_MYSQLDB_HOST +- CONNECTION_MYSQLDB_PORT + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `database` | string | false | false | (Optional) The name of the database. Defaults to `mysql_db` if not provided. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `host` | string | false | true | The host name used to connect to the database. Mapped from the recipe module's output. | +| `password` | string | true | false | (Required) The administrator password for the MySQL database. Marked `x-radius-sensitive`: Radius encrypts it at rest, redacts it on reads, and exposes it decrypted only to the recipe as `{{context.resource.properties.password}}`. | +| `port` | integer | false | true | The port number used to connect to the database. Mapped from the recipe module's output (MySQL flexible server uses 3306). | +| `username` | string | true | false | (Required) The administrator username for the MySQL database. Provided directly on the resource and passed to the recipe as `{{context.resource.properties.username}}`. | +| `version` | string | false | false | (Optional) The major MySQL server version in the X.Y format. Defaults to `8.4` if not provided.
Allowed values: `5.7`, `8.0`, `8.4`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | diff --git a/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/postgresqldatabases/index.md b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/postgresqldatabases/index.md new file mode 100644 index 000000000..72d231a42 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/postgresqldatabases/index.md @@ -0,0 +1,87 @@ +--- +type: docs +title: "Reference: radius.data/postgresqldatabases@2025-08-01-preview" +linkTitle: "postgresqldatabases" +description: "Detailed reference documentation for radius.data/postgresqldatabases@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Data/postgreSqlDatabases Resource Type deploys a PostgreSQL database. Provide the administrator `username` and `password` directly on the resource. The `password` property is marked `x-radius-sensitive`, so Radius encrypts it at rest, redacts it on reads, and exposes it (decrypted) only to the recipe that provisions the database. +```bicep +resource postgresql 'Radius.Data/postgreSqlDatabases@2025-08-01-preview' = { + name: 'postgresql' + properties: { + environment: environment + application: myApplication.id + size: 'S' + database: 'appdb' + username: 'myadmin' + // From a @secure() password parameter passed in via the CLI + password: password + } + } +``` + +When deploying the application definition, provide the database password value as a parameter. It is recommended to use a password generator such as `openssl` or equivalent. For example, `rad deploy app.bicep -p password=$(openssl rand -hex 16)`. + +To connect your container to the database, create a connection from the Container resource to the database as shown below. +```bicep +resource myApplication 'Radius.Core/Applications@2025-08-01-preview' = { ... } + +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + application: myApplication.id + environment: environment + container: { + image: 'frontend:1.25' + ports: { + web: { + containerPort: 8080 + } + } + } + connections: { + postgresql: { + source: postgresql.id + } + } + } +} +``` + +The connection automatically injects environment variables into the container for all properties from the database. The environment variables are named `CONNECTION__`. In this example, the connection name is `postgresql` so the environment variables will be: + +- CONNECTION_POSTGRESQL_DATABASE +- CONNECTION_POSTGRESQL_HOST +- CONNECTION_POSTGRESQL_PORT + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `database` | string | false | false | (Optional) The name of the database. Defaults to `postgres_db` if not provided. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `host` | string | false | true | The host name used to connect to the database. | +| `initSql` | string | false | false | (Optional) SQL script mounted into the PostgreSQL container's `/docker-entrypoint-initdb.d/` directory and executed whenever PGDATA is empty. With the default ephemeral storage this runs on every pod restart. If a PersistentVolumeClaim is used, the script runs only on the very first startup and subsequent changes to initSql are ignored on existing volumes. Limited to ~1 MiB. Useful for creating tables, indexes, and inserting seed data. | +| `password` | string | true | false | (Required) The administrator password for the PostgreSQL database. Marked `x-radius-sensitive`: Radius encrypts it at rest, redacts it on reads, and exposes it decrypted only to the recipe as `{{context.resource.properties.password}}`. | +| `port` | string | false | true | The port number used to connect to the database. | +| `size` | string | false | false | (Optional) The size of the PostgreSQL database. Defaults to `S` if not provided.
Allowed values: `L`, `M`, `S`. | +| `username` | string | true | false | (Required) The administrator username for the PostgreSQL database. Provided directly on the resource and passed to the recipe as `{{context.resource.properties.username}}`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | diff --git a/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/rediscaches/index.md b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/rediscaches/index.md new file mode 100644 index 000000000..7b56c9f31 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/rediscaches/index.md @@ -0,0 +1,92 @@ +--- +type: docs +title: "Reference: radius.data/rediscaches@2025-08-01-preview" +linkTitle: "rediscaches" +description: "Detailed reference documentation for radius.data/rediscaches@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Data/redisCaches Resource Type deploys a Redis cache. To deploy a +Redis cache, add a redisCaches resource to the application definition Bicep +file. Unlike database types, no secret is required: Azure Managed Redis +generates its own access keys, so the platform-engineer recipe needs no +injected credentials. +```bicep +resource cache 'Radius.Data/redisCaches@2025-08-01-preview' = { + name: 'redis' + properties: { + environment: environment + application: myApplication.id + size: 'S' + } +} +``` + +To connect your container to the cache, create a connection from the +Container resource to the cache as shown below. +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + application: myApplication.id + environment: environment + containers: { + frontend: { + image: 'frontend:1.25' + } + } + connections: { + redis: { + source: cache.id + } + } + } +} +``` + +The connection automatically injects environment variables into the +container for all properties from the cache. The environment variables are +named `CONNECTION__`. In this example the +connection name is `redis` so the environment variables will be: + +- CONNECTION_REDIS_HOST +- CONNECTION_REDIS_PORT + +The `url` secret is NOT injected via the connection — it is materialized into +a managed `Radius.Security/secrets` resource. Bind it into a container env var +with a `secretKeyRef`, using `redis.properties.secrets.name` as the `secretName` +and key `url` (see the `secrets` property). + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `host` | string | false | true | (Read Only) The host name used to connect to the cache. Mapped from the recipe module's output. | +| `port` | integer | false | true | (Read Only) The TLS port number used to connect to the cache. Mapped from the recipe module's `port` output (Azure Managed Redis uses 10000). | +| `secrets` | [object](#secrets) | false | false | (Read-only) Recipe secrets. The reserved `name` sub-property references the managed Radius.Security/secrets resource Radius materializes from the recipe's `outputs.secrets`; the other sub-properties declare secret keys whose values are written only into that managed secret (never onto this resource). Consumers bind a key into a container env var via `secretKeyRef`, using `.properties.secrets.name` as `secretName`. | +| `size` | string | false | false | (Optional) The size of the Redis cache. Defaults to `S` if not provided. The recipe maps the size onto a concrete cloud SKU.
Allowed values: `L`, `M`, `S`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | + +### `secrets` {#secrets} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `name` | string | false | true | (Reserved) Name of the managed Radius.Security/secrets resource. Use as `secretName` in a container `secretKeyRef`. | +| `url` | string | false | true | (Read Only) The full TLS connection URL (`rediss://:@:`) used to connect to the cache, including the access key. Mapped from the recipe module's `primaryConnectionString` output; delivered via the managed secret. | diff --git a/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/sqlserverdatabases/index.md b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/sqlserverdatabases/index.md new file mode 100644 index 000000000..7488c665f --- /dev/null +++ b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/sqlserverdatabases/index.md @@ -0,0 +1,90 @@ +--- +type: docs +title: "Reference: radius.data/sqlserverdatabases@2025-08-01-preview" +linkTitle: "sqlserverdatabases" +description: "Detailed reference documentation for radius.data/sqlserverdatabases@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Data/sqlServerDatabases Resource Type deploys a SQL database. Provide the administrator `username` and `password` directly on the resource. The `password` property is marked `x-radius-sensitive`, so Radius encrypts it at rest, redacts it on reads, and exposes it (decrypted) only to the recipe that provisions the database. +```bicep +resource sqlserver 'Radius.Data/sqlServerDatabases@2025-08-01-preview' = { + name: 'sqlserver' + properties: { + environment: environment + application: myApplication.id + database: 'appdb' + username: 'myadmin' + // From a @secure() password parameter passed in via the CLI + password: password + } +} +``` + +When deploying the application definition, provide the database password value as a parameter. It is recommended to use a password generator such as `openssl` or equivalent. For example, `rad deploy app.bicep -p password=$(openssl rand -hex 16)`. + +To connect your container to the database, create a connection from the +Container resource to the database as shown below. This verification test is +provisioning-only because the stock demo image has no SQL Server backend, but +the type still exposes a connection surface for applications that can use it. +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + application: myApplication.id + environment: environment + container: { + image: 'frontend:1.25' + } + connections: { + sqlserver: { + source: sqlserver.id + } + } + } +} +``` + +The connection automatically injects environment variables into the +container for all properties from the database. The environment variables are +named `CONNECTION__`. In this example the +connection name is `sqlserver` so the environment variables will be: + +- CONNECTION_SQLSERVER_DATABASE +- CONNECTION_SQLSERVER_HOST +- CONNECTION_SQLSERVER_PORT + +The schema is platform-neutral: the same developer-facing properties can be +backed by Azure SQL Database, AWS RDS for SQL Server, or a Kubernetes SQL +Server recipe by changing only the platform recipe's module source, +parameters, and outputs. Azure maps host from the AVM +`fullyQualifiedDomainName` output; AWS Terraform would map an RDS endpoint; +Kubernetes would map a Service DNS name. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `database` | string | true | false | (Required) The SQL database name to create on the server. Defaults to `appdb` in the sample application. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `host` | string | false | true | The SQL Server fully qualified domain name. Mapped from the recipe module's `fullyQualifiedDomainName` output. | +| `password` | string | true | false | (Required) The administrator password for the SQL database. Marked `x-radius-sensitive`: Radius encrypts it at rest, redacts it on reads, and exposes it decrypted only to the recipe as `{{context.resource.properties.password}}`. | +| `port` | string | false | true | The SQL Server TCP port. Azure SQL Database listens on 1433. | +| `username` | string | true | false | (Required) The administrator username for the SQL database. Provided directly on the resource and passed to the recipe as `{{context.resource.properties.username}}`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | diff --git a/docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/kafka/index.md b/docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/kafka/index.md new file mode 100644 index 000000000..e146eea73 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/kafka/index.md @@ -0,0 +1,96 @@ +--- +type: docs +title: "Reference: radius.messaging/kafka@2025-08-01-preview" +linkTitle: "kafka" +description: "Detailed reference documentation for radius.messaging/kafka@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Messaging/kafka Resource Type deploys a Kafka-compatible +messaging namespace. On Azure, the verification recipe provisions Azure +Event Hubs with its Kafka surface enabled by the Standard tier and creates +an Event Hub named by the developer-authored `topic` property. +```bicep +resource kafka 'Radius.Messaging/kafka@2025-08-01-preview' = { + name: 'kafka' + properties: { + environment: environment + application: myApplication.id + topic: 'events' + } +} +``` + +To connect a container to the cluster, create a connection from the +Container resource to the Kafka cluster as shown below. +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + application: myApplication.id + environment: environment + container: { + image: 'frontend:1.25' + } + connections: { + kafka: { + source: kafka.id + } + } + } +} +``` + +The connection automatically injects environment variables into the +container for all properties from the cluster. The environment variables are +named `CONNECTION__`. In this example the +connection name is `kafka` so the environment variables will be: + +- CONNECTION_KAFKA_HOST + +The `connectionString` secret is NOT injected via the connection — it is +materialized into a managed `Radius.Security/secrets` resource. Bind it into +a container env var with a `secretKeyRef`, using `kafka.properties.secrets.name` +as the `secretName` and key `connectionString` (see the `secrets` property). + +Portability note: the schema is platform-neutral so the same type works +with Azure AVM (Bicep), AWS Terraform registry modules, and Kubernetes +recipes. Only the recipePack `source` plus `parameters`/`outputs` mapping +change per platform; the developer-facing properties (knobs and readOnly +connection surface) stay identical. For example, Azure maps `host` from the +Event Hubs namespace name while AWS MSK can map it from Terraform +`bootstrap_brokers`, and a Kubernetes Strimzi/Kafka recipe can map it from +the broker bootstrap Service DNS. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `host` | string | false | true | The host name used to connect to the Kafka-compatible endpoint. For Azure Event Hubs this is the namespace name; the bootstrap server is `.servicebus.windows.net:9093`. | +| `secrets` | [object](#secrets) | false | false | (Read-only) Recipe secrets. The reserved `name` sub-property references the managed Radius.Security/secrets resource Radius materializes from the recipe's `outputs.secrets`; the other sub-properties declare secret keys whose values are written only into that managed secret (never onto this resource). Consumers bind a key into a container env var via `secretKeyRef`, using `.properties.secrets.name` as `secretName`. | +| `topic` | string | false | false | (Optional) The Kafka topic/Event Hub name to create. Defaults to `events`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | + +### `secrets` {#secrets} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `connectionString` | string | false | true | The connection string used to connect to the Kafka-compatible endpoint. Mapped from the recipe module's `primaryConnectionString` output; delivered via the managed secret. | +| `name` | string | false | true | (Reserved) Name of the managed Radius.Security/secrets resource. Use as `secretName` in a container `secretKeyRef`. | diff --git a/docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/rabbitmq/index.md b/docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/rabbitmq/index.md new file mode 100644 index 000000000..7b2d247e4 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/rabbitmq/index.md @@ -0,0 +1,68 @@ +--- +type: docs +title: "Reference: radius.messaging/rabbitmq@2025-08-01-preview" +linkTitle: "rabbitmq" +description: "Detailed reference documentation for radius.messaging/rabbitmq@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Messaging/rabbitMQ Resource Type deploys a queue-compatible +messaging resource. In the Azure verification recipe, the platform engineer +maps this type to Azure Service Bus using the Service Bus AMQP endpoint. This +provisions the resource and maps its connection outputs; it does not prove +RabbitMQ broker API compatibility. +```bicep +resource queue 'Radius.Messaging/rabbitMQ@2025-08-01-preview' = { + name: 'rabbitmq' + properties: { + environment: environment + application: myApplication.id + queue: 'jobs' + } +} +``` + +To connect your workload to the queue, create a connection from the workload +resource to the queue resource. The connection automatically injects +environment variables named `CONNECTION__`. +For a connection named `rabbitmq`, the variables are: + +- CONNECTION_RABBITMQ_HOST + +The `connectionString` secret is NOT injected via the connection — it is +materialized into a managed `Radius.Security/secrets` resource. Bind it into +a container env var with a `secretKeyRef`, using `rabbitmq.properties.secrets.name` +as the `secretName` and key `connectionString` (see the `secrets` property). + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `host` | string | false | true | The host or namespace name used to connect to the queue. Mapped from the recipe module's output. | +| `queue` | string | false | false | (Optional) The queue name to create. Defaults to `jobs` if not provided. | +| `secrets` | [object](#secrets) | false | false | (Read-only) Recipe secrets. The reserved `name` sub-property references the managed Radius.Security/secrets resource Radius materializes from the recipe's `outputs.secrets`; the other sub-properties declare secret keys whose values are written only into that managed secret (never onto this resource). Consumers bind a key into a container env var via `secretKeyRef`, using `.properties.secrets.name` as `secretName`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | + +### `secrets` {#secrets} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `connectionString` | string | false | true | The primary connection string used to connect to the queue. Mapped from the recipe module's output; delivered via the managed secret. | +| `name` | string | false | true | (Reserved) Name of the managed Radius.Security/secrets resource. Use as `secretName` in a container `secretKeyRef`. | diff --git a/docs/content/reference/resources/radius/radius.security/2025-08-01-preview/secrets/index.md b/docs/content/reference/resources/radius/radius.security/2025-08-01-preview/secrets/index.md new file mode 100644 index 000000000..5cbef8fae --- /dev/null +++ b/docs/content/reference/resources/radius/radius.security/2025-08-01-preview/secrets/index.md @@ -0,0 +1,79 @@ +--- +type: docs +title: "Reference: radius.security/secrets@2025-08-01-preview" +linkTitle: "secrets" +description: "Detailed reference documentation for radius.security/secrets@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Security/secrets Resource Type stores sensitive data such as tokens, passwords, keys, and certificates. To create a new Secret, start by adding parameter to your application definition decorated with `@secure()`. Then add a `secrets` resource. Never include secret values in an application definition. +```bicep + extension radius + + @description('The Radius environment ID') + param environment string + + @secure() + param password string + + resource myApplication 'Radius.Core/applications@2025-08-01-preview' = { + name: 'my-app' + properties: { + environment: environment + } + } + + // Passing password as a parameter to `rad deploy` + // password=$(openssl rand -hex 16) + // rad deploy app.bicep -p password=$password + resource dbCredentials 'Radius.Security/secrets@2025-08-01-preview' = { + name: 'db-creds' + properties: { + environment: environment + application: myApplication.id + data: { + username: { + value: 'admin' + } + password: { + // From password parameter passed in via CLI. + value: password + } + } + } + } + ``` +When deploying the application, specify the secret value as a command-line parameter. It is recommended to use a password generator such as `openssl` or equivalent. For example, `rad deploy app.bicep -p password=$(openssl rand -hex 16)`. +For details on how to use the secret with another resource such as a container or database, see the documentation for those resource types. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `data` | [object](#data) | true | false | (Required) Map of secret data. For example: `data: { username: { value: user1 } password: { value: pass }}` | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `kind` | string | false | false | (Optional) The kind of content of the secret. If not specified, generic is assumed. basicAuthentication, awsIRSA, and azureWorkloadIdentity should only be used for configuring authentication to OCI registries for storing Bicep templates. This will change in the future.
Allowed values: `awsIRSA`, `azureWorkloadIdentity`, `basicAuthentication`, `certificate-pem`, `certificate-pkcs12`, `generic`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | + +### `data` {#data} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `encoding` | string | false | false | (Optional) Content encoding of the value. If not specified, `string` is assumed.
Allowed values: `base64`, `string`. | +| `value` | string | true | false | (Required) The string value of the secret unless encoding is set to 'base64'. | diff --git a/docs/content/reference/resources/radius/radius.storage/2025-08-01-preview/objectstorage/index.md b/docs/content/reference/resources/radius/radius.storage/2025-08-01-preview/objectstorage/index.md new file mode 100644 index 000000000..6f4701644 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.storage/2025-08-01-preview/objectstorage/index.md @@ -0,0 +1,100 @@ +--- +type: docs +title: "Reference: radius.storage/objectstorage@2025-08-01-preview" +linkTitle: "objectstorage" +description: "Detailed reference documentation for radius.storage/objectstorage@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +## Description + +The Radius.Storage/objectStorage Resource Type deploys an object storage +container (an S3-style bucket / Azure Blob container / GCS bucket). To deploy +one, add an objectStorage resource to the application definition Bicep file. +Unlike database types, no secret is required from the developer: Azure Storage +generates its own account keys, so the platform-engineer recipe needs no +injected credentials. +```bicep +resource store 'Radius.Storage/objectStorage@2025-08-01-preview' = { + name: 'store' + properties: { + environment: environment + application: myApplication.id + containerName: 'data' + } +} +``` + +To connect your container to the store, create a connection from the +Container resource to the store as shown below. This verification test is +provisioning-only because the stock demo image has no Azure Blob backend, but +the type still exposes a connection surface for applications that can use it. +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + application: myApplication.id + environment: environment + container: { + image: 'frontend:1.25' + } + connections: { + storage: { + source: store.id + } + } + } +} +``` + +The connection automatically injects environment variables into the +container for all properties from the store. The environment variables are +named `CONNECTION__`. In this example the +connection name is `storage` so the environment variables will be: + +- CONNECTION_STORAGE_CONTAINERNAME +- CONNECTION_STORAGE_ENDPOINT +- CONNECTION_STORAGE_ACCOUNTNAME + +The `connectionString` and `accountKey` secrets are NOT injected via the +connection — they are materialized into a managed `Radius.Security/secrets` +resource. Bind them into container env vars with a `secretKeyRef`, using +`store.properties.secrets.name` as the `secretName` and the desired key +(`connectionString` or `accountKey`; see the `secrets` property). + +The schema is platform-neutral: the same developer-facing properties can be +backed by Azure Blob Storage, AWS S3, or a Kubernetes object-store recipe by +changing only the platform recipe's module source, parameters, and outputs. + +## Top-Level Properties + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `accountName` | string | false | true | The Azure Storage account name. Mapped from the recipe module's `name` output. | +| `application` | string | false | false | (Optional) The Radius Application ID. `myApplication.id` for example. | +| `codeReference` | string | false | false | Optional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27 | +| `connections` | [object](#connections) | false | false | Map of connection name to connection data. | +| `containerName` | string | false | false | (Optional) The object container (blob container / S3 bucket) name to create inside the storage account. Defaults to `data` if not provided. | +| `endpoint` | string | false | true | The object storage endpoint used to connect to the store. Mapped from the recipe module's `primaryBlobEndpoint` output. | +| `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | +| `secrets` | [object](#secrets) | false | false | (Read-only) Recipe secrets. The reserved `name` sub-property references the managed Radius.Security/secrets resource Radius materializes from the recipe's `outputs.secrets`; the other sub-properties declare secret keys whose values are written only into that managed secret (never onto this resource). Consumers bind a key into a container env var via `secretKeyRef`, using `.properties.secrets.name` as `secretName`. | + +## Object Properties + +### `connections` {#connections} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `disableDefaultEnvVars` | boolean | false | false | Disables the automatic injection of environment variables from the connected resource's properties. | +| `source` | string | true | false | Resource ID of the source resource for this connection. | + +### `secrets` {#secrets} + +| Property | Type | Required | Read-Only | Description | +|----------|------|----------|-----------|-------------| +| `accountKey` | string | false | true | The Azure Storage account access key. Mapped from the recipe module's `primaryAccessKey` output; delivered via the managed secret. | +| `connectionString` | string | false | true | The storage account connection string. Mapped from the recipe module's `primaryConnectionString` output; delivered via the managed secret. | +| `name` | string | false | true | (Reserved) Name of the managed Radius.Security/secrets resource. Use as `secretName` in a container `secretKeyRef`. | From e63dda3bade877d2a636898a4d63bf624478f5a3 Mon Sep 17 00:00:00 2001 From: "radius-docs[bot]" <291938785+radius-docs[bot]@users.noreply.github.com> Date: Tue, 4 Aug 2026 21:18:28 +0000 Subject: [PATCH 2/3] docs: synced local 'docs/content/reference/cli/' with remote 'docs/docs/content/reference/cli/' Signed-off-by: radius-docs[bot] <291938785+radius-docs[bot]@users.noreply.github.com> --- .../reference/cli/rad_application_graph.md | 6 +++--- docs/content/reference/cli/rad_deploy.md | 1 + .../reference/cli/rad_environment_create.md | 14 +++++++++----- .../reference/cli/rad_environment_update.md | 2 +- .../reference/cli/rad_install_kubernetes.md | 16 ++++++++++++---- docs/content/reference/cli/rad_resource_list.md | 15 ++++++++++++++- docs/content/reference/cli/rad_shutdown.md | 4 ++-- docs/content/reference/cli/rad_startup.md | 2 +- 8 files changed, 43 insertions(+), 17 deletions(-) diff --git a/docs/content/reference/cli/rad_application_graph.md b/docs/content/reference/cli/rad_application_graph.md index d185366ba..433d02d2d 100644 --- a/docs/content/reference/cli/rad_application_graph.md +++ b/docs/content/reference/cli/rad_application_graph.md @@ -21,8 +21,8 @@ the command compiles the template and writes the resulting modeled graph to ./app-graph.json without contacting the control plane. If the command runs inside a GitHub Actions runner (GITHUB_ACTIONS=true), the -modeled graph is committed to /app-graph.json on the radius-graph -orphan branch instead of the local filesystem. This is auto-detected; no flag +modeled graph is saved to /app-graph.json in the radius-graph +archive instead of the local filesystem. This is auto-detected; no flag is required. ``` @@ -46,7 +46,7 @@ rad app graph ./app.bicep -a, --application string The application name -g, --group string The resource group name -h, --help help for graph - --include-icons When set with --preview, embeds each referenced resource type icon's SVG bytes in the response. + --include-icons When set with --preview (deployed) or with a bicep-file argument (modeled), embeds each referenced resource type icon's SVG bytes in the response's icons map. -o, --output string output format (supported formats are json, table) (default "table") --preview Use the Radius.Core preview implementation (can also be set via RADIUS_PREVIEW=true) -w, --workspace string The workspace name diff --git a/docs/content/reference/cli/rad_deploy.md b/docs/content/reference/cli/rad_deploy.md index 15a9b6394..f7fcebfcc 100644 --- a/docs/content/reference/cli/rad_deploy.md +++ b/docs/content/reference/cli/rad_deploy.md @@ -85,6 +85,7 @@ rad deploy myapp.bicep --parameters @myfile.json --parameters version=latest -g, --group string The resource group name -h, --help help for deploy -p, --parameters stringArray Specify parameters for the deployment + --preview Deploy the application using the Radius.Core/applications resource type instead of Applications.Core/applications (can also be set via RADIUS_PREVIEW=true) -w, --workspace string The workspace name ``` diff --git a/docs/content/reference/cli/rad_environment_create.md b/docs/content/reference/cli/rad_environment_create.md index 83c96a3a0..a308911db 100644 --- a/docs/content/reference/cli/rad_environment_create.md +++ b/docs/content/reference/cli/rad_environment_create.md @@ -24,18 +24,21 @@ rad environment create [envName] [flags] ``` -## Create environment with default namespace +## Create environment rad env create myenv -## Create environment with a specific namespace -rad env create myenv --kubernetes-namespace mynamespace - ## Create environment with Azure cloud provider rad env create myenv --azure-subscription-id --azure-resource-group ## Create environment with AWS cloud provider rad env create myenv --aws-region --aws-account-id +## Create environment with a specific Kubernetes namespace +rad env create myenv --kubernetes-namespace mynamespace + +## Create environment with recipe packs (--preview) +rad env create myenv --preview --recipe-packs pack1,pack2 + ``` ### Options @@ -49,7 +52,8 @@ rad env create myenv --aws-region --aws-account-id -g, --group string The resource group name -h, --help help for create --kubernetes-namespace string The namespace where Kubernetes resources will be deployed - --preview Use the Radius.Core preview implementation (can also be set via RADIUS_PREVIEW=true) + --preview Use the Radius.Core preview implementation for environment create (can also be set via RADIUS_PREVIEW=true) + --recipe-packs strings Specify recipe packs to assign to the environment (--preview). Accepts comma-separated values. -w, --workspace string The workspace name ``` diff --git a/docs/content/reference/cli/rad_environment_update.md b/docs/content/reference/cli/rad_environment_update.md index 7c73ce58b..772bdcd30 100644 --- a/docs/content/reference/cli/rad_environment_update.md +++ b/docs/content/reference/cli/rad_environment_update.md @@ -67,7 +67,7 @@ rad env update myenv --recipe-packs pack1,pack2 -g, --group string The resource group name -h, --help help for update --kubernetes-namespace string The namespace where Kubernetes resources will be deployed - --preview Use the Radius.Core preview implementation for environment update. + --preview Use the Radius.Core preview implementation for environment update (can also be set via RADIUS_PREVIEW=true) --recipe-packs strings Specify recipe packs to replace the environment's recipe pack list (--preview). Accepts comma-separated values. -w, --workspace string The workspace name ``` diff --git a/docs/content/reference/cli/rad_install_kubernetes.md b/docs/content/reference/cli/rad_install_kubernetes.md index 9eeb8954b..2afc26f05 100644 --- a/docs/content/reference/cli/rad_install_kubernetes.md +++ b/docs/content/reference/cli/rad_install_kubernetes.md @@ -17,10 +17,14 @@ By default 'rad install kubernetes' will install Radius with the version matchin Radius will be installed in the 'radius-system' namespace. For more information visit https://docs.radapp.io/concepts#technical-architecture -This command also ensures that a default resource group named 'default' and a default environment -named 'default' (using the 'default' Kubernetes namespace) exist so the cluster is immediately -ready to deploy applications. If either resource already exists, it is left unchanged; user -customizations are never overwritten, even with '--reinstall'. +On install or reinstall, this command also ensures that a default resource group named 'default' +and a default environment named 'default' (using the 'default' Kubernetes namespace) exist so the +cluster is immediately ready to deploy applications. If either resource already exists, it is left +unchanged (GET-first); user customizations are never overwritten, even with '--reinstall'. + +By default the environment is created using the 'Applications.Core/environments' resource type. +Pass '--preview' (or set RADIUS_PREVIEW=true) to create it using the new 'Radius.Core/environments' +resource type with the default recipe pack instead. Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit https://docs.radapp.io/guides/operations/kubernetes/install/. @@ -35,6 +39,9 @@ rad install kubernetes [flags] # Install Radius with default settings in current Kubernetes context rad install kubernetes +# Install Radius and create the default environment using the Radius.Core/environments type +rad install kubernetes --preview + # Install Radius with default settings in specified Kubernetes context rad install kubernetes --kubecontext mycluster @@ -92,6 +99,7 @@ rad install kubernetes --set global.terraform.loglevel=DEBUG --contour-set-file stringArray Set values from files on the command line (can specify multiple or separate files with commas: key1=filename1,key2=filename2) -h, --help help for kubernetes --kubecontext string The Kubernetes context to use, will use the default if unset + --preview Create the default environment using the Radius.Core/environments resource type instead of Applications.Core/environments (can also be set via RADIUS_PREVIEW=true) --reinstall Specify to force reinstallation of Radius --set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --set-file stringArray Set values from files on the command line (can specify multiple or separate files with commas: key1=filename1,key2=filename2) diff --git a/docs/content/reference/cli/rad_resource_list.md b/docs/content/reference/cli/rad_resource_list.md index 0efb47e94..53c47a76f 100644 --- a/docs/content/reference/cli/rad_resource_list.md +++ b/docs/content/reference/cli/rad_resource_list.md @@ -12,7 +12,7 @@ Lists resources ### Synopsis -List all resources of specified type +List all resources of a specified type. If no resource type is given, lists all resources of any type in an environment or application. ``` rad resource list [resourceType] [flags] @@ -35,12 +35,25 @@ rad resource list Applications.Core/containers --application icecream-store # list all resources of a specified type in an application (shorthand flag) rad resource list Applications.Core/containers -a icecream-store +# list all resources of a specified type in a specified environment +rad resource list Applications.Core/containers -e not-default-env + +# list all resources of any type in the default environment +rad resource list + +# list all resources of any type in a specified environment +rad resource list -e not-default-env + +# list all resources of any type in an application +rad resource list -a icecream-store + ``` ### Options ``` -a, --application string The application name + -e, --environment string The environment name -g, --group string The resource group name -h, --help help for list -o, --output string output format (supported formats are json, table) (default "table") diff --git a/docs/content/reference/cli/rad_shutdown.md b/docs/content/reference/cli/rad_shutdown.md index 3aa3905cb..f143c44f9 100644 --- a/docs/content/reference/cli/rad_shutdown.md +++ b/docs/content/reference/cli/rad_shutdown.md @@ -15,8 +15,8 @@ Back up Radius state and prepare for shutdown Back up all durable Radius state for the current workspace. Dumps the control-plane PostgreSQL databases and exports the Terraform recipe state Secrets, -commits them to the radius-state git orphan branch, and pushes to the remote when one is -configured. The state can be restored into a fresh control plane with 'rad startup'. +commits them to the radius-state archive. The state can be restored into a fresh control plane +with 'rad startup'. This command does not delete the cluster or uninstall Radius. diff --git a/docs/content/reference/cli/rad_startup.md b/docs/content/reference/cli/rad_startup.md index 46131f329..bb64d56b2 100644 --- a/docs/content/reference/cli/rad_startup.md +++ b/docs/content/reference/cli/rad_startup.md @@ -14,7 +14,7 @@ Restore Radius state after startup Restore durable Radius state for the current workspace. -Opens the radius-state git orphan branch, waits for the control-plane PostgreSQL instance to be +Opens the radius-state archive, waits for the control-plane PostgreSQL instance to be ready, restores the control-plane databases, and re-creates the Terraform recipe state Secrets. Run this after Radius is installed on a fresh cluster to resume from the state saved by 'rad shutdown'. From dbf4838297ddad133c40a5155adcd9d6d6dea41f Mon Sep 17 00:00:00 2001 From: "radius-docs[bot]" <291938785+radius-docs[bot]@users.noreply.github.com> Date: Wed, 12 Aug 2026 22:23:12 +0000 Subject: [PATCH 3/3] docs: synced local 'docs/content/reference/resources/' with remote 'docs/docs/content/reference/resources/' Signed-off-by: radius-docs[bot] <291938785+radius-docs[bot]@users.noreply.github.com> --- .../radius.compute/2025-08-01-preview/containers/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containers/index.md b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containers/index.md index f328265c8..e342f6f8d 100644 --- a/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containers/index.md +++ b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/containers/index.md @@ -57,7 +57,7 @@ resource myContainer 'Radius.Compute/containers@2025-08-01-preview' = { } ``` -When a port is included, a Kubernetes Service named demo with the type ClusterIP is created. +When a port is included, a Kubernetes Service of type ClusterIP is created for the container. Its name is `-`, lowercased to satisfy Kubernetes naming rules — for the example above, `mycontainer-demo`. The recipe publishes each port-exposing container's in-cluster Service DNS name in the read-only `hosts` map, keyed by container name. Peer containers can address a specific container by referencing `.properties.hosts.` instead of hardcoding a Service name. To create an ephemeral emptyDir shared between two containers add a Containers.properties.volumes. @@ -109,6 +109,7 @@ To mount a persistent volume or secret see the PersistentVolumes and Secrets Res | `containers` | [object](#containers) | true | false | | | `environment` | string | true | false | (Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be `environment`. | | `extensions` | [object](#extensions) | false | false | (Optional) Properties for additional functionality. daprSidecar is the only available option. | +| `hosts` | object | false | true | (Read Only) Map of container name to the in-cluster DNS host of that container's Kubernetes Service. Populated for every container that exposes a port, so a multi-container resource publishes all of its Service hosts. Peer containers address a specific container by referencing `.properties.hosts.`. | | `platformOptions` | object | false | false | (Optional) If enabled by the platform engineer, properties to be passed to the Recipe for the specified platform. | | `replicas` | integer | false | false | (Optional) The minimum number of replicas for the set of containers. | | `restartPolicy` | string | false | false | (Optional) Defines how a containers behave when they terminate. `Always` will restart containers regardless of their exit status. `OnFailure` will restart containers if they return a non-zero exit code.
Allowed values: `Always`, `Never`, `OnFailure`. |