Share via

az vmss diagnostics

  • Reference

Configure the Azure Virtual Machine Scale Set diagnostics extension.

Commands

Name Description Type Status
az vmss diagnostics get-default-config

Show the default config file which defines data to be collected.

 Core GA
az vmss diagnostics set

Enable diagnostics on a VMSS.

 Core GA

az vmss diagnostics get-default-config

Edit

Show the default config file which defines data to be collected.

az vmss diagnostics get-default-config [--is-windows-os]

Optional Parameters

--is-windows-os

For Windows VMs.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az vmss diagnostics set

Edit

Enable diagnostics on a VMSS.

az vmss diagnostics set --resource-group
                        --settings
                        --vmss-name
                        [--no-auto-upgrade {false, true}]
                        [--no-auto-upgrade-minor-version {false, true}]
                        [--protected-settings]
                        [--version]

Examples

Enable diagnostics on a VMSS. (autogenerated)

az vmss diagnostics set --protected-settings {protected-settings} --resource-group MyResourceGroup --settings '{"commandToExecute": "echo testing"}' --vmss-name MyVmss

Required Parameters

--resource-group -g

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

--settings

Json string or a file path, which defines data to be collected.

--vmss-name

Scale set name.

Optional Parameters

--no-auto-upgrade
Deprecated

Option '--no-auto-upgrade' has been deprecated and will be removed in a future release. Use '--no-auto-upgrade-minor-version' instead.

If set, the extension service will not automatically pick or upgrade to the latest minor version, even if the extension is redeployed.

Accepted values: false, true
Default value: False
--no-auto-upgrade-minor-version

If set, the extension service will not automatically pick or upgrade to the latest minor version, even if the extension is redeployed.

Accepted values: false, true
Default value: False
--protected-settings

Json string or a file path containing private configurations such as storage account keys, etc.

--version

Version of the diagnostics extension. Will use the latest if not specfied.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.