Interface ScriptExecutions


  • public interface ScriptExecutions
    Resource collection API of ScriptExecutions.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<ScriptExecution> list​(String resourceGroupName,
                                                                     String privateCloudName)
        List script executions in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        Returns:
        pageable list of script executions.
        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.
      • list

        com.azure.core.http.rest.PagedIterable<ScriptExecution> list​(String resourceGroupName,
                                                                     String privateCloudName,
                                                                     com.azure.core.util.Context context)
        List script executions in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        context - The context to associate with this operation.
        Returns:
        pageable list of script executions.
        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.
      • get

        ScriptExecution get​(String resourceGroupName,
                            String privateCloudName,
                            String scriptExecutionName)
        Get an script execution by name in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        scriptExecutionName - Name of the user-invoked script execution resource.
        Returns:
        an script execution by name in a private cloud.
        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.
      • getWithResponse

        com.azure.core.http.rest.Response<ScriptExecution> getWithResponse​(String resourceGroupName,
                                                                           String privateCloudName,
                                                                           String scriptExecutionName,
                                                                           com.azure.core.util.Context context)
        Get an script execution by name in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        scriptExecutionName - Name of the user-invoked script execution resource.
        context - The context to associate with this operation.
        Returns:
        an script execution by name in a private cloud.
        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.
      • delete

        void delete​(String resourceGroupName,
                    String privateCloudName,
                    String scriptExecutionName)
        Cancel a ScriptExecution in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        scriptExecutionName - Name of the user-invoked script execution resource.
        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.
      • delete

        void delete​(String resourceGroupName,
                    String privateCloudName,
                    String scriptExecutionName,
                    com.azure.core.util.Context context)
        Cancel a ScriptExecution in a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        scriptExecutionName - Name of the user-invoked script execution resource.
        context - The context to associate with this operation.
        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.
      • getExecutionLogs

        ScriptExecution getExecutionLogs​(String resourceGroupName,
                                         String privateCloudName,
                                         String scriptExecutionName)
        Return the logs for a script execution resource.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        scriptExecutionName - Name of the user-invoked script execution resource.
        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.
      • getExecutionLogsWithResponse

        com.azure.core.http.rest.Response<ScriptExecution> getExecutionLogsWithResponse​(String resourceGroupName,
                                                                                        String privateCloudName,
                                                                                        String scriptExecutionName,
                                                                                        List<ScriptOutputStreamType> scriptOutputStreamType,
                                                                                        com.azure.core.util.Context context)
        Return the logs for a script execution resource.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        scriptExecutionName - Name of the user-invoked script execution resource.
        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.
      • getById

        ScriptExecution getById​(String id)
        Get an script execution by name in a private cloud.
        Parameters:
        id - the resource ID.
        Returns:
        an script execution by name in a private cloud.
        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.
      • getByIdWithResponse

        com.azure.core.http.rest.Response<ScriptExecution> getByIdWithResponse​(String id,
                                                                               com.azure.core.util.Context context)
        Get an script execution by name in a private cloud.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        an script execution by name in a private cloud.
        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.
      • deleteById

        void deleteById​(String id)
        Cancel a ScriptExecution in a private cloud.
        Parameters:
        id - the resource ID.
        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.
      • deleteByIdWithResponse

        void deleteByIdWithResponse​(String id,
                                    com.azure.core.util.Context context)
        Cancel a ScriptExecution in a private cloud.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        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.
      • define

        ScriptExecution.DefinitionStages.Blank define​(String name)
        Begins definition for a new ScriptExecution resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new ScriptExecution definition.