Share via

ScriptExecutionProperties interface

Package:
@azure/arm-avs

Properties of a user-invoked script

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
finishedAt

Time the script execution was finished
hiddenParameters

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

Standard information out stream from the powershell execution
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
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
submittedAt

Time the script execution was submitted
timeout

Time limit for execution
warnings

Standard warning out stream from the powershell execution

Property Details

errors

Standard error output stream from the powershell execution

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

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

information?: string[]

Property Value

string[]

namedOutputs

User-defined dictionary.

namedOutputs?: Record<string, Record<string, any>>

Property Value

Record<string, Record<string, any>>

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

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

startedAt?: Date

Property Value

Date

submittedAt

Time the script execution was submitted

submittedAt?: Date

Property Value

Date

timeout

Time limit for execution

timeout: string

Property Value

string

warnings

Standard warning out stream from the powershell execution

warnings?: string[]

Property Value

string[]