Package com.azure.resourcemanager.logic.models

Interface Workflows

public interface Workflows
Resource collection API of Workflows.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<Workflow> list()
      Gets a list of workflows by subscription.
      Returns:
      a list of workflows by subscription as paginated response with PagedIterable.
      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.

    • list

      com.azure.core.http.rest.PagedIterable<Workflow> list(Integer top, String filter, com.azure.core.util.Context context)
      Gets a list of workflows by subscription.
      Parameters:
      top - The number of items to be included in the result.
      filter - The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.
      context - The context to associate with this operation.
      Returns:
      a list of workflows by subscription as paginated response with PagedIterable.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Workflow> listByResourceGroup(String resourceGroupName)
      Gets a list of workflows by resource group.
      Parameters:
      resourceGroupName - The resource group name.
      Returns:
      a list of workflows by resource group as paginated response with PagedIterable.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Workflow> listByResourceGroup(String resourceGroupName, Integer top, String filter, com.azure.core.util.Context context)
      Gets a list of workflows by resource group.
      Parameters:
      resourceGroupName - The resource group name.
      top - The number of items to be included in the result.
      filter - The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.
      context - The context to associate with this operation.
      Returns:
      a list of workflows by resource group as paginated response with PagedIterable.
      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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Workflow> getByResourceGroupWithResponse(String resourceGroupName, String workflowName, com.azure.core.util.Context context)
      Gets a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      context - The context to associate with this operation.
      Returns:
      a workflow along with Response.
      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.

    • getByResourceGroup

      Workflow getByResourceGroup(String resourceGroupName, String workflowName)
      Gets a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      Returns:
      a workflow.
      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.

    • updateWithResponse

      com.azure.core.http.rest.Response<Workflow> updateWithResponse(String resourceGroupName, String workflowName, com.azure.core.util.Context context)
      Updates a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      context - The context to associate with this operation.
      Returns:
      the workflow type along with Response.
      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.

    • update

      Workflow update(String resourceGroupName, String workflowName)
      Updates a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      Returns:
      the workflow type.
      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.

    • deleteByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Void> deleteByResourceGroupWithResponse(String resourceGroupName, String workflowName, com.azure.core.util.Context context)
      Deletes a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      context - The context to associate with this operation.
      Returns:
      the Response.
      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.

    • deleteByResourceGroup

      void deleteByResourceGroup(String resourceGroupName, String workflowName)
      Deletes a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      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.

    • disableWithResponse

      com.azure.core.http.rest.Response<Void> disableWithResponse(String resourceGroupName, String workflowName, com.azure.core.util.Context context)
      Disables a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      context - The context to associate with this operation.
      Returns:
      the Response.
      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.

    • disable

      void disable(String resourceGroupName, String workflowName)
      Disables a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      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.

    • enableWithResponse

      com.azure.core.http.rest.Response<Void> enableWithResponse(String resourceGroupName, String workflowName, com.azure.core.util.Context context)
      Enables a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      context - The context to associate with this operation.
      Returns:
      the Response.
      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.

    • enable

      void enable(String resourceGroupName, String workflowName)
      Enables a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      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.

    • generateUpgradedDefinitionWithResponse

      com.azure.core.http.rest.Response<Object> generateUpgradedDefinitionWithResponse(String resourceGroupName, String workflowName, GenerateUpgradedDefinitionParameters parameters, com.azure.core.util.Context context)
      Generates the upgraded definition for a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      parameters - Parameters for generating an upgraded definition.
      context - The context to associate with this operation.
      Returns:
      any object along with Response.
      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.

    • generateUpgradedDefinition

      Object generateUpgradedDefinition(String resourceGroupName, String workflowName, GenerateUpgradedDefinitionParameters parameters)
      Generates the upgraded definition for a workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      parameters - Parameters for generating an upgraded definition.
      Returns:
      any object.
      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.

    • listCallbackUrlWithResponse

      com.azure.core.http.rest.Response<WorkflowTriggerCallbackUrl> listCallbackUrlWithResponse(String resourceGroupName, String workflowName, GetCallbackUrlParameters listCallbackUrl, com.azure.core.util.Context context)
      Get the workflow callback Url.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      listCallbackUrl - Which callback url to list.
      context - The context to associate with this operation.
      Returns:
      the workflow callback Url along with Response.
      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.

    • listCallbackUrl

      WorkflowTriggerCallbackUrl listCallbackUrl(String resourceGroupName, String workflowName, GetCallbackUrlParameters listCallbackUrl)
      Get the workflow callback Url.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      listCallbackUrl - Which callback url to list.
      Returns:
      the workflow callback Url.
      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.

    • listSwaggerWithResponse

      com.azure.core.http.rest.Response<Object> listSwaggerWithResponse(String resourceGroupName, String workflowName, com.azure.core.util.Context context)
      Gets an OpenAPI definition for the workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      context - The context to associate with this operation.
      Returns:
      an OpenAPI definition for the workflow along with Response.
      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.

    • listSwagger

      Object listSwagger(String resourceGroupName, String workflowName)
      Gets an OpenAPI definition for the workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      Returns:
      an OpenAPI definition for the workflow.
      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.

    • move

      void move(String resourceGroupName, String workflowName, WorkflowReference move)
      Moves an existing workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      move - The workflow to move.
      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.

    • move

      void move(String resourceGroupName, String workflowName, WorkflowReference move, com.azure.core.util.Context context)
      Moves an existing workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      move - The workflow to move.
      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.

    • regenerateAccessKeyWithResponse

      com.azure.core.http.rest.Response<Void> regenerateAccessKeyWithResponse(String resourceGroupName, String workflowName, RegenerateActionParameter keyType, com.azure.core.util.Context context)
      Regenerates the callback URL access key for request triggers.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      keyType - The access key type.
      context - The context to associate with this operation.
      Returns:
      the Response.
      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.

    • regenerateAccessKey

      void regenerateAccessKey(String resourceGroupName, String workflowName, RegenerateActionParameter keyType)
      Regenerates the callback URL access key for request triggers.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      keyType - The access key type.
      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.

    • validateByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Void> validateByResourceGroupWithResponse(String resourceGroupName, String workflowName, WorkflowInner validate, com.azure.core.util.Context context)
      Validates the workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      validate - The workflow.
      context - The context to associate with this operation.
      Returns:
      the Response.
      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.

    • validateByResourceGroup

      void validateByResourceGroup(String resourceGroupName, String workflowName, WorkflowInner validate)
      Validates the workflow.
      Parameters:
      resourceGroupName - The resource group name.
      workflowName - The workflow name.
      validate - The workflow.
      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.

    • validateByLocationWithResponse

      com.azure.core.http.rest.Response<Void> validateByLocationWithResponse(String resourceGroupName, String location, String workflowName, WorkflowInner validate, com.azure.core.util.Context context)
      Validates the workflow definition.
      Parameters:
      resourceGroupName - The resource group name.
      location - The workflow location.
      workflowName - The workflow name.
      validate - The workflow.
      context - The context to associate with this operation.
      Returns:
      the Response.
      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.

    • validateByLocation

      void validateByLocation(String resourceGroupName, String location, String workflowName, WorkflowInner validate)
      Validates the workflow definition.
      Parameters:
      resourceGroupName - The resource group name.
      location - The workflow location.
      workflowName - The workflow name.
      validate - The workflow.
      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

      Workflow getById(String id)
      Gets a workflow.
      Parameters:
      id - the resource ID.
      Returns:
      a workflow along with Response.
      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<Workflow> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets a workflow.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a workflow along with Response.
      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)
      Deletes a workflow.
      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

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a workflow.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the Response.
      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

      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.