managed_instance_dtcs

Creates, updates, deletes, gets or lists a managed_instance_dtcs resource.

Overview

Name	managed_instance_dtcs
Type	Resource
Id	azure.sql.managed_instance_dtcs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dtcEnabled	boolean	Active status of managed instance DTC.
dtcHostNameDnsSuffix	string	Host name dns suffix of managed instance DTC.
externalDnsSuffixSearchList	array	External dns suffix search list of managed instance DTC.
provisioningState	string	Provisioning state of managed instance DTC. Known values are: "Created", "InProgress", "Succeeded", "Failed", and "Canceled". (Created, InProgress, Succeeded, Failed, Canceled)
securitySettings	object	Security settings of managed instance DTC.
systemData	object	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".

list_by_managed_instance

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dtcEnabled	boolean	Active status of managed instance DTC.
dtcHostNameDnsSuffix	string	Host name dns suffix of managed instance DTC.
externalDnsSuffixSearchList	array	External dns suffix search list of managed instance DTC.
provisioningState	string	Provisioning state of managed instance DTC. Known values are: "Created", "InProgress", "Succeeded", "Failed", and "Canceled". (Created, InProgress, Succeeded, Failed, Canceled)
securitySettings	object	Security settings of managed instance DTC.
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, managed_instance_name, dtc_name, subscription_id		Gets managed instance DTC settings.
list_by_managed_instance	select	resource_group_name, managed_instance_name, subscription_id		Gets a list of managed instance DTC settings.
create_or_update	insert	resource_group_name, managed_instance_name, dtc_name, subscription_id		Updates managed instance DTC settings.
create_or_update	replace	resource_group_name, managed_instance_name, dtc_name, subscription_id		Updates managed instance DTC settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dtc_name	string	The name of the managed instance DTC. "current" Required.
managed_instance_name	string	The name of the managed instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets managed instance DTC settings.

SELECT
id,
name,
dtcEnabled,
dtcHostNameDnsSuffix,
externalDnsSuffixSearchList,
provisioningState,
securitySettings,
systemData,
type
FROM azure.sql.managed_instance_dtcs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND dtc_name = '{{ dtc_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_managed_instance

Gets a list of managed instance DTC settings.

SELECT
id,
name,
dtcEnabled,
dtcHostNameDnsSuffix,
externalDnsSuffixSearchList,
provisioningState,
securitySettings,
systemData,
type
FROM azure.sql.managed_instance_dtcs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Updates managed instance DTC settings.

INSERT INTO azure.sql.managed_instance_dtcs (
properties,
resource_group_name,
managed_instance_name,
dtc_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ managed_instance_name }}',
'{{ dtc_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_instance_dtcs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_instance_dtcs resource.
  - name: managed_instance_name
    value: "{{ managed_instance_name }}"
    description: Required parameter for the managed_instance_dtcs resource.
  - name: dtc_name
    value: "{{ dtc_name }}"
    description: Required parameter for the managed_instance_dtcs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_instance_dtcs resource.
  - name: properties
    description: |
      Resource properties.
    value:
      dtcEnabled: {{ dtcEnabled }}
      securitySettings:
        transactionManagerCommunicationSettings:
          allowInboundEnabled: {{ allowInboundEnabled }}
          allowOutboundEnabled: {{ allowOutboundEnabled }}
          authentication: "{{ authentication }}"
        xaTransactionsEnabled: {{ xaTransactionsEnabled }}
        snaLu6point2TransactionsEnabled: {{ snaLu6point2TransactionsEnabled }}
        xaTransactionsDefaultTimeout: {{ xaTransactionsDefaultTimeout }}
        xaTransactionsMaximumTimeout: {{ xaTransactionsMaximumTimeout }}
      externalDnsSuffixSearchList:
        - "{{ externalDnsSuffixSearchList }}"
      dtcHostNameDnsSuffix: "{{ dtcHostNameDnsSuffix }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Updates managed instance DTC settings.

REPLACE azure.sql.managed_instance_dtcs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND dtc_name = '{{ dtc_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;