Get-AzureRmSqlSyncAgentLinkedDatabase

Reference

Module:: AzureRM.Sql

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

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

The Get-AzureRmSqlSyncAgentLinkedDatabases 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.

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.

Parameters

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	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