< Back

Get-AzureRmSqlSyncAgentLinkedDatabase

Tue Jan 29, 2019 10:09 pm

NAME Get-AzureRmSqlSyncAgentLinkedDatabase



SYNOPSIS

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





SYNTAX

Get-AzureRmSqlSyncAgentLinkedDatabase [-ResourceGroupName] <String> [-ServerName] <String> [-SyncAgentName] <String> [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

The name of the resource group.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ServerName <String>

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



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SyncAgentName <String>

The sync agent name.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentLinkedDatabaseModel







NOTES









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



PS C:\\> Get-AzureRmSqlSyncAgentLinkedDatabases -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SyncAgentName "SyncAgent01" |

Format-List

SeverName : sever01

DatabaseId : databaseId

DatabaseName : database01

DatabaseType : SQLServerDatabase

Description :

UserName : myAccount



This command returns the linked SQL Server databases linked by an Azure SQL sync agent.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... eddatabase