Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Using the Azure CLI command, az connectedmachine run-command, you can securely execute scripts or commands on Arc-enabled virtual machines without connecting directly to them through Remote Desktop Protocol or SSH.
This article provides examples that use az connectedmachine run-command to help you understand how to use the Azure CLI to execute scripts or commands on your Arc-enabled server.
Prerequisites
- The Connected Machine agent version on the Arc-enabled server must be 1.33 or higher.
Azure CLI sample requests
The following examples use az connectedmachine run-command to run a shell script on an Arc-enabled server.
Execute a script on a machine
This command delivers the script to the machine, executes it, and returns the captured output.
az connectedmachine run-command create --name "myRunCommand" --machine-name "myMachine" --resource-group "myRG" --script "Write-Host Hello World!"
List all deployed Run command resources on a machine
This command returns a full list of previously deployed Run commands along with their properties.
az connectedmachine run-command list --machine-name "myMachine" --resource-group "myRG"
Get execution status and results
This command retrieves current execution progress for a Run command, including latest output, start/end time, exit code, and terminal state of the execution.
az connectedmachine run-command show --name "myRunCommand" --machine-name "myMachine" --resource-group "myRG"
Note
Output and error fields in instanceView is limited to the last 4 KB. To access the full output and error, you can forward the output and error data to storage append blobs using -outputBlobUri and -errorBlobUri parameters while executing the Run command.
Delete the Run command resource from a machine
This command removes the Run command resource previously deployed on the machine. If the script execution is still in progress, execution is terminated.
az connectedmachine run-command delete --name "myRunCommand" --machine-name "myMachine" --resource-group "myRG"