< Back
Update-AzureRmSqlSyncSchema
Post
NAME Update-AzureRmSqlSyncSchema
SYNOPSIS
Update the sync schema for a sync member database or a sync hub database. It will get the the latest database schema from the real database and
then use it refresh the schema cached by Sync metadata database. If "SyncMemberName" is specified, it will refresh the member database schema; if
not, it will refresh the hub database schema.
SYNTAX
Update-AzureRmSqlSyncSchema [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-SyncGroupName] <String>
[-DefaultProfile <IAzureContextContainer>] [-PassThru] [-SyncMemberName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Update-AzureRmSqlSyncSchema cmdlet updates the sync schema for a sync member database or a sync hub database.
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
-PassThru [<SwitchParameter>]
Defines Whether return the sync group this cmdlet works on
Required? false
Position? named
Default value False
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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SyncGroupName <String>
The sync group name.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SyncMemberName <String>
The sync member name.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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: Update the sync schema for a hub database
PS C:\\>Update-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName
"syncGroup01"
This command updates the sync schema for the hub database in the sync group syncGroup01
Example 2: Update the sync schema for a member database
PS C:\\>Update-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName
"syncGroup01" -SyncMemberName "syncMember01"
This command updates the sync schema for the member database in the sync member syncMember01
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... syncschema
SYNOPSIS
Update the sync schema for a sync member database or a sync hub database. It will get the the latest database schema from the real database and
then use it refresh the schema cached by Sync metadata database. If "SyncMemberName" is specified, it will refresh the member database schema; if
not, it will refresh the hub database schema.
SYNTAX
Update-AzureRmSqlSyncSchema [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-SyncGroupName] <String>
[-DefaultProfile <IAzureContextContainer>] [-PassThru] [-SyncMemberName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Update-AzureRmSqlSyncSchema cmdlet updates the sync schema for a sync member database or a sync hub database.
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
-PassThru [<SwitchParameter>]
Defines Whether return the sync group this cmdlet works on
Required? false
Position? named
Default value False
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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SyncGroupName <String>
The sync group name.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SyncMemberName <String>
The sync member name.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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: Update the sync schema for a hub database
PS C:\\>Update-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName
"syncGroup01"
This command updates the sync schema for the hub database in the sync group syncGroup01
Example 2: Update the sync schema for a member database
PS C:\\>Update-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName
"syncGroup01" -SyncMemberName "syncMember01"
This command updates the sync schema for the member database in the sync member syncMember01
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... syncschema