ScriptExecutionData Class

Definition

A class representing the ScriptExecution data model. An instance of a script executed by a user - custom or AVS

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

Constructors

ScriptExecutionData()

Initializes a new instance of ScriptExecutionData.

Properties

Errors

Standard error output stream from the powershell execution.

FailureReason

Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.

FinishedOn

Time the script execution was finished.

HiddenParameters

Parameters that will be hidden/not visible to ARM, such as passwords and credentials Please note ScriptExecutionParameterDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include PSCredentialExecutionParameterDetails, ScriptSecureStringExecutionParameterDetails and ScriptStringExecutionParameterDetails.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Information

Standard information out stream from the powershell execution.

Name

The name of the resource.

(Inherited from ResourceData)
NamedOutputs

User-defined dictionary.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
Output

Standard output stream from the powershell execution.

Parameters

Parameters the script will accept Please note ScriptExecutionParameterDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include PSCredentialExecutionParameterDetails, ScriptSecureStringExecutionParameterDetails and ScriptStringExecutionParameterDetails.

ProvisioningState

The state of the script execution resource.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
Retention

Time to live for the resource. If not provided, will be available for 60 days.

ScriptCmdletId

A reference to the script cmdlet resource if user is running a AVS script.

StartedOn

Time the script execution was started.

SubmittedOn

Time the script execution was submitted.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Timeout

Time limit for execution.

Warnings

Standard warning out stream from the powershell execution.

Explicit Interface Implementations

IJsonModel<ScriptExecutionData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ScriptExecutionData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ScriptExecutionData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ScriptExecutionData>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ScriptExecutionData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to