az logicapp run

Note

This reference is part of the logicapp extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az logicapp run command. Learn more about extensions.

Manage Logic Apps Standard workflow runs.

Commands

Name	Description	Type	Status
az logicapp run action	Inspect the individual actions inside a workflow run.	Extension	GA
az logicapp run action list	List the actions of a workflow run and their individual status.	Extension	GA
az logicapp run action show	Show one action from a workflow run.	Extension	GA
az logicapp run action show-content	Download the recorded inputs or outputs of a run action.	Extension	GA
az logicapp run cancel	Request cancellation of one Stateful workflow run.	Extension	GA
az logicapp run list	List workflow runs.	Extension	GA
az logicapp run resubmit	Request a new Stateful execution starting from one eligible action of a completed run.	Extension	GA
az logicapp run show	Show one workflow run.	Extension	GA
az logicapp run start	Start a workflow run by firing a trigger.	Extension	GA
az logicapp run wait	Wait for a Stateful run to reach a terminal status within a deadline.	Extension	GA

az logicapp run cancel

Request cancellation of one Stateful workflow run.

Requires confirmation or --yes. A POST acknowledgement is not cancellation: without --wait a bounded readback reports cancelled, pending or an observation failure. --wait requires observed Cancelled for exit 0; another terminal state exits 4 and a wait deadline exits 2. Already-terminal runs are unchanged (exit 0) without POST. Cancellation does not roll back effects or guarantee in-flight actions stop. No uncertain request is retried, and timeout never sends another cancellation. Stateless workflows are rejected before mutation.

az logicapp run cancel --run-id
                       --workflow
                       [--acquire-policy-token]
                       [--change-reference]
                       [--context]
                       [--host-key]
                       [--interval]
                       [--local]
                       [--name]
                       [--port]
                       [--resource-group]
                       [--timeout]
                       [--wait]
                       [--yes]

Examples

Request cancellation and wait for an observed Cancelled status.

az logicapp run cancel --local --workflow hello --run-id RUN_ID --yes --wait --timeout 60 --interval 2

Required Parameters

--run-id

Workflow run id.

--workflow

Workflow name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--context

Named Logic Apps CLI context used to resolve target coordinates.

--host-key

Master key for a local host that requires one. Sent as an x-functions-key header.

--interval

Polling interval in seconds (1-300), no greater than timeout. Defaults to 5.

Property	Value
Default value:	5

--local

Target a local Logic Apps runtime instead of a deployed app.

Property	Value
Default value:	False

--name -n

Name of the Logic App Standard site.

--port

Local runtime port. Requires --local when supplied on the command line.

--resource-group -g

Name of resource group containing the Logic App Standard site.

--timeout

Observation deadline in seconds (1-86400). Timeout never cancels a run. Defaults to 300.

Property	Value
Default value:	300

--wait

Wait for observed Cancelled status, not just POST acknowledgement.

Property	Value
Default value:	False

--yes -y

Skip interactive confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az logicapp run list

List workflow runs.

Pages server-side. Each response carries nextContinuationToken; pass it back as --next-token to fetch the next page. Do not derive the token yourself: the platform's token is what keeps runs created between pages from being skipped.

az logicapp run list --workflow
                     [--context]
                     [--continuation-token --next-token]
                     [--host-key]
                     [--local]
                     [--max-items]
                     [--name]
                     [--port]
                     [--resource-group]
                     [--status]

Examples

List the most recent runs from a local runtime.

az logicapp run list --local --port 7071 --workflow process-order --max-items 20

List only failed runs of a deployed app.

az logicapp run list --resource-group orders-rg --name orders-app --workflow process-order --status Failed

Required Parameters

--workflow

Workflow name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--context

Named Logic Apps CLI context used to resolve target coordinates.

--continuation-token --next-token

Server-side continuation token returned as nextContinuationToken by a previous run list call; sent to the service as native $skiptoken and treated as opaque by the CLI. Do not derive the token yourself.

Property	Value
Parameter group:	Pagination Arguments

--host-key

Master key for a local host that requires one. Sent as an x-functions-key header.

--local

Target a local Logic Apps runtime instead of a deployed app.

Property	Value
Default value:	False

--max-items

Maximum number of runs to return in this page.

Property	Value
Parameter group:	Pagination Arguments

--name -n

Name of the Logic App Standard site.

--port

Local runtime port. Requires --local when supplied on the command line.

--resource-group -g

Name of resource group containing the Logic App Standard site.

--status

Filter by run status, for example Failed or Succeeded.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az logicapp run resubmit

Request a new Stateful execution starting from one eligible action of a completed run.

Requires --workflow, --run-id and one --action, plus confirmation or --yes. This is the run-resubmit API with actionsToResubmit, not trigger-history replay. The runtime must advertise canResubmit=true for that executed action; missing, false or malformed eligibility, skipped actions and active source runs refuse before POST. The CLI never enables the feature or emulates graph eligibility. Run/action identity and stable metadata are rechecked after confirmation. The runtime uses the source workflow version and retained prior results. Selected/dependent actions can repeat external effects with current connections and settings. This is a new execution, not in-place resume or exactly-once recovery. HTTP 202 reports accepted, not completed. newRunId comes only from the service; a missing identity reports acceptedNewRunIdUnknown. No Location/latest-run fallback, trigger-history substitution, configuration restore or automatic POST retry. Use run wait separately when a new identity is returned. Preflight/submission each use a 60-second deadline excluding interactive confirmation time.

az logicapp run resubmit --action
                         --run-id
                         --workflow
                         [--acquire-policy-token]
                         [--change-reference]
                         [--context]
                         [--host-key]
                         [--local]
                         [--name]
                         [--port]
                         [--resource-group]
                         [--yes]

Examples

Resubmit one eligible action from a retained completed Stateful run.

az logicapp run resubmit --local --workflow hello --run-id RUN_ID --action Send_HTTP --yes

Required Parameters

--action

One executed action in the completed source run; requires runtime canResubmit=true.

--run-id

Workflow run id.

--workflow

Workflow name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--context

Named Logic Apps CLI context used to resolve target coordinates.

--host-key

Master key for a local host that requires one. Sent as an x-functions-key header.

--local

Target a local Logic Apps runtime instead of a deployed app.

Property	Value
Default value:	False

--name -n

Name of the Logic App Standard site.

--port

Local runtime port. Requires --local when supplied on the command line.

--resource-group -g

Name of resource group containing the Logic App Standard site.

--yes -y

Skip confirmation of a new execution and potentially repeated external effects.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az logicapp run show

Show one workflow run.

az logicapp run show --run-id
                     --workflow
                     [--context]
                     [--host-key]
                     [--local]
                     [--name]
                     [--port]
                     [--resource-group]
                     [--show-content-urls]

Examples

Show a run from a local runtime.

az logicapp run show --local --port 7071 --workflow process-order --run-id 08584129676611502966413873720CU00

Required Parameters

--run-id

Workflow run id.

--workflow

Workflow name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--context

Named Logic Apps CLI context used to resolve target coordinates.

--host-key

Master key for a local host that requires one. Sent as an x-functions-key header.

--local

Target a local Logic Apps runtime instead of a deployed app.

Property	Value
Default value:	False

--name -n

Name of the Logic App Standard site.

--port

Local runtime port. Requires --local when supplied on the command line.

--resource-group -g

Name of resource group containing the Logic App Standard site.

--show-content-urls

Emit SAS-bearing content-link URIs. Default redacts URI values.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az logicapp run start

Start a workflow run by firing a trigger.

az logicapp run start --trigger
                      --workflow
                      [--acquire-policy-token]
                      [--change-reference]
                      [--context]
                      [--host-key]
                      [--local]
                      [--name]
                      [--payload-file]
                      [--port]
                      [--resource-group]

Examples

Start a run against a local runtime.

az logicapp run start --local --port 7071 --workflow process-order --trigger manual --payload-file .\payload.json

Required Parameters

--trigger

Trigger name.

--workflow

Workflow name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--context

Named Logic Apps CLI context used to resolve target coordinates.

--host-key

Master key for a local host that requires one. Sent as an x-functions-key header.

--local

Target a local Logic Apps runtime instead of a deployed app.

Property	Value
Default value:	False

--name -n

Name of the Logic App Standard site.

--payload-file

JSON payload file.

--port

Local runtime port. Requires --local when supplied on the command line.

--resource-group -g

Name of resource group containing the Logic App Standard site.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az logicapp run wait

Wait for a Stateful run to reach a terminal status within a deadline.

Supports running local and deployed Standard apps and saved targets. Exit 0 means observed Succeeded; 4 means a different terminal status; 2 means the CLI wait deadline expired (not workflow TimedOut); 1 means an observation error. Missing runs, authorization failures, malformed responses and unknown statuses fail promptly. No missing-run grace period, implicit cancellation or retry. JSON/table/query output is preserved before nonzero result exits. Responses omit inputs, outputs, provider errors and signed URLs. Each network request is bounded; an in-flight read may exceed the polling deadline by its 5-second read timeout. OS DNS resolution and CLI token acquisition are not forcibly interrupted by that network timeout.

az logicapp run wait --run-id
                     --workflow
                     [--acquire-policy-token]
                     [--change-reference]
                     [--context]
                     [--host-key]
                     [--interval]
                     [--local]
                     [--name]
                     [--port]
                     [--resource-group]
                     [--timeout]

Examples

Wait up to a minute for a local Stateful run.

az logicapp run wait --local --workflow hello --run-id RUN_ID --timeout 60 --interval 2

Required Parameters

--run-id

Workflow run id.

--workflow

Workflow name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--context

Named Logic Apps CLI context used to resolve target coordinates.

--host-key

Master key for a local host that requires one. Sent as an x-functions-key header.

--interval

Polling interval in seconds (1-300), no greater than timeout. Defaults to 5.

Property	Value
Default value:	5

--local

Target a local Logic Apps runtime instead of a deployed app.

Property	Value
Default value:	False

--name -n

Name of the Logic App Standard site.

--port

Local runtime port. Requires --local when supplied on the command line.

--resource-group -g

Name of resource group containing the Logic App Standard site.

--timeout

Observation deadline in seconds (1-86400). Timeout never cancels a run. Defaults to 300.

Property	Value
Default value:	300

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False