Share via


az logic integration-account batch-configuration

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 integration-account batch-configuration command. Learn more about extensions.

Manage integration account batch configuration.

Commands

Name Description Type Status
az logic integration-account batch-configuration create

Create a batch configuration for an integration account.

Extension GA
az logic integration-account batch-configuration delete

Delete a batch configuration for an integration account.

Extension GA
az logic integration-account batch-configuration list

List the batch configurations for an integration account.

Extension GA
az logic integration-account batch-configuration show

Show a batch configuration for an integration account.

Extension GA
az logic integration-account batch-configuration update

Update a batch configuration for an integration account.

Extension GA

az logic integration-account batch-configuration create

Create a batch configuration for an integration account.

az logic integration-account batch-configuration create --batch-configuration-name
                                                        --batch-group-name
                                                        --integration-account-name
                                                        --release-criteria
                                                        --resource-group
                                                        [--changed-time]
                                                        [--created-time]
                                                        [--location]
                                                        [--metadata]
                                                        [--tags]

Examples

Create batch configuration

az logic integration-account batch-configuration create -g rg -n batch --integration-account-name name --batch-group-name group --release-criteria '{recurrence:{frequency:Minute,interval:1},messageCount:10,batchSize:10000}'

Required Parameters

--batch-configuration-name --name -n

The batch configuration name.

--batch-group-name

The name of the batch group.

--integration-account-name

The integration account name.

--release-criteria

The batch release criteria. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

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

Optional Parameters

--changed-time

The changed time.

--created-time

The created time.

--location -l

The resource location.

--metadata

The metadata Support json-file and yaml-file.

--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 integration-account batch-configuration delete

Delete a batch configuration for an integration account.

az logic integration-account batch-configuration delete [--batch-configuration-name]
                                                        [--ids]
                                                        [--integration-account-name]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--yes]

Examples

Delete batch configuration

az logic integration-account batch-configuration delete -g rg -n batch --integration-account-name name

Optional Parameters

--batch-configuration-name --name -n

The batch configuration name.

--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.

--integration-account-name

The integration account 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 integration-account batch-configuration list

List the batch configurations for an integration account.

az logic integration-account batch-configuration list --integration-account-name
                                                      --resource-group

Examples

List batch configuration

az logic integration-account batch-configuration list -g rg --integration-account-name name

Required Parameters

--integration-account-name

The integration account name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 integration-account batch-configuration show

Show a batch configuration for an integration account.

az logic integration-account batch-configuration show [--batch-configuration-name]
                                                      [--ids]
                                                      [--integration-account-name]
                                                      [--resource-group]
                                                      [--subscription]

Examples

Show batch configuration

az logic integration-account batch-configuration show -g rg -n batch --integration-account-name name

Optional Parameters

--batch-configuration-name --name -n

The batch configuration name.

--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.

--integration-account-name

The integration account 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 integration-account batch-configuration update

Update a batch configuration for an integration account.

az logic integration-account batch-configuration update [--add]
                                                        [--batch-configuration-name]
                                                        [--batch-group-name]
                                                        [--changed-time]
                                                        [--created-time]
                                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--ids]
                                                        [--integration-account-name]
                                                        [--location]
                                                        [--metadata]
                                                        [--release-criteria]
                                                        [--remove]
                                                        [--resource-group]
                                                        [--set]
                                                        [--subscription]
                                                        [--tags]

Examples

Update batch configuration

az logic integration-account batch-configuration update -g rg -n batch --integration-account-name name --release-criteria '{recurrence:{frequency:Minute,interval:2},messageCount:20,batchSize:12000}'

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>.

--batch-configuration-name --name -n

The batch configuration name.

--batch-group-name

The name of the batch group.

--changed-time

The changed time.

--created-time

The created time.

--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
--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.

--integration-account-name

The integration account name.

--location -l

The resource location.

--metadata

The metadata Support json-file and yaml-file.

--release-criteria

The batch release criteria. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--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.