az logic workflow

  • Reference

Note

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

Manage workflow.

Commands

Name Description Type Status
az logic workflow create

Create a workflow.

 Extension GA
az logic workflow delete

Delete a workflow.

 Extension GA
az logic workflow generate-upgraded-definition

Generates the upgraded definition for a workflow.

 Extension GA
az logic workflow identity

Manage workflow identity.

 Extension GA
az logic workflow identity assign

Assign identities.

 Extension GA
az logic workflow identity remove

Remove identities.

 Extension GA
az logic workflow list

List workflows.

 Extension GA
az logic workflow show

Show a workflow.

 Extension GA
az logic workflow update

Update a workflow.

 Extension GA

az logic workflow create

Create a workflow.

az logic workflow create --name
                         --resource-group
                         [--access-control]
                         [--definition]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--integration-service-environment]
                         [--location]
                         [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                         [--mi-user-assigned]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Examples

Create workflow

az logic workflow create --resource-group rg --name workflow --definition workflow.json

Required Parameters

--name -n

The workflow name.

--resource-group -g

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

Optional Parameters

--access-control

The access control configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--definition

The definition. Support json-file and yaml-file.

--endpoints-configuration

The endpoints configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--integration-account

The integration account. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--integration-service-environment

The integration service environment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

The resource location.

--mi-system-assigned

Enable system assigned identity.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--mi-user-assigned

Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--state

The state.

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

The resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az logic workflow delete

Delete a workflow.

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

Examples

Delete workflow

az logic workflow delete --resource-group rg --name workflow

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The workflow name.

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az logic workflow generate-upgraded-definition

Generates the upgraded definition for a workflow.

az logic workflow generate-upgraded-definition [--ids]
                                               [--resource-group]
                                               [--subscription]
                                               [--target-schema-version]
                                               [--workflow-name]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

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

--subscription

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

--target-schema-version

The target schema version.

--workflow-name

The workflow name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az logic workflow list

List workflows.

az logic workflow list [--filter]
                       [--max-items]
                       [--next-token]
                       [--resource-group]
                       [--top]

Examples

List all workflows in a resource group

az logic workflow list --resource-group rg

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.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--resource-group -g

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

--top

The number of items to be included in the result.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az logic workflow show

Show a workflow.

az logic workflow show [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

Examples

Show workflow

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The workflow name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az logic workflow update

Update a workflow.

az logic workflow update --name
                         --resource-group
                         [--add]
                         [--definition]
                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                         [--location]
                         [--remove]
                         [--set]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Examples

Update workflow

az logic workflow update --resource-group rg --name workflow --definition workflow.json

Required Parameters

--name -n

The workflow name.

--resource-group -g

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--definition

The definition. Support json-file and yaml-file.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--location -l

The resource location.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--state

The state.

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

The resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.