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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--resource-group -g

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.

--changed-time

The changed time.

Property Value
Parameter group: Properties Arguments
--created-time

The created time.

Property Value
Parameter group: Properties Arguments
--___location -l

The resource ___location.

Property Value
Parameter group: BatchConfiguration Arguments
--metadata

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

Property Value
Parameter group: Properties Arguments
--tags

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

Property Value
Parameter group: BatchConfiguration Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

The batch configuration name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--integration-account-name

The integration account name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

The batch configuration name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--integration-account-name

The integration account name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--batch-configuration-name --name -n

The batch configuration name.

Property Value
Parameter group: Resource Id Arguments
--batch-group-name

The name of the batch group.

Property Value
Parameter group: Properties Arguments
--changed-time

The changed time.

Property Value
Parameter group: Properties Arguments
--created-time

The created time.

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Resource Id Arguments
--integration-account-name

The integration account name.

Property Value
Parameter group: Resource Id Arguments
--___location -l

The resource ___location.

Property Value
Parameter group: BatchConfiguration Arguments
--metadata

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

Property Value
Parameter group: Properties Arguments
--release-criteria

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

Property Value
Parameter group: Properties Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

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

Property Value
Parameter group: BatchConfiguration Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False