VirtualMachineRunCommandProperties Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20230701

Assembly:: Az.Compute.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Describes the properties of a Virtual Machine run command.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20230701.VirtualMachineRunCommandPropertiesTypeConverter))]
public class VirtualMachineRunCommandProperties : Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20230701.IVirtualMachineRunCommandProperties

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20230701.VirtualMachineRunCommandPropertiesTypeConverter))>]
type VirtualMachineRunCommandProperties = class
    interface IVirtualMachineRunCommandProperties
    interface IJsonSerializable

Public Class VirtualMachineRunCommandProperties
Implements IVirtualMachineRunCommandProperties

Inheritance: Object
VirtualMachineRunCommandProperties

Attributes: TypeConverterAttribute

Implements: IVirtualMachineRunCommandProperties IJsonSerializable

Constructors

VirtualMachineRunCommandProperties()

Creates an new VirtualMachineRunCommandProperties instance.

Properties

AsyncExecution	Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
ErrorBlobManagedIdentityClientId	Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided.
ErrorBlobManagedIdentityObjectId	Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided.
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.
InstanceViewEndTime	Script end time.
InstanceViewError	Script error stream.
InstanceViewExecutionMessage	Communicate script configuration errors or execution messages.
InstanceViewExecutionState	Script execution status.
InstanceViewExitCode	Exit code returned from script execution.
InstanceViewOutput	Script output stream.
InstanceViewStartTime	Script start time.
InstanceViewStatuses	The resource status information.
OutputBlobManagedIdentityClientId	Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided.
OutputBlobManagedIdentityObjectId	Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided.
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.
Parameter	The parameters used by the script.
ProtectedParameter	The parameters used by the script.
ProvisioningState	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
RunAsPassword	Specifies the user account password on the VM when executing the run command.
RunAsUser	Specifies the user account on the VM when executing the run command.
ScriptUriManagedIdentityClientId	Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided.
ScriptUriManagedIdentityObjectId	Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided.
SourceCommandId	Specifies a commandId of predefined built-in script.
SourceScript	Specifies the script content to be executed on the VM.
SourceScriptUri	Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
TimeoutInSecond	The timeout in seconds to execute the run command.
TreatFailureAsDeploymentFailure	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

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of VirtualMachineRunCommandProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of VirtualMachineRunCommandProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20230701.IVirtualMachineRunCommandProperties.
FromJsonString(String)	Creates a new instance of VirtualMachineRunCommandProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of VirtualMachineRunCommandProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.

Applies to

Share via