Introduction and experience of Logic App Standard Advanced Tools – Part I

Scenario

Microsoft announced General Availability (GA) of Logic App standard on 25th May 2021. We created an intelligent and efficient tool to self-troubleshoot Azure Logic App Standard. This tool integrated several useful features for Logic App Standard which are not available in Logic App portal yet. This blog introduces how to use this tool to help manage and troubleshoot logic app standard.

This tool is still under development and this article will introduce some features so that it is Part I. We will have Part II and Part III in the future. Thanks!

 

References

GitHub - Drac-Zhang/Logic-App-STD-Advanced-Tools

 

Services Used

Azure Logic Apps (Standard) – Need Kudo Permission

 

Introduction

1) Download tool:

 

2) Install tool:

Just drag it into Kudo and it will install automatically:

 

Help Page

If you want to read Help Page first, please use this command

LogicAppAdvancedTool -?

(Main page of Help Page)

LogicAppAdvancedTool [Command] -?

(Introduction of each command)

LogicAppAdvancedTool [Command] [Sub Command]-?

(Introduction of each sub command)

For example:

 

Command format

Please use command

LogicAppAdvancedTool [Command]

LogicAppAdvancedTool [Command] -wf [WorkflowName]

For some other commands, they have sub-commands, eg. SyncToLocal:

LogicAppAdvancedTool [Command] [SubCommand]

Please note: Commands are case-insensitive.

 

Command reference

Backup:

Retrieve all the definitions which can be found in Storage Table and save as Json files. The storage table saves the definition for the past 90 days by default even they have been deleted.

Usage:

Backup [options]

Options:

For example:

 

CancelRuns:

Cancel all the running/waiting instances of a workflow.

Please note: Be aware of this command will cause data loss.

Usage:

CancelRuns [options]

Options:

For example:

 

CleanJobQueue:

(Deprecated) Clear Logic App storage queue, this action could cause data loss.

CleanUpContainers:

Delete all the Logic App auto-generated blob containers for run history before a specific date.

Usage:

CleanUpContainers [options]

Options:

For example:

 

CleanUpTables:

Delete all the Logic App auto-generated storage tables for run history before a specific date.

Usage:

CleanUpTables [options]

Options:

For example:

CleanUpRunHistory:

Combined command of CleanUpContainers and CleanUpTables.

Usage:

CleanUpRunHistory [options]

Options:

 

For example:

 

Check connectivity:

Check the connection between Logic App and Storage Account via DNS resolution and TCP ping of 443 port. This command needs Kudu site is available.

Usage:

CheckConnectivity [options]

Options:

For example:

 

Clone:

Clone a workflow to a new workflow, only support for same Logic App and same kind (stateful or stateless).

Usage:

Clone [options]

Options:

For example:

 

ConvertToStateful:

Clone a stateless workflow and create a new stateful workflow.

Usage:

ConvertToStateful [options]

Options:

For example:

 

Decode:

Decode a workflow based on provided version to human readable content.

Usage:

Decode [options]

Options:

For example:

 

GenerateTablePrefix:

Generate Logic App/Workflow's storage table prefix.

Usage:

GenerateTablePrefix [options]

Options:

For example:

GenerateRunHistoryUrl:

Generate run history of failure runs of a specific workflow on a specific day. The url can directly open run history page.

Usage:

GenerateRunHistoryUrl [options]

Options:

For example:

 

IngestWorkflow:

(In development) This is an experimental feature. NOT fully tested, DON'T use in PROD environment!!! Ingest a workflow into Storage Table directly to bypass workflow definition validation.

ListVersions:

List all the existing versions of a workflow.

Usage:

ListVersions [options]

Options:

For example:

 

ListWorkflows:

List all the existing workflows which can be found in the storage table.

Usage:

ListWorkflows [options]

Options:

 

For example:

 

RestoreAll:

Restore all the workflows which were deleted accidentally.

Please note: Restore all workflows which have been deleted, the existing workflows will not be impacted.

Usage:

RestoreAll [options]

Options:

For example:

 

RestoreSingleWorkflow:

Restore a workflow which has been deleted accidentally.

Usage:

RestoreSingleWorkflow [options]

Options:

For example:

 

RestoreRunHistory:

Restore run history of a deleted/overwritten workflow.

Please note: This is an experimental feature that might cause unexpected behavior in Logic App runtime since we directly modify workflow id.

Usage:

RestoreRunHistory [options]

Options:

For example:

RetrieveFailures:

Retrieve all the detailed failure information of a workflow for a specific day/run.

Usage:

RetrieveFailures [command] [options]

Options:

Commands:

Run 'RetrieveFailures [command] -?' for more information about command.

 

For example:

 

Revert:

Revert a workflow to a specific version.

Usage:

Revert [options]

Options:

 

For example:

 

SyncToLocal:

Sync remote wwwroot folder of Logic App Standard to local project. This command must run on a local computer. There are 3 subcommands for different usage, please use '-?' for more information.

Please note: Local computers need to have access to Storage Account.

Usage:

SyncToLocal [command] [options]

Options:

Commands:

Run 'SyncToLocal [command] -?' for more information about a command.

For example:

 

SearchInHistory:

Search for a keyword in workflow run history based on date.

Usage:

SearchInHistory [options]

Options:

For example: