POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand/?api-version=2023-09-01
Run command on the VM.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
vmName |
String | Yes |
The name of the virtual machine. |
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resourceGroupName |
String | Yes |
The name of the resource group. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
commandId |
String | Yes |
The run command id. |
script[] |
Array | No |
Optional. The script to be executed. When this value is given, the given script will override the default script of the command. |
parameters[] |
Array | No |
The run command parameters. |
parameters[].name |
String | Yes |
The run command parameter name. |
parameters[].value |
String | Yes |
The run command parameter value. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.