Get-AzSqlInstanceDtc
Gets an Azure SQL Managed Instance DTC.
Syntax
GetByNameParameterSet (Default)
Get-AzSqlInstanceDtc
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByParentObjectParameterSet
Get-AzSqlInstanceDtc
[-InstanceObject] <AzureSqlManagedInstanceModel>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdParameterSet
Get-AzSqlInstanceDtc
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzSqlInstanceDtc cmdlet returns information about an Azure SQL Managed Instance DTC.
Examples
Example 1 Get the managed instance DTC
Get-AzSqlInstanceDtc -ResourceGroupName ResourceGroup1 -InstanceName ManagedInstance1
ResourceGroupName : ResourceGroup1
ManagedInstanceName : ManagedInstance1
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current
DtcEnabled : True
DtcHostNameDnsSuffix : suffix1.net
DtcHostName : name1.suffix1.net
ExternalDnsSuffixSearchList : {suffix1.net}
SecuritySettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcSecuritySettings
This command gets the managed instance DTC of the managed instance.
Example 2 Get the managed instance DTC of the previously fetched managed instance
$managedInstance = Get-AzSqlInstance -ResourceGroupName ResourceGroup1 -InstanceName ManagedInstance1
Get-AzSqlInstanceDtc -InstanceObject $managedInstance
ResourceGroupName : ResourceGroup1
ManagedInstanceName : ManagedInstance1
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current
DtcEnabled : True
DtcHostNameDnsSuffix : suffix1.net
DtcHostName : name1.suffix1.net
ExternalDnsSuffixSearchList : {suffix1.net}
SecuritySettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcSecuritySettings
This command gets the managed instance DTC by passing the managed instance object.
Example 3 Get the managed instance DTC with the specified resource ID
Get-AzSqlInstanceDtc -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current
ResourceGroupName : ResourceGroup1
ManagedInstanceName : ManagedInstance1
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current
DtcEnabled : True
DtcHostNameDnsSuffix : suffix1.net
DtcHostName : name1.suffix1.net
ExternalDnsSuffixSearchList : {suffix1.net}
SecuritySettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcSecuritySettings
This command gets the managed instance DTC by passing the resource ID of the DTC.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InstanceName
Name of the managed instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByNameParameterSet
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InstanceObject
Input object of the managed instance.
Parameter properties
| Type: | AzureSqlManagedInstanceModel |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByParentObjectParameterSet
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
Name of the resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByNameParameterSet
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceId
Resource ID of the managed instance DTC.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByResourceIdParameterSet
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.