New-​Azure​Rm​Sql​Sync​Agent​Key

Creates an Azure SQL Sync Agent Key.

Syntax

New-AzureRmSqlSyncAgentKey
   [-ResourceGroupName] <String>
   [-ServerName] <String>
   [-SyncAgentName] <String>
   [-Confirm]
   [-WhatIf]

Description

The New-AzureRmSqlSyncAgentKey cmdlet creates an Azure SQL Sync Agent key.

Examples

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

PS C:\> New-AzureRmSqlSyncAgentKey -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SyncAgentName "SyncAgent01"
SyncAgentKey                  : Key

This command creates a sync agent key for an Azure SQL Sync Agent.

Required Parameters

-ResourceGroupName

The name of the resource group.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServerName

The name of the Azure SQL Server the sync agent is in.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SyncAgentName

The sync agent name.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentKeyModel