New-AzureRmSqlSyncAgent

NAME New-AzureRmSqlSyncAgent



SYNOPSIS

Creates an Azure SQL Sync Agent.





SYNTAX

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

-SyncDatabaseName <String> [-SyncDatabaseResourceGroupName <String>] [-SyncDatabaseServerName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]



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

-SyncDatabaseResourceID <String> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The New-AzureRmSqlSyncAgent cmdlet creates an Azure SQL 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? true

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



-SyncDatabaseName <String>

The database used to store sync related metadata.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SyncDatabaseResourceGroupName <String>

The resource group the sync metadata database belongs to.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SyncDatabaseResourceID <String>

The resource ID of the sync metadata database.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SyncDatabaseServerName <String>

The server on which the sync metadata database is hosted.



Required? false

Position? named

Default value None

Accept pipeline input? False

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







NOTES









Example 1: Create a sync agent for an Azure SQL server.



PS C:\\> New-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name "SyncAgent01" -SyncDatabaseServerName

"syncDatabaseServer01"

-SyncDatabaseName "syncDatabaseName01" -SyncDatabaseResourceGroupName "syncDatabaseResourceGroup01" | 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: :

Version : 4.2.0.0

IsUpToDate : True

ExpiryTime : 12/31/9999 11:59:59 PM

State : NeverConnected



This command creates a sync agent for an Azure SQL server.







RELATED LINKS

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

Remove-AzureRmSqlSyncAgent

Get-AzureRmSqlSyncAgent