az logicapp run action

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 action command. Learn more about extensions.

Inspect the individual actions inside a workflow run.

Commands

Name	Description	Type	Status
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 action list

List the actions of a workflow run and their individual status.

This is the first step in answering why a run failed. run show reports only that an action failed; this names which one. Content links are redacted by default because they carry a SAS token.

az logicapp run action list --run-id
                            --workflow
                            [--context]
                            [--continuation-token --next-token]
                            [--host-key]
                            [--local]
                            [--max-items]
                            [--name]
                            [--port]
                            [--resource-group]
                            [--show-content-urls]

Examples

Find the failed action in a run.

az logicapp run action list --local --port 7071 --workflow process-order --run-id 08584129676611502966413873720CU00 --query "value[?status=='Failed']"

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.

--continuation-token --next-token

Token returned as nextContinuationToken by a previous call, to fetch the next page.

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 actions 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.

--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 action show

Show one action from a workflow run.

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

Examples

Show a single action.

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

Required Parameters

--action

Name of the action inside the run, as it appears in the workflow definition.

--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 action show-content

Download the recorded inputs or outputs of a run action.

The platform stores action payloads out of band and returns only a link. This downloads the payload and prints it, so a connector's underlying error detail is visible without handling a SAS URI by hand. Defaults to outputs. Not every action records both payloads: an action that failed before it produced a response has no outputs at all, and its error text is on run action show instead.

az logicapp run action show-content --action
                                    --run-id
                                    --workflow
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--content {inputs, outputs}]
                                    [--context]
                                    [--host-key]
                                    [--local]
                                    [--max-bytes]
                                    [--name]
                                    [--port]
                                    [--resource-group]

Examples

Read why an action failed.

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

Read the inputs an action was given, capped in size.

az logicapp run action show-content --resource-group orders-rg --name orders-app --workflow process-order --run-id 08584129676611502966413873720CU00 --action Send_message --content inputs --max-bytes 4096

Required Parameters

--action

Name of the action inside the run, as it appears in the workflow definition.

--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

--content

Which recorded payload to download. Defaults to outputs, which is where action failure detail appears.

Property	Value
Default value:	outputs
Accepted values:	inputs, outputs

--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

--max-bytes

Download at most this many bytes of the payload.

--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.

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