az automation software-update-configuration

Note

This reference is part of the automation extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az automation software-update-configuration command. Learn more about extensions.

Automation software-update-configuration.

Commands

Name	Description	Type	Status
az automation software-update-configuration create	Create automation software-update-configuration.	Extension	GA
az automation software-update-configuration delete	Delete an automation software-update-configuration.	Extension	GA
az automation software-update-configuration list	List all software-update-configurations for the account.	Extension	GA
az automation software-update-configuration machine-runs	Software Update Configuration Machine Runs.	Extension	GA
az automation software-update-configuration machine-runs list	List software update configuration machine-runs.	Extension	GA
az automation software-update-configuration machine-runs show	Get a single software update configuration machine runs by Id.	Extension	GA
az automation software-update-configuration runs	Software Update Configuration Runs.	Extension	GA
az automation software-update-configuration runs list	Return list of software update configuration runs.	Extension	GA
az automation software-update-configuration runs show	Get a single software update configuration runs by Id.	Extension	GA
az automation software-update-configuration show	Get a single software-update-configuration by name.	Extension	GA

az automation software-update-configuration create

Create automation software-update-configuration.

az automation software-update-configuration create --automation-account-name
                                                   --configuration-name
                                                   --frequency
                                                   --interval
                                                   --operating-system {Linux, Windows}
                                                   --resource-group
                                                   [--azure-queries-locations]
                                                   [--azure-queries-scope]
                                                   [--azure-queries-tags]
                                                   [--azure-virtual-machines]
                                                   [--creation-time]
                                                   [--description]
                                                   [--duration]
                                                   [--excluded-kb-numbers]
                                                   [--expiry-time]
                                                   [--expiry-time-offset-minutes]
                                                   [--included-kb-numbers]
                                                   [--included-update-classifications]
                                                   [--is-enabled {false, true}]
                                                   [--last-modified-time]
                                                   [--next-run]
                                                   [--next-run-offset-minutes]
                                                   [--non-azure-computer-names]
                                                   [--non-azure-queries-function-alias]
                                                   [--non-azure-queries-workspace-id]
                                                   [--post-task-job-id]
                                                   [--post-task-source]
                                                   [--post-task-status]
                                                   [--pre-task-job-id]
                                                   [--pre-task-source]
                                                   [--pre-task-status]
                                                   [--reboot-setting]
                                                   [--start-time]
                                                   [--time-zone]

Examples

Create an automation software-update-configuration

az automation software-update-configuration create --automation-account-name "myAutomationAccount"                  --resource-group "rg" -n mySoftwareUpdateConfiguration --frequency Hour --interval 1                  --operating-system windows --excluded-kb-numbers 16800,16800 -n confgname                  --included-update-classifications Critical --duration pT2H0M --azure-virtual-machines                  /subscriptions/{subid}/resourceGroups/{rg}/providers/Microsoft.Compute/virtualMachines/myVM

Required Parameters

--automation-account-name

The name of the automation account.

--configuration-name --name -n

The name of the software update configuration.

--frequency

The frequency of the schedule.

--interval

The interval of the schedule.

--operating-system

Operating system of target machines.

Accepted values: Linux, Windows

--resource-group -g

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

Optional Parameters

--azure-queries-locations

Space-separated list of Azure queries location in the software update configuration.

--azure-queries-scope

Space-separated list of Azure queries scope in the software update configuration.

--azure-queries-tags

Space-separated list of Azure queries tag settings in the software update configuration.

--azure-virtual-machines

Space-separated list of azure resource Ids for azure virtual machines targeted by the software update configuration.

--creation-time

The creation time. Format: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) timezone (+/-hh:mm).

--description

The description of the schedule.

--duration

Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601.

--excluded-kb-numbers

Space-separated list of KB numbers excluded from the software update configuration.

--expiry-time

The end time of the schedule. Format: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) timezone (+/-hh:mm).

--expiry-time-offset-minutes

The expiry time's offset in minutes.

--included-kb-numbers

Space-separated list of KB numbers included from the software update configuration.

--included-update-classifications

Update classification included in the software update configuration. A comma separated string with required values.

--is-enabled

Indicating whether this schedule is enabled.

Accepted values: false, true

--last-modified-time

The last modified time. Format: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) timezone (+/-hh:mm).

--next-run

The next run time of the schedule. Format: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) timezone (+/-hh:mm).

--next-run-offset-minutes

The next run time's offset in minutes.

--non-azure-computer-names

Space-separated list of names of non-azure machines targeted by the software update configuration.

--non-azure-queries-function-alias

Log Analytics Saved Search name.

--non-azure-queries-workspace-id

Workspace Id for Log Analytics.

--post-task-job-id

The job id of the task.

--post-task-source

The name of the source of the task.

--post-task-status

The status of the task.

--pre-task-job-id

The job id of the task.

--pre-task-source

The name of the source of the task.

--pre-task-status

The status of the task.

--reboot-setting

Reboot setting for the software update configuration.

--start-time

The start time of the schedule. Format: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) timezone (+/-hh:mm).

--time-zone

The time zone of the schedule.

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 automation software-update-configuration delete

Delete an automation software-update-configuration.

az automation software-update-configuration delete --automation-account-name
                                                   --configuration-name
                                                   --resource-group
                                                   [--yes]

Examples

Delete automation software-update-configuration

az automation software-update-configuration delete --name "mySoftwareUpdateConfiguration"                --resource-group "rg" --automation-account-name "myAutomationAccount"

Required Parameters

--automation-account-name

The name of the automation account.

--configuration-name --name -n

The name of the software update configuration.

--resource-group -g

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

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 automation software-update-configuration list

List all software-update-configurations for the account.

az automation software-update-configuration list --automation-account-name
                                                 --resource-group

Examples

List software-update-configurations by automation account

az automation software-update-configuration list --automation-account-name "myAutomationAccount"                 --resource-group "rg"

Required Parameters

--automation-account-name

The name of the automation account.

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

--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 automation software-update-configuration show

Get a single software-update-configuration by name.

az automation software-update-configuration show --automation-account-name
                                                 --configuration-name
                                                 --resource-group

Examples

Get software-update-configuration

az automation software-update-configuration show --automation-account-name "myAutomationAccount"                --resource-group "rg" --name "mySoftwareUpdateConfiguration"

Required Parameters

--automation-account-name

The name of the automation account.

--configuration-name --name -n

The name of the software update configuration.

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

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