Workflows Interface

public interface Workflows

Resource collection API of Workflows.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new Workflow resource.

abstract DeleteWorkflowResponse deleteById(String id)

Deletes a workflow.

abstract Response<DeleteWorkflowResponse> deleteByIdWithResponse(String id, Context context)

Deletes a workflow.

abstract DeleteWorkflowResponse deleteByResourceGroup(String resourceGroupName, String workflowName)

Deletes a workflow.

abstract Response<DeleteWorkflowResponse> deleteByResourceGroupWithResponse(String resourceGroupName, String workflowName, Context context)

Deletes a workflow.

abstract Workflow getById(String id)

Gets a workflow.

abstract Response<Workflow> getByIdWithResponse(String id, Context context)

Gets a workflow.

abstract Workflow getByResourceGroup(String resourceGroupName, String workflowName)

Gets a workflow.

abstract Response<Workflow> getByResourceGroupWithResponse(String resourceGroupName, String workflowName, Context context)

Gets a workflow.

abstract PagedIterable<Workflow> list()

Gets a list of workflows associated with the specified subscription.

abstract PagedIterable<Workflow> list(Context context)

Gets a list of workflows associated with the specified subscription.

abstract PagedIterable<Workflow> listByResourceGroup(String resourceGroupName)

Gets a list of workflows within a resource group.

abstract PagedIterable<Workflow> listByResourceGroup(String resourceGroupName, String managedClusterResource, Context context)

Gets a list of workflows within a resource group.

Method Details

define

public abstract Workflow.DefinitionStages.Blank define(String name)

Begins definition for a new Workflow resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Workflow definition.

deleteById

public abstract DeleteWorkflowResponse deleteById(String id)

Deletes a workflow.

Parameters:

id - the resource ID.

Returns:

delete response if content must be provided on delete operation along with Response<T>.

deleteByIdWithResponse

public abstract Response<DeleteWorkflowResponse> deleteByIdWithResponse(String id, Context context)

Deletes a workflow.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

delete response if content must be provided on delete operation along with Response<T>.

deleteByResourceGroup

public abstract DeleteWorkflowResponse deleteByResourceGroup(String resourceGroupName, String workflowName)

Deletes a workflow.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workflowName - The name of the workflow resource.

Returns:

delete response if content must be provided on delete operation.

deleteByResourceGroupWithResponse

public abstract Response<DeleteWorkflowResponse> deleteByResourceGroupWithResponse(String resourceGroupName, String workflowName, Context context)

Deletes a workflow.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workflowName - The name of the workflow resource.
context - The context to associate with this operation.

Returns:

delete response if content must be provided on delete operation along with Response<T>.

getById

public abstract Workflow getById(String id)

Gets a workflow.

Parameters:

id - the resource ID.

Returns:

a workflow along with Response<T>.

getByIdWithResponse

public abstract Response<Workflow> getByIdWithResponse(String id, Context context)

Gets a workflow.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

a workflow along with Response<T>.

getByResourceGroup

public abstract Workflow getByResourceGroup(String resourceGroupName, String workflowName)

Gets a workflow.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workflowName - The name of the workflow resource.

Returns:

a workflow.

getByResourceGroupWithResponse

public abstract Response<Workflow> getByResourceGroupWithResponse(String resourceGroupName, String workflowName, Context context)

Gets a workflow.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workflowName - The name of the workflow resource.
context - The context to associate with this operation.

Returns:

a workflow along with Response<T>.

list

public abstract PagedIterable<Workflow> list()

Gets a list of workflows associated with the specified subscription.

Returns:

a list of workflows associated with the specified subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<Workflow> list(Context context)

Gets a list of workflows associated with the specified subscription.

Parameters:

context - The context to associate with this operation.

Returns:

a list of workflows associated with the specified subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<Workflow> listByResourceGroup(String resourceGroupName)

Gets a list of workflows within a resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

a list of workflows within a resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<Workflow> listByResourceGroup(String resourceGroupName, String managedClusterResource, Context context)

Gets a list of workflows within a resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
managedClusterResource - The ManagedCluster resource associated with the workflows.
context - The context to associate with this operation.

Returns:

a list of workflows within a resource group as paginated response with PagedIterable<T>.

Applies to