MachineRunCommandProperties Class
Definition
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 run command.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.MachineRunCommandPropertiesTypeConverter))]
public class MachineRunCommandProperties : Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IMachineRunCommandProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.MachineRunCommandPropertiesTypeConverter))>]
type MachineRunCommandProperties = class
interface IMachineRunCommandProperties
interface IJsonSerializable
Public Class MachineRunCommandProperties
Implements IMachineRunCommandProperties
- Inheritance
-
MachineRunCommandProperties
- Attributes
- Implements
Constructors
MachineRunCommandProperties() |
Creates an new MachineRunCommandProperties 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. |
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. |
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. |
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. |
TimeoutInSecond |
The timeout in seconds to execute the run command. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of MachineRunCommandProperties. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of MachineRunCommandProperties. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IMachineRunCommandProperties. |
FromJsonString(String) |
Creates a new instance of MachineRunCommandProperties, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of MachineRunCommandProperties into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
ToString() |