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
Autogenerate reference docs
Signed-off-by: rad-ci-bot <[email protected]>
  • Loading branch information
rad-ci-bot committed Nov 6, 2025
commit 948230af02f2cd576d9cc9939f9964c011a0d324
1 change: 1 addition & 0 deletions docs/content/reference/cli/rad.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Radius CLI
* [rad initialize]({{< ref rad_initialize.md >}}) - Initialize Radius
* [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes
* [rad recipe-pack]({{< ref rad_recipe-pack.md >}}) - Manage recipe-packs
* [rad resource]({{< ref rad_resource.md >}}) - Manage resources
* [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types
* [rad rollback]({{< ref rad_rollback.md >}}) - Rolls back Radius for a given platform
Expand Down
38 changes: 38 additions & 0 deletions docs/content/reference/cli/rad_recipe-pack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
type: docs
title: "rad recipe-pack CLI reference"
linkTitle: "rad recipe-pack"
slug: rad_recipe-pack
url: /reference/cli/rad_recipe-pack/
description: "Details on the rad recipe-pack Radius CLI command"
---
## rad recipe-pack

Manage recipe-packs

### Synopsis

Manage recipe-packs
Recipe-packs automate the deployment of infrastructure and configuration of radius resources.

### Options

```
-h, --help help for recipe-pack
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
-o, --output string output format (supported formats are json, table) (default "table")
```

### SEE ALSO

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad recipe-pack delete]({{< ref rad_recipe-pack_delete.md >}}) - Delete recipe pack
* [rad recipe-pack list]({{< ref rad_recipe-pack_list.md >}}) - List recipe packs
* [rad recipe-pack show]({{< ref rad_recipe-pack_show.md >}}) - Show recipe pack details

55 changes: 55 additions & 0 deletions docs/content/reference/cli/rad_recipe-pack_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
type: docs
title: "rad recipe-pack delete CLI reference"
linkTitle: "rad recipe-pack delete"
slug: rad_recipe-pack_delete
url: /reference/cli/rad_recipe-pack_delete/
description: "Details on the rad recipe-pack delete Radius CLI command"
---
## rad recipe-pack delete

Delete recipe pack

### Synopsis

Delete a recipe pack from the current workspace scope.

```
rad recipe-pack delete [flags]
```

### Examples

```
# Delete specified recipe pack
rad recipe-pack delete my-recipe-pack
# Delete recipe pack in a specified resource group
rad recipe-pack delete my-recipe-pack --group my-group
# Delete recipe pack and bypass confirmation prompt
rad recipe-pack delete my-recipe-pack --yes
```

### Options

```
-g, --group string The resource group name
-h, --help help for delete
-w, --workspace string The workspace name
-y, --yes The confirmation flag
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
-o, --output string output format (supported formats are json, table) (default "table")
```

### SEE ALSO

* [rad recipe-pack]({{< ref rad_recipe-pack.md >}}) - Manage recipe-packs

45 changes: 45 additions & 0 deletions docs/content/reference/cli/rad_recipe-pack_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
type: docs
title: "rad recipe-pack list CLI reference"
linkTitle: "rad recipe-pack list"
slug: rad_recipe-pack_list
url: /reference/cli/rad_recipe-pack_list/
description: "Details on the rad recipe-pack list Radius CLI command"
---
## rad recipe-pack list

List recipe packs

### Synopsis

Lists all recipe packs in all scopes

```
rad recipe-pack list [flags]
```

### Examples

```
rad recipe-packs list
```

### Options

```
-g, --group string The resource group name
-h, --help help for list
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad recipe-pack]({{< ref rad_recipe-pack.md >}}) - Manage recipe-packs

52 changes: 52 additions & 0 deletions docs/content/reference/cli/rad_recipe-pack_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
type: docs
title: "rad recipe-pack show CLI reference"
linkTitle: "rad recipe-pack show"
slug: rad_recipe-pack_show
url: /reference/cli/rad_recipe-pack_show/
description: "Details on the rad recipe-pack show Radius CLI command"
---
## rad recipe-pack show

Show recipe pack details

### Synopsis

Show recipe pack details

```
rad recipe-pack show [flags]
```

### Examples

```


# Show specified recipe pack
rad recipe-show show my-recipe-pack

# Show specified recipe pack in a specified resource group
rad recipe-show show my-recipe-pack --group my-group

```

### Options

```
-g, --group string The resource group name
-h, --help help for show
-o, --output string output format (supported formats are plain-text, json) (default "plain-text")
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad recipe-pack]({{< ref rad_recipe-pack.md >}}) - Manage recipe-packs

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_resource-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Manage resource types

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad resource-type create]({{< ref rad_resource-type_create.md >}}) - Create or update a resource type
* [rad resource-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete resource type
* [rad resource-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete a resource type
* [rad resource-type list]({{< ref rad_resource-type_list.md >}}) - List resource resource types
* [rad resource-type show]({{< ref rad_resource-type_show.md >}}) - Show resource resource type

33 changes: 16 additions & 17 deletions docs/content/reference/cli/rad_resource-type_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,35 @@ Create or update a resource type

### Synopsis

Create or update a resource type from a resource type manifest.

Resource types are user defined types such as 'Mycompany.Messaging/plaid'.

Creating a resource type defines a new type that can be used in applications.

Input can be passed in using a JSON or YAML file using the --from-file option.

resource-type name argument is optional. If specified, only the specified type is created/updated.
If not specified, all resource types in the referenced file are created/updated.

Create or update a resource type from a resource type definition file.

Resource types define the resources that Radius can deploy and the API for those resources. They are defined by a name, one or more API versions, and an OpenAPI schema.

Input can be passed in using a JSON or YAML file using the --from-file option.

The resource type name argument is optional. If specified, only the specified type is created/updated. If not specified, all resource types in the referenced file are created/updated.

The resource type name argument is the simple name (e.g., 'testResources') not the fully qualified name.


```
rad resource-type create [input] [flags]
rad resource-type create [resource-type-name] [flags]
```

### Examples

```

# Create a resource type from YAML file
# Create a specific resource type from a YAML file
rad resource-type create myType --from-file /path/to/input.yaml

# Create a resource type from JSON file
# Create a specific resource type from a JSON file
rad resource-type create myType --from-file /path/to/input.json

# Create all resource types from YAML file
rad resource-type create --from-file /path/to/input.yaml
# Create all resource types from a YAML file
rad resource-type create --from-file /path/to/input.yaml

# Create all resource types from JSON file
# Create all resource types from a JSON file
rad resource-type create --from-file /path/to/input.json

```
Expand Down
17 changes: 9 additions & 8 deletions docs/content/reference/cli/rad_resource-type_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,27 @@ description: "Details on the rad resource-type delete Radius CLI command"
---
## rad resource-type delete

Delete resource type
Delete a resource type

### Synopsis

Delete resource type

Resource types are the entities that implement resource types such as 'Applications.Core/containers'. Each resource type can define multiple API versions, and each API version defines a schema that resource instances conform to. Resource providers can be created and deleted by users.
Delete a resource type

Deleting a resource type will delete the specified resource type. For example, deleting 'Applications.Core/containers' will delete that type (but not deployed instances of the type).

The resource type name argument must be a fully qualified resource type name in the format 'ResourceType.Namespace/resourceTypeName' (e.g., 'Radius.Compute/containers').

Deleting a resource type will delete all resources of the specified resource type. For example, deleting 'Applications.Core/containers' will delete all containers.

```
rad resource-type delete [resource type] [flags]
rad resource-type delete [resource-type-name] [flags]
```

### Examples

```

# Delete a resource type
rad resource-type delete Applications.Core/containers
# Delete a resource type (fully qualified name required)
rad resource-type delete Radius.Compute/containers

# Delete a resource type (bypass confirmation)
rad resource-type delete Applications.Core/containers --yes
Expand Down
7 changes: 7 additions & 0 deletions docs/content/reference/resources/radius/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Reference: radius"
linkTitle: "radius"
description: "Detailed reference documentation for radius"
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Reference: 2025-08-01-preview"
linkTitle: "2025-08-01-preview"
description: "Detailed reference documentation for 2025-08-01-preview"
---

Loading
Loading