az monitor account trace-container

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

Manage the trace container of an Azure Monitor workspace.

Commands

Name Description Type Status
az monitor account trace-container create

Create the trace container of an Azure Monitor workspace.

Core Preview
az monitor account trace-container show

Show the trace container of an Azure Monitor workspace.

Core Preview
az monitor account trace-container update

Update the trace container of an Azure Monitor workspace.

Core Preview
az monitor account trace-container wait

Place the CLI in a waiting state until a condition is met.

Core Preview

az monitor account trace-container create

Preview

Command group 'az monitor account trace-container' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create the trace container of an Azure Monitor workspace.

A workspace has one trace container, named default. On an existing container, omitted settings keep their current values. A new container defaults to 30 days retention, a 600-second duration window and Enabled trace metrics.

az monitor account trace-container create --azure-monitor-workspace-name
                                          --resource-group
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--retention-days]
                                          [--trace-duration-window]
                                          [--trace-metrics {Disabled, Enabled}]

Examples

Create the trace container of an Azure Monitor workspace

az monitor account trace-container create -g obsRg -w myAmw --retention-days 30 --trace-duration-window 600 --trace-metrics Enabled

Required Parameters

--azure-monitor-workspace-name -w

The name of the Azure Monitor Workspace. The name is case insensitive.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--retention-days

The number of days for which the traces are retained. Value must be between 4 and 730 days.

Property Value
Parameter group: Properties Arguments
--trace-duration-window

The trace duration window in seconds.

Property Value
Parameter group: Properties Arguments
--trace-metrics

Controls trace-derived metrics. New containers default to Enabled.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
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 monitor account trace-container show

Preview

Command group 'az monitor account trace-container' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show the trace container of an Azure Monitor workspace.

az monitor account trace-container show [--azure-monitor-workspace-name]
                                        [--ids]
                                        [--resource-group]
                                        [--subscription]

Examples

Show the trace container of an Azure Monitor workspace

az monitor account trace-container show -g obsRg -w myAmw

Optional Parameters

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

--azure-monitor-workspace-name -w

The name of the Azure Monitor Workspace. The name is case insensitive.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False

az monitor account trace-container update

Preview

Command group 'az monitor account trace-container' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the trace container of an Azure Monitor workspace.

Omitted settings keep their current values.

az monitor account trace-container update [--acquire-policy-token]
                                          [--add]
                                          [--azure-monitor-workspace-name]
                                          [--change-reference]
                                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--ids]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--remove]
                                          [--resource-group]
                                          [--retention-days]
                                          [--set]
                                          [--subscription]
                                          [--trace-duration-window]
                                          [--trace-metrics {Disabled, Enabled}]

Examples

Update the trace container of an Azure Monitor workspace

az monitor account trace-container update -g obsRg -w myAmw --retention-days 90

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--azure-monitor-workspace-name -w

The name of the Azure Monitor Workspace. The name is case insensitive.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--retention-days

The number of days for which the traces are retained. Value must be between 4 and 730 days.

Property Value
Parameter group: Properties Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--trace-duration-window

The trace duration window in seconds.

Property Value
Parameter group: Properties Arguments
--trace-metrics

Controls trace-derived metrics. New containers default to Enabled.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
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.

--verbose

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

Property Value
Default value: False

az monitor account trace-container wait

Preview

Command group 'az monitor account trace-container' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az monitor account trace-container wait [--acquire-policy-token]
                                        [--azure-monitor-workspace-name]
                                        [--change-reference]
                                        [--created]
                                        [--custom]
                                        [--deleted]
                                        [--exists]
                                        [--ids]
                                        [--interval]
                                        [--resource-group]
                                        [--subscription]
                                        [--timeout]
                                        [--updated]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--azure-monitor-workspace-name -w

The name of the Azure Monitor Workspace. The name is case insensitive.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
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.

--verbose

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

Property Value
Default value: False