az logic workflow

Note

This reference is part of the logic extension for the Azure CLI (version 2.48.0 or higher). The extension will automatically install the first time you run an az logic workflow command. Learn more about extensions.

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Logic workflow.

Commands

Name Description Type Status
az logic workflow create

Creates or updates a workflow using a JSON file for the defintion.

Extension Preview
az logic workflow delete

Deletes a workflow.

Extension Preview
az logic workflow list

Gets a list of workflows by subscription.

Extension Preview
az logic workflow show

Gets a workflow.

Extension Preview
az logic workflow update

Updates a workflow.

Extension Preview

az logic workflow create

Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Creates or updates a workflow using a JSON file for the defintion.

az logic workflow create --definition
                         --location
                         --name
                         --resource-group
                         [--access-control]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--integration-service-environment]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Examples

Create or update a workflow

az logic workflow create --resource-group "test_resource_group" --location "centralus" --name "test_workflow" --definition "workflow.json"

Required Parameters

--definition

Path to a workflow defintion JSON file (see https://github.com/Azure/azure-cli-extensions/blob/main/src/logic/README.md for more info on this). This JSON format should match what the logic app design tool exports.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

The workflow name.

--resource-group -g

The resource group name.

Optional Parameters

--access-control

The access control configuration controls access to this workflow. See https://github.com/Azure/azure-cli-extensions/blob/main/src/logic/README.md for more information.

--endpoints-configuration

The endpoints configuration.

--integration-account

The integration account.

--integration-service-environment

The integration service environment.

--state

The state.

accepted values: Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended
--tags

The resource tags.

Global Parameters
--debug
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity to show all debug logs.

--help -h
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show this help message and exit.

--only-show-errors
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Only show errors, suppressing warnings.

--output -o
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Output format.

--query
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity. Use --debug for full debug logs.

az logic workflow delete

Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes a workflow.

az logic workflow delete --name
                         --resource-group
                         [--yes]

Examples

Delete a workflow

az logic workflow delete --resource-group "test_resource_group" --name "test_workflow"

Required Parameters

--name -n

The workflow name.

--resource-group -g

The resource group name.

Optional Parameters

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity to show all debug logs.

--help -h
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show this help message and exit.

--only-show-errors
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Only show errors, suppressing warnings.

--output -o
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Output format.

--query
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity. Use --debug for full debug logs.

az logic workflow list

Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets a list of workflows by subscription.

az logic workflow list [--filter]
                       [--resource-group]
                       [--top]

Examples

List all workflows in a resource group

az logic workflow list --resource-group "test_resource_group"

List all workflows in a subscription

az logic workflow list

Optional Parameters

--filter

The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.

--resource-group -g

The resource group name.

--top

The number of items to be included in the result.

Global Parameters
--debug
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity to show all debug logs.

--help -h
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show this help message and exit.

--only-show-errors
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Only show errors, suppressing warnings.

--output -o
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Output format.

--query
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity. Use --debug for full debug logs.

az logic workflow show

Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets a workflow.

az logic workflow show --name
                       --resource-group

Examples

Get a workflow

az logic workflow show --resource-group "test_resource_group" --name "test_workflow"

Required Parameters

--name -n

The workflow name.

--resource-group -g

The resource group name.

Global Parameters
--debug
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity to show all debug logs.

--help -h
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show this help message and exit.

--only-show-errors
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Only show errors, suppressing warnings.

--output -o
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Output format.

--query
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity. Use --debug for full debug logs.

az logic workflow update

Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Updates a workflow.

az logic workflow update --name
                         --resource-group
                         [--definition]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Examples

Patch a workflow

az logic workflow update --resource-group "test_resource_group" --definition workflow.json --name "test_workflow"

Required Parameters

--name -n

The workflow name.

--resource-group -g

The resource group name.

Optional Parameters

--definition

Path to a workflow defintion JSON file (see https://github.com/Azure/azure-cli-extensions/blob/main/src/logic/README.md for more info on this). This JSON format should match what the logic app design tool exports.

--state

The state.

accepted values: Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended
--tags

The resource tags.

Global Parameters
--debug
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity to show all debug logs.

--help -h
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show this help message and exit.

--only-show-errors
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Only show errors, suppressing warnings.

--output -o
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Output format.

--query
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose
Preview

Command group 'logic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Increase logging verbosity. Use --debug for full debug logs.