az automanage configuration-profile

Note

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

Manage configuration profile.

Commands

Name	Description	Type	Status
az automanage configuration-profile create	Create a configuration profile.	Extension	GA
az automanage configuration-profile delete	Delete a configuration profile.	Extension	GA
az automanage configuration-profile list	List configuration profiles within a subscription.	Extension	GA
az automanage configuration-profile show	Get information about a configuration profile.	Extension	GA
az automanage configuration-profile update	Update a configuration profile.	Extension	GA
az automanage configuration-profile version	Manage configuration profile version.	Extension	GA
az automanage configuration-profile version create	Create a configuration profile version.	Extension	GA
az automanage configuration-profile version delete	Delete a configuration profile version.	Extension	GA
az automanage configuration-profile version list	List configuration profile versions for a configuration profile.	Extension	GA
az automanage configuration-profile version show	Get information about a configuration profile version.	Extension	GA
az automanage configuration-profile version update	Update a configuration profile version.	Extension	GA

az automanage configuration-profile create

Create a configuration profile.

az automanage configuration-profile create --configuration-profile-name --name
                                           --resource-group
                                           [--configuration]
                                           [--location]
                                           [--tags]

Examples

create configuration-profile

az automanage configuration-profile create -n {profile_name} -g {rg} --configuration '{"Antimalware/Enable":false,"Backup/Enable":false,"VMInsights/Enable":true,"AzureSecurityCenter/Enable":true,"UpdateManagement/Enable":true,"ChangeTrackingAndInventory/Enable":true,"GuestConfiguration/Enable":true,"LogAnalytics/Enable":true,"BootDiagnostics/Enable":true}'

create with datatime array

az automanage configuration-profile create -n {profile_name} -g {rg} --configuration '{"Backup/SchedulePolicy/ScheduleRunTimes":["2023-02-10T18:25:43.511Z", "2023-02-12T01:02:03.456Z"],"Backup/RetentionPolicy/DailySchedule/RetentionTimes":["2023-02-10T18:25:43.511Z", "2023-02-12T01:02:03.456Z"]}'

Required Parameters

--configuration-profile-name --name -n

Name of the configuration profile.

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

--configuration

Configuration dictionary of the configuration profile. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Parameters Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters 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.

--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 automanage configuration-profile delete

Delete a configuration profile.

az automanage configuration-profile delete [--configuration-profile-name --name]
                                           [--ids]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Examples

delete configuration-profile

az automanage configuration-profile delete -n {profile_name} -g {rg}

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-profile-name --name -n

Name of the configuration profile.

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

--yes -y

Do not prompt for confirmation.

Property	Value
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

az automanage configuration-profile list

List configuration profiles within a subscription.

az automanage configuration-profile list [--resource-group]

Examples

list configuration-profile

az automanage configuration-profile list -g {rg}

Optional Parameters

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

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

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 automanage configuration-profile show

Get information about a configuration profile.

az automanage configuration-profile show [--configuration-profile-name --name]
                                         [--ids]
                                         [--resource-group]
                                         [--subscription]

Examples

show configuration-profile

az automanage configuration-profile show -n {profile_name} -g {rg}

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-profile-name --name -n

The configuration profile name.

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 automanage configuration-profile update

Update a configuration profile.

az automanage configuration-profile update [--add]
                                           [--configuration]
                                           [--configuration-profile-name --name]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ids]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]
                                           [--tags]

Examples

update configuration-profile

az automanage configuration-profile update -n {profile_name} -g {rg} --configuration '{"Antimalware/Enable":true,"VMInsights/Enable":false}'

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

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

--configuration

Configuration dictionary of the configuration profile. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--configuration-profile-name --name -n

The configuration profile name.

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

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

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters 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