az maintenance applyupdate

  • Reference

Note

This reference is part of the maintenance extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az maintenance applyupdate command. Learn more about extensions.

Manage apply update with maintenance.

Commands

Name Description Type Status
az maintenance applyupdate create

Apply maintenance updates to resource.

 Extension GA
az maintenance applyupdate create-or-update

Create maintenance updates to resource.

 Extension GA
az maintenance applyupdate create-or-update-parent

Apply maintenance updates to resource with parent.

 Extension GA
az maintenance applyupdate list

Get Configuration records within a subscription.

 Extension GA
az maintenance applyupdate show

Track maintenance updates to resource.

 Extension GA
az maintenance applyupdate show-parent

Track maintenance updates to resource with parent.

 Extension GA
az maintenance applyupdate update

Update maintenance updates to resource.

 Extension GA

az maintenance applyupdate create

Apply maintenance updates to resource.

az maintenance applyupdate create --provider-name
                                  --resource-group
                                  --resource-name
                                  --resource-type

Examples

ApplyUpdates_CreateOrUpdate

az maintenance applyupdate create --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdtest1" --resource-type "virtualMachineScaleSets"

Required Parameters

--provider-name

Resource provider name.

--resource-group -g

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

--resource-name

Resource identifier.

--resource-type

Resource type.

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 maintenance applyupdate create-or-update

Create maintenance updates to resource.

az maintenance applyupdate create-or-update [--apply-update-name]
                                            [--ids]
                                            [--last-update-time]
                                            [--provider-name]
                                            [--resource-group]
                                            [--resource-id]
                                            [--resource-name]
                                            [--resource-type]
                                            [--status {Cancel, Cancelled, Completed, InProgress, NoUpdatesPending, Pending, RetryLater, RetryNow}]
                                            [--subscription]

Examples

ApplyUpdates_CreateOrUpdate

az maintenance applyupdate create-or-update --apply-update-name "20230921151000" --provider-name "Microsoft.Maintenance" --resource-group "Maintenance-RG-1598" --resource-name "configuration1" --resource-type "maintenanceConfigurations" --status "Cancel"

Optional Parameters

--apply-update-name --name -n

ApplyUpdate name.

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

--last-update-time

Last Update time.

--provider-name

Resource provider name.

--resource-group -g

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

--resource-id

The resourceId.

--resource-name

Resource identifier.

--resource-type

Resource type.

--status

The status.

accepted values: Cancel, Cancelled, Completed, InProgress, NoUpdatesPending, Pending, RetryLater, RetryNow
--subscription

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

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 maintenance applyupdate create-or-update-parent

Apply maintenance updates to resource with parent.

az maintenance applyupdate create-or-update-parent [--ids]
                                                   [--provider-name]
                                                   [--resource-group]
                                                   [--resource-name]
                                                   [--resource-parent-name]
                                                   [--resource-parent-type]
                                                   [--resource-type]
                                                   [--subscription]

Examples

ApplyUpdates_CreateOrUpdateParent

az maintenance applyupdate create-or-update-parent --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdvm1" --resource-parent-name "smdtest1" --resource-parent-type "virtualMachineScaleSets" --resource-type "virtualMachines"

Optional Parameters

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

--provider-name

Resource provider name.

--resource-group -g

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

--resource-name

Resource identifier.

--resource-parent-name

Resource parent identifier.

--resource-parent-type

Resource parent type.

--resource-type

Resource type.

--subscription

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

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 maintenance applyupdate list

Get Configuration records within a subscription.

az maintenance applyupdate list

Examples

ApplyUpdates_List

az maintenance applyupdate list
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 maintenance applyupdate show

Track maintenance updates to resource.

az maintenance applyupdate show [--apply-update-name]
                                [--ids]
                                [--provider-name]
                                [--resource-group]
                                [--resource-name]
                                [--resource-type]
                                [--subscription]

Examples

ApplyUpdates_Get

az maintenance applyupdate show --name "e9b9685d-78e4-44c4-a81c-64a14f9b87b6" --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdtest1" --resource-type "virtualMachineScaleSets"

Optional Parameters

--apply-update-name --name -n

ApplyUpdate Id.

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

--provider-name

Resource provider name.

--resource-group -g

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

--resource-name

Resource identifier.

--resource-type

Resource type.

--subscription

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

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 maintenance applyupdate show-parent

Track maintenance updates to resource with parent.

az maintenance applyupdate show-parent [--apply-update-name]
                                       [--ids]
                                       [--provider-name]
                                       [--resource-group]
                                       [--resource-name]
                                       [--resource-parent-name]
                                       [--resource-parent-type]
                                       [--resource-type]
                                       [--subscription]

Examples

ApplyUpdates_GetParent

az maintenance applyupdate show-parent --name "e9b9685d-78e4-44c4-a81c-64a14f9b87b6"  --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdvm1" --resource-parent-name "smdtest1" --resource-parent-type "virtualMachineScaleSets"  --resource-type "virtualMachines"

Optional Parameters

--apply-update-name --name -n

ApplyUpdate Id.

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

--provider-name

Resource provider name.

--resource-group -g

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

--resource-name

Resource identifier.

--resource-parent-name

Resource parent identifier.

--resource-parent-type

Resource parent type.

--resource-type

Resource type.

--subscription

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

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 maintenance applyupdate update

Update maintenance updates to resource.

az maintenance applyupdate update [--add]
                                  [--apply-update-name]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--ids]
                                  [--last-update-time]
                                  [--provider-name]
                                  [--remove]
                                  [--resource-group]
                                  [--resource-id]
                                  [--resource-name]
                                  [--resource-type]
                                  [--set]
                                  [--status {Cancel, Cancelled, Completed, InProgress, NoUpdatesPending, Pending, RetryLater, RetryNow}]
                                  [--subscription]

Examples

ApplyUpdates_Update

az maintenance applyupdate update --apply-update-name "20230921151000" --provider-name "Microsoft.Maintenance" --resource-group "Maintenance-RG-1598" --resource-name "configuration1" --resource-type "maintenanceConfigurations" --status "Cancel"

Optional Parameters

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

--apply-update-name --name -n

ApplyUpdate Id.

--force-string

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

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.

--last-update-time

Last Update time.

--provider-name

Resource provider name.

--remove

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

--resource-group -g

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

--resource-id

The resourceId.

--resource-name

Resource identifier.

--resource-type

Resource type.

--set

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

--status

The status.

accepted values: Cancel, Cancelled, Completed, InProgress, NoUpdatesPending, Pending, RetryLater, RetryNow
--subscription

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

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.