VirtualMachineRunCommandData Class

Reference

Definition

Namespace:: Azure.ResourceManager.Compute

Assembly:: Azure.ResourceManager.Compute.dll

Package:: Azure.ResourceManager.Compute v1.6.0

Package:: Azure.ResourceManager.Compute v1.7.0-beta.1

Source:: VirtualMachineRunCommandData.cs

Source:: VirtualMachineRunCommandData.cs

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.

A class representing the VirtualMachineRunCommand data model. Describes a Virtual Machine run command.

public class VirtualMachineRunCommandData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.VirtualMachineRunCommandData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.VirtualMachineRunCommandData>

type VirtualMachineRunCommandData = class
    inherit TrackedResourceData
    interface IJsonModel<VirtualMachineRunCommandData>
    interface IPersistableModel<VirtualMachineRunCommandData>

Public Class VirtualMachineRunCommandData
Inherits TrackedResourceData
Implements IJsonModel(Of VirtualMachineRunCommandData), IPersistableModel(Of VirtualMachineRunCommandData)

Inheritance: Object

ResourceData

TrackedResourceData
VirtualMachineRunCommandData

Implements: IJsonModel<VirtualMachineRunCommandData> IPersistableModel<VirtualMachineRunCommandData> IPersistableModel<T>

Constructors

VirtualMachineRunCommandData(AzureLocation)

Initializes a new instance of VirtualMachineRunCommandData.

Properties

AsyncExecution	Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
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.
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.
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData)
InstanceView	The virtual machine run command instance view.
Location	The geo-location where the resource lives. (Inherited from TrackedResourceData)
Name	The name of the resource. (Inherited from ResourceData)
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.
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.
Parameters	The parameters used by the script.
ProtectedParameters	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.
ResourceType	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData)
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.
Source	The source of the run command script.
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData)
Tags	Resource tags. (Inherited from TrackedResourceData)
TimeoutInSeconds	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

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)	(Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<VirtualMachineRunCommandData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<VirtualMachineRunCommandData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<VirtualMachineRunCommandData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<VirtualMachineRunCommandData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<VirtualMachineRunCommandData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via