request-workflow-cancellation¶

Description¶

Request a long running workflow cancellation by resource ID and workflow type.

Synopsis¶

  request-workflow-cancellation
[--resource-id <value>]
[--workflow-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--resource-id (string)

The unique identifier of the resource.

--workflow-type (string)

The workflow type.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

workflowMetadata -> (array)

The list of workflow metedata for cancelled workflows.

item -> (object)

The workflow metadata.

resourceId -> (string)

The unique identifier of the resource.

workflowIndex -> (integer)

The workflow index. Monotonically increases for each subsequent workflow for a resource.

workflowType -> (string)

The workflow type.

workflowId -> (string)

The workflow identifier.

lastKnownStatus -> (string)

The last known status of the workflow.

Form Factors¶

public, private