Get-AzureRmSqlSyncGroup

NAME Get-AzureRmSqlSyncGroup



SYNOPSIS

Returns information about Azure SQL Database Sync Groups.





SYNTAX

Get-AzureRmSqlSyncGroup [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [[-Name] <String>] [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmSqlSyncGroup cmdlet returns information about one or more Azure SQL Database Sync Groups. Specify the name of a sync group to see

information for only that sync group.





PARAMETERS

-DatabaseName <String>

The name of the Azure SQL Database.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-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 group name.



Required? false

Position? 3

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.



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







NOTES









Example 1: Get all instances of Azure SQL Sync Group assigned to an Azure SQL Database



PS C:\\>Get-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" | Format-List

ResourceId :

/subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}

ResourceGroupName : ResourceGroup01

ServerName : Server01

DatabaseName : Database01

SyncGroupName : SyncGroup01

SyncDatabaseId :

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

IntervalInSeconds : 100

ConflictResolutionPolicy: : HubWin

HubDatabaseUserName : myAccount

HubDatabasePassword :

SyncState : NotReady

LastSyncTime : 1/1/0001 12:00:00 AM

Schema :



ResourceId :

/subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup02}

ResourceGroupName : ResourceGroup01

ServerName : Server01

DatabaseName : Database01

SyncGroupName : SyncGroup02

SyncDatabaseId :

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

IntervalInSeconds : 100

ConflictResolutionPolicy: : HubWin

HubDatabaseUserName : myAccount

HubDatabasePassword :

SyncState : NotReady

LastSyncTime : 1/1/0001 12:00:00 AM

Schema :



This command gets information about all the Azure SQL Database Sync Groups assigned to an Azure SQL Database.





Example 2: Get information about an Azure SQL Database Sync Group



PS C:\\>Get-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Name "SyncGroup01" |

Format-List

ResourceId :

/subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup02}

ResourceGroupName : ResourceGroup01

ServerName : Server01

DatabaseName : Database01

SyncGroupName : SyncGroup02

SyncDatabaseId :

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

IntervalInSeconds : 100

ConflictResolutionPolicy: : HubWin

HubDatabaseUserName : myAccount

HubDatabasePassword :

SyncState : NotReady

LastSyncTime : 1/1/0001 12:00:00 AM

Schema :



This command gets information about the Azure SQL Database Sync Group with name "SyncGroup01"







RELATED LINKS

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

New-AzureRmSqlSyncGroup

Update-AzureRmSqlSyncGroup

Remove-AzureRmSqlSyncGroup