Get-​Azure​Rm​Sql​Server​Communication​Link

Gets communication links for elastic database transactions between database servers.

Syntax

Get-AzureRmSqlServerCommunicationLink
   [-ResourceGroupName] <String>
   [-ServerName] <String>
   [[-LinkName] <String>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The Get-AzureRmSqlServerCommunicationLink 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

Example 1: Get all communication links for a server

PS C:\>Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17"

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

Example 2: Get a specific communication link for a server

PS C:\>Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link01"

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

Required Parameters

-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
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
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
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel

Notes

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