Get-AzSqlSyncAgentLinkedDatabase

Reference

Module:: Az.Sql

Returns information about SQL Server databases linked by a sync agent.

Syntax

Get-AzSqlSyncAgentLinkedDatabase
   [-ServerName] <String>
   [-SyncAgentName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSqlSyncAgentLinkedDatabase cmdlet returns information about SQL Server databases linked by a sync agent.

Examples

Example 1: Get the linked SQL Server databases for an Azure SQL sync agent.

The following example returns the linked SQL Server databases linked by an Azure SQL sync agent.

Get-AzSqlSyncAgentLinkedDatabase -ResourceGroupName MyResourceGroup -ServerName s1 -SyncAgentName 'SyncAgent01'

Parameters

-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

-ResourceGroupName

The name of the resource group.

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

-ServerName

The name of the Azure SQL Server the sync agent is in.

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

-SyncAgentName

The sync agent name.

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

Inputs

String

Outputs

AzureSqlSyncAgentLinkedDatabaseModel