Package com.azure.resourcemanager.avs.models

Interface ScriptExecution

  • public interface ScriptExecution
    An immutable client-side representation of ScriptExecution.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • scriptCmdletId

        String scriptCmdletId()
        Gets the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.
        Returns:
        the scriptCmdletId value.

      • parameters

        List<ScriptExecutionParameter> parameters()
        Gets the parameters property: Parameters the script will accept.
        Returns:
        the parameters value.

      • hiddenParameters

        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.

      • failureReason

        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.

      • timeout

        String timeout()
        Gets the timeout property: Time limit for execution.
        Returns:
        the timeout value.

      • retention

        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.

      • submittedAt

        OffsetDateTime submittedAt()
        Gets the submittedAt property: Time the script execution was submitted.
        Returns:
        the submittedAt value.

      • startedAt

        OffsetDateTime startedAt()
        Gets the startedAt property: Time the script execution was started.
        Returns:
        the startedAt value.

      • finishedAt

        OffsetDateTime finishedAt()
        Gets the finishedAt property: Time the script execution was finished.
        Returns:
        the finishedAt value.

      • provisioningState

        ScriptExecutionProvisioningState provisioningState()
        Gets the provisioningState property: The state of the script execution resource.
        Returns:
        the provisioningState value.

      • output

        List<String> output()
        Gets the output property: Standard output stream from the powershell execution.
        Returns:
        the output value.

      • namedOutputs

        Map<String,​Object> namedOutputs()
        Gets the namedOutputs property: User-defined dictionary.
        Returns:
        the namedOutputs value.

      • information

        List<String> information()
        Gets the information property: Standard information out stream from the powershell execution.
        Returns:
        the information value.

      • warnings

        List<String> warnings()
        Gets the warnings property: Standard warning out stream from the powershell execution.
        Returns:
        the warnings value.

      • errors

        List<String> errors()
        Gets the errors property: Standard error output stream from the powershell execution.
        Returns:
        the errors value.

      • innerModel

        ScriptExecutionInner innerModel()
        Gets the inner com.azure.resourcemanager.avs.fluent.models.ScriptExecutionInner object.
        Returns:
        the inner object.

      • update

        ScriptExecution.Update update()
        Begins update for the ScriptExecution resource.
        Returns:
        the stage of resource update.

      • refresh

        ScriptExecution refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        ScriptExecution refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • getExecutionLogs

        ScriptExecution getExecutionLogs()
        Return the logs for a script execution resource.
        Returns:
        an instance of a script executed by a user - custom or AVS.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getExecutionLogsWithResponse

        com.azure.core.http.rest.Response<ScriptExecution> getExecutionLogsWithResponse​(List<ScriptOutputStreamType> scriptOutputStreamType,
                                                                                com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.