ScriptExecution interface

Package:

@azure/arm-avs

An instance of a script executed by a user - custom or AVS

Extends

ProxyResource

Properties

errors	Standard error output stream from the powershell execution NOTE: This property will not be serialized. It can only be populated by the server.
failureReason	Error message if the script was able to run, but if the script itself had errors or powershell threw an exception
finishedAt	Time the script execution was finished NOTE: This property will not be serialized. It can only be populated by the server.
hiddenParameters	Parameters that will be hidden/not visible to ARM, such as passwords and credentials
information	Standard information out stream from the powershell execution NOTE: This property will not be serialized. It can only be populated by the server.
namedOutputs	User-defined dictionary.
output	Standard output stream from the powershell execution
parameters	Parameters the script will accept
provisioningState	The state of the script execution resource NOTE: This property will not be serialized. It can only be populated by the server.
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
startedAt	Time the script execution was started NOTE: This property will not be serialized. It can only be populated by the server.
submittedAt	Time the script execution was submitted NOTE: This property will not be serialized. It can only be populated by the server.
timeout	Time limit for execution
warnings	Standard warning out stream from the powershell execution NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

errors

Standard error output stream from the powershell execution NOTE: This property will not be serialized. It can only be populated by the server.

errors?: string[]

Property Value

string[]

failureReason

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

failureReason?: string

Property Value

string

finishedAt

Time the script execution was finished NOTE: This property will not be serialized. It can only be populated by the server.

finishedAt?: Date

Property Value

Date

hiddenParameters

Parameters that will be hidden/not visible to ARM, such as passwords and credentials

hiddenParameters?: ScriptExecutionParameterUnion[]

Property Value

ScriptExecutionParameterUnion[]

information

Standard information out stream from the powershell execution NOTE: This property will not be serialized. It can only be populated by the server.

information?: string[]

Property Value

string[]

namedOutputs

User-defined dictionary.

namedOutputs?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

output

Standard output stream from the powershell execution

output?: string[]

Property Value

string[]

parameters

Parameters the script will accept

parameters?: ScriptExecutionParameterUnion[]

Property Value

ScriptExecutionParameterUnion[]

provisioningState

The state of the script execution resource NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

retention

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

retention?: string

Property Value

string

scriptCmdletId

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

scriptCmdletId?: string

Property Value

string

startedAt

Time the script execution was started NOTE: This property will not be serialized. It can only be populated by the server.

startedAt?: Date

Property Value

Date

submittedAt

Time the script execution was submitted NOTE: This property will not be serialized. It can only be populated by the server.

submittedAt?: Date

Property Value

Date

timeout

Time limit for execution

timeout?: string

Property Value

string

warnings

Standard warning out stream from the powershell execution NOTE: This property will not be serialized. It can only be populated by the server.

warnings?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type