ScriptExecution interface
An instance of a script executed by a user - custom or AVS
- Extends
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. |
| failure |
Error message if the script was able to run, but if the script itself had errors or powershell threw an exception |
| finished |
Time the script execution was finished NOTE: This property will not be serialized. It can only be populated by the server. |
| hidden |
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. |
| named |
User-defined dictionary. |
| output | Standard output stream from the powershell execution |
| parameters | Parameters the script will accept |
| provisioning |
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 |
| script |
A reference to the script cmdlet resource if user is running a AVS script |
| started |
Time the script execution was started NOTE: This property will not be serialized. It can only be populated by the server. |
| submitted |
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. |
| system |
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?: stringProperty 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?: DateProperty Value
Date
hiddenParameters
Parameters that will be hidden/not visible to ARM, such as passwords and credentials
hiddenParameters?: ScriptExecutionParameterUnion[]Property Value
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
provisioningState
The state of the script execution resource NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: stringProperty Value
string
retention
Time to live for the resource. If not provided, will be available for 60 days
retention?: stringProperty Value
string
scriptCmdletId
A reference to the script cmdlet resource if user is running a AVS script
scriptCmdletId?: stringProperty 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?: DateProperty 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?: DateProperty Value
Date
timeout
Time limit for execution
timeout?: stringProperty 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?: stringProperty 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?: stringProperty 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?: SystemDataProperty Value
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?: stringProperty Value
string
Inherited From ProxyResource.type