az guestconfig guest-configuration-assignment
Guestconfig guest-configuration-assignment.
Commands
az guestconfig guest-configuration-assignment create |
Creates an association between a VM and guest configuration. |
az guestconfig guest-configuration-assignment delete |
Delete a guest configuration assignment. |
az guestconfig guest-configuration-assignment list |
List all guest configuration assignments for a virtual machine. |
az guestconfig guest-configuration-assignment show |
Get information about a guest configuration assignment. |
az guestconfig guest-configuration-assignment update |
Creates an association between a VM and guest configuration. |
az guestconfig guest-configuration-assignment wait |
Place the CLI in a waiting state until a condition of the guestconfig guest-configuration-assignment is met. |
az guestconfig guest-configuration-assignment create
Creates an association between a VM and guest configuration.
az guestconfig guest-configuration-assignment create --guest-configuration-assignment-name
--resource-group
--vm-name
[--context]
[--guest-configuration-configuration-parameter]
[--guest-configuration-configuration-setting]
[--guest-configuration-name]
[--guest-configuration-version]
[--latest-assignment-report-assignment]
[--location]
[--name]
[--no-wait]
Examples
Create or update guest configuration assignment
az guestconfig guest-configuration-assignment create --guest-configuration-assignment-name "WhitelistedApplication" --guest-configuration-name "WhitelistedApplication" --location "westcentralus" --context "Azure policy" --guest-configuration-name "WhitelistedApplication" --guest-configuration-configuration-parameter name="[InstalledApplication]bwhitelistedapp;Name" value="NotePad,sql" --guest-configuration-configuration-setting action-after-reboot="ContinueConfiguration" configuration-mode="MonitorOnly" configuration-mode-frequency-mins=15 reboot-if-needed="False" --guest-configuration-version "1.*" --resource-group "myResourceGroupName" --vm-name "myVMName"
Required Parameters
Name of the guest configuration assignment.
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 source which initiated the guest configuration assignment. Ex: Azure Policy.
The configuration parameters for the guest configuration.
The configuration setting for the guest configuration.
Name of the guest configuration.
Version of the guest configuration.
Configuration details of the guest configuration assignment. Expected value: json-string/@json-file.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name of the guest configuration assignment.
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az guestconfig guest-configuration-assignment delete
Delete a guest configuration assignment.
az guestconfig guest-configuration-assignment delete --name
--resource-group
--vm-name
[--no-wait]
Examples
Delete an guest configuration assignment
az guestconfig guest-configuration-assignment delete --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName"
Required Parameters
Name of the guest configuration assignment.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the virtual machine.
Optional Parameters
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az guestconfig guest-configuration-assignment list
List all guest configuration assignments for a virtual machine.
az guestconfig guest-configuration-assignment list --resource-group
--vm-name
Examples
List all guest configuration assignments for a virtual machine
az guestconfig guest-configuration-assignment list --resource-group "myResourceGroupName" --vm-name "myVMName"
Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the virtual machine.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az guestconfig guest-configuration-assignment show
Get information about a guest configuration assignment.
az guestconfig guest-configuration-assignment show --name
--resource-group
--vm-name
Examples
Get a guest configuration assignment
az guestconfig guest-configuration-assignment show --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName"
Required Parameters
The guest configuration assignment name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the virtual machine.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az guestconfig guest-configuration-assignment update
Creates an association between a VM and guest configuration.
az guestconfig guest-configuration-assignment update --guest-configuration-assignment-name
--resource-group
--vm-name
[--context]
[--guest-configuration-configuration-parameter]
[--guest-configuration-configuration-setting]
[--guest-configuration-name]
[--guest-configuration-version]
[--latest-assignment-report-assignment]
[--location]
[--name]
[--no-wait]
Examples
Create or update guest configuration assignment
az guestconfig guest-configuration-assignment update --guest-configuration-assignment-name "WhitelistedApplication" --guest-configuration-name "WhitelistedApplication" --location "westcentralus" --context "Azure policy" --guest-configuration-name "WhitelistedApplication" --guest-configuration-configuration-parameter name="[InstalledApplication]bwhitelistedapp;Name" value="NotePad,sql" --guest-configuration-configuration-setting action-after-reboot="ContinueConfiguration" configuration-mode="MonitorOnly" configuration-mode-frequency-mins=15 reboot-if-needed="False" --guest-configuration-version "1.*" --resource-group "myResourceGroupName" --vm-name "myVMName"
Required Parameters
Name of the guest configuration assignment.
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 source which initiated the guest configuration assignment. Ex: Azure Policy.
The configuration parameters for the guest configuration.
The configuration setting for the guest configuration.
Name of the guest configuration.
Version of the guest configuration.
Configuration details of the guest configuration assignment. Expected value: json-string/@json-file.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name of the guest configuration assignment.
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az guestconfig guest-configuration-assignment wait
Place the CLI in a waiting state until a condition of the guestconfig guest-configuration-assignment is met.
az guestconfig guest-configuration-assignment wait --name
--resource-group
--vm-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Examples
Pause executing next line of CLI script until the guestconfig guest-configuration-assignment is successfully created.
az guestconfig guest-configuration-assignment wait --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName" --created
Pause executing next line of CLI script until the guestconfig guest-configuration-assignment is successfully deleted.
az guestconfig guest-configuration-assignment wait --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName" --deleted
Required Parameters
The guest configuration assignment name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the virtual machine.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.