Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/content/reference/cli/rad_application_graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <source-branch>/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 <source-branch>/app-graph.json in the radius-graph
archive instead of the local filesystem. This is auto-detected; no flag
is required.

```
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_environment_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
15 changes: 14 additions & 1 deletion docs/content/reference/cli/rad_resource_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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")
Expand Down
4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_shutdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_startup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ description: "Detailed reference documentation for radius.core/applications@2025
| Property | Type | Description |
|----------|------|-------------|
| **apiVersion** | '2025-08-01-preview' | The resource api version <br />_(ReadOnly, DeployTimeConstant)_ |
| **environment** | string | Fully qualified resource ID for the environment that the application is linked to <br />_(ReadOnly)_ |
| **environment** | string | (Required) Fully qualified resource ID of the environment the application is deployed to <br />_(ReadOnly)_ |
| **id** | string | The resource id <br />_(ReadOnly, DeployTimeConstant)_ |
| **location** | string | The geo-location where the resource lives |
| **name** | string | The resource name <br />_(Required, DeployTimeConstant, Identifier)_ |
| **properties** | [ApplicationProperties](#applicationproperties) | The resource-specific properties for this resource. <br />_(Required)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation. <br />_(ReadOnly)_ |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Application resource within the Radius control plane. Does not include the other resources that compose the Application. <br />_(ReadOnly)_ |
| **status** | [ResourceStatus](#resourcestatus) | (Read Only) Deployment details for the Application, including any output resources Radius created for it. <br />_(ReadOnly)_ |
| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information. <br />_(ReadOnly)_ |
| **tags** | [Record](#record) | Resource tags. |
| **type** | 'Radius.Core/applications' | The resource type <br />_(ReadOnly, DeployTimeConstant)_ |
Expand All @@ -33,9 +33,9 @@ description: "Detailed reference documentation for radius.core/applications@2025

| Property | Type | Description |
|----------|------|-------------|
| **environment** | string | Fully qualified resource ID for the environment that the application is linked to <br />_(Required)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation. <br />_(ReadOnly)_ |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |
| **environment** | string | (Required) Fully qualified resource ID of the environment the application is deployed to <br />_(Required)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Application resource within the Radius control plane. Does not include the other resources that compose the Application. <br />_(ReadOnly)_ |
| **status** | [ResourceStatus](#resourcestatus) | (Read Only) Deployment details for the Application, including any output resources Radius created for it. <br />_(ReadOnly)_ |

### ResourceStatus

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ description: "Detailed reference documentation for radius.core/bicepsettings@202
| **location** | string | The geo-location where the resource lives |
| **name** | string | The resource name <br />_(Required, DeployTimeConstant, Identifier)_ |
| **properties** | [BicepSettingsProperties](#bicepsettingsproperties) | The resource-specific properties for this resource. <br />_(Required)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation. <br />_(ReadOnly)_ |
| **referencedBy** | string[] | Environments that reference this Bicep configuration. <br />_(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. <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Bicep settings resource within the Radius control plane. <br />_(ReadOnly)_ |
| **referencedBy** | string[] | (Read Only) Resource IDs of the Environments that reference this Bicep settings resource. <br />_(ReadOnly)_ |
| **registryAuthentications** | [Record](#record) | (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. <br />_(ReadOnly)_ |
| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information. <br />_(ReadOnly)_ |
| **tags** | [Record](#record) | Resource tags. |
| **type** | 'Radius.Core/bicepSettings' | The resource type <br />_(ReadOnly, DeployTimeConstant)_ |
Expand All @@ -33,9 +33,9 @@ description: "Detailed reference documentation for radius.core/bicepsettings@202

| Property | Type | Description |
|----------|------|-------------|
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation. <br />_(ReadOnly)_ |
| **referencedBy** | string[] | Environments that reference this Bicep configuration. <br />_(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. |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Bicep settings resource within the Radius control plane. <br />_(ReadOnly)_ |
| **referencedBy** | string[] | (Read Only) Resource IDs of the Environments that reference this Bicep settings resource. <br />_(ReadOnly)_ |
| **registryAuthentications** | [Record](#record) | (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. |

### Record

Expand All @@ -53,11 +53,11 @@ description: "Detailed reference documentation for radius.core/bicepsettings@202

| 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'. |
| **authenticationMethod** | 'AwsIrsa' | 'AzureWI' | 'BasicAuth' | (Optional) How Radius authenticates to the registry. |
| **awsIamRoleArn** | string | (Optional) AWS IAM Role ARN for IRSA authentication. Required when `authenticationMethod` is `AwsIrsa`. |
| **azureWiClientId** | string | (Optional) Azure Workload Identity client ID. Required when `authenticationMethod` is `AzureWI`. |
| **azureWiTenantId** | string | (Optional) Azure Workload Identity tenant ID. Required when `authenticationMethod` is `AzureWI`. |
| **basicAuthSecretId** | string | (Optional) The ID of a `Radius.Security/secrets` resource containing the username and password. Required when `authenticationMethod` is `BasicAuth`. |

### Record

Expand Down
Loading
Loading