az vm run-command invoke returns "This is a sample script with parameters " after update 2.78.0

[gergroen]

Describe the bug

az version
$vmId = "<vm-id>"
$azResult = az vm run-command invoke --ids $vmId --scripts "Write-Host 'Test 123'" --command-id RunPowerShellScript
$azResult

Result version 2.77.0:

az version
{
  "azure-cli": "2.77.0",
  "azure-cli-core": "2.77.0",
  "azure-cli-telemetry": "1.1.0",
  "extensions": {}
}
$vmId = "<vm-id>"
$azResult = az vm run-command invoke --ids $vmId --scripts "Write-Host 'Test 123'" --command-id RunPowerShellScript
$azResult
{
  "value": [
    {
      "code": "ComponentStatus/StdOut/succeeded",
      "displayStatus": "Provisioning succeeded",
      "level": "Info",
      "message": "Test 123",
      "time": null
    },
    {
      "code": "ComponentStatus/StdErr/succeeded",
      "displayStatus": "Provisioning succeeded",
      "level": "Info",
      "message": "",
      "time": null
    }
  ]
}

Result version 2.78.0:

az version
{
  "azure-cli": "2.78.0",
  "azure-cli-core": "2.78.0",
  "azure-cli-telemetry": "1.1.0",
  "extensions": {}
}
$vmId = "<vm-id>"
$azResult = az vm run-command invoke --ids $vmId --scripts "Write-Host 'Test 123'" --command-id RunPowerShellScript
$azResult
{
  "value": [
    {
      "code": "ComponentStatus/StdOut/succeeded",
      "displayStatus": "Provisioning succeeded",
      "level": "Info",
      "message": "This is a sample script with parameters  "
    },
    {
      "code": "ComponentStatus/StdErr/succeeded",
      "displayStatus": "Provisioning succeeded",
      "level": "Info",
      "message": ""
    }
  ]
}

Related command

az version
$vmId = ""
$azResult = az vm run-command invoke --ids $vmId --scripts "Write-Host 'Test 123'" --command-id RunPowerShellScript
$azResult

Errors

'This is a sample script with parameters ' instead of 'Test 123' in result

Issue script & Debug output

az version
$vmId = "<vm-id>"
$azResult = az vm run-command invoke --ids $vmId --scripts "Write-Host 'Test 123'" --command-id RunPowerShellScript
$azResult

Result version 2.78.0:

az version
{
  "azure-cli": "2.78.0",
  "azure-cli-core": "2.78.0",
  "azure-cli-telemetry": "1.1.0",
  "extensions": {}
}
$vmId = "<vm-id>"
$azResult = az vm run-command invoke --ids $vmId --scripts "Write-Host 'Test 123'" --command-id RunPowerShellScript
$azResult
{
  "value": [
    {
      "code": "ComponentStatus/StdOut/succeeded",
      "displayStatus": "Provisioning succeeded",
      "level": "Info",
      "message": "This is a sample script with parameters  "
    },
    {
      "code": "ComponentStatus/StdErr/succeeded",
      "displayStatus": "Provisioning succeeded",
      "level": "Info",
      "message": ""
    }
  ]
}

Expected behavior

Result version 2.77.0:

az version
{
  "azure-cli": "2.77.0",
  "azure-cli-core": "2.77.0",
  "azure-cli-telemetry": "1.1.0",
  "extensions": {}
}
$vmId = "<vm-id>"
$azResult = az vm run-command invoke --ids $vmId --scripts "Write-Host 'Test 123'" --command-id RunPowerShellScript
$azResult
{
  "value": [
    {
      "code": "ComponentStatus/StdOut/succeeded",
      "displayStatus": "Provisioning succeeded",
      "level": "Info",
      "message": "Test 123",
      "time": null
    },
    {
      "code": "ComponentStatus/StdErr/succeeded",
      "displayStatus": "Provisioning succeeded",
      "level": "Info",
      "message": "",
      "time": null
    }
  ]
}

Environment Summary

azure-cli 2.78.0

Additional context

No response

[yonzhan]

Thank you for opening this issue, we will look into it.

[github-actions]

Here are some similar issues that might help you. Please check if they can solve your problem.

• az vm run-command invoke produces cached output #5833

---

Possible solution (Extracted from existing issue, might be incorrect; please verify carefully)

Solution 1:

The workaround for now is to directly use the az vm extension set and then use the get-instance-view to retrieve the output:

az vm extension set -g tg --vm-name vm1 -n customScript --publisher Microsoft.Azure.Extensions --settings "{\"commandToExecute\": \"date\"}" --version 2.0
az vm get-instance-view -g rg -n vm1 --query "instanceView.extensions|[?type=='Microsoft.Azure.Extensions.customScript']|[0].statuses[0].message"

Reference:

• az vm run-command invoke produces cached output #5833 (comment)

Solution 2:

As a workaround, you should always change the script (maybe add an empty line at the end) to force re-execution. Currently, we detect no changes in the script and we don't execute it again. This was a bug on our side that we are fixing now.

Reference:

• az vm run-command invoke produces cached output #5833 (comment)

Powered by issue-sentinel

[aa2811]

I think I've found the issue: there's been some refactoring of this command, and I think it's broken how the --scripts parameter is being passed in.

I am not familiar with how the CLI works internally, but my best guess is:

When az vm run-command invoke is run, this function gets invoked with the CLI args:
custom.py#L2816

That passes through to the run_command_invoke function: custom.py#L2776

Which calls

Invoke(cli_ctx=cmd.cli_ctx)(command_args={
        'resource_group': resource_group_name,
        'vm_name': vm_vmss_name,
        'command_id': command_id,
        'scripts': scripts,
        'parameters': params
    })

But the corresponding class definition for Invoke takes script, not scripts: _invoke.py#L199

So it's not getting passed through and using the default value, and this command is completely broken.

I do have to question the level of regression testing you're doing here...