Microsoft.Compute virtualMachines/runCommands 2021-04-01
Article 12/09/2024
2 contributors
Feedback
In this article
Bicep resource definition
The virtualMachines/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.Compute/virtualMachines/runCommands resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2021-04-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
asyncExecution: bool
errorBlobUri: 'string'
outputBlobUri: 'string'
parameters: [
{
name: 'string'
value: 'string'
}
]
protectedParameters: [
{
name: 'string'
value: 'string'
}
]
runAsPassword: 'string'
runAsUser: 'string'
source: {
commandId: 'string'
script: 'string'
scriptUri: 'string'
}
timeoutInSeconds: int
}
tags: {
{customized property}: 'string'
}
}
Property values
Microsoft.Compute/virtualMachines/runCommands
Name
Description
Value
location
Resource location
string (required)
name
The resource name
string (required)
parent
In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.Child resource outside parent resource .
Symbolic name for resource of type: virtualMachines
properties
Describes the properties of a Virtual Machine run command.
VirtualMachineRunCommandProperties
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
Name
Description
Value
name
The run command parameter name.
string (required)
value
The run command parameter value.
string (required)
VirtualMachineRunCommandProperties
Name
Description
Value
asyncExecution
Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
bool
errorBlobUri
Specifies the Azure storage blob where script error stream will be uploaded.
string
outputBlobUri
Specifies the Azure storage blob where script output stream will be uploaded.
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 VM when executing the run command.
string
runAsUser
Specifies the user account on the VM when executing the run command.
string
source
The source of the run command script.
VirtualMachineRunCommandScriptSource
timeoutInSeconds
The timeout in seconds to execute the run command.
int
VirtualMachineRunCommandScriptSource
Name
Description
Value
commandId
Specifies a commandId of predefined built-in script.
string
script
Specifies the script content to be executed on the VM.
string
scriptUri
Specifies the script download location.
string
Quickstart samples
The following quickstart samples deploy this resource type.
Bicep File
Description
GitLab Omnibus This template simplifies the deployment of GitLab Omnibus on a Virtual Machine with a public DNS, leveraging the public IP's DNS. It utilizes the Standard_F8s_v2 instance size, which aligns with reference architecture and supports up to 1000 users (20 RPS). The instance is pre-configured to use HTTPS with a Let's Encrypt certificate for secure connections.
SharePoint Subscription / 2019 / 2016 fully configured Create a DC, a SQL Server 2022, and from 1 to 5 server(s) hosting a SharePoint Subscription / 2019 / 2016 farm with an extensive configuration, including trusted authentication, user profiles with personal sites, an OAuth trust (using a certificate), a dedicated IIS site for hosting high-trust add-ins, etc... The latest version of key softwares (including Fiddler, vscode, np++, 7zip, ULS Viewer) is installed. SharePoint machines have additional fine-tuning to make them immediately usable (remote administration tools, custom policies for Edge and Chrome, shortcuts, etc...).
ARM template resource definition
The virtualMachines/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.Compute/virtualMachines/runCommands resource, add the following JSON to your template.
{
"type": "Microsoft.Compute/virtualMachines/runCommands",
"apiVersion": "2021-04-01",
"name": "string",
"location": "string",
"properties": {
"asyncExecution": "bool",
"errorBlobUri": "string",
"outputBlobUri": "string",
"parameters": [
{
"name": "string",
"value": "string"
}
],
"protectedParameters": [
{
"name": "string",
"value": "string"
}
],
"runAsPassword": "string",
"runAsUser": "string",
"source": {
"commandId": "string",
"script": "string",
"scriptUri": "string"
},
"timeoutInSeconds": "int"
},
"tags": {
"{customized property}": "string"
}
}
Property values
Microsoft.Compute/virtualMachines/runCommands
Name
Description
Value
apiVersion
The api version
'2021-04-01'
location
Resource location
string (required)
name
The resource name
string (required)
properties
Describes the properties of a Virtual Machine run command.
VirtualMachineRunCommandProperties
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
type
The resource type
'Microsoft.Compute/virtualMachines/runCommands'
Name
Description
Value
name
The run command parameter name.
string (required)
value
The run command parameter value.
string (required)
VirtualMachineRunCommandProperties
Name
Description
Value
asyncExecution
Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
bool
errorBlobUri
Specifies the Azure storage blob where script error stream will be uploaded.
string
outputBlobUri
Specifies the Azure storage blob where script output stream will be uploaded.
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 VM when executing the run command.
string
runAsUser
Specifies the user account on the VM when executing the run command.
string
source
The source of the run command script.
VirtualMachineRunCommandScriptSource
timeoutInSeconds
The timeout in seconds to execute the run command.
int
VirtualMachineRunCommandScriptSource
Name
Description
Value
commandId
Specifies a commandId of predefined built-in script.
string
script
Specifies the script content to be executed on the VM.
string
scriptUri
Specifies the script download location.
string
Quickstart templates
The following quickstart templates deploy this resource type.
Template
Description
GitLab Omnibus This template simplifies the deployment of GitLab Omnibus on a Virtual Machine with a public DNS, leveraging the public IP's DNS. It utilizes the Standard_F8s_v2 instance size, which aligns with reference architecture and supports up to 1000 users (20 RPS). The instance is pre-configured to use HTTPS with a Let's Encrypt certificate for secure connections.
SharePoint Subscription / 2019 / 2016 fully configured Create a DC, a SQL Server 2022, and from 1 to 5 server(s) hosting a SharePoint Subscription / 2019 / 2016 farm with an extensive configuration, including trusted authentication, user profiles with personal sites, an OAuth trust (using a certificate), a dedicated IIS site for hosting high-trust add-ins, etc... The latest version of key softwares (including Fiddler, vscode, np++, 7zip, ULS Viewer) is installed. SharePoint machines have additional fine-tuning to make them immediately usable (remote administration tools, custom policies for Edge and Chrome, shortcuts, etc...).
The virtualMachines/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.Compute/virtualMachines/runCommands resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/virtualMachines/runCommands@2021-04-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
asyncExecution = bool
errorBlobUri = "string"
outputBlobUri = "string"
parameters = [
{
name = "string"
value = "string"
}
]
protectedParameters = [
{
name = "string"
value = "string"
}
]
runAsPassword = "string"
runAsUser = "string"
source = {
commandId = "string"
script = "string"
scriptUri = "string"
}
timeoutInSeconds = int
}
})
}
Property values
Microsoft.Compute/virtualMachines/runCommands
Name
Description
Value
location
Resource location
string (required)
name
The resource name
string (required)
parent_id
The ID of the resource that is the parent for this resource.
ID for resource of type: virtualMachines
properties
Describes the properties of a Virtual Machine run command.
VirtualMachineRunCommandProperties
tags
Resource tags
Dictionary of tag names and values.
type
The resource type
"Microsoft.Compute/virtualMachines/runCommands@2021-04-01"
Name
Description
Value
name
The run command parameter name.
string (required)
value
The run command parameter value.
string (required)
VirtualMachineRunCommandProperties
Name
Description
Value
asyncExecution
Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
bool
errorBlobUri
Specifies the Azure storage blob where script error stream will be uploaded.
string
outputBlobUri
Specifies the Azure storage blob where script output stream will be uploaded.
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 VM when executing the run command.
string
runAsUser
Specifies the user account on the VM when executing the run command.
string
source
The source of the run command script.
VirtualMachineRunCommandScriptSource
timeoutInSeconds
The timeout in seconds to execute the run command.
int
VirtualMachineRunCommandScriptSource
Name
Description
Value
commandId
Specifies a commandId of predefined built-in script.
string
script
Specifies the script content to be executed on the VM.
string
scriptUri
Specifies the script download location.
string
