LinuxCommandLibrary

az-logicapp

Manage Azure Logic Apps

TLDR

Create a logic app

$ az logicapp create [[-n|--name]] [name] [[-g|--resource-group]] [resource_group] [[-s|--storage-account]] [storage_account]
copy

Delete a logic app
$ az logicapp delete [[-n|--name]] [name] [[-g|--resource-group]] [resource_group]
copy

List logic apps
$ az logicapp list [[-g|--resource-group]] [resource_group]
copy

Restart a logic app
$ az logicapp restart [[-n|--name]] [name] [[-g|--resource-group]] [resource_group]
copy

Start a logic app
$ az logicapp start [[-n|--name]] [name] [[-g|--resource-group]] [resource_group]
copy

Stop a logic app
$ az logicapp stop [[-n|--name]] [name] [[-g|--resource-group]] [resource_group]
copy

SYNOPSIS

az logicapp <SUBCOMMAND> [<OPTIONS>]

PARAMETERS

--help
    Shows help message for the command or subcommand.

--output <format>
    Output format. Accepts json, jsonc, tsv, table, yaml, yamlc, none.

--query <jmespath>
    JMESPath query to filter the results of the command.

--verbose
    Increase logging verbosity to show all debug logs.

--only-show-errors
    Only show errors, suppressing warnings and other output.

--subscription <name-or-id>
    Name or ID of subscription. If not specified, the default subscription is used.

--resource-group -g <name>
    Name of the resource group (required for operations like create, delete, show, update).

--name -n <name>
    Name of the Logic App workflow (required for operations like create, delete, show, update).

--location -l <location>
    Location (e.g., eastus, westeurope) for new resources (required for create).

--definition <path-to-json-file>
    Path to a JSON file containing the workflow definition (required for create and update).

DESCRIPTION

Azure Logic Apps are a cloud service that helps schedule, automate, and orchestrate tasks, business processes, and workflows when you need to integrate apps, data, devices, and systems. The az logicapp command group provides a comprehensive set of functionalities within the Azure CLI to manage these resources. It allows users to create, delete, list, show details, and update Logic App workflows directly from the command line. This command group is essential for automating deployment and management tasks of Logic Apps in a programmatic way, facilitating DevOps practices for cloud-based integrations and orchestrations. It simplifies interactions with the Azure API for Logic Apps, abstracting complex REST calls into straightforward CLI commands, enabling efficient management of serverless integration workflows.

CAVEATS

The az logicapp command group requires the Azure CLI to be installed and properly configured, including prior authentication via az login.
Internet connectivity is necessary to interact with Azure services.
Users must have appropriate Azure RBAC permissions to manage Logic Apps within their subscription.
The workflow definition JSON, often provided via the --definition parameter, can be highly complex and demands a thorough understanding of the Logic Apps workflow schema for effective use.

SUBCOMMANDS

The az logicapp is not a standalone command but a command group. To perform operations, you must specify a subcommand, such as create, delete, list, show, or update. Each subcommand has its own specific set of parameters and functionalities.

WORKFLOW DEFINITION LANGUAGE (WDL)

A core aspect of managing Logic Apps, especially during creation or update, is providing a workflow definition. This definition is typically a JSON file that describes the Logic App's triggers, actions, and control flow using the Workflow Definition Language. Proficiency in WDL is essential for effectively using the --definition parameter.

AUTHENTICATION

Before executing any az logicapp command, you must authenticate your Azure CLI session using the az login command. This establishes your credentials and allows the CLI to interact with your Azure subscription.

HISTORY

The Azure CLI, developed by Microsoft, has been a primary command-line interface for managing Azure resources since its initial release in 2014. The az logicapp command group was introduced as Azure Logic Apps matured into a key serverless integration service. Its development has closely tracked the evolution of Logic Apps, continuously adding support for new features, including the more recent Logic Apps Standard plan, which allows for stateful and stateless workflows to run on an App Service Plan. This command group is regularly updated to align with Azure service enhancements and to improve the overall command-line management experience.

SEE ALSO

az(1), az login, az functionapp, az webapp, az resource

Copied to clipboard