az logicapp workflow

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

Manage Logic Apps Standard workflows.

Commands

Name Description Type Status
az logicapp workflow create

Add a workflow to an existing local Logic Apps Standard project.

Extension GA
az logicapp workflow delete

Remove one workflow.json while retaining shared and sibling files.

Extension GA
az logicapp workflow disable

Configure one deployed Standard workflow as Disabled and observe runtime state.

Extension GA
az logicapp workflow enable

Configure one deployed Standard workflow as Enabled and observe runtime state.

Extension GA
az logicapp workflow export

Export one authored workflow.json without changing the app.

Extension GA
az logicapp workflow list

List workflows in a running local or deployed Logic Apps Standard app.

Extension GA
az logicapp workflow set

Replace one existing workflow.json with revision checks and runtime preflight.

Extension GA
az logicapp workflow show

Read a workflow's metadata and authored workflow.json.

Extension GA
az logicapp workflow validate

Validate workflow definitions offline by default.

Extension GA

az logicapp workflow create

Add a workflow to an existing local Logic Apps Standard project.

Authors locally only and makes no network call. Writes just the workflow's workflow.json, leaving host.json and local.settings.json untouched, so adding a second workflow is non-destructive. Not idempotent: it fails if the workflow already exists, so it is safe to retry only with --force.

az logicapp workflow create --workflow
                            [--acquire-policy-token]
                            [--change-reference]
                            [--context]
                            [--file]
                            [--force]
                            [--kind {Stateful, Stateless}]
                            [--path]

Examples

Add a workflow using the starter template.

az logicapp workflow create --path .\orders --workflow process-order

Add a workflow from an authored definition.

az logicapp workflow create --path .\orders --workflow send-message --file .\send.json

Required Parameters

--workflow

Name of the workflow to add.

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 project context. Cloud contexts are refused, not replaced by another local target.

--file

Existing workflow.json or bare definition to use instead of the starter template.

--force

Replace the workflow if it already exists. Not safe to retry without it.

Property Value
Default value: False
--kind

Workflow kind. Defaults to Stateful, or the kind in --file.

Property Value
Accepted values: Stateful, Stateless
--path

Existing project root. Defaults to local context path or current directory.

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

Remove one workflow.json while retaining shared and sibling files.

Requires --allow-non-atomic to acknowledge the runtime's non-transactional VFS behavior. Reads and checks the existing supported workflow and exact revision, prompts unless --yes is supplied, rechecks after confirmation, and conditionally deletes only workflow.json. Verifies absence with a file-plane 404; unknown outcomes or a recreated file are errors, never silently retried. --if-match optionally binds deletion to an earlier show/export revision.

Other workflow files and the workflow directory are retained, as are shared app settings, connections, artifacts and identities. Runtime removal is asynchronous; this does not cancel active runs, purge run history or delete the app resource. Export first for recovery. No wildcard/force revision bypass is supported.

az logicapp workflow delete --workflow
                            [--acquire-policy-token]
                            [--allow-non-atomic]
                            [--change-reference]
                            [--context]
                            [--host-key]
                            [--if-match]
                            [--local]
                            [--name]
                            [--port]
                            [--resource-group]
                            [--yes]

Examples

Delete a workflow on a running local host.

az logicapp workflow delete --local --workflow hello --allow-non-atomic --yes

Delete one workflow using a saved target and confirmation.

az logicapp workflow delete --context dev --workflow hello --allow-non-atomic

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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--allow-non-atomic

Required acknowledgement that VFS mutations are not transactional and cannot guarantee rollback or prevent every race.

Property Value
Default value: False
--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.

--if-match

Exact ETag from workflow show/export. Refuse a stale edit. Wildcards and weak ETags are rejected; ETags are always checked even when omitted.

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

Do not prompt for confirmation. Does not bypass revision checks or non-atomic acknowledgement.

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

Configure one deployed Standard workflow as Disabled and observe runtime state.

Supports deployed Stateful/Stateless workflows using -g/-n or a cloud context. Local runtime targets are rejected without requests, file edits or host restarts. Disabling stops new ordinary workflow instances/triggers after propagation; existing in-progress/pending runs continue. This does not cancel runs, purge history, reset triggers or stop the app resource. Requires --allow-non-atomic and confirmation unless --yes is supplied. App Service replaces the entire settings map; values are retained from a snapshot, but unrelated concurrent changes can be lost. There is no settings ETag/transaction guarantee. Settings updates can have hosting/reload effects. configuredState is verified by settings readback; runtimeState is a separate single observation. Pending/unknown results warn instead of claiming trigger quiescence. Already configured requests do not write or prompt. No automatic retry/rollback is attempted, and uncertain writes/readbacks return errors. Neither settings values nor raw provider errors appear in command results or this operation's REST debug logs.

az logicapp workflow disable --workflow
                             [--acquire-policy-token]
                             [--allow-non-atomic]
                             [--change-reference]
                             [--context]
                             [--host-key]
                             [--local]
                             [--name]
                             [--port]
                             [--resource-group]
                             [--yes]

Examples

Disable only hello, without stopping its app or cancelling runs.

az logicapp workflow disable -g my-rg -n my-app --workflow hello --allow-non-atomic

Disable a workflow through a saved deployed target.

az logicapp workflow disable --context production --workflow hello --allow-non-atomic --yes

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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--allow-non-atomic

Required acknowledgement that App Service replaces the complete app settings map. Concurrent unrelated changes can be lost despite preflight/readback.

Property Value
Default value: False
--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

Do not prompt for confirmation. Does not bypass snapshot checks or non-atomic acknowledgement.

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

Configure one deployed Standard workflow as Enabled and observe runtime state.

Supports deployed Stateful/Stateless workflows using -g/-n or a cloud context. Local runtime targets are rejected without editing files or restarting hosts. Requires --allow-non-atomic because App Service replaces the entire app settings map when setting Workflows.<name>.FlowState. Other settings are preserved from the snapshot, but concurrent unrelated updates can be lost despite preflight and readback. Coordinate all settings writers. Requires confirmation unless --yes is supplied; enabling may process accumulated trigger backlog. Reports verified configuredState separately from runtimeState after one runtime observation. Converged means matching metadata, not drained runs or proof that all dispatchers are quiescent. Pending/unknown states produce warnings without automatic retries or rollback. This does not start/stop the app, edit definitions, cancel runs or purge history. App settings and provider error bodies are not exposed, including by this operation's REST debug logs.

az logicapp workflow enable --workflow
                            [--acquire-policy-token]
                            [--allow-non-atomic]
                            [--change-reference]
                            [--context]
                            [--host-key]
                            [--local]
                            [--name]
                            [--port]
                            [--resource-group]
                            [--yes]

Examples

Enable one deployed workflow after coordinating settings writers.

az logicapp workflow enable -g my-rg -n my-app --workflow hello --allow-non-atomic

Use a saved deployed target without prompting.

az logicapp workflow enable --context production --workflow hello --allow-non-atomic --yes

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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--allow-non-atomic

Required acknowledgement that App Service replaces the complete app settings map. Concurrent unrelated changes can be lost despite preflight/readback.

Property Value
Default value: False
--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

Do not prompt for confirmation. Does not bypass snapshot checks or non-atomic acknowledgement.

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

Export one authored workflow.json without changing the app.

Preserves the actual Stateful or Stateless kind and the complete authored workflow file, including expressions and runtime configuration. Requires a .json destination outside the filesystem root and --force to replace a file. Publishes the complete file atomically; directories and symbolic links are rejected. No full app download, connections or app credentials are included. Definitions can contain authored sensitive literals: protect the output file. The result includes the source file etag for a later --if-match guard.

az logicapp workflow export --output-path
                            --workflow
                            [--acquire-policy-token]
                            [--change-reference]
                            [--context]
                            [--force]
                            [--host-key]
                            [--local]
                            [--name]
                            [--port]
                            [--resource-group]

Examples

Export one local workflow.

az logicapp workflow export --local --workflow hello --output-path .\download\hello\workflow.json

Export one deployed workflow.

az logicapp workflow export -g my-rg -n my-app --workflow hello --output-path .\hello.json

Required Parameters

--output-path

Destination .json file for one workflow. Not a full app export. Definitions can contain authored secrets.

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

--force

Atomically replace an existing regular output file.

Property Value
Default value: False
--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.

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

List workflows in a running local or deployed Logic Apps Standard app.

Returns value and nextContinuationToken. Each item has name, kind, state and health. Fetches the entire service inventory before client-side paging, sorted by name. Tokens are offsets, not snapshots; inventory changes between calls can shift page boundaries. Unknown state or health is reported as null. Inventory traversal allows at most 100 service pages and 10000 accumulated entries, failing explicitly without partial results when either limit is exceeded.

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

Examples

Discover workflows in a local runtime.

az logicapp workflow list --local --port 7071 --output table

Discover workflows in a deployed app.

az logicapp workflow list --resource-group my-rg --name my-app

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

Client-side offset token from nextContinuationToken. Inventory is read completely on each call before paging.

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

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

Replace one existing workflow.json with revision checks and runtime preflight.

Requires a complete --file with the same Stateful/Stateless kind. Performs static checks and target-runtime definition validation before writing. Reads the current file revision, confirms the target, rechecks after confirmation, writes with an exact If-Match, and verifies the write receipt and file bytes. --if-match can also bind the update to the revision from a previous show/export. No --force bypass is available. Identical input is validated but not written.

Requires --allow-non-atomic: VFS is not transactional. ETag checks cannot prevent every race or partial upload, and a concurrently deleted file can be recreated. Export first and coordinate with other writers. Unexpected creation, ambiguous failures and unverified results fail explicitly. A mismatched owned revision is conditionally restored only when ownership can be verified; newer or missing files are not blindly overwritten. Guaranteed rollback is not available.

Verification covers the authored file, not execution or completed runtime reload. This does not create a new workflow intentionally, convert its kind, change shared settings/connections, or cancel runs. Read-only/run-from-package targets may reject writes; use documented deployment commands instead.

az logicapp workflow set --file
                         --workflow
                         [--acquire-policy-token]
                         [--allow-non-atomic]
                         [--change-reference]
                         [--context]
                         [--host-key]
                         [--if-match]
                         [--local]
                         [--name]
                         [--port]
                         [--resource-group]
                         [--yes]

Examples

Update a workflow on a running local host after retaining an export.

az logicapp workflow set --local --workflow hello --file .\edited\workflow.json --allow-non-atomic --yes

Guard a deployed update using the ETag obtained during export.

az logicapp workflow set -g my-rg -n my-app --workflow hello --file .\edited\workflow.json --if-match saved-etag --allow-non-atomic

Required Parameters

--file

Complete authored workflow.json replacing the existing workflow, with the same Stateful/Stateless kind. Not a bare definition or partial patch.

--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
--allow-non-atomic

Required acknowledgement that VFS mutations are not transactional and cannot guarantee rollback or prevent every race.

Property Value
Default value: False
--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.

--if-match

Exact ETag from workflow show/export. Refuse a stale edit. Wildcards and weak ETags are rejected; ETags are always checked even when omitted.

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

Do not prompt for confirmation. Does not bypass revision checks or non-atomic acknowledgement.

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

Read a workflow's metadata and authored workflow.json.

Returns name, kind, state, health, etag, and workflow (the complete workflow.json object). Reads the runtime metadata and file plane with the same target and authentication. Does not resolve app settings or download connections, credentials, or other app files. Authored definitions can themselves contain sensitive literals. JSON output contains the definition; table output shows only name, kind, state and health. The etag can be passed to set/delete --if-match to guard an editing session.

az logicapp workflow show --workflow
                          [--context]
                          [--host-key]
                          [--local]
                          [--name]
                          [--port]
                          [--resource-group]

Examples

Read one local workflow.

az logicapp workflow show --local --workflow hello

Read a workflow using a saved context.

az logicapp workflow show --context dev --workflow hello

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.

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

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

Validate workflow definitions offline by default.

Invalid workflow shapes, including non-object triggers, are returned as structured validation findings rather than unexpected exceptions. Static validation continues checking actions and references when triggers are invalid.

az logicapp workflow validate [--acquire-policy-token]
                              [--all]
                              [--change-reference]
                              [--context]
                              [--fail-on-warning]
                              [--host-key]
                              [--local]
                              [--name]
                              [--path]
                              [--port]
                              [--resource-group]
                              [--with-runtime]
                              [--workflow]

Examples

Validate one workflow in a local project.

az logicapp workflow validate --path .\orders --workflow process-order

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

Validate every workflow.

Property Value
Default value: False
--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.

--fail-on-warning

Warnings cause a non-zero exit.

Property Value
Default value: False
--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.

--path

Project root. Defaults to local context path or current directory.

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

--with-runtime

Also run runtime-backed validation.

Property Value
Default value: False
--workflow

Validate one workflow.

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