From b1f6937c9fa3f3e268d3eb31453b85a034e6bb77 Mon Sep 17 00:00:00 2001 From: rad-ci-bot Date: Tue, 12 May 2026 21:48:14 +0000 Subject: [PATCH] Autogenerate reference docs Signed-off-by: rad-ci-bot --- .../reference/cli/rad_application_delete.md | 11 +- .../reference/cli/rad_application_graph.md | 3 - .../reference/cli/rad_application_show.md | 5 +- .../reference/cli/rad_application_status.md | 5 +- .../reference/cli/rad_environment_update.md | 5 +- docs/content/reference/cli/rad_initialize.md | 1 + .../reference/cli/rad_resource_delete.md | 4 + docs/content/reference/cli/rad_run.md | 8 +- .../2025-08-01-preview/bicepconfigs/index.md | 81 ++++++++++++ .../2025-08-01-preview/environments/index.md | 2 + .../terraformconfigs/index.md | 125 ++++++++++++++++++ 11 files changed, 229 insertions(+), 21 deletions(-) create mode 100644 docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md create mode 100644 docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md diff --git a/docs/content/reference/cli/rad_application_delete.md b/docs/content/reference/cli/rad_application_delete.md index 294d5d970..ff7dfe1ee 100644 --- a/docs/content/reference/cli/rad_application_delete.md +++ b/docs/content/reference/cli/rad_application_delete.md @@ -22,11 +22,8 @@ rad application delete [flags] ``` -# Delete current application -rad app delete - -# Delete current application and bypass confirmation prompt -rad app delete --yes +# Delete specified application and bypass confirmation prompt +rad app delete --yes --application my-app # Delete specified application rad app delete my-app @@ -34,12 +31,16 @@ rad app delete my-app # Delete specified application in a specified resource group rad app delete my-app --group my-group +# Force delete an application with resources stuck in a non-terminal state +rad app delete my-app --force + ``` ### Options ``` -a, --application string The application name + --force Force the operation even if the resource is in a non-terminal provisioning state -g, --group string The resource group name -h, --help help for delete -w, --workspace string The workspace name diff --git a/docs/content/reference/cli/rad_application_graph.md b/docs/content/reference/cli/rad_application_graph.md index daeef5429..b90741d29 100644 --- a/docs/content/reference/cli/rad_application_graph.md +++ b/docs/content/reference/cli/rad_application_graph.md @@ -22,9 +22,6 @@ rad application graph [flags] ``` -# Show graph for current application -rad app graph - # Show graph for specified application rad app graph my-application ``` diff --git a/docs/content/reference/cli/rad_application_show.md b/docs/content/reference/cli/rad_application_show.md index a8dcc10c6..29090335c 100644 --- a/docs/content/reference/cli/rad_application_show.md +++ b/docs/content/reference/cli/rad_application_show.md @@ -12,7 +12,7 @@ Show Radius Application details ### Synopsis -Show Radius Application details. Shows the user's default application (if configured) by default. +Show Radius Application details ``` rad application show [flags] @@ -22,9 +22,6 @@ rad application show [flags] ``` -# Show current application -rad app show - # Show specified application rad app show my-app diff --git a/docs/content/reference/cli/rad_application_status.md b/docs/content/reference/cli/rad_application_status.md index 48ae31e34..8808c6c5e 100644 --- a/docs/content/reference/cli/rad_application_status.md +++ b/docs/content/reference/cli/rad_application_status.md @@ -12,7 +12,7 @@ Show Radius Application status ### Synopsis -Show Radius Application status, such as public endpoints and resource count. Shows details for the user's default application (if configured) by default. +Show Radius Application status, such as public endpoints and resource count. ``` rad application status [flags] @@ -22,9 +22,6 @@ rad application status [flags] ``` -# Show status of current application -rad app status - # Show status of specified application rad app status my-app diff --git a/docs/content/reference/cli/rad_environment_update.md b/docs/content/reference/cli/rad_environment_update.md index f93395dd6..3209f08b6 100644 --- a/docs/content/reference/cli/rad_environment_update.md +++ b/docs/content/reference/cli/rad_environment_update.md @@ -48,6 +48,9 @@ rad env update myenv --kubernetes-namespace mynamespace ## Remove Kubernetes cloud provider (preview) rad env update myenv --clear-kubernetes +## Set recipe packs to environment (--preview) +rad env update myenv --recipe-packs pack1,pack2 + ``` ### Options @@ -66,7 +69,7 @@ rad env update myenv --clear-kubernetes --kubernetes-namespace string The namespace where Kubernetes resources will be deployed (preview) -o, --output string output format (supported formats are json, table) (default "table") --preview Use the Radius.Core preview implementation for environment update. - --recipe-packs stringArray Specify recipe packs to be added to the environment (--preview) + --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_initialize.md b/docs/content/reference/cli/rad_initialize.md index 784430708..25fe7a82c 100644 --- a/docs/content/reference/cli/rad_initialize.md +++ b/docs/content/reference/cli/rad_initialize.md @@ -66,6 +66,7 @@ rad init --set-file global.rootCA.cert=/path/to/rootCA.crt --full Prompt user for all available configuration options -h, --help help for initialize -o, --output string output format (supported formats are json, table) (default "table") + --preview Use the Radius.Core preview implementation --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_delete.md b/docs/content/reference/cli/rad_resource_delete.md index d4932d299..1e8fb7407 100644 --- a/docs/content/reference/cli/rad_resource_delete.md +++ b/docs/content/reference/cli/rad_resource_delete.md @@ -26,11 +26,15 @@ sample list of resourceType: Applications.Core/containers, Applications.Core/gat # Delete a container named orders rad resource delete Applications.Core/containers orders + +# Force delete a resource that is stuck in a non-terminal state +rad resource delete Applications.Core/containers orders --force ``` ### Options ``` + --force Force the operation even if the resource is in a non-terminal provisioning state -g, --group string The resource group name -h, --help help for delete -o, --output string output format (supported formats are json, table) (default "table") diff --git a/docs/content/reference/cli/rad_run.md b/docs/content/reference/cli/rad_run.md index 3ca6ea543..d2085f226 100644 --- a/docs/content/reference/cli/rad_run.md +++ b/docs/content/reference/cli/rad_run.md @@ -28,16 +28,16 @@ rad run [file] [flags] ``` # Run app.bicep -rad run app.bicep +rad run app.bicep --application my-app # Run in a specific environment -rad run app.bicep --environment prod +rad run app.bicep --environment prod --application my-app # Run app.bicep and specify a string parameter -rad run app.bicep --parameters version=latest +rad run app.bicep --parameters version=latest --application my-app # Run app.bicep and specify parameters from multiple sources -rad run app.bicep --parameters @myfile.json --parameters version=latest +rad run app.bicep --parameters @myfile.json --parameters version=latest --application my-app ``` diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md new file mode 100644 index 000000000..fcff6412e --- /dev/null +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md @@ -0,0 +1,81 @@ +--- +type: docs +title: "Reference: radius.core/bicepconfigs@2025-08-01-preview" +linkTitle: "bicepconfigs" +description: "Detailed reference documentation for radius.core/bicepconfigs@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## 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** | [BicepConfigProperties](#bicepconfigproperties) | Bicep configuration properties.
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Radius.Core/bicepConfigs' | The resource type
_(ReadOnly, DeployTimeConstant)_ | + +### BicepConfigProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **referencedBy** | string[] | Environments that reference this Bicep configuration.
_(ReadOnly)_ | +| **registryAuthentications** | [BicepConfigPropertiesRegistryAuthentications](#bicepconfigpropertiesregistryauthentications) | 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. | + +### BicepConfigPropertiesRegistryAuthentications + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [BicepRegistryAuthentication](#bicepregistryauthentication) + +### BicepRegistryAuthentication + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **authenticationMethod** | 'AwsIrsa' | 'AzureWI' | 'BasicAuth' | Supported authentication methods for private Bicep registries. | +| **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 an Applications.Core/SecretStore resource containing username and password for BasicAuth. Required when authenticationMethod is 'BasicAuth'. | + +### 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 created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + 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 0d6b0e49e..625fada6e 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 @@ -30,11 +30,13 @@ description: "Detailed reference documentation for radius.core/environments@2025 | Property | Type | Description | |----------|------|-------------| +| **bicepConfig** | string | Resource ID of a Radius.Core/bicepConfigs resource providing Bicep recipe settings. | | **providers** | [Providers](#providers) | | | **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | | **recipePacks** | string[] | List of Recipe Pack resource IDs linked to this environment. | | **recipeParameters** | [EnvironmentPropertiesRecipeParameters](#environmentpropertiesrecipeparameters) | Recipe specific parameters that apply to all resources of a given type in this environment. | | **simulated** | bool | Simulated environment. | +| **terraformConfig** | string | Resource ID of a Radius.Core/terraformConfigs resource providing Terraform recipe settings. | ### Providers diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md new file mode 100644 index 000000000..f2ec90d28 --- /dev/null +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md @@ -0,0 +1,125 @@ +--- +type: docs +title: "Reference: radius.core/terraformconfigs@2025-08-01-preview" +linkTitle: "terraformconfigs" +description: "Detailed reference documentation for radius.core/terraformconfigs@2025-08-01-preview" +--- + +{{< schemaExample >}} + +## 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** | [TerraformConfigProperties](#terraformconfigproperties) | Terraform configuration properties.
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Radius.Core/terraformConfigs' | The resource type
_(ReadOnly, DeployTimeConstant)_ | + +### TerraformConfigProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **env** | [TerraformConfigPropertiesEnv](#terraformconfigpropertiesenv) | Environment variables injected during Terraform recipe execution. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **referencedBy** | string[] | Environments that reference this Terraform configuration.
_(ReadOnly)_ | +| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file (.terraformrc) settings. See https://developer.hashicorp.com/terraform/cli/config for details. | + +### TerraformConfigPropertiesEnv + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### TerraformrcConfig + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **credentials** | [TerraformrcConfigCredentials](#terraformrcconfigcredentials) | 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 for Terraform CLI. | + +### TerraformrcConfigCredentials + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [TerraformCredentialConfig](#terraformcredentialconfig) + +### TerraformCredentialConfig + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **secret** | string | The ID of an Applications.Core/SecretStore resource containing the authentication token. The secret store must have a secret named 'token'. | + +### TerraformProviderInstallation + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **direct** | [TerraformProviderDirect](#terraformproviderdirect) | Direct provider installation configuration. | +| **networkMirror** | [TerraformProviderMirror](#terraformprovidermirror) | Network mirror configuration for Terraform 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 created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string +