az logicapp runtime

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

Manage local Logic Apps Standard runtimes.

Commands

Name Description Type Status
az logicapp runtime doctor

Diagnose a local project's runtime prerequisites without changing them.

Extension GA
az logicapp runtime show

Show local Logic Apps Standard runtime status.

Extension GA
az logicapp runtime start

Start a local Logic Apps Standard runtime.

Extension GA
az logicapp runtime stop

Stop a local runtime started by this CLI.

Extension GA

az logicapp runtime doctor

Diagnose a local project's runtime prerequisites without changing them.

Reads project files, selected child-environment tool versions, cached bundle evidence and literal loopback ports. Never installs, downloads, starts, stops, repairs, decrypts settings, changes context, or contacts cloud storage. Configuration and upstream values are not printed. A stopped host is an optional skipped live probe, not an offline preflight failure. Unknown tool and bundle compatibility is not healthy. This is not a workflow business test. Exit 0 means no required blockers or unknown checks, 1 means a required failure, and 2 means a required unknown (or optional failed/warning/unknown with --strict). JSON and table findings are printed before a diagnostic nonzero exit. Exact tool/bundle compatibility remains required unknown, so an otherwise responsive project normally exits 2; unknown is not failure or healthy certification.

az logicapp runtime doctor [--acquire-policy-token]
                           [--change-reference]
                           [--context]
                           [--path]
                           [--port]
                           [--probe-timeout]
                           [--strict]

Examples

Diagnose a local project and preserve JSON findings for CI.

az logicapp runtime doctor --path .\orders --output json

Inspect a saved local context in a human-readable table.

az logicapp runtime doctor --context orders-local --output table

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 local context. Cannot combine with --path or --port.

--path

Local project root. Defaults to active local context or current directory.

--port

Local host port. Defaults to saved context port or 7071.

--probe-timeout

Per-probe timeout in seconds, 1 to 10. No downloads or service starts.

Property Value
Default value: 2
--strict

Also exit 2 for optional failed, warning or unknown checks.

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

Show local Logic Apps Standard runtime status.

az logicapp runtime show [--port]

Examples

Show runtime status.

az logicapp runtime show --port 7071

Optional Parameters

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

--port

Local runtime port to inspect. Defaults to the saved local context port, otherwise 7071.

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

Start a local Logic Apps Standard runtime.

When the project's local.settings.json sets AzureWebJobsStorage to UseDevelopmentStorage=true, the Azurite storage emulator is started automatically on ports 10000-10002 unless one is already serving there, in which case it is reused. Only an emulator this CLI started is ever stopped, and only once no CLI-started foreground or background runtime is still using it. Process ownership is checked using both PID and creation time on Windows, Linux, and macOS; an unverified or recycled PID is never stopped. Pass --no-azurite to manage the emulator yourself.

az logicapp runtime start [--acquire-policy-token]
                          [--background]
                          [--change-reference]
                          [--no-azurite]
                          [--path]
                          [--port]
                          [--ready-timeout]

Examples

Start a project runtime in the background.

az logicapp runtime start --path .\orders --port 7071 --background

Start a runtime without touching the storage emulator.

az logicapp runtime start --path .\orders --port 7071 --background --no-azurite

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

Detach and record process identity for stop.

Property Value
Default value: False
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-azurite

Do not start the Azurite storage emulator. By default it is started when the project uses development storage and nothing is already serving on port 10000.

Property Value
Default value: False
--path

Project root to run.

--port

Listener port. Defaults to the saved local context port, otherwise 7071.

--ready-timeout

Seconds to wait for the management endpoint to answer when running in the background. 0 returns immediately without waiting.

Property Value
Default value: 30
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 runtime stop

Stop a local runtime started by this CLI.

A retry can remove a cleanup-pending receipt once every recorded process and launch consumer has exited and the port is idle. It never signals a recycled or unverifiable PID. Confirmed exited Windows processes may still have open handles. Recovered receipts report result already-exited rather than terminated.

az logicapp runtime stop [--acquire-policy-token]
                         [--all]
                         [--change-reference]
                         [--port]

Examples

Stop one CLI-started runtime.

az logicapp runtime stop --port 7071

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

Stop all runtimes previously started by this CLI.

Property Value
Default value: False
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--port

Stop CLI-started runtime on this port. Defaults to the saved local context port, otherwise 7071. Ignored with --all.

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