az maintenance assignment
Note
This reference is part of the maintenance extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az maintenance assignment command. Learn more about extensions.
Manage configuration assignment with maintenance.
Commands
Name | Description | Type | Status |
---|---|---|---|
az maintenance assignment create |
Apply maintenance updates to resource. |
Extension | GA |
az maintenance assignment create-or-update-parent |
Apply maintenance updates to resource with parent. |
Extension | GA |
az maintenance assignment create-or-update-resource-group |
Create configuration for resource. |
Extension | Experimental |
az maintenance assignment create-or-update-subscription |
Create configuration for resource. |
Extension | Experimental |
az maintenance assignment delete |
Delete configuration for resource. |
Extension | GA |
az maintenance assignment delete-parent |
Delete configuration for resource. |
Extension | GA |
az maintenance assignment delete-resource-group |
Delete configuration for resource. |
Extension | Experimental |
az maintenance assignment delete-subscription |
Delete configuration for resource. |
Extension | Experimental |
az maintenance assignment list |
List configurationAssignments for resource. |
Extension | GA |
az maintenance assignment list-parent |
List configurationAssignments for resource. |
Extension | GA |
az maintenance assignment list-subscription |
List configuration assignment within a subscription. |
Extension | Experimental |
az maintenance assignment show |
Get configuration assignment for resource.. |
Extension | GA |
az maintenance assignment show-parent |
Get configuration assignment for resource.. |
Extension | GA |
az maintenance assignment show-resource-group |
Get configuration assignment for resource.. |
Extension | Experimental |
az maintenance assignment show-subscription |
Get configuration assignment for resource.. |
Extension | Experimental |
az maintenance assignment update |
Update configuration for resource. |
Extension | GA |
az maintenance assignment update-parent |
Update configuration for resource. |
Extension | GA |
az maintenance assignment update-resource-group |
Update configuration for resource. |
Extension | Experimental |
az maintenance assignment update-subscription |
Update configuration for resource. |
Extension | Experimental |
az maintenance assignment create
Apply maintenance updates to resource.
az maintenance assignment create --configuration-assignment-name --name
--provider-name
--resource-group
--resource-name
--resource-type
[--config-id --maintenance-configuration-id]
[--filter-locations]
[--filter-os-types]
[--filter-resource-groups]
[--filter-resource-types]
[--filter-tags]
[--filter-tags-operator {All, Any}]
[--location]
[--resource-id]
Examples
ConfigurationAssignments_CreateOrUpdate
az maintenance assignment create --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" --name "workervmConfiguration" --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "test1" --resource-type "virtualMachineScaleSets"
Required Parameters
Configuration assignment name.
Resource provider name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Resource identifier.
Resource type.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The maintenance configuration Id.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
List of locations to scope the query to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed operating systems. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resource groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
Dictionary of tags with its list of values. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Filter VMs by Any or All specified tags.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Accepted values: | All, Any |
Location of the resource.
Property | Value |
---|---|
Parameter group: | ConfigurationAssignment Arguments |
The unique resourceId.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment create-or-update-parent
Apply maintenance updates to resource with parent.
az maintenance assignment create-or-update-parent [--config-id --maintenance-configuration-id]
[--configuration-assignment-name --name]
[--filter-locations]
[--filter-os-types]
[--filter-resource-groups]
[--filter-resource-types]
[--filter-tags]
[--filter-tags-operator {All, Any}]
[--ids]
[--location]
[--provider-name]
[--resource-group]
[--resource-id]
[--resource-name]
[--resource-parent-name]
[--resource-parent-type]
[--resource-type]
[--subscription]
Examples
ConfigurationAssignments_CreateOrUpdateParent
az maintenance assignment create-or-update-parent --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1" --name "workervmPolicy" --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdvm1" --resource-parent-name "test1" --resource-parent-type "virtualMachineScaleSets" --resource-type "virtualMachines"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The maintenance configuration Id.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
List of locations to scope the query to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed operating systems. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resource groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
Dictionary of tags with its list of values. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Filter VMs by Any or All specified tags.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Accepted values: | All, Any |
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 |
Location of the resource.
Property | Value |
---|---|
Parameter group: | ConfigurationAssignment Arguments |
Resource provider name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The unique resourceId.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment create-or-update-resource-group
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create configuration for resource.
az maintenance assignment create-or-update-resource-group [--config-id --maintenance-configuration-id]
[--configuration-assignment-name --name]
[--filter-locations]
[--filter-os-types]
[--filter-resource-groups]
[--filter-resource-types]
[--filter-tags]
[--filter-tags-operator {All, Any}]
[--ids]
[--location]
[--resource-group]
[--resource-id]
[--subscription]
Examples
ConfigurationAssignments_CreateOrUpdateResourceGroup
az maintenance assignment create-or-update-resource-group --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1" --name assignmentname --filter-locations eastus2euap centraluseuap --filter-os-types windows linux --filter-tags "{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}" --filter-tags-operator All --resource-group examplerg1
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The maintenance configuration Id.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
List of locations to scope the query to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed operating systems. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resource groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
Dictionary of tags with its list of values. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Filter VMs by Any or All specified tags.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Accepted values: | All, Any |
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 |
Location of the resource.
Property | Value |
---|---|
Parameter group: | ConfigurationAssignment Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The unique resourceId.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment create-or-update-subscription
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create configuration for resource.
az maintenance assignment create-or-update-subscription [--config-id --maintenance-configuration-id]
[--configuration-assignment-name --name]
[--filter-locations]
[--filter-os-types]
[--filter-resource-groups]
[--filter-resource-types]
[--filter-tags]
[--filter-tags-operator {All, Any}]
[--ids]
[--location]
[--resource-id]
[--subscription]
Examples
ConfigurationAssignments_CreateOrUpdateSubscription
az maintenance assignment create-or-update-subscription --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1" --name assignmentname --filter-locations eastus2euap centraluseuap --filter-os-types windows linux --filter-tags "{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}" --filter-tags-operator All
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The maintenance configuration Id.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
List of locations to scope the query to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed operating systems. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resource groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
Dictionary of tags with its list of values. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Filter VMs by Any or All specified tags.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Accepted values: | All, Any |
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 |
Location of the resource.
Property | Value |
---|---|
Parameter group: | ConfigurationAssignment Arguments |
The unique resourceId.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment delete
Delete configuration for resource.
az maintenance assignment delete [--configuration-assignment-name --name]
[--ids]
[--provider-name]
[--resource-group]
[--resource-name]
[--resource-type]
[--subscription]
[--yes]
Examples
ConfigurationAssignments_Delete
az maintenance assignment delete --name "workervmConfiguration" --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdtest1" --resource-type "virtualMachineScaleSets"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Unique configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 provider name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment delete-parent
Delete configuration for resource.
az maintenance assignment delete-parent [--configuration-assignment-name --name]
[--ids]
[--provider-name]
[--resource-group]
[--resource-name]
[--resource-parent-name]
[--resource-parent-type]
[--resource-type]
[--subscription]
[--yes]
Examples
ConfigurationAssignments_DeleteParent
az maintenance assignment delete-parent --name "workervmConfiguration" --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdvm1" --resource-parent-name "smdtest1" --resource-parent-type "virtualMachineScaleSets" --resource-type "virtualMachines"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Unique configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 provider name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment delete-resource-group
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete configuration for resource.
az maintenance assignment delete-resource-group [--configuration-assignment-name --name]
[--ids]
[--resource-group]
[--subscription]
[--yes]
Examples
ConfigurationAssignments_DeleteSubscription
az maintenance assignment delete-resource-group --resource-group "examplerg" --name "example1"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Unique configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment delete-subscription
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete configuration for resource.
az maintenance assignment delete-subscription [--configuration-assignment-name --name]
[--ids]
[--subscription]
[--yes]
Examples
ConfigurationAssignments_DeleteSubscription
az maintenance assignment delete-subscription --name "example1"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Unique configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment list
List configurationAssignments for resource.
az maintenance assignment list --provider-name
--resource-group
--resource-name
--resource-type
Examples
ConfigurationAssignments_List
az maintenance assignment list --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdtest1" --resource-type "virtualMachineScaleSets"
Required Parameters
Resource provider name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Resource identifier.
Resource type.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment list-parent
List configurationAssignments for resource.
az maintenance assignment list-parent [--ids]
[--provider-name]
[--resource-group]
[--resource-name]
[--resource-parent-name]
[--resource-parent-type]
[--resource-type]
[--subscription]
Examples
ConfigurationAssignments_ListParent
az maintenance assignment list-parent --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdtestvm1" --resource-parent-name "smdtest1" --resource-parent-type "virtualMachineScaleSets" --resource-type "virtualMachines"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 provider name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment list-subscription
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List configuration assignment within a subscription.
az maintenance assignment list-subscription
Examples
ConfigurationAssignments_List
az maintenance assignment list-subscription
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment show
Get configuration assignment for resource..
az maintenance assignment show [--configuration-assignment-name --name]
[--ids]
[--provider-name]
[--resource-group]
[--resource-name]
[--resource-type]
[--subscription]
Examples
ConfigurationAssignments_Get
az maintenance assignment show --name "workervmConfiguration" --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdtest1" --resource-type "virtualMachineScaleSets"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 provider name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment show-parent
Get configuration assignment for resource..
az maintenance assignment show-parent [--configuration-assignment-name --name]
[--ids]
[--provider-name]
[--resource-group]
[--resource-name]
[--resource-parent-name]
[--resource-parent-type]
[--resource-type]
[--subscription]
Examples
ConfigurationAssignments_GetParent
az maintenance assignment show-parent --name "workervmPolicy" --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdvm1" --resource-parent- name "smdtest1" --resource-parent-type "virtualMachineScaleSets" --resource-type "virtualMachines"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 provider name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment show-resource-group
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get configuration assignment for resource..
az maintenance assignment show-resource-group [--configuration-assignment-name --name]
[--ids]
[--resource-group]
[--subscription]
Examples
ConfigurationAssignments_GetResourceGroup
az maintenance assignment show-subscription --resource-group "examplerg" --name "example1"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment show-subscription
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get configuration assignment for resource..
az maintenance assignment show-subscription [--configuration-assignment-name --name]
[--ids]
[--subscription]
Examples
ConfigurationAssignments_GetSubscription
az maintenance assignment show-subscription --name "example1"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment update
Update configuration for resource.
az maintenance assignment update [--add]
[--config-id --maintenance-configuration-id]
[--configuration-assignment-name --name]
[--filter-locations]
[--filter-os-types]
[--filter-resource-groups]
[--filter-resource-types]
[--filter-tags]
[--filter-tags-operator {All, Any}]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--location]
[--provider-name]
[--remove]
[--resource-group]
[--resource-id]
[--resource-name]
[--resource-type]
[--set]
[--subscription]
Examples
ConfigurationAssignments_Update
az maintenance assignment update --maintenance-configuration-id "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" --name "workervmConfiguration" --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdtest1" --resource-type "virtualMachineScaleSets"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
The maintenance configuration Id.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
List of locations to scope the query to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed operating systems. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resource groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
Dictionary of tags with its list of values. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Filter VMs by Any or All specified tags.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Accepted values: | All, Any |
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 |
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 |
Location of the resource.
Property | Value |
---|---|
Parameter group: | ConfigurationAssignment Arguments |
Resource provider name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The unique resourceId.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment update-parent
Update configuration for resource.
az maintenance assignment update-parent [--config-id --maintenance-configuration-id]
[--configuration-assignment-name --name]
[--filter-locations]
[--filter-os-types]
[--filter-resource-groups]
[--filter-resource-types]
[--filter-tags]
[--filter-tags-operator {All, Any}]
[--ids]
[--location]
[--provider-name]
[--resource-group]
[--resource-id]
[--resource-name]
[--resource-parent-name]
[--resource-parent-type]
[--resource-type]
[--subscription]
Examples
ConfigurationAssignments_UpdateParent
az maintenance assignment update-parent --maintenance-configuration-id "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1" --name "workervmPolicy" --provider-name "Microsoft.Compute" --resource-group "examplerg" --resource-name "smdvm1" --resource-parent-name "smdtest1" --resource-parent-type "virtualMachineScaleSets" --resource-type "virtualMachines"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The maintenance configuration Id.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
List of locations to scope the query to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed operating systems. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resource groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
Dictionary of tags with its list of values. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Filter VMs by Any or All specified tags.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Accepted values: | All, Any |
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 |
Location of the resource.
Property | Value |
---|---|
Parameter group: | ConfigurationAssignment Arguments |
Resource provider name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The unique resourceId.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent identifier.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource parent type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment update-resource-group
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update configuration for resource.
az maintenance assignment update-resource-group [--config-id --maintenance-configuration-id]
[--configuration-assignment-name --name]
[--filter-locations]
[--filter-os-types]
[--filter-resource-groups]
[--filter-resource-types]
[--filter-tags]
[--filter-tags-operator {All, Any}]
[--ids]
[--location]
[--resource-group]
[--resource-id]
[--subscription]
Examples
ConfigurationAssignments_UpdateResourceGroup
az maintenance assignment create-or-update-resource-group --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1" --name assignmentname --filter-locations eastus2euap centraluseuap --filter-os-types windows linux --filter-tags "{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}" --filter-tags-operator All --resource-group examplerg1
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The maintenance configuration Id.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
List of locations to scope the query to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed operating systems. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resource groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
Dictionary of tags with its list of values. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Filter VMs by Any or All specified tags.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Accepted values: | All, Any |
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 |
Location of the resource.
Property | Value |
---|---|
Parameter group: | ConfigurationAssignment Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The unique resourceId.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az maintenance assignment update-subscription
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update configuration for resource.
az maintenance assignment update-subscription [--config-id --maintenance-configuration-id]
[--configuration-assignment-name --name]
[--filter-locations]
[--filter-os-types]
[--filter-resource-groups]
[--filter-resource-types]
[--filter-tags]
[--filter-tags-operator {All, Any}]
[--ids]
[--location]
[--resource-id]
[--subscription]
Examples
ConfigurationAssignments_UpdateSubscription
az maintenance assignment update-subscription --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1" --name assignmentname --filter-locations eastus2euap centraluseuap --filter-os-types windows linux --filter-tags "{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}" --filter-tags-operator All
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The maintenance configuration Id.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Configuration assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
List of locations to scope the query to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed operating systems. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resource groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
List of allowed resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Filter Arguments |
Dictionary of tags with its list of values. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Filter VMs by Any or All specified tags.
Property | Value |
---|---|
Parameter group: | FilterTagSettings Arguments |
Accepted values: | All, Any |
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 |
Location of the resource.
Property | Value |
---|---|
Parameter group: | ConfigurationAssignment Arguments |
The unique resourceId.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |