az containerapp env telemetry otlp

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 telemetry otlp command. Learn more about extensions.

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

Commands to manage otlp settings for the container apps environment.

Commands

Name	Description	Type	Status
az containerapp env telemetry otlp add	Add container apps environment telemetry otlp settings.	Extension	Preview
az containerapp env telemetry otlp list	List container apps environment telemetry otlp settings.	Extension	Preview
az containerapp env telemetry otlp remove	Remove container apps environment telemetry otlp settings.	Extension	Preview
az containerapp env telemetry otlp show	Show container apps environment telemetry otlp settings.	Extension	Preview
az containerapp env telemetry otlp update	Update container apps environment telemetry otlp settings.	Extension	Preview

az containerapp env telemetry otlp add

Preview

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

Add container apps environment telemetry otlp settings.

az containerapp env telemetry otlp add --endpoint
                                       --name
                                       --otlp-name
                                       --resource-group
                                       [--enable-open-telemetry-logs {false, true}]
                                       [--enable-open-telemetry-metrics {false, true}]
                                       [--enable-open-telemetry-traces {false, true}]
                                       [--headers]
                                       [--insecure {false, true}]
                                       [--no-wait]

Examples

Add container apps environment telemetry otlp settings.

az containerapp env telemetry otlp add -n MyContainerappEnvironment -g MyResourceGroup \
    --otlp-name otlpName --endpoint otlpEndpoint --insecure false --headers api-key=apiKey \
    --enable-open-telemetry-traces true --enable-open-telemetry-logs true --enable-open-telemetry-metrics true

Required Parameters

--endpoint -e

The endpoint of the otlp entry.

--name -n

Name of the Container Apps environment.

--otlp-name

The name of the otlp entry.

--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.

--enable-open-telemetry-logs -l

Boolean indicating whether to enable open telemetry logs.

Property	Value
Default value:	False
Accepted values:	false, true

--enable-open-telemetry-metrics -m

Boolean indicating whether to enable open telemetry metrics.

Property	Value
Default value:	False
Accepted values:	false, true

--enable-open-telemetry-traces -t

Boolean indicating whether to enable open telemetry traces.

Property	Value
Default value:	False
Accepted values:	false, true

--headers

A list of headers for the otlp. Space-separated values in 'key=value' format.

--insecure

Boolean indicating whether the otlp is insecure or not.

Property	Value
Default value:	False
Accepted values:	false, true

--no-wait

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

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 telemetry otlp list

Preview

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

List container apps environment telemetry otlp settings.

az containerapp env telemetry otlp list --name
                                        --resource-group

Examples

List container apps environment telemetry otlp settings.

az containerapp env telemetry otlp list -n MyContainerappEnvironment -g MyResourceGroup

Required Parameters

--name -n

Name of the Container Apps environment.

--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 telemetry otlp remove

Preview

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

Remove container apps environment telemetry otlp settings.

az containerapp env telemetry otlp remove --name
                                          --otlp-name
                                          --resource-group
                                          [--no-wait]
                                          [--yes]

Examples

Remove container apps environment telemetry otlp settings.

az containerapp env telemetry otlp remove -n MyContainerappEnvironment -g MyResourceGroup \
    --otlp-name otlpName

Required Parameters

--name -n

Name of the Container Apps environment.

--otlp-name

The name of the otlp entry.

--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 telemetry otlp show

Preview

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

Show container apps environment telemetry otlp settings.

az containerapp env telemetry otlp show --name
                                        --otlp-name
                                        --resource-group

Examples

Show container apps environment telemetry otlp settings.

az containerapp env telemetry otlp show -n MyContainerappEnvironment -g MyResourceGroup \
    --otlp-name otlpName

Required Parameters

--name -n

Name of the Container Apps environment.

--otlp-name

The name of the otlp entry.

--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 telemetry otlp update

Preview

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

Update container apps environment telemetry otlp settings.

az containerapp env telemetry otlp update --name
                                          --otlp-name
                                          --resource-group
                                          [--enable-open-telemetry-logs {false, true}]
                                          [--enable-open-telemetry-metrics {false, true}]
                                          [--enable-open-telemetry-traces {false, true}]
                                          [--endpoint]
                                          [--headers]
                                          [--insecure {false, true}]
                                          [--no-wait]

Examples

Update container apps environment telemetry otlp settings.

az containerapp env telemetry otlp update -n MyContainerappEnvironment -g MyResourceGroup \
    --otlp-name otlpName --endpoint otlpEndpoint --insecure false --headers api-key=apiKey \
    --enable-open-telemetry-traces true --enable-open-telemetry-logs true --enable-open-telemetry-metrics true

Required Parameters

--name -n

Name of the Container Apps environment.

--otlp-name

The name of the otlp entry.

--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.

--enable-open-telemetry-logs -l

Boolean indicating whether to enable open telemetry logs.

Property	Value
Accepted values:	false, true

--enable-open-telemetry-metrics -m

Boolean indicating whether to enable open telemetry metrics.

Property	Value
Accepted values:	false, true

--enable-open-telemetry-traces -t

Boolean indicating whether to enable open telemetry traces.

Property	Value
Accepted values:	false, true

--endpoint -e

The endpoint of the otlp entry.

--headers

A list of headers for the otlp. Space-separated values in 'key=value' format.

--insecure

Boolean indicating whether the otlp is insecure or not.

Property	Value
Accepted values:	false, true

--no-wait

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

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