az automanage configuration-profile-assignment vm
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 --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
Name of the configuration profile assignment. Only default is supported.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the virtual machine.
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 Automanage configurationProfile ARM Resource URI.
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 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 --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of the configuration profile assignment.
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 |
The name of the virtual machine.
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 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 --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The configuration profile 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 |
The name of the virtual machine.
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 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 --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
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 Automanage configurationProfile ARM Resource URI.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The configuration profile assignment name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
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 |
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 |
The name of the virtual machine.
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 |