Package version:

Interface VirtualMachineRunCommand

Describes a Virtual Machine run command.

interface VirtualMachineRunCommand {
    asyncExecution?: boolean;
    errorBlobManagedIdentity?: RunCommandManagedIdentity;
    errorBlobUri?: string;
    id?: string;
    instanceView?: VirtualMachineRunCommandInstanceView;
    location: string;
    name?: string;
    outputBlobManagedIdentity?: RunCommandManagedIdentity;
    outputBlobUri?: string;
    parameters?: RunCommandInputParameter[];
    protectedParameters?: RunCommandInputParameter[];
    provisioningState?: string;
    runAsPassword?: string;
    runAsUser?: string;
    source?: VirtualMachineRunCommandScriptSource;
    tags?: {
        [propertyName: string]: string;
    };
    timeoutInSeconds?: number;
    treatFailureAsDeploymentFailure?: boolean;
    type?: string;
}

Hierarchy (view full)

Properties

asyncExecution? errorBlobManagedIdentity? errorBlobUri? id? instanceView? location name? outputBlobManagedIdentity? outputBlobUri? parameters? protectedParameters? provisioningState? runAsPassword? runAsUser? source? tags? timeoutInSeconds? treatFailureAsDeploymentFailure? type?

Properties

OptionalasyncExecution

asyncExecution?: boolean

Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.

OptionalerrorBlobManagedIdentity

errorBlobManagedIdentity?: RunCommandManagedIdentity

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

OptionalerrorBlobUri

errorBlobUri?: string

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.

Optional Readonlyid

id?: string

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyinstanceView

instanceView?: VirtualMachineRunCommandInstanceView

The virtual machine run command instance view. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional Readonlyname

name?: string

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

OptionaloutputBlobManagedIdentity

outputBlobManagedIdentity?: RunCommandManagedIdentity

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

OptionaloutputBlobUri

outputBlobUri?: string

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.

Optionalparameters

parameters?: RunCommandInputParameter[]

The parameters used by the script.

OptionalprotectedParameters

protectedParameters?: RunCommandInputParameter[]

The parameters used by the script.

Optional ReadonlyprovisioningState

provisioningState?: 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 NOTE: This property will not be serialized. It can only be populated by the server.

OptionalrunAsPassword

runAsPassword?: string

Specifies the user account password on the VM when executing the run command.

OptionalrunAsUser

runAsUser?: string

Specifies the user account on the VM when executing the run command.

Optionalsource

source?: VirtualMachineRunCommandScriptSource

The source of the run command script.

Optionaltags

tags?: {
    [propertyName: string]: string;
}

Resource tags

OptionaltimeoutInSeconds

timeoutInSeconds?: number

The timeout in seconds to execute the run command.

OptionaltreatFailureAsDeploymentFailure

treatFailureAsDeploymentFailure?: boolean

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

Optional Readonlytype

type?: string

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility