az logicapp context

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

Manage saved Logic Apps target shortcuts.

Contexts store local path/port or deployed resource group/app names only. They do not store credentials or bind subscription/tenant; Azure CLI login and account selection, including --subscription, remain inherited.

Commands

Name Description Type Status
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 context create

Create a named Logic Apps CLI context.

az logicapp context create --name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--logic-app-name]
                           [--path]
                           [--port]
                           [--resource-group]
                           [--use]

Examples

Create and activate a local context.

az logicapp context create --name orders-local --path .\orders --use

Required Parameters

--name

Context 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
--logic-app-name

Deployed Logic App Standard site name.

--path

Local project directory.

--port

Local runtime port. Defaults to 7071 for local contexts.

--resource-group -g

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

--use

Make context active.

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

Delete one saved shortcut, never a project or Azure resource.

Prompts unless --yes is supplied. Deleting the active shortcut clears the active selection without choosing a replacement; runtime commands then require an explicit target or a deliberate context use. Other shortcuts are preserved.

az logicapp context delete --name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--yes]

Examples

Remove a saved shortcut only.

az logicapp context delete --name orders-local

Required Parameters

--name

Saved shortcut to delete; no project or Azure resource is deleted.

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

Confirm shortcut deletion without prompting. Active deletion clears selection without choosing a replacement.

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

List saved targets with their active selection.

Read-only, name-sorted inventory. Does not create a missing context store.

az logicapp context list

Examples

Inspect saved targets in a table.

az logicapp context list --output table
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 context show

Show a named saved target, or the active target.

az logicapp context show [--name]

Examples

Inspect the active target.

az logicapp context show

Inspect a saved target without activating it.

az logicapp context show --name orders-local

Optional Parameters

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

--name

Saved context name. Defaults to the active context.

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

Edit an existing saved target without changing its selection.

Omitted fields are retained. Editing an active target prompts unless --yes is supplied. Switching kind requires --kind and complete new coordinates: path and port for local, resource group and logic-app-name for cloud. Old known coordinates are cleared. Does not create a missing context or contact Azure.

az logicapp context update --name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--kind {cloud, local}]
                           [--logic-app-name]
                           [--path]
                           [--port]
                           [--resource-group]
                           [--yes]

Examples

Edit the port of an existing local shortcut.

az logicapp context update --name orders-local --port 7079

Deliberately switch an existing shortcut to a deployed target.

az logicapp context update --name dev --kind cloud -g my-rg --logic-app-name my-app --yes

Required Parameters

--name

Existing saved context name, not the Logic App 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
--kind

Target kind. Required for a local/cloud transition, together with complete new coordinates.

Property Value
Accepted values: cloud, local
--logic-app-name

New deployed Logic App name. Required with --resource-group when switching to cloud.

--path

New local path; need not exist yet. Omitted fields are retained.

--port

New local port. Required with --path when switching from cloud to local.

--resource-group -g

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

--yes -y

Confirm editing the active target without prompting. Does not bypass validation or concurrent-change 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 context use

Select the active Logic Apps CLI context.

az logicapp context use --name
                        [--acquire-policy-token]
                        [--change-reference]

Examples

Use a registered context.

az logicapp context use --name orders-local

Required Parameters

--name

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