az sql mi dtc
Commands related to managed instance DTC management.
The managed instance DTC object can be fetched and updated using these commands.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az sql mi dtc show |
Get managed instance DTC settings. |
Core | GA |
| az sql mi dtc update |
Update managed instance DTC settings. |
Core | GA |
| az sql mi dtc wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az sql mi dtc show
Get managed instance DTC settings.
This command gets managed instance DTC settings.
az sql mi dtc show [--ids]
[--managed-instance-name]
[--resource-group]
[--subscription]Examples
Gets the managed instance DTC
az sql mi show --g resourceGroup1 --managed-instance-name managedInstance1Gets the managed instance DTC with the specified resource ID
az sql mi show --ids /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/currentRequired Parameters
Optional Parameters
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.
The name of the managed instance.
Name of the resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az sql mi dtc update
Update managed instance DTC settings.
This command updates the managed instance DTC settings. All parameters are optional.
az sql mi dtc update [--add]
[--allow-inbound-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--allow-outbound-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--authentication]
[--dtc-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--external-dns-suffix-search-list]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--managed-instance-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--sna-lu-transactions {0, 1, f, false, n, no, t, true, y, yes}]
[--subscription]
[--xa-default-timeout]
[--xa-max-timeout]
[--xa-transactions {0, 1, f, false, n, no, t, true, y, yes}]Examples
Enable DTC on a managed instance
az sql mi dtc update -g resourceGroup1 --mi managedInstance1 --dtc-enabled true
az sql mi dtc update --ids /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current --dtc-enabled trueAllow XA transactions for managed instance DTC
az sql mi dtc update -g resourceGroup1 --mi managedInstance1 --xa-transactions-enabled trueRequired Parameters
Optional Parameters
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>.
Allow Inbound traffic to managed instance DTC.
Allow Outbound traffic of managed instance DTC.
Authentication type of managed instance DTC.
Active status of managed instance DTC.
External dns suffix search list of managed instance DTC. 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.
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.
The name of the managed instance.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
Name of the resource group.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
Allow SNA LU 6.2 Transactions to managed instance DTC.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Default timeout for XA Transactions (in seconds).
Maximum timeout for XA Transactions (in seconds).
Allow XA Transactions to managed instance DTC.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az sql mi dtc wait
Place the CLI in a waiting state until a condition is met.
az sql mi dtc wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--managed-instance-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Examples
Required Parameters
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the managed instance.
Name of the resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Azure CLI