Edit

Update-AzSqlSyncMember

  • Reference
Module:
Az.Sql

Updates an Azure SQL Database Sync Member.

Syntax

Update-AzSqlSyncMember
      -Name <String>
      [-MemberDatabaseCredential <PSCredential>]
      [-UsePrivateLinkConnection <Boolean>]
      [-SyncMemberAzureDatabaseResourceId <String>]
      [-SyncGroupName] <String>
      [-ServerName] <String>
      [-DatabaseName] <String>
      [-ResourceGroupName] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzSqlSyncGroup cmdlet modifies properties of an Azure SQL Database Sync Member.

Examples

Example 1

$credential = Get-Credential
Update-AzSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" `
-MemberDatabaseCredential $credential | Format-List

ResourceId                  : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01}
ResourceGroupName           : ResourceGroup01
ServerName                  : Server01
DatabaseName                : Database01
SyncGroupName               : SyncGroup01
SyncMemberName              : SyncMember01
SyncDirection               : OneWayMemberToHub
MemberDatabaseType:         : AzureSqlDatabase
SyncAgentId                 : 
SqlServerDatabaseId         : 
MemberServerName            : memberServer01.full.dns.name
MemberDatabaseName          : memberDatabase01
MemberDatabaseUserName      : myAccount-new
MemberDatabasePassword      : 
SyncState                   : Good

This command resets the administrator password for the member database.

Example 2

Updates an Azure SQL Database Sync Member. (autogenerated)

Update-AzSqlSyncMember -DatabaseName 'Database01' -MemberDatabaseCredential <PSCredential> -Name 'SyncMember01' -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01' -SyncGroupName 'SyncGroup01' -SyncMemberAzureDatabaseResourceId <String>

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-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:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MemberDatabaseCredential

The credential (username and password) of the Azure SQL Database.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

The sync member name.

Type:String
Aliases:SyncMemberName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-SyncMemberAzureDatabaseResourceId

The resource ID for the sync member database, used if UsePrivateLinkConnection is set to true.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UsePrivateLinkConnection

Whether to use private link when connecting to this sync member.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

AzureSqlSyncMemberModel