Docs Home
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
azure-native-v2.compute.VirtualMachineRunCommandByVirtualMachine
Explore with Pulumi AI
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
Describes a Virtual Machine run command. Azure REST API version: 2023-03-01. Prior API version in Azure Native 1.x: 2021-03-01.
Other available API versions: 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01.
Create VirtualMachineRunCommandByVirtualMachine Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VirtualMachineRunCommandByVirtualMachine(name: string, args: VirtualMachineRunCommandByVirtualMachineArgs, opts?: CustomResourceOptions);@overload
def VirtualMachineRunCommandByVirtualMachine(resource_name: str,
args: VirtualMachineRunCommandByVirtualMachineArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VirtualMachineRunCommandByVirtualMachine(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
vm_name: Optional[str] = None,
output_blob_managed_identity: Optional[RunCommandManagedIdentityArgs] = None,
run_as_password: Optional[str] = None,
async_execution: Optional[bool] = None,
output_blob_uri: Optional[str] = None,
parameters: Optional[Sequence[RunCommandInputParameterArgs]] = None,
protected_parameters: Optional[Sequence[RunCommandInputParameterArgs]] = None,
error_blob_uri: Optional[str] = None,
location: Optional[str] = None,
run_as_user: Optional[str] = None,
run_command_name: Optional[str] = None,
source: Optional[VirtualMachineRunCommandScriptSourceArgs] = None,
tags: Optional[Mapping[str, str]] = None,
timeout_in_seconds: Optional[int] = None,
treat_failure_as_deployment_failure: Optional[bool] = None,
error_blob_managed_identity: Optional[RunCommandManagedIdentityArgs] = None)func NewVirtualMachineRunCommandByVirtualMachine(ctx *Context, name string, args VirtualMachineRunCommandByVirtualMachineArgs, opts ...ResourceOption) (*VirtualMachineRunCommandByVirtualMachine, error)public VirtualMachineRunCommandByVirtualMachine(string name, VirtualMachineRunCommandByVirtualMachineArgs args, CustomResourceOptions? opts = null)public VirtualMachineRunCommandByVirtualMachine(String name, VirtualMachineRunCommandByVirtualMachineArgs args)
public VirtualMachineRunCommandByVirtualMachine(String name, VirtualMachineRunCommandByVirtualMachineArgs args, CustomResourceOptions options)
type: azure-native:compute:VirtualMachineRunCommandByVirtualMachine
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. VirtualMachineRunCommandByVirtualMachineArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. VirtualMachineRunCommandByVirtualMachineArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. VirtualMachineRunCommandByVirtualMachineArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. VirtualMachineRunCommandByVirtualMachineArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. VirtualMachineRunCommandByVirtualMachineArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var virtualMachineRunCommandByVirtualMachineResource = new AzureNative.Compute.VirtualMachineRunCommandByVirtualMachine("virtualMachineRunCommandByVirtualMachineResource", new()
{
ResourceGroupName = "string",
VmName = "string",
OutputBlobManagedIdentity =
{
{ "clientId", "string" },
{ "objectId", "string" },
},
RunAsPassword = "string",
AsyncExecution = false,
OutputBlobUri = "string",
Parameters = new[]
{
{
{ "name", "string" },
{ "value", "string" },
},
},
ProtectedParameters = new[]
{
{
{ "name", "string" },
{ "value", "string" },
},
},
ErrorBlobUri = "string",
Location = "string",
RunAsUser = "string",
RunCommandName = "string",
Source =
{
{ "commandId", "string" },
{ "script", "string" },
{ "scriptUri", "string" },
{ "scriptUriManagedIdentity",
{
{ "clientId", "string" },
{ "objectId", "string" },
} },
},
Tags =
{
{ "string", "string" },
},
TimeoutInSeconds = 0,
TreatFailureAsDeploymentFailure = false,
ErrorBlobManagedIdentity =
{
{ "clientId", "string" },
{ "objectId", "string" },
},
});
example, err := compute.NewVirtualMachineRunCommandByVirtualMachine(ctx, "virtualMachineRunCommandByVirtualMachineResource", &compute.VirtualMachineRunCommandByVirtualMachineArgs{
ResourceGroupName: "string",
VmName: "string",
OutputBlobManagedIdentity: map[string]interface{}{
"clientId": "string",
"objectId": "string",
},
RunAsPassword: "string",
AsyncExecution: false,
OutputBlobUri: "string",
Parameters: []map[string]interface{}{
map[string]interface{}{
"name": "string",
"value": "string",
},
},
ProtectedParameters: []map[string]interface{}{
map[string]interface{}{
"name": "string",
"value": "string",
},
},
ErrorBlobUri: "string",
Location: "string",
RunAsUser: "string",
RunCommandName: "string",
Source: map[string]interface{}{
"commandId": "string",
"script": "string",
"scriptUri": "string",
"scriptUriManagedIdentity": map[string]interface{}{
"clientId": "string",
"objectId": "string",
},
},
Tags: map[string]interface{}{
"string": "string",
},
TimeoutInSeconds: 0,
TreatFailureAsDeploymentFailure: false,
ErrorBlobManagedIdentity: map[string]interface{}{
"clientId": "string",
"objectId": "string",
},
})
var virtualMachineRunCommandByVirtualMachineResource = new VirtualMachineRunCommandByVirtualMachine("virtualMachineRunCommandByVirtualMachineResource", VirtualMachineRunCommandByVirtualMachineArgs.builder()
.resourceGroupName("string")
.vmName("string")
.outputBlobManagedIdentity(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.runAsPassword("string")
.asyncExecution(false)
.outputBlobUri("string")
.parameters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.protectedParameters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.errorBlobUri("string")
.location("string")
.runAsUser("string")
.runCommandName("string")
.source(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.timeoutInSeconds(0)
.treatFailureAsDeploymentFailure(false)
.errorBlobManagedIdentity(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
virtual_machine_run_command_by_virtual_machine_resource = azure_native.compute.VirtualMachineRunCommandByVirtualMachine("virtualMachineRunCommandByVirtualMachineResource",
resource_group_name=string,
vm_name=string,
output_blob_managed_identity={
clientId: string,
objectId: string,
},
run_as_password=string,
async_execution=False,
output_blob_uri=string,
parameters=[{
name: string,
value: string,
}],
protected_parameters=[{
name: string,
value: string,
}],
error_blob_uri=string,
location=string,
run_as_user=string,
run_command_name=string,
source={
commandId: string,
script: string,
scriptUri: string,
scriptUriManagedIdentity: {
clientId: string,
objectId: string,
},
},
tags={
string: string,
},
timeout_in_seconds=0,
treat_failure_as_deployment_failure=False,
error_blob_managed_identity={
clientId: string,
objectId: string,
})
const virtualMachineRunCommandByVirtualMachineResource = new azure_native.compute.VirtualMachineRunCommandByVirtualMachine("virtualMachineRunCommandByVirtualMachineResource", {
resourceGroupName: "string",
vmName: "string",
outputBlobManagedIdentity: {
clientId: "string",
objectId: "string",
},
runAsPassword: "string",
asyncExecution: false,
outputBlobUri: "string",
parameters: [{
name: "string",
value: "string",
}],
protectedParameters: [{
name: "string",
value: "string",
}],
errorBlobUri: "string",
location: "string",
runAsUser: "string",
runCommandName: "string",
source: {
commandId: "string",
script: "string",
scriptUri: "string",
scriptUriManagedIdentity: {
clientId: "string",
objectId: "string",
},
},
tags: {
string: "string",
},
timeoutInSeconds: 0,
treatFailureAsDeploymentFailure: false,
errorBlobManagedIdentity: {
clientId: "string",
objectId: "string",
},
});
type: azure-native:compute:VirtualMachineRunCommandByVirtualMachine
properties:
asyncExecution: false
errorBlobManagedIdentity:
clientId: string
objectId: string
errorBlobUri: string
location: string
outputBlobManagedIdentity:
clientId: string
objectId: string
outputBlobUri: string
parameters:
- name: string
value: string
protectedParameters:
- name: string
value: string
resourceGroupName: string
runAsPassword: string
runAsUser: string
runCommandName: string
source:
commandId: string
script: string
scriptUri: string
scriptUriManagedIdentity:
clientId: string
objectId: string
tags:
string: string
timeoutInSeconds: 0
treatFailureAsDeploymentFailure: false
vmName: string
VirtualMachineRunCommandByVirtualMachine Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The VirtualMachineRunCommandByVirtualMachine resource accepts the following input properties:
- Resource
Group Name stringThis property is required. 
Changes to this property will trigger replacement. - The name of the resource group.
- Vm
Name stringThis property is required. Changes to this property will trigger replacement. - The name of the virtual machine where the run command should be created or updated.
- Async
Execution bool - Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- Error
Blob Pulumi.Managed Identity Azure Native. Compute. Inputs. Run Command Managed Identity - 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
- Error
Blob stringUri - 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.
- Location string
- Resource location
- Output
Blob Pulumi.Managed Identity Azure Native. Compute. Inputs. Run Command Managed Identity - 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
- Output
Blob stringUri - 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.
- Parameters
List<Pulumi.
Azure Native. Compute. Inputs. Run Command Input Parameter> - The parameters used by the script.
- Protected
Parameters List<Pulumi.Azure Native. Compute. Inputs. Run Command Input Parameter> - The parameters used by the script.
- Run
As stringPassword - Specifies the user account password on the VM when executing the run command.
- Run
As stringUser - Specifies the user account on the VM when executing the run command.
- Run
Command Name - The name of the virtual machine run command.
- Source
Pulumi.
Azure Native. Compute. Inputs. Virtual Machine Run Command Script Source - The source of the run command script.
- Dictionary<string, string>
- Resource tags
- Timeout
In intSeconds - The timeout in seconds to execute the run command.
- Treat
Failure boolAs Deployment Failure - Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- Resource
Group Name stringThis property is required. Changes to this property will trigger replacement. - The name of the resource group.
- Vm
Name stringThis property is required. Changes to this property will trigger replacement. - The name of the virtual machine where the run command should be created or updated.
- Async
Execution bool - Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- Error
Blob RunManaged Identity Command Managed Identity Args - 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
- Error
Blob stringUri - 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.
- Location string
- Resource location
- Output
Blob RunManaged Identity Command Managed Identity Args - 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
- Output
Blob stringUri - 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.
- Parameters
[]Run
Command Input Parameter Args - The parameters used by the script.
- Protected
Parameters []RunCommand Input Parameter Args - The parameters used by the script.
- Run
As stringPassword - Specifies the user account password on the VM when executing the run command.
- Run
As stringUser - Specifies the user account on the VM when executing the run command.
- Run
Command Name - The name of the virtual machine run command.
- Source
Virtual
Machine Run Command Script Source Args - The source of the run command script.
- map[string]string
- Resource tags
- Timeout
In intSeconds - The timeout in seconds to execute the run command.
- Treat
Failure boolAs Deployment Failure - Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- resource
Group Name StringThis property is required. Changes to this property will trigger replacement. - The name of the resource group.
- vm
Name StringThis property is required. Changes to this property will trigger replacement. - The name of the virtual machine where the run command should be created or updated.
- async
Execution Boolean - Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- error
Blob RunManaged Identity Command Managed Identity - 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
- error
Blob StringUri - 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.
- location String
- Resource location
- output
Blob RunManaged Identity Command Managed Identity - 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
- output
Blob StringUri - 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.
- parameters
List<Run
Command Input Parameter> - The parameters used by the script.
- protected
Parameters List<RunCommand Input Parameter> - The parameters used by the script.
- run
As StringPassword - Specifies the user account password on the VM when executing the run command.
- run
As StringUser - Specifies the user account on the VM when executing the run command.
- run
Command Name - The name of the virtual machine run command.
- source
Virtual
Machine Run Command Script Source - The source of the run command script.
- Map<String,String>
- Resource tags
- timeout
In IntegerSeconds - The timeout in seconds to execute the run command.
- treat
Failure BooleanAs Deployment Failure - Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- resource
Group Name stringThis property is required. Changes to this property will trigger replacement. - The name of the resource group.
- vm
Name stringThis property is required. Changes to this property will trigger replacement. - The name of the virtual machine where the run command should be created or updated.
- async
Execution boolean - Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- error
Blob RunManaged Identity Command Managed Identity - 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
- error
Blob stringUri - 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.
- location string
- Resource location
- output
Blob RunManaged Identity Command Managed Identity - 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
- output
Blob stringUri - 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.
- parameters
Run
Command Input Parameter[] - The parameters used by the script.
- protected
Parameters RunCommand Input Parameter[] - The parameters used by the script.
- run
As stringPassword - Specifies the user account password on the VM when executing the run command.
- run
As stringUser - Specifies the user account on the VM when executing the run command.
- run
Command Name - The name of the virtual machine run command.
- source
Virtual
Machine Run Command Script Source - The source of the run command script.
- {[key: string]: string}
- Resource tags
- timeout
In numberSeconds - The timeout in seconds to execute the run command.
- treat
Failure booleanAs Deployment Failure - Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- resource_
group_ name strThis property is required. Changes to this property will trigger replacement. - The name of the resource group.
- vm_
name strThis property is required. Changes to this property will trigger replacement. - The name of the virtual machine where the run command should be created or updated.
- async_
execution bool - Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- error_
blob_ Runmanaged_ identity Command Managed Identity Args - 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
- error_
blob_ struri - 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.
- location str
- Resource location
- output_
blob_ Runmanaged_ identity Command Managed Identity Args - 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
- output_
blob_ struri - 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.
- parameters
Sequence[Run
Command Input Parameter Args] - The parameters used by the script.
- protected_
parameters Sequence[RunCommand Input Parameter Args] - The parameters used by the script.
- run_
as_ strpassword - Specifies the user account password on the VM when executing the run command.
- run_
as_ struser - Specifies the user account on the VM when executing the run command.
- run_
command_ name - The name of the virtual machine run command.
- source
Virtual
Machine Run Command Script Source Args - The source of the run command script.
- Mapping[str, str]
- Resource tags
- timeout_
in_ intseconds - The timeout in seconds to execute the run command.
- treat_
failure_ boolas_ deployment_ failure - Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- resource
Group Name StringThis property is required. Changes to this property will trigger replacement. - The name of the resource group.
- vm
Name StringThis property is required. Changes to this property will trigger replacement. - The name of the virtual machine where the run command should be created or updated.
- async
Execution Boolean - Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- error
Blob Property MapManaged Identity - 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
- error
Blob StringUri - 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.
- location String
- Resource location
- output
Blob Property MapManaged Identity - 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
- output
Blob StringUri - 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.
- parameters List<Property Map>
- The parameters used by the script.
- protected
Parameters List<Property Map> - The parameters used by the script.
- run
As StringPassword - Specifies the user account password on the VM when executing the run command.
- run
As StringUser - Specifies the user account on the VM when executing the run command.
- run
Command Name - The name of the virtual machine run command.
- source Property Map
- The source of the run command script.
- Map<String>
- Resource tags
- timeout
In NumberSeconds - The timeout in seconds to execute the run command.
- treat
Failure BooleanAs Deployment Failure - Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
Outputs
All input properties are implicitly available as output properties. Additionally, the VirtualMachineRunCommandByVirtualMachine resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
View Pulumi.Azure Native. Compute. Outputs. Virtual Machine Run Command Instance View Response - The virtual machine run command instance view.
- Name string
- Resource name
- Provisioning
State string - The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- Type string
- Resource type
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
View VirtualMachine Run Command Instance View Response - The virtual machine run command instance view.
- Name string
- Resource name
- Provisioning
State string - The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- Type string
- Resource type
- id String
- The provider-assigned unique ID for this managed resource.
- instance
View VirtualMachine Run Command Instance View Response - The virtual machine run command instance view.
- name String
- Resource name
- provisioning
State String - The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- type String
- Resource type
- id string
- The provider-assigned unique ID for this managed resource.
- instance
View VirtualMachine Run Command Instance View Response - The virtual machine run command instance view.
- name string
- Resource name
- provisioning
State string - The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- type string
- Resource type
- id str
- The provider-assigned unique ID for this managed resource.
- instance_
view VirtualMachine Run Command Instance View Response - The virtual machine run command instance view.
- name str
- Resource name
- provisioning_
state str - The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- type str
- Resource type
- id String
- The provider-assigned unique ID for this managed resource.
- instance
View Property Map - The virtual machine run command instance view.
- name String
- Resource name
- provisioning
State String - The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
- type String
- Resource type
Supporting Types
InstanceViewStatusResponse, InstanceViewStatusResponseArgs
, InstanceViewStatusResponseArgs
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
- code string
- The status code.
- display
Status string - The short localizable label for the status.
- level string
- The level code.
- message string
- The detailed status message, including for alerts and error messages.
- time string
- The time of the status.
- code str
- The status code.
- display_
status str - The short localizable label for the status.
- level str
- The level code.
- message str
- The detailed status message, including for alerts and error messages.
- time str
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
RunCommandInputParameter, RunCommandInputParameterArgs
, RunCommandInputParameterArgs
RunCommandInputParameterResponse, RunCommandInputParameterResponseArgs
, RunCommandInputParameterResponseArgs
RunCommandManagedIdentity, RunCommandManagedIdentityArgs
, RunCommandManagedIdentityArgs
RunCommandManagedIdentityResponse, RunCommandManagedIdentityResponseArgs
, RunCommandManagedIdentityResponseArgs
VirtualMachineRunCommandInstanceViewResponse, VirtualMachineRunCommandInstanceViewResponseArgs
, VirtualMachineRunCommandInstanceViewResponseArgs
- End
Time string - Script end time.
- Error string
- Script error stream.
- Execution
Message string - Communicate script configuration errors or execution messages.
- Execution
State string - Script execution status.
- Exit
Code int - Exit code returned from script execution.
- Output string
- Script output stream.
- Start
Time string - Script start time.
- Statuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status Response> - The resource status information.
- End
Time string - Script end time.
- Error string
- Script error stream.
- Execution
Message string - Communicate script configuration errors or execution messages.
- Execution
State string - Script execution status.
- Exit
Code int - Exit code returned from script execution.
- Output string
- Script output stream.
- Start
Time string - Script start time.
- Statuses
[]Instance
View Status Response - The resource status information.
- end
Time String - Script end time.
- error String
- Script error stream.
- execution
Message String - Communicate script configuration errors or execution messages.
- execution
State String - Script execution status.
- exit
Code Integer - Exit code returned from script execution.
- output String
- Script output stream.
- start
Time String - Script start time.
- statuses
List<Instance
View Status Response> - The resource status information.
- end
Time string - Script end time.
- error string
- Script error stream.
- execution
Message string - Communicate script configuration errors or execution messages.
- execution
State string - Script execution status.
- exit
Code number - Exit code returned from script execution.
- output string
- Script output stream.
- start
Time string - Script start time.
- statuses
Instance
View Status Response[] - The resource status information.
- end_
time str - Script end time.
- error str
- Script error stream.
- execution_
message str - Communicate script configuration errors or execution messages.
- execution_
state str - Script execution status.
- exit_
code int - Exit code returned from script execution.
- output str
- Script output stream.
- start_
time str - Script start time.
- statuses
Sequence[Instance
View Status Response] - The resource status information.
- end
Time String - Script end time.
- error String
- Script error stream.
- execution
Message String - Communicate script configuration errors or execution messages.
- execution
State String - Script execution status.
- exit
Code Number - Exit code returned from script execution.
- output String
- Script output stream.
- start
Time String - Script start time.
- statuses List<Property Map>
- The resource status information.
VirtualMachineRunCommandScriptSource, VirtualMachineRunCommandScriptSourceArgs
, VirtualMachineRunCommandScriptSourceArgs
- Command
Id string - Specifies a commandId of predefined built-in script.
- Script string
- Specifies the script content to be executed on the VM.
- Script
Uri string - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- Script
Uri Pulumi.Managed Identity Azure Native. Compute. Inputs. Run Command Managed Identity - 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.
- Command
Id string - Specifies a commandId of predefined built-in script.
- Script string
- Specifies the script content to be executed on the VM.
- Script
Uri string - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- Script
Uri RunManaged Identity Command Managed Identity - 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.
- command
Id String - Specifies a commandId of predefined built-in script.
- script String
- Specifies the script content to be executed on the VM.
- script
Uri String - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script
Uri RunManaged Identity Command Managed Identity - 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.
- command
Id string - Specifies a commandId of predefined built-in script.
- script string
- Specifies the script content to be executed on the VM.
- script
Uri string - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script
Uri RunManaged Identity Command Managed Identity - 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.
- command_
id str - Specifies a commandId of predefined built-in script.
- script str
- Specifies the script content to be executed on the VM.
- script_
uri str - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script_
uri_ Runmanaged_ identity Command Managed Identity - 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.
- command
Id String - Specifies a commandId of predefined built-in script.
- script String
- Specifies the script content to be executed on the VM.
- script
Uri String - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script
Uri Property MapManaged Identity - 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.
VirtualMachineRunCommandScriptSourceResponse, VirtualMachineRunCommandScriptSourceResponseArgs
, VirtualMachineRunCommandScriptSourceResponseArgs
- Command
Id string - Specifies a commandId of predefined built-in script.
- Script string
- Specifies the script content to be executed on the VM.
- Script
Uri string - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- Script
Uri Pulumi.Managed Identity Azure Native. Compute. Inputs. Run Command Managed Identity Response - 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.
- Command
Id string - Specifies a commandId of predefined built-in script.
- Script string
- Specifies the script content to be executed on the VM.
- Script
Uri string - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- Script
Uri RunManaged Identity Command Managed Identity Response - 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.
- command
Id String - Specifies a commandId of predefined built-in script.
- script String
- Specifies the script content to be executed on the VM.
- script
Uri String - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script
Uri RunManaged Identity Command Managed Identity Response - 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.
- command
Id string - Specifies a commandId of predefined built-in script.
- script string
- Specifies the script content to be executed on the VM.
- script
Uri string - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script
Uri RunManaged Identity Command Managed Identity Response - 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.
- command_
id str - Specifies a commandId of predefined built-in script.
- script str
- Specifies the script content to be executed on the VM.
- script_
uri str - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script_
uri_ Runmanaged_ identity Command Managed Identity Response - 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.
- command
Id String - Specifies a commandId of predefined built-in script.
- script String
- Specifies the script content to be executed on the VM.
- script
Uri String - Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script
Uri Property MapManaged Identity - 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.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:compute:VirtualMachineRunCommandByVirtualMachine myRunCommand /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi