az logicapp dependency

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

Inspect and install Logic Apps Standard local dependencies.

Commands

Name Description Type Status
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 dependency check

Check local dependencies required by Logic Apps Standard tooling.

az logicapp dependency check [--acquire-policy-token]
                             [--change-reference]
                             [--context]
                             [--kind {azurite, bundle, core-tools, dotnet, node}]
                             [--path]

Examples

Check selected dependencies.

az logicapp dependency check --kind core-tools --kind 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
--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.

--kind

Limit dependencies checked. Repeat for multiple kinds.

Property Value
Accepted values: azurite, bundle, core-tools, dotnet, node
--path

Project root whose local.settings.json decides whether Azurite is required. 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 dependency install

Download and install local dependencies required by Logic Apps Standard tooling.

Installs Azure Functions Core Tools, Node.js, Azurite, and the Logic Apps extension bundle from their publishers into a folder shared with Visual Studio Code's Azure Logic Apps extension (~/.azurelogicapps/dependencies by default, or LA_DEPENDENCIES_PATH), so a machine already set up for VS Code is not made to download them twice.

Archives are verified against the publisher's published SHA256 where one exists -- Node.js through SHASUMS256.txt and Core Tools through their .sha2 sidecar -- and every install records a .logicapps-integrity.json manifest, which is what lets 'az logicapp dependency uninstall' remove only what this CLI put there.

Azurite is published only through npm and needs its dependency tree resolved, so it is installed with the npm that ships alongside Node.js, confined to the managed folder. It is fetched from the public npm registry rather than whatever registry your npm is configured for; pass --source-url to use another. Install Node.js first if you do not already have it.

Managed tool folders are added only to child-process environments for npm, Azurite, and local runtimes. Your global PATH is not modified.

The .NET SDK is deliberately not installed. Its only vendor-supported route is a remote install script, and this command will not run one on your machine. 'az logicapp dependency check' still reports it.

az logicapp dependency install [--acquire-policy-token]
                               [--change-reference]
                               [--force]
                               [--gh-token]
                               [--kind {azurite, bundle, core-tools, dotnet, node}]
                               [--source-url]
                               [--target-dir]
                               [--version]
                               [--yes]

Examples

Install everything this CLI can install.

az logicapp dependency install --yes

Install just Functions Core Tools.

az logicapp dependency install --kind core-tools --yes

Install the Azurite storage emulator for local runs.

az logicapp dependency install --kind azurite --yes

Pin a specific Core Tools version.

az logicapp dependency install --kind core-tools --version 4.0.7030 --yes

Install into a different directory.

az logicapp dependency install --kind node --target-dir /opt/logicapps-deps --yes

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

Reinstall even when the requested version is already present and intact.

Property Value
Default value: False
--gh-token

GitHub token used when resolving the latest Functions Core Tools release, to survive anonymous rate limits.

--kind

Limit dependencies installed. Repeat for multiple kinds. Defaults to all installable kinds. dotnet is accepted but refused with guidance.

Property Value
Accepted values: azurite, bundle, core-tools, dotnet, node
--source-url

Download the archive from this URL instead of the publisher default, or for azurite, the npm registry to install from instead of registry.npmjs.org. Requires exactly one --kind. Publisher checksums are not verified for a custom source.

--target-dir

Directory to install into. Defaults to LA_DEPENDENCIES_PATH, or ~/.azurelogicapps/dependencies.

--version

Install a specific version instead of the latest published. Requires exactly one --kind.

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

Remove local dependencies that this CLI installed.

Removes only material recorded in a .logicapps-integrity.json manifest written by 'az logicapp dependency install'. A dependency folder without that manifest is left untouched, because the dependency root is shared with Visual Studio Code and may hold tools this CLI never installed.

az logicapp dependency uninstall [--acquire-policy-token]
                                 [--change-reference]
                                 [--kind {azurite, bundle, core-tools, dotnet, node}]
                                 [--target-dir]
                                 [--yes]

Examples

Remove everything this CLI installed.

az logicapp dependency uninstall --yes

Remove only Node.js.

az logicapp dependency uninstall --kind node --yes

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

Limit dependencies removed. Repeat for multiple kinds. Defaults to all installable kinds. dotnet is accepted but refused with guidance.

Property Value
Accepted values: azurite, bundle, core-tools, dotnet, node
--target-dir

Directory to remove from. Defaults to LA_DEPENDENCIES_PATH, or ~/.azurelogicapps/dependencies.

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