Share via


MachineRunCommandData Class

Definition

A class representing the MachineRunCommand data model. Describes a Run Command

public class MachineRunCommandData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.HybridCompute.MachineRunCommandData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.HybridCompute.MachineRunCommandData>
type MachineRunCommandData = class
    inherit TrackedResourceData
    interface IJsonModel<MachineRunCommandData>
    interface IPersistableModel<MachineRunCommandData>
Public Class MachineRunCommandData
Inherits TrackedResourceData
Implements IJsonModel(Of MachineRunCommandData), IPersistableModel(Of MachineRunCommandData)
Inheritance
MachineRunCommandData
Implements

Constructors

MachineRunCommandData(AzureLocation)

Initializes a new instance of MachineRunCommandData.

Properties

AsyncExecution

Optional. If set to true, provisioning will complete as soon as 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 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.

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 machine when executing the run command.

RunAsUser

Specifies the user account on the machine 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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<MachineRunCommandData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<MachineRunCommandData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<MachineRunCommandData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<MachineRunCommandData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<MachineRunCommandData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to