Managed Instance Dtcs - Get

Service:: SQL Database

API Version:: 2025-01-01

Gets managed instance DTC settings.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/dtc/current?api-version=2025-01-01

URI Parameters

Name	In	Required	Type	Description
dtcName	path	True	DtcName	The name of the managed instance DTC.
managedInstanceName	path	True	string	The name of the managed instance.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ManagedInstanceDtc	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Gets managed instance DTC settings.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance/dtc/current?api-version=2025-01-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ManagedInstanceDtcGet.json
// this example is just showing the usage of "ManagedInstanceDtcs_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testrg";
string managedInstanceName = "testinstance";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// get the collection of this ManagedInstanceDtcResource
ManagedInstanceDtcCollection collection = managedInstance.GetManagedInstanceDtcs();

// invoke the operation
DtcName dtcName = DtcName.Current;
NullableResponse<ManagedInstanceDtcResource> response = await collection.GetIfExistsAsync(dtcName);
ManagedInstanceDtcResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ManagedInstanceDtcData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/dtc",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance/dtc/current",
  "properties": {
    "dtcEnabled": true,
    "dtcHostNameDnsSuffix": "dtcHostNameSuffixExample.com",
    "externalDnsSuffixSearchList": [
      "dns.example1.com",
      "dns.example2.com"
    ],
    "provisioningState": "Succeeded",
    "securitySettings": {
      "snaLu6point2TransactionsEnabled": false,
      "transactionManagerCommunicationSettings": {
        "allowInboundEnabled": false,
        "allowOutboundEnabled": true,
        "authentication": "NoAuth"
      },
      "xaTransactionsDefaultTimeout": 1000,
      "xaTransactionsEnabled": false,
      "xaTransactionsMaximumTimeout": 3000
    }
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DtcName
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedInstanceDtc	SQL Managed Instance DTC
ManagedInstanceDtcSecuritySettings	The Security Settings of managed instance DTC.
ManagedInstanceDtcTransactionManagerCommunicationSettings	The Transaction Manager Communication Settings of managed instance DTC.
ProvisioningState	The ARM provisioning state of the job execution.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DtcName

Enumeration

Value	Description
current	current

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ManagedInstanceDtc

Object

SQL Managed Instance DTC

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.dtcEnabled	boolean	Active status of managed instance DTC.
properties.dtcHostNameDnsSuffix	string	Host name dns suffix of managed instance DTC.
properties.externalDnsSuffixSearchList	string[]	External dns suffix search list of managed instance DTC.
properties.provisioningState	ProvisioningState	Provisioning state of managed instance DTC.
properties.securitySettings	ManagedInstanceDtcSecuritySettings	Security settings of managed instance DTC.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ManagedInstanceDtcSecuritySettings

Object

The Security Settings of managed instance DTC.

Name	Type	Description
snaLu6point2TransactionsEnabled	boolean	Allow SNA LU 6.2 Transactions to managed instance DTC.
transactionManagerCommunicationSettings	ManagedInstanceDtcTransactionManagerCommunicationSettings	Transaction Manager communication settings of managed instance DTC.
xaTransactionsDefaultTimeout	integer (int32)	Default timeout for XA Transactions (in seconds).
xaTransactionsEnabled	boolean	Allow XA Transactions to managed instance DTC.
xaTransactionsMaximumTimeout	integer (int32)	Maximum timeout for XA Transactions (in seconds).

ManagedInstanceDtcTransactionManagerCommunicationSettings

Object

The Transaction Manager Communication Settings of managed instance DTC.

Name	Type	Description
allowInboundEnabled	boolean	Allow Inbound traffic to managed instance DTC.
allowOutboundEnabled	boolean	Allow Outbound traffic of managed instance DTC.
authentication	string	Authentication type of managed instance DTC.

ProvisioningState

Enumeration

The ARM provisioning state of the job execution.

Value	Description
Created	Created
InProgress	InProgress
Succeeded	Succeeded
Failed	Failed
Canceled	Canceled

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.