Share via

az containerapp env dotnet-component

  • Preview

Note

This reference is part of the containerapp extension for the Azure CLI (version 2.62.0 or higher). The extension will automatically install the first time you run an az containerapp env dotnet-component command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage DotNet components within the environment.

Commands

Name Description Type Status
az containerapp env dotnet-component create

Command to create DotNet component to enable Aspire Dashboard. Supported DotNet component type is Aspire Dashboard.

 Extension Preview
az containerapp env dotnet-component delete

Command to delete DotNet component to disable Aspire Dashboard.

 Extension Preview
az containerapp env dotnet-component list

Command to list DotNet components within the environment.

 Extension Preview
az containerapp env dotnet-component show

Command to show DotNet component in environment.

 Extension Preview

az containerapp env dotnet-component create

Preview

Command group 'containerapp env dotnet-component' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to create DotNet component to enable Aspire Dashboard. Supported DotNet component type is Aspire Dashboard.

az containerapp env dotnet-component create --environment
                                            --name
                                            --resource-group
                                            [--no-wait]
                                            [--type {AspireDashboard}]

Examples

Create a DotNet component to enable Aspire Dashboard.

az containerapp env dotnet-component create -g MyResourceGroup \
    -n MyDotNetComponentName \
    --environment MyEnvironment \
    --type AspireDashboard

Required Parameters

--environment

The environment name.

--name -n

The DotNet component name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--type

The type of DotNet component.

Property Value
Default value: AspireDashboard
Accepted values: AspireDashboard
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az containerapp env dotnet-component delete

Preview

Command group 'containerapp env dotnet-component' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to delete DotNet component to disable Aspire Dashboard.

az containerapp env dotnet-component delete --environment
                                            --name
                                            --resource-group
                                            [--no-wait]
                                            [--yes]

Examples

Delete DotNet component.

az containerapp env dotnet-component delete -g MyResourceGroup \
    -n MyDotNetComponentName \
    --environment MyEnvironment

Required Parameters

--environment

The environment name.

--name -n

The DotNet component name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az containerapp env dotnet-component list

Preview

Command group 'containerapp env dotnet-component' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to list DotNet components within the environment.

az containerapp env dotnet-component list --environment
                                          --resource-group

Examples

List all DotNet components within an environment.

az containerapp env dotnet-component list -g MyResourceGroup --environment MyEnvironment

Required Parameters

--environment

The environment name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az containerapp env dotnet-component show

Preview

Command group 'containerapp env dotnet-component' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to show DotNet component in environment.

az containerapp env dotnet-component show --environment
                                          --name
                                          --resource-group

Examples

Show the details of an environment.

az containerapp env dotnet-component show -n MyDotNetComponentName --environment MyContainerappEnvironment -g MyResourceGroup

Required Parameters

--environment

The environment name.

--name -n

The DotNet component name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False