az logic workflow
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
The workflow name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The access control configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The definition. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The endpoints configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The integration account. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The integration service environment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The resource location.
Enable system assigned identity.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The state.
Property | Value |
---|---|
Accepted values: | Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended |
The resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The workflow name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The target schema version.
Property | Value |
---|---|
Parameter group: | Parameters Arguments |
The workflow name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.
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.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The number of items to be included in the result.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The workflow name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
The workflow name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
The definition. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The resource location.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
The state.
Property | Value |
---|---|
Accepted values: | Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended |
The resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |