Get-AzureRmSqlSyncAgent

NAME Get-AzureRmSqlSyncAgent



SYNOPSIS

Returns information about Azure SQL Sync Agents.





SYNTAX

Get-AzureRmSqlSyncAgent [-ResourceGroupName] <String> [-ServerName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>]

[<CommonParameters>]





DESCRIPTION

The Get-AzureRmSqlSyncAgent cmdlet returns information about one or more Azure SQL Sync Agents. Specify the name of a sync agent to see

information for only that 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



-Name <String>

The sync agent name.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

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



<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.AzureSqlSyncAgentModel







NOTES









Example 1: Get all instances of Azure SQL Sync Agent assigned to an Azure SQL Server



PS C:\\>Get-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Format-List

ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01}

ResourceGroupName : ResourceGroup01

ServerName : Server01

DatabaseName : Database01

SyncAgentName : SyncAgent01

SyncDatabaseId :

subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01}

LastAliveTime: : 6/1/2017 5:08:48 AM

Version : 4.3.6348.1

IsUpToDate : False

ExpiryTime :

State : Online



ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent02}

ResourceGroupName : ResourceGroup01

ServerName : Server01

DatabaseName : Database01

SyncAgentName : SyncAgent02

SyncDatabaseId :

subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01}

LastAliveTime: : 6/1/2017 5:08:48 AM

Version : 4.3.6348.1

IsUpToDate : False

ExpiryTime :

State : Online



This command gets information about all the Azure SQL Sync Agents assigned to an Azure SQL Server.





Example 2: Get information about an Azure SQL Sync Agent



PS C:\\>Get-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name "SyncAgent01" | Format-List

ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01}

ResourceGroupName : ResourceGroup01

ServerName : Server01

DatabaseName : Database01

SyncAgentName : SyncAgent01

SyncDatabaseId :

subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01}

LastAliveTime: : 6/1/2017 5:08:48 AM

Version : 4.3.6348.1

IsUpToDate : False

ExpiryTime :

State : Online



This command gets information about the Azure SQL Database Sync Agent with name "SyncAgent01"







RELATED LINKS

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

Remove-AzureRmSqlSyncAgent

New-AzureRmSqlSyncAgent