Get-AzureRmSqlSyncSchema
Returns information about the sync schema of a member database or a hub database.
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-AzureRmSqlSyncSchema
[-SyncGroupName] <String>
[-SyncMemberName <String>]
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmSqlSyncSchema cmdlet returns information about the sync schema of a member database or a hub database.
Examples
Example 1.1: Get the sync schema for a hub database
PS C:\>Get-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01"
Tables LastUpdateTime
------ --------------
{dbo.Table_1, dbo.Table_2} 6/13/2017 10:03:44 AM
This command gets the sync schema for the hub database in the sync group syncGroup01.
Example 1.2: Get the sync schema for a hub database, and expand Tables
PS C:\>Get-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" | select -ExpandProperty Tables
Columns : {column1, column2}
ErrorId : Schema_TableHasNoPrimaryKey
HasError : True
Name : dbo.Table_1
QuotedName : [dbo].[Table_1]
Columns : {column2, column4}
ErrorId : Schema_TableHasNoPrimaryKey
HasError : True
Name : dbo.Table_2
QuotedName : [dbo].[Table_2]
This command gets the sync schema for the hub database in the sync group syncGroup01 and expand Tables property.
Example 2: Get the sync schema for a member database
PS C:\>Get-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -SyncMemberName "syncMember01"
The schema payload is the same as Example 1.
This command gets the sync schema for the member database in the sync member syncMember01.
Parameters
-DatabaseName
The name of the Azure SQL Database.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-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.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SyncGroupName
The sync group name.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SyncMemberName
The sync member name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |