Class ScriptExecutionProperties
java.lang.Object
com.azure.resourcemanager.avs.fluent.models.ScriptExecutionProperties
Properties of a user-invoked script.
-
Constructor Summary
ConstructorDescriptionCreates an instance of ScriptExecutionProperties class. -
Method Summary
Modifier and TypeMethodDescriptionerrors()
Get the errors property: Standard error output stream from the powershell execution.Get the failureReason property: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.Get the finishedAt property: Time the script execution was finished.Get the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.Get the information property: Standard information out stream from the powershell execution.Get the namedOutputs property: User-defined dictionary.output()
Get the output property: Standard output stream from the powershell execution.Get the parameters property: Parameters the script will accept.Get the provisioningState property: The state of the script execution resource.Get the retention property: Time to live for the resource.Get the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.Get the startedAt property: Time the script execution was started.Get the submittedAt property: Time the script execution was submitted.timeout()
Get the timeout property: Time limit for execution.void
validate()
Validates the instance.warnings()
Get the warnings property: Standard warning out stream from the powershell execution.withFailureReason
(String failureReason) Set the failureReason property: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.withHiddenParameters
(List<ScriptExecutionParameter> hiddenParameters) Set the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.withNamedOutputs
(Map<String, Object> namedOutputs) Set the namedOutputs property: User-defined dictionary.withOutput
(List<String> output) Set the output property: Standard output stream from the powershell execution.withParameters
(List<ScriptExecutionParameter> parameters) Set the parameters property: Parameters the script will accept.withRetention
(String retention) Set the retention property: Time to live for the resource.withScriptCmdletId
(String scriptCmdletId) Set the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.withTimeout
(String timeout) Set the timeout property: Time limit for execution.
-
Constructor Details
-
ScriptExecutionProperties
public ScriptExecutionProperties()Creates an instance of ScriptExecutionProperties class.
-
-
Method Details
-
scriptCmdletId
Get the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.- Returns:
- the scriptCmdletId value.
-
withScriptCmdletId
Set the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.- Parameters:
scriptCmdletId
- the scriptCmdletId value to set.- Returns:
- the ScriptExecutionProperties object itself.
-
parameters
Get the parameters property: Parameters the script will accept.- Returns:
- the parameters value.
-
withParameters
Set the parameters property: Parameters the script will accept.- Parameters:
parameters
- the parameters value to set.- Returns:
- the ScriptExecutionProperties object itself.
-
withHiddenParameters
public ScriptExecutionProperties withHiddenParameters(List<ScriptExecutionParameter> hiddenParameters) Set the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.- Parameters:
hiddenParameters
- the hiddenParameters value to set.- Returns:
- the ScriptExecutionProperties object itself.
-
failureReason
Get the failureReason property: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.- Returns:
- the failureReason value.
-
withFailureReason
Set the failureReason property: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.- Parameters:
failureReason
- the failureReason value to set.- Returns:
- the ScriptExecutionProperties object itself.
-
timeout
Get the timeout property: Time limit for execution.- Returns:
- the timeout value.
-
withTimeout
Set the timeout property: Time limit for execution.- Parameters:
timeout
- the timeout value to set.- Returns:
- the ScriptExecutionProperties object itself.
-
retention
Get the retention property: Time to live for the resource. If not provided, will be available for 60 days.- Returns:
- the retention value.
-
withRetention
Set the retention property: Time to live for the resource. If not provided, will be available for 60 days.- Parameters:
retention
- the retention value to set.- Returns:
- the ScriptExecutionProperties object itself.
-
submittedAt
Get the submittedAt property: Time the script execution was submitted.- Returns:
- the submittedAt value.
-
startedAt
Get the startedAt property: Time the script execution was started.- Returns:
- the startedAt value.
-
finishedAt
Get the finishedAt property: Time the script execution was finished.- Returns:
- the finishedAt value.
-
provisioningState
Get the provisioningState property: The state of the script execution resource.- Returns:
- the provisioningState value.
-
output
Get the output property: Standard output stream from the powershell execution.- Returns:
- the output value.
-
withOutput
Set the output property: Standard output stream from the powershell execution.- Parameters:
output
- the output value to set.- Returns:
- the ScriptExecutionProperties object itself.
-
namedOutputs
Get the namedOutputs property: User-defined dictionary.- Returns:
- the namedOutputs value.
-
withNamedOutputs
Set the namedOutputs property: User-defined dictionary.- Parameters:
namedOutputs
- the namedOutputs value to set.- Returns:
- the ScriptExecutionProperties object itself.
-
information
Get the information property: Standard information out stream from the powershell execution.- Returns:
- the information value.
-
warnings
Get the warnings property: Standard warning out stream from the powershell execution.- Returns:
- the warnings value.
-
errors
Get the errors property: Standard error output stream from the powershell execution.- Returns:
- the errors value.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-