MachineRunCommand Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models

Assembly:

Az.ConnectedMachine.private.dll

Describes a Run Command

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.MachineRunCommandTypeConverter))]
public class MachineRunCommand : Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IMachineRunCommand, Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.MachineRunCommandTypeConverter))>]
type MachineRunCommand = class
    interface IMachineRunCommand
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates

Public Class MachineRunCommand
Implements IMachineRunCommand, IValidates

Inheritance

Object

MachineRunCommand

Attributes

TypeConverterAttribute

Implements

IMachineRunCommand IResource ITrackedResource IJsonSerializable IValidates

Constructors

MachineRunCommand()

Creates an new MachineRunCommand instance.

Properties

AsyncExecution	Optional. If set to true, provisioning will complete as soon as 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.
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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 status information.
Location	The geo-location where the resource lives
MachineName
Name	The name of the resource
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.
ResourceGroupName	Gets the resource group name
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.
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 the commandId of predefined built-in script.
SourceScript	Specifies the script content to be executed on the machine.
SourceScriptUri	Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tags	Resource tags.
TimeoutInSecond	The timeout in seconds to execute the run command.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of MachineRunCommand.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of MachineRunCommand.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IMachineRunCommand.
FromJsonString(String)	Creates a new instance of MachineRunCommand, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of MachineRunCommand into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.