az logicapp

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage logic apps.

Commands

Name	Description	Type	Status
az logicapp config	Configure a logic app.	Core	GA
az logicapp config appsettings	Configure logic app settings.	Core	GA
az logicapp config appsettings delete	Delete a logic app's settings.	Core	GA
az logicapp config appsettings list	Show settings for a logic app.	Core	GA
az logicapp config appsettings set	Update a logic app's settings.	Core	GA
az logicapp connection	Author local and inspect deployed Logic Apps Standard connections.	Extension	GA
az logicapp connection acl	Manage access policies on a managed API connection.	Extension	GA
az logicapp connection acl add	Grant an Entra identity access to a managed API connection.	Extension	GA
az logicapp connection acl list	List access policies on a managed API connection.	Extension	GA
az logicapp connection acl remove	Remove an access policy from a managed API connection.	Extension	GA
az logicapp connection acl show	Show one access policy on a managed API connection.	Extension	GA
az logicapp connection create	Add a service provider connection to a local project, or a managed API connection to a deployed app.	Extension	GA
az logicapp connection delete	Remove a connection from a deployed Logic App.	Extension	GA
az logicapp connection list	List connections wired into a deployed Logic App Standard app.	Extension	GA
az logicapp connection managed	Create managed API connections for deployed Logic Apps Standard sites.	Extension	GA
az logicapp connection managed create	Create and wire a managed API connection using distinct connection and app names.	Extension	GA
az logicapp connection show	Show one connection wired into a deployed Logic App Standard app.	Extension	GA
az logicapp connection test	Test a configured Logic Apps Standard connection.	Extension	GA
az logicapp connector	Inspect Logic Apps Standard connectors.	Extension	GA
az logicapp connector list	List connectors visible to a Logic Apps Standard runtime.	Extension	GA
az logicapp connector managed	Inspect Azure managed connectors from the ARM APIHub catalog.	Extension	GA
az logicapp connector managed list	List Azure managed connectors from the ARM APIHub catalog.	Extension	GA
az logicapp connector managed operation	Inspect operations exposed by an Azure managed connector.	Extension	GA
az logicapp connector managed operation list	List operations for one Azure managed connector.	Extension	GA
az logicapp connector managed operation show	Show one operation for an Azure managed connector.	Extension	GA
az logicapp connector managed show	Show one Azure managed connector from ARM APIHub.	Extension	GA
az logicapp connector operation	Inspect operations exposed by a built-in (service provider) connector.	Extension	GA
az logicapp connector operation list	List operations exposed by a built-in (service provider) connector.	Extension	GA
az logicapp connector operation show	Show one operation exposed by a built-in (service provider) connector.	Extension	GA
az logicapp connector show	Show one connector from a Logic Apps Standard runtime.	Extension	GA
az logicapp context	Manage saved Logic Apps target shortcuts.	Extension	GA
az logicapp context create	Create a named Logic Apps CLI context.	Extension	GA
az logicapp context delete	Delete one saved shortcut, never a project or Azure resource.	Extension	GA
az logicapp context list	List saved targets with their active selection.	Extension	GA
az logicapp context show	Show a named saved target, or the active target.	Extension	GA
az logicapp context update	Edit an existing saved target without changing its selection.	Extension	GA
az logicapp context use	Select the active Logic Apps CLI context.	Extension	GA
az logicapp create	Create a logic app.	Core	GA
az logicapp delete	Delete a logic app.	Core	GA
az logicapp dependency	Inspect and install Logic Apps Standard local dependencies.	Extension	GA
az logicapp dependency check	Check local dependencies required by Logic Apps Standard tooling.	Extension	GA
az logicapp dependency install	Download and install local dependencies required by Logic Apps Standard tooling.	Extension	GA
az logicapp dependency uninstall	Remove local dependencies that this CLI installed.	Extension	GA
az logicapp deployment	Manage logic app deployments.	Core and Extension	GA
az logicapp deployment package	Create a deterministic deployment package for a Logic Apps Standard project.	Extension	GA
az logicapp deployment source	Manage logicapp app deployment via source control.	Core	GA
az logicapp deployment source config-zip	Perform deployment using the kudu zip push deployment for a logic app.	Core	GA
az logicapp identity	Manage the managed identity of a deployed Logic App Standard site.	Extension	GA
az logicapp identity assign	Assign a managed identity to a deployed Logic App.	Extension	GA
az logicapp identity remove	Remove a managed identity from a deployed Logic App.	Extension	GA
az logicapp identity show	Show the managed identity of a deployed Logic App.	Extension	GA
az logicapp list	List logic apps.	Core	GA
az logicapp project	Manage local Logic Apps Standard projects.	Extension	GA
az logicapp project create	Create or adopt a local Logic Apps Standard project.	Extension	GA
az logicapp restart	Restart a logic app.	Core	GA
az logicapp run	Manage Logic Apps Standard workflow runs.	Extension	GA
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 runtime	Manage local Logic Apps Standard runtimes.	Extension	GA
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 scale	Scale a logic app.	Core	GA
az logicapp show	Get the details of a logic app.	Core	GA
az logicapp start	Start a logic app.	Core	GA
az logicapp stop	Stop a logic app.	Core	GA
az logicapp test	Scaffold, inspect and explicitly run local native SDK test projects.	Extension	GA
az logicapp test create	Scaffold a native SDK test project without restoring packages or running code.	Extension	GA
az logicapp test plan	Produce a bounded, versioned local preflight report; never run tests.	Extension	GA
az logicapp test results	Inspect saved preflight or sanitized native test reports.	Extension	GA
az logicapp test results show	Inspect a saved JSON test report without rerunning tests or following embedded paths.	Extension	GA
az logicapp test run	Explicitly build and run reviewed native SDK/MSTest tests with a deadline.	Extension	GA
az logicapp trigger	Manage Logic Apps Standard workflow triggers.	Extension	GA
az logicapp trigger history	Replay explicitly selected retained trigger histories.	Extension	GA
az logicapp trigger history resubmit	Request a new Stateful execution from an explicit retained fired trigger history.	Extension	GA
az logicapp update	Update a logic app.	Core	GA
az logicapp workflow	Manage Logic Apps Standard workflows.	Extension	GA
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 create

Create a logic app.

The logic app's name must be able to produce a unique FQDN as AppName.azurewebsites.net.

az logicapp create --name
                   --resource-group
                   --storage-account
                   [--acquire-policy-token]
                   [--app-insights]
                   [--app-insights-key]
                   [--change-reference]
                   [--deployment-container-image-name]
                   [--deployment-local-git]
                   [--deployment-source-branch]
                   [--deployment-source-url]
                   [--disable-app-insights {false, true}]
                   [--docker-registry-server-password]
                   [--docker-registry-server-user]
                   [--domain-name-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
                   [--functions-version {4}]
                   [--https-only {false, true}]
                   [--plan]
                   [--runtime-version {~14, ~16, ~18}]
                   [--tags]

Examples

Create a basic logic app.

az logicapp create -g myRG --subscription mySubscription -p MyPlan -n myLogicApp -s myStorageAccount

Create a logic app with a unique domain name scope.

az logicapp create -g myRG --subscription mySubscription -p MyPlan -n myLogicApp -s myStorageAccount --domain-name-scope TenantReuse

Required Parameters

--name -n

Name of the new logic app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--storage-account -s

Provide a string value of a Storage Account in the provided Resource Group. Or Resource ID of a Storage Account in a different Resource Group.

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

--app-insights

Name of the existing App Insights project to be added to the logic app. Must be in the same resource group.

--app-insights-key

Instrumentation key of App Insights to be added.

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--deployment-container-image-name -i

Container image name from container registry, e.g. publisher/image-name:tag.

--deployment-local-git -l

Enable local git.

--deployment-source-branch -b

The branch to deploy.

Property	Value
Default value:	master

--deployment-source-url -u

Git repository URL to link with manual integration.

--disable-app-insights

Disable creating application insights resource during logicapp create. No logs will be available.

Property	Value
Accepted values:	false, true

--docker-registry-server-password -w

The container registry server password. Required for private registries.

--docker-registry-server-user -d

The container registry server username.

--domain-name-scope

Specify the scope of uniqueness for the default hostname during resource creation.

Property	Value
Accepted values:	NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse

--functions-version -v

The functions version for logic app.

Property	Value
Default value:	4
Accepted values:	4

--https-only

Redirect all traffic made to an app using HTTP to HTTPS.

Property	Value
Default value:	False
Accepted values:	false, true

--plan -p

Name or resource id of the logicapp app service plan. Use 'appservice plan create' to get one. If using an App Service plan from a different resource group, the full resource id must be used and not the plan name.

--runtime-version

The runtime version for logic app.

Property	Value
Accepted values:	~14, ~16, ~18

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 delete

Delete a logic app.

az logicapp delete --name
                   --resource-group
                   [--acquire-policy-token]
                   [--change-reference]
                   [--slot]
                   [--yes]

Examples

Delete a logic app.

az logicapp delete --name myLogicApp --resource-group myRG --subscription mySubscription

Required Parameters

--name -n

Name of the logic app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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

--slot -s

The name of the slot. Default to the productions slot if not specified.

--yes -y

Do not prompt for 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 list

List logic apps.

az logicapp list [--resource-group]

Examples

List default host name and state for all logic apps.

az logicapp list --query "[].hostName: defaultHostName, state: state"

List all running logic apps.

az logicapp list --query "[?state=='Running']"

Optional Parameters

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 restart

Restart a logic app.

az logicapp restart --name
                    --resource-group
                    [--acquire-policy-token]
                    [--change-reference]
                    [--slot]

Examples

Restart a logic app.

az logicapp restart --name myLogicApp --resource-group myRG

Required Parameters

--name -n

Name of the logic app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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

--slot -s

The name of the slot. Default to the productions slot if not specified.

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 scale

Scale a logic app.

az logicapp scale --name
                  --resource-group
                  [--acquire-policy-token]
                  [--change-reference]
                  [--max-instances]
                  [--min-instances]
                  [--slot]

Examples

Scale a logic app.

az logicapp scale --name myLogicApp --resource-group myRG --subscription mySubscription --min-instances 2 --max-instances 4

Required Parameters

--name -n

Name of the logic app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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

--max-instances

The maximum number of instances this logic app can scale out to under load.

--min-instances

The number of instances that are always ready and warm for this logic app.

--slot -s

The name of the slot. Default to the productions slot if not specified.

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 show

Get the details of a logic app.

az logicapp show --name
                 --resource-group

Examples

Get the details of a logic app.

az logicapp show --name myLogicApp --resource-group myRG --subscription mySubscription

Required Parameters

--name -n

Name of the logic app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 start

Start a logic app.

az logicapp start --name
                  --resource-group
                  [--acquire-policy-token]
                  [--change-reference]
                  [--slot]

Examples

Start a logic app

az logicapp start --name myLogicApp --resource-group myRG

Required Parameters

--name -n

Name of the logic app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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

--slot -s

The name of the slot. Default to the productions slot if not specified.

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 stop

Stop a logic app.

az logicapp stop --name
                 --resource-group
                 [--acquire-policy-token]
                 [--change-reference]
                 [--slot]

Examples

Stop a logic app.

az logicapp stop --name myLogicApp --resource-group myRG

Required Parameters

--name -n

Name of the logic app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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

--slot -s

The name of the slot. Default to the productions slot if not specified.

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 update

Update a logic app.

az logicapp update --name
                   --resource-group
                   [--acquire-policy-token]
                   [--add]
                   [--change-reference]
                   [--force-string]
                   [--plan]
                   [--remove]
                   [--set]
                   [--slot]

Examples

Update a logic app. (autogenerated)

az logicapp update --name myLogicApp --resource-group myRG

Required Parameters

--name -n

Name of the logic app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	False

--plan

The name or resource id of the plan to update the logicapp with.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--slot -s

The name of the slot. Default to the productions slot if not specified.

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