From 0d8b6b879cb6f281249583cfdf40b4b5fc6556fc Mon Sep 17 00:00:00 2001 From: "radius-docs[bot]" <291938785+radius-docs[bot]@users.noreply.github.com> Date: Fri, 24 Jul 2026 18:25:33 +0000 Subject: [PATCH 1/2] 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> --- .../2025-08-01-preview/applications/index.md | 12 ++--- .../2025-08-01-preview/bicepsettings/index.md | 22 ++++----- .../2025-08-01-preview/environments/index.md | 46 +++++++++---------- .../2025-08-01-preview/recipepacks/index.md | 24 +++++----- .../terraformsettings/index.md | 36 +++++++-------- 5 files changed, 70 insertions(+), 70 deletions(-) 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..9297cff20 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 @@ -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
_(ReadOnly, DeployTimeConstant)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | +| **environment** | string | (Required) Fully qualified resource ID of the environment the application is deployed 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)_ | +| **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.
_(ReadOnly)_ | +| **status** | [ResourceStatus](#resourcestatus) | (Read Only) Deployment details for the Application, including any output resources Radius created for it.
_(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)_ | @@ -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
_(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)_ | +| **environment** | string | (Required) Fully qualified resource ID of the environment the application is deployed to
_(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.
_(ReadOnly)_ | +| **status** | [ResourceStatus](#resourcestatus) | (Read Only) Deployment details for the Application, including any output resources Radius created for it.
_(ReadOnly)_ | ### ResourceStatus 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..d7c4c6d28 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 @@ -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
_(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)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Bicep settings resource within the Radius control plane.
_(ReadOnly)_ | +| **referencedBy** | string[] | (Read Only) Resource IDs of the Environments that reference this Bicep settings resource.
_(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.
_(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)_ | @@ -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.
_(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. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Bicep settings resource within the Radius control plane.
_(ReadOnly)_ | +| **referencedBy** | string[] | (Read Only) Resource IDs of the Environments that reference this Bicep settings resource.
_(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 @@ -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 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..b80368b50 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 @@ -16,19 +16,19 @@ description: "Detailed reference documentation for radius.core/environments@2025 | 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)_ | +| **bicepSettings** | string | (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.
_(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)_ | +| **providers** | [Providers](#providers) | (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.
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Environment resource within the Radius control plane. Does not include the resources deployed to the Environment.
_(ReadOnly)_ | +| **recipePacks** | string[] | (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.
_(ReadOnly)_ | +| **recipeParameters** | [Record](#record) | (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.
_(ReadOnly)_ | +| **simulated** | bool | (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.
_(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)_ | +| **terraformSettings** | string | (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.
_(ReadOnly)_ | | **type** | 'Radius.Core/environments' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### EnvironmentProperties @@ -37,13 +37,13 @@ description: "Detailed reference documentation for radius.core/environments@2025 | 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. | +| **bicepSettings** | string | (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** | [Providers](#providers) | (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** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Environment resource within the Radius control plane. Does not include the resources deployed to the Environment.
_(ReadOnly)_ | +| **recipePacks** | string[] | (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** | [Record](#record) | (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** | bool | (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 | (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. | ### Providers @@ -51,9 +51,9 @@ description: "Detailed reference documentation for radius.core/environments@2025 | 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. | +| **aws** | [ProvidersAws](#providersaws) | (Optional) Configuration for deploying resources to AWS. | +| **azure** | [ProvidersAzure](#providersazure) | (Optional) Configuration for deploying resources to Azure. | +| **kubernetes** | [ProvidersKubernetes](#providerskubernetes) | (Optional) Configuration for deploying resources to Kubernetes. | ### ProvidersAws @@ -61,8 +61,8 @@ description: "Detailed reference documentation for radius.core/environments@2025 | 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)_ | +| **accountId** | string | (Required) ID of the AWS account that resources are deployed into.
_(Required)_ | +| **region** | string | (Required) AWS region that resources are deployed into.
_(Required)_ | ### ProvidersAzure @@ -70,9 +70,9 @@ description: "Detailed reference documentation for radius.core/environments@2025 | 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)_ | +| **identity** | [IdentitySettings](#identitysettings) | (Optional) Managed or workload identity Radius uses to authenticate to Azure when deploying resources. | +| **resourceGroupName** | string | (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 | (Required) ID of the Azure subscription that resources are deployed into.
_(Required)_ | ### IdentitySettings @@ -91,7 +91,7 @@ description: "Detailed reference documentation for radius.core/environments@2025 | Property | Type | Description | |----------|------|-------------| -| **namespace** | string | Kubernetes namespace to deploy workloads into.
_(Required)_ | +| **namespace** | string | (Required) Kubernetes namespace that workloads are deployed into.
_(Required)_ | ### Record 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..c05b591f1 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 @@ -20,9 +20,9 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- | **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)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Recipe Pack resource within the Radius control plane.
_(ReadOnly)_ | +| **recipes** | [Record](#record) | (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`.
_(ReadOnly)_ | +| **referencedBy** | string[] | (Read Only) Resource IDs of the Environments 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)_ | @@ -33,9 +33,9 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- | 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)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Recipe Pack resource within the Radius control plane.
_(ReadOnly)_ | +| **recipes** | [Record](#record) | (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`.
_(Required)_ | +| **referencedBy** | string[] | (Read Only) Resource IDs of the Environments that reference this Recipe Pack.
_(ReadOnly)_ | ### Record @@ -53,11 +53,11 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- | 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)_ | +| **kind** | 'bicep' | 'terraform' | (Required) The kind of Recipe, which determines how Radius runs it.
_(Required)_ | +| **outputs** | [Record](#record) | (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** | [Record](#record) | (Optional) Default parameter values passed to the Recipe when it runs. An Environment can override these per resource type through its `recipeParameters` property. | +| **plainHttp** | bool | (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 | (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.
_(Required)_ | ### Record @@ -67,7 +67,7 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- #### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: any ### Record 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..4fc31652b 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 @@ -16,16 +16,16 @@ description: "Detailed reference documentation for radius.core/terraformsettings | 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)_ | +| **env** | [Record](#record) | (Optional) Environment variables injected into the Terraform process during 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)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Terraform settings resource within the Radius control plane.
_(ReadOnly)_ | +| **referencedBy** | string[] | (Read Only) Resource IDs of the Environments that reference this Terraform settings resource.
_(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)_ | +| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | (Optional) Settings for the Terraform CLI configuration file. Radius renders these into a `.terraformrc` file used when running Terraform Recipes.
_(ReadOnly)_ | | **type** | 'Radius.Core/terraformSettings' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### Record @@ -44,10 +44,10 @@ description: "Detailed reference documentation for radius.core/terraformsettings | 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). | +| **env** | [Record](#record) | (Optional) Environment variables injected into the Terraform process during Recipe execution. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | (Read Only) The status of the Terraform settings resource within the Radius control plane.
_(ReadOnly)_ | +| **referencedBy** | string[] | (Read Only) Resource IDs of the Environments that reference this Terraform settings resource.
_(ReadOnly)_ | +| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | (Optional) Settings for the Terraform CLI configuration file. Radius renders these into a `.terraformrc` file used when running Terraform Recipes. | ### Record @@ -65,8 +65,8 @@ description: "Detailed reference documentation for radius.core/terraformsettings | 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. | +| **credentials** | [Record](#record) | (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** | [TerraformProviderInstallation](#terraformproviderinstallation) | (Optional) Controls where Terraform installs providers from, such as a network mirror instead of the public registry. | ### Record @@ -84,7 +84,7 @@ description: "Detailed reference documentation for radius.core/terraformsettings | 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'. | +| **secret** | string | (Optional) The ID of a `Radius.Security/secrets` resource containing the authentication token. The secret must have a key named `token`. | ### TerraformProviderInstallation @@ -92,8 +92,8 @@ description: "Detailed reference documentation for radius.core/terraformsettings | Property | Type | Description | |----------|------|-------------| -| **direct** | [TerraformProviderDirect](#terraformproviderdirect) | Direct provider installation configuration. | -| **networkMirror** | [TerraformProviderMirror](#terraformprovidermirror) | Network mirror configuration for downloading providers. | +| **direct** | [TerraformProviderDirect](#terraformproviderdirect) | (Optional) Providers to install directly from the public registry rather than a mirror. | +| **networkMirror** | [TerraformProviderMirror](#terraformprovidermirror) | (Optional) A network mirror to install providers from instead of the public registry. | ### TerraformProviderDirect @@ -101,8 +101,8 @@ description: "Detailed reference documentation for radius.core/terraformsettings | Property | Type | Description | |----------|------|-------------| -| **exclude** | string[] | Provider address patterns to exclude from direct installation. | -| **include** | string[] | Provider address patterns to include for direct installation. | +| **exclude** | string[] | (Optional) Provider address patterns to exclude from direct installation. | +| **include** | string[] | (Optional) Provider address patterns to include for direct installation. | ### TerraformProviderMirror @@ -110,9 +110,9 @@ description: "Detailed reference documentation for radius.core/terraformsettings | 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. | +| **exclude** | string[] | (Optional) Provider address patterns to exclude from this mirror. | +| **include** | string[] | (Optional) Provider address patterns to include from this mirror. | +| **url** | string | (Optional) The URL of the provider mirror. | ### SystemData From cf0782f0d5b82a18aff8d6a1b0f6d34c62f31d7a Mon Sep 17 00:00:00 2001 From: "radius-docs[bot]" <291938785+radius-docs[bot]@users.noreply.github.com> Date: Fri, 24 Jul 2026 18:25:40 +0000 Subject: [PATCH 2/2] 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 +++--- .../reference/cli/rad_environment_update.md | 2 +- 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 +- 5 files changed, 21 insertions(+), 8 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_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_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'.