Get-AzSqlInstanceLink
Returns information about link feature for Azure SQL Managed Instance.
Syntax
GetByNameParameterSet (Default)
Get-AzSqlInstanceLink
[-ResourceGroupName] <String>
[-InstanceName] <String>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByParentObjectParameterSet
Get-AzSqlInstanceLink
[[-Name] <String>]
[-InstanceObject] <AzureSqlManagedInstanceModel>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByInstanceResourceIdParameterSet
Get-AzSqlInstanceLink
[[-Name] <String>]
[-InstanceResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdParameterSet
Get-AzSqlInstanceLink
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzSqlInstanceLink cmdlet returns information about one or more instance of Managed Instance links. Specify the name of a link to see information for that link only.
Examples
Example 1: Get information about an active link on Azure SQL Managed Instance
Get-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Link01"
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01
Name : Link01
DistributedAvailabilityGroupName : Link01
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database01}
InstanceAvailabilityGroupName : AG_Database01_MI
PartnerAvailabilityGroupName : AG_Database01
PartnerEndpoint : TCP://SERVER01:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
This command gets information about the instance link named "Link01" on instance "Instance01" and resource group "ResourceGroup01".
Example 2: Get information about all active links on Azure SQL Managed Instance
Get-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01"
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01
Name : Link01
DistributedAvailabilityGroupName : Link01
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database01}
InstanceAvailabilityGroupName : AG_Database01_MI
PartnerAvailabilityGroupName : AG_Database01
PartnerEndpoint : TCP://SERVER01:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link02
Name : Link02
DistributedAvailabilityGroupName : Link02
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database02}
InstanceAvailabilityGroupName : AG_Database02_MI
PartnerAvailabilityGroupName : AG_Database02
PartnerEndpoint : TCP://SERVER02:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
This command gets information about all active instance links on instance "ManagedInstance01" and resource group "ResourceGroup01".
Example 3: Get all instance links on Azure SQL Managed Instance using Instance object
$instance = Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01"
Get-AzSqlInstanceLink -InstanceObject $instance
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01
Name : Link01
DistributedAvailabilityGroupName : Link01
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database01}
InstanceAvailabilityGroupName : AG_Database01_MI
PartnerAvailabilityGroupName : AG_Database01
PartnerEndpoint : TCP://SERVER01:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link02
Name : Link02
DistributedAvailabilityGroupName : Link02
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database02}
InstanceAvailabilityGroupName : AG_Database02_MI
PartnerAvailabilityGroupName : AG_Database02
PartnerEndpoint : TCP://SERVER02:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
This command gets information on all active instance links on the instance "ManagedInstance01".
Example 4: Get all instance links on Azure SQL Managed Instance using resource identifier
Get-AzSqlInstanceLink -InstanceResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01"
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01
Name : Link01
DistributedAvailabilityGroupName : Link01
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database01}
InstanceAvailabilityGroupName : AG_Database01_MI
PartnerAvailabilityGroupName : AG_Database01
PartnerEndpoint : TCP://SERVER01:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link02
Name : Link02
DistributedAvailabilityGroupName : Link02
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database02}
InstanceAvailabilityGroupName : AG_Database02_MI
PartnerAvailabilityGroupName : AG_Database02
PartnerEndpoint : TCP://SERVER02:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
This command gets information about all instance links for the instance "ManagedInstance01".
Example 5: Get an instance link using its resource identifier
Get-AzSqlInstanceLink -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01"
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01
Name : Link01
DistributedAvailabilityGroupName : Link01
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database01}
InstanceAvailabilityGroupName : AG_Database01_MI
PartnerAvailabilityGroupName : AG_Database01
PartnerEndpoint : TCP://SERVER01:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
This command gets information about the instance link named "Link01".
Example 6: Get all instance links for a Managed Instance by piping an instance object
Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" | Get-AzSqlInstanceLink
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01
Name : Link01
DistributedAvailabilityGroupName : Link01
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database01}
InstanceAvailabilityGroupName : AG_Database01_MI
PartnerAvailabilityGroupName : AG_Database01
PartnerEndpoint : TCP://SERVER01:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link02
Name : Link02
DistributedAvailabilityGroupName : Link02
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database02}
InstanceAvailabilityGroupName : AG_Database02_MI
PartnerAvailabilityGroupName : AG_Database02
PartnerEndpoint : TCP://SERVER02:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
This command gets information about all instance links within the instance "ManagedInstance01".
Example 7: Get a specific instance link for an instance by piping an instance object and specifying the link name
Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" | Get-AzSqlInstanceLink -Name "Link01"
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01
Name : Link01
DistributedAvailabilityGroupName : Link01
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database01}
InstanceAvailabilityGroupName : AG_Database01_MI
PartnerAvailabilityGroupName : AG_Database01
PartnerEndpoint : TCP://SERVER01:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
This command gets information about the instance link named "Link01: within the instance "Instance01".
Example 8: Get information about instance link using positional parameters
Get-AzSqlInstanceLink "ResourceGroup01" "ManagedInstance01" "Link01"
ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01
Name : Link01
DistributedAvailabilityGroupName : Link01
DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Databases : {Database01}
InstanceAvailabilityGroupName : AG_Database01_MI
PartnerAvailabilityGroupName : AG_Database01
PartnerEndpoint : TCP://SERVER01:5022
InstanceLinkRole : Secondary
PartnerLinkRole : Primary
ReplicationMode : Async
FailoverMode : Manual
SeedingMode : Automatic
This command gets information about the instance link named "Link01" on instance "Instance01" and resource group "ResourceGroup01".
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
Instance input object.
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 |
-InstanceResourceId
Managed instance resource ID.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByInstanceResourceIdParameterSet
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Managed Instance link name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | LinkName |
Parameter sets
GetByNameParameterSet
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
GetByParentObjectParameterSet
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
GetByInstanceResourceIdParameterSet
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| 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
The instance link resource ID.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByResourceIdParameterSet
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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.
