Edit

Get-AzSqlServerCommunicationLink

  • Reference
Module:
Az.Sql

Gets communication links for elastic database transactions between database servers.

Syntax

Get-AzSqlServerCommunicationLink
   [[-LinkName] <String>]
   [-ServerName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-AzSqlServerCommunicationLink cmdlet gets server-to-server communication links for elastic database transactions in Azure SQL Database. Specify the name of a server communication link to see the properties for that link.

Examples

Get-AzSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17"

This command gets all server-to-server communication links for elastic database transactions for the server named ContosoServer17.

Get-AzSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link01"

This command gets the server-to-server communication link named Link01.

Get-AzSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link*"

This command gets all server-to-server communication links for elastic database transactions for the server named ContosoServer17 that start with "Link".

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LinkName

Specifies the name of the server communication link that this cmdlet gets.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-ResourceGroupName

Specifies the name of the resource group to which the server specified by the ServerName parameter belongs.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServerName

Specifies the name of a server. This server contains a communication link that this cmdlet gets.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

AzureSqlServerCommunicationLinkModel

Notes

  • Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql