ScriptExecution Interface

public interface ScriptExecution

An immutable client-side representation of ScriptExecution.

Method Summary

Modifier and Type Method and Description
abstract List<String> errors()

Gets the errors property: Standard error output stream from the powershell execution.

abstract String failureReason()

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

abstract OffsetDateTime finishedAt()

Gets the finishedAt property: Time the script execution was finished.

abstract ScriptExecution getExecutionLogs()

Return the logs for a script execution resource.

abstract Response<ScriptExecution> getExecutionLogsWithResponse(List<ScriptOutputStreamType> scriptOutputStreamType, Context context)

Return the logs for a script execution resource.

abstract List<ScriptExecutionParameter> hiddenParameters()

Gets the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.

abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

abstract List<String> information()

Gets the information property: Standard information out stream from the powershell execution.

abstract ScriptExecutionInner innerModel()

Gets the inner com.azure.resourcemanager.avs.fluent.models.ScriptExecutionInner object.

abstract String name()

Gets the name property: The name of the resource.

abstract Map<String,Object> namedOutputs()

Gets the namedOutputs property: User-defined dictionary.

abstract List<String> output()

Gets the output property: Standard output stream from the powershell execution.

abstract List<ScriptExecutionParameter> parameters()

Gets the parameters property: Parameters the script will accept.

abstract ScriptExecutionProvisioningState provisioningState()

Gets the provisioningState property: The state of the script execution resource.

abstract ScriptExecution refresh()

Refreshes the resource to sync with Azure.

abstract ScriptExecution refresh(Context context)

Refreshes the resource to sync with Azure.

abstract String resourceGroupName()

Gets the name of the resource group.

abstract String retention()

Gets the retention property: Time to live for the resource.

abstract String scriptCmdletId()

Gets the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.

abstract OffsetDateTime startedAt()

Gets the startedAt property: Time the script execution was started.

abstract OffsetDateTime submittedAt()

Gets the submittedAt property: Time the script execution was submitted.

abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

abstract String timeout()

Gets the timeout property: Time limit for execution.

abstract String type()

Gets the type property: The type of the resource.

abstract Update update()

Begins update for the ScriptExecution resource.

abstract List<String> warnings()

Gets the warnings property: Standard warning out stream from the powershell execution.

Method Details

errors

public abstract List<String> errors()

Gets the errors property: Standard error output stream from the powershell execution.

Returns:

the errors value.

failureReason

public abstract String failureReason()

Gets 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.

finishedAt

public abstract OffsetDateTime finishedAt()

Gets the finishedAt property: Time the script execution was finished.

Returns:

the finishedAt value.

getExecutionLogs

public abstract ScriptExecution getExecutionLogs()

Return the logs for a script execution resource.

Returns:

an instance of a script executed by a user - custom or AVS.

getExecutionLogsWithResponse

public abstract Response<ScriptExecution> getExecutionLogsWithResponse(List<ScriptOutputStreamType> scriptOutputStreamType, Context context)

Return the logs for a script execution resource.

Parameters:

scriptOutputStreamType - Name of the desired output stream to return. If not provided, will return all. An empty array will return nothing.
context - The context to associate with this operation.

Returns:

an instance of a script executed by a user - custom or AVS along with Response<T>.

hiddenParameters

public abstract List<ScriptExecutionParameter> hiddenParameters()

Gets the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.

Returns:

the hiddenParameters value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

information

public abstract List<String> information()

Gets the information property: Standard information out stream from the powershell execution.

Returns:

the information value.

innerModel

public abstract ScriptExecutionInner innerModel()

Gets the inner com.azure.resourcemanager.avs.fluent.models.ScriptExecutionInner object.

Returns:

the inner object.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

namedOutputs

public abstract Map<String,Object> namedOutputs()

Gets the namedOutputs property: User-defined dictionary.

Returns:

the namedOutputs value.

output

public abstract List<String> output()

Gets the output property: Standard output stream from the powershell execution.

Returns:

the output value.

parameters

public abstract List<ScriptExecutionParameter> parameters()

Gets the parameters property: Parameters the script will accept.

Returns:

the parameters value.

provisioningState

public abstract ScriptExecutionProvisioningState provisioningState()

Gets the provisioningState property: The state of the script execution resource.

Returns:

the provisioningState value.

refresh

public abstract ScriptExecution refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract ScriptExecution refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

retention

public abstract String retention()

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

Returns:

the retention value.

scriptCmdletId

public abstract String scriptCmdletId()

Gets the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.

Returns:

the scriptCmdletId value.

startedAt

public abstract OffsetDateTime startedAt()

Gets the startedAt property: Time the script execution was started.

Returns:

the startedAt value.

submittedAt

public abstract OffsetDateTime submittedAt()

Gets the submittedAt property: Time the script execution was submitted.

Returns:

the submittedAt value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

timeout

public abstract String timeout()

Gets the timeout property: Time limit for execution.

Returns:

the timeout value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract ScriptExecution.Update update()

Begins update for the ScriptExecution resource.

Returns:

the stage of resource update.

warnings

public abstract List<String> warnings()

Gets the warnings property: Standard warning out stream from the powershell execution.

Returns:

the warnings value.

Applies to