az automanage configuration-profile-assignment vm

Reference

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-assignment vm command. Learn more about extensions.

Manage association between a VM and Automanage configuration profile.

Commands

Name	Description	Type	Status
az automanage configuration-profile-assignment vm create	Create an association between a VM and Automanage configuration profile.	Extension	GA
az automanage configuration-profile-assignment vm delete	Delete an association between a VM and Automanage configuration profile.	Extension	GA
az automanage configuration-profile-assignment vm report	Manage report within a given VM configuration profile assignment.	Extension	GA
az automanage configuration-profile-assignment vm report list	List reports within a given VM configuration profile assignment.	Extension	GA
az automanage configuration-profile-assignment vm report show	Get information about a report associated with a VM configuration profile assignment run.	Extension	GA
az automanage configuration-profile-assignment vm show	Get information about an association between a VM and Automanage configuration profile.	Extension	GA
az automanage configuration-profile-assignment vm update	Update an association between a VM and Automanage configuration profile.	Extension	GA

az automanage configuration-profile-assignment vm create

Create an association between a VM and Automanage configuration profile.

az automanage configuration-profile-assignment vm create --configuration-profile-assignment-name
                                                         --resource-group
                                                         --vm-name
                                                         [--configuration-profile]

Examples

create configuration-profile-assignment for vm

az automanage configuration-profile-assignment vm create -n default -g {rg} --vm-name {vm_name} --configuration-profile {profile_id}

Required Parameters

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

Name of the configuration profile assignment. Only default is supported.

--resource-group -g

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

--vm-name

The name of the virtual machine.

Optional Parameters

--configuration-profile

The Automanage configurationProfile ARM Resource URI.

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

Delete an association between a VM and Automanage configuration profile.

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

Examples

delete configuration-profile-assignment for vm

az automanage configuration-profile-assignment vm delete -n default -g {rg} --vm-name {vm_name}

Optional Parameters

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

Name of the configuration profile assignment.

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

--resource-group -g

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

--subscription

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

--vm-name

The name of the virtual machine.

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

Get information about an association between a VM and Automanage configuration profile.

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

Examples

show configuration-profile-assignment vm

az automanage configuration-profile-assignment vm show -n default -g {rg} --vm-name {vm_name}

Optional Parameters

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

The configuration profile assignment name.

--ids

--resource-group -g

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

--subscription

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

--vm-name

The name of the virtual machine.

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

Update an association between a VM and Automanage configuration profile.

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

Examples

update configuration-profile-assignment vm

az automanage configuration-profile-assignment vm update --n default -g {rg} --vm-name {vm_name} --configuration-profile {profile_id_2}

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

--configuration-profile

The Automanage configurationProfile ARM Resource URI.

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

The configuration profile assignment name.

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

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

--set

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

--subscription

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

--vm-name

The name of the virtual machine.

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.

Share via

az automanage configuration-profile-assignment vm

Commands

az automanage configuration-profile-assignment vm create

Examples

Required Parameters

Optional Parameters

az automanage configuration-profile-assignment vm delete

Examples

Optional Parameters

az automanage configuration-profile-assignment vm show

Examples

Optional Parameters

az automanage configuration-profile-assignment vm update

Examples

Optional Parameters

Feedback

Additional resources