The machines/runCommands resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.HybridCompute/machines/runCommands resource, add the following JSON to your template.
{
"type": "Microsoft.HybridCompute/machines/runCommands",
"apiVersion": "2023-10-03-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"asyncExecution": "bool",
"errorBlobManagedIdentity": {
"clientId": "string",
"objectId": "string"
},
"errorBlobUri": "string",
"outputBlobManagedIdentity": {
"clientId": "string",
"objectId": "string"
},
"outputBlobUri": "string",
"parameters": [
{
"name": "string",
"value": "string"
}
],
"protectedParameters": [
{
"name": "string",
"value": "string"
}
],
"runAsPassword": "string",
"runAsUser": "string",
"source": {
"commandId": "string",
"script": "string",
"scriptUri": "string",
"scriptUriManagedIdentity": {
"clientId": "string",
"objectId": "string"
}
},
"timeoutInSeconds": "int"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.HybridCompute/machines/runCommands' |
apiVersion | The resource api version | '2023-10-03-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
location | The geo-location where the resource lives | string (required) |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
properties | Describes Run Command Properties | MachineRunCommandProperties |
Name | Description | Value |
---|---|---|
asyncExecution | Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete. | bool |
errorBlobManagedIdentity | User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged |
RunCommandManagedIdentity |
errorBlobUri | Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter. | string |
outputBlobManagedIdentity | User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged |
RunCommandManagedIdentity |
outputBlobUri | Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. | string |
parameters | The parameters used by the script. | RunCommandInputParameter[] |
protectedParameters | The parameters used by the script. | RunCommandInputParameter[] |
runAsPassword | Specifies the user account password on the machine when executing the run command. | string Constraints: Sensitive value. Pass in as a secure parameter. |
runAsUser | Specifies the user account on the machine when executing the run command. | string |
source | The source of the run command script. | MachineRunCommandScriptSource |
timeoutInSeconds | The timeout in seconds to execute the run command. | int |
Name | Description | Value |
---|---|---|
clientId | Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. | string |
objectId | Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. | string |
Name | Description | Value |
---|---|---|
name | The run command parameter name. | string (required) |
value | The run command parameter value. | string (required) |
Name | Description | Value |
---|---|---|
commandId | Specifies the commandId of predefined built-in script. | string |
script | Specifies the script content to be executed on the machine. | string |
scriptUri | Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. | string |
scriptUriManagedIdentity | User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. |
RunCommandManagedIdentity |