az guestconfig guest-configuration-hcrp-assignment
Note
This reference is part of the guestconfig extension for the Azure CLI (version 2.3.1 or higher). The extension will automatically install the first time you run an az guestconfig guest-configuration-hcrp-assignment command. Learn more about extensions.
This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Guestconfig guest-configuration-hcrp-assignment.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az guestconfig guest-configuration-hcrp-assignment create |
Creates an association between a ARC machine and guest configuration. |
Extension | Experimental |
| az guestconfig guest-configuration-hcrp-assignment delete |
Delete a guest configuration assignment. |
Extension | Experimental |
| az guestconfig guest-configuration-hcrp-assignment list |
List all guest configuration assignments for an ARC machine. |
Extension | Experimental |
| az guestconfig guest-configuration-hcrp-assignment show |
Get information about a guest configuration assignment. |
Extension | Experimental |
| az guestconfig guest-configuration-hcrp-assignment update |
Creates an association between a ARC machine and guest configuration. |
Extension | Experimental |
| az guestconfig guest-configuration-hcrp-assignment wait |
Place the CLI in a waiting state until a condition of the guestconfig guest-configuration-hcrp-assignment is met. |
Extension | Experimental |
az guestconfig guest-configuration-hcrp-assignment create
Command group 'guestconfig guest-configuration-hcrp-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Creates an association between a ARC machine and guest configuration.
az guestconfig guest-configuration-hcrp-assignment create --guest-configuration-assignment-name
--machine-name
--resource-group
[--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-hcrp-assignment create --guest-configuration-assignment-name "WhitelistedApplication" --machine-name "myMachineName" --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"Required Parameters
Name of the guest configuration assignment.
The name of the ARC machine.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The source which initiated the guest configuration assignment. Ex: Azure Policy.
The configuration parameters for the guest configuration.
Usage: --guest-configuration-configuration-parameter name=XX value=XX
name: Name of the configuration parameter. value: Value of the configuration parameter.
Multiple actions can be specified by using more than one --guest-configuration-configuration-parameter argument.
The configuration setting for the guest configuration.
Usage: --guest-configuration-configuration-setting configuration-mode=XX allow-module-overwrite=XX action-after-reboot=XX refresh-frequency-mins=XX reboot-if-needed=XX configuration-mode-frequency-mins=XX
configuration-mode: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. allow-module-overwrite: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false action-after-reboot: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration refresh-frequency-mins: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. reboot-if-needed: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. configuration-mode-frequency-mins: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15.
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.
Global Parameters
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.
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.
az guestconfig guest-configuration-hcrp-assignment delete
Command group 'guestconfig guest-configuration-hcrp-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a guest configuration assignment.
az guestconfig guest-configuration-hcrp-assignment delete [--guest-configuration-assignment-name]
[--ids]
[--machine-name]
[--no-wait]
[--resource-group]
[--subscription]Examples
Delete an guest configuration assignment
az guestconfig guest-configuration-hcrp-assignment delete --guest-configuration-assignment-name "SecureProtocol" --machine-name "myMachineName" --resource-group "myResourceGroupName"Optional Parameters
Name of the guest configuration assignment.
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.
The name of the ARC machine.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
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.
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.
az guestconfig guest-configuration-hcrp-assignment list
Command group 'guestconfig guest-configuration-hcrp-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List all guest configuration assignments for an ARC machine.
az guestconfig guest-configuration-hcrp-assignment list --machine-name
--resource-groupExamples
List all guest configuration assignments for a virtual machine
az guestconfig guest-configuration-hcrp-assignment list --machine-name "myMachineName" --resource-group "myResourceGroupName"Required Parameters
The name of the ARC machine.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
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.
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.
az guestconfig guest-configuration-hcrp-assignment show
Command group 'guestconfig guest-configuration-hcrp-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get information about a guest configuration assignment.
az guestconfig guest-configuration-hcrp-assignment show [--guest-configuration-assignment-name]
[--ids]
[--machine-name]
[--resource-group]
[--subscription]Examples
Get a guest configuration assignment
az guestconfig guest-configuration-hcrp-assignment show --guest-configuration-assignment-name "SecureProtocol" --machine-name "myMachineName" --resource-group "myResourceGroupName"Optional Parameters
The guest configuration assignment name.
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.
The name of the ARC machine.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
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.
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.
az guestconfig guest-configuration-hcrp-assignment update
Command group 'guestconfig guest-configuration-hcrp-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Creates an association between a ARC machine and guest configuration.
az guestconfig guest-configuration-hcrp-assignment update [--context]
[--guest-configuration-assignment-name]
[--guest-configuration-configuration-parameter]
[--guest-configuration-configuration-setting]
[--guest-configuration-name]
[--guest-configuration-version]
[--ids]
[--latest-assignment-report-assignment]
[--location]
[--machine-name]
[--name]
[--no-wait]
[--resource-group]
[--subscription]Examples
Create or update guest configuration assignment
az guestconfig guest-configuration-hcrp-assignment update --guest-configuration-assignment-name "WhitelistedApplication" --machine-name "myMachineName" --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"Optional Parameters
The source which initiated the guest configuration assignment. Ex: Azure Policy.
Name of the guest configuration assignment.
The configuration parameters for the guest configuration.
Usage: --guest-configuration-configuration-parameter name=XX value=XX
name: Name of the configuration parameter. value: Value of the configuration parameter.
Multiple actions can be specified by using more than one --guest-configuration-configuration-parameter argument.
The configuration setting for the guest configuration.
Usage: --guest-configuration-configuration-setting configuration-mode=XX allow-module-overwrite=XX action-after-reboot=XX refresh-frequency-mins=XX reboot-if-needed=XX configuration-mode-frequency-mins=XX
configuration-mode: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. allow-module-overwrite: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false action-after-reboot: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration refresh-frequency-mins: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. reboot-if-needed: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. configuration-mode-frequency-mins: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15.
Name of the guest configuration.
Version of the guest configuration.
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.
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>.
The name of the ARC machine.
Name of the guest configuration assignment.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
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.
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.
az guestconfig guest-configuration-hcrp-assignment wait
Command group 'guestconfig guest-configuration-hcrp-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition of the guestconfig guest-configuration-hcrp-assignment is met.
az guestconfig guest-configuration-hcrp-assignment wait [--created]
[--custom]
[--deleted]
[--exists]
[--guest-configuration-assignment-name]
[--ids]
[--interval]
[--machine-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Examples
Pause executing next line of CLI script until the guestconfig guest-configuration-hcrp-assignment is successfully created.
az guestconfig guest-configuration-hcrp-assignment wait --guest-configuration-assignment-name "SecureProtocol" --machine-name "myMachineName" --resource-group "myResourceGroupName" --createdPause executing next line of CLI script until the guestconfig guest-configuration-hcrp-assignment is successfully deleted.
az guestconfig guest-configuration-hcrp-assignment wait --guest-configuration-assignment-name "SecureProtocol" --machine-name "myMachineName" --resource-group "myResourceGroupName" --deletedOptional 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.
The guest configuration assignment name.
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.
Polling interval in seconds.
The name of the ARC machine.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
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.
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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for