Set-SqlAvailabilityReplica

模块:

SQLServer

设置可用性副本上的设置。

语法

Set-SqlAvailabilityReplica
   [-AvailabilityMode <AvailabilityReplicaAvailabilityMode>]
   [-FailoverMode <AvailabilityReplicaFailoverMode>]
   [-EndpointUrl <String>]
   [-SessionTimeout <Int32>]
   [-ConnectionModeInPrimaryRole <AvailabilityReplicaConnectionModeInPrimaryRole>]
   [-ConnectionModeInSecondaryRole <AvailabilityReplicaConnectionModeInSecondaryRole>]
   [-SeedingMode <AvailabilityReplicaSeedingMode>]
   [-BackupPriority <Int32>]
   [-ReadOnlyRoutingList <String[]>]
   [-ReadonlyRoutingConnectionUrl <String>]
   [-LoadBalancedReadOnlyRoutingList <String[][]>]
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-SqlAvailabilityReplica
   [-AvailabilityMode <AvailabilityReplicaAvailabilityMode>]
   [-FailoverMode <AvailabilityReplicaFailoverMode>]
   [-EndpointUrl <String>]
   [-SessionTimeout <Int32>]
   [-ConnectionModeInPrimaryRole <AvailabilityReplicaConnectionModeInPrimaryRole>]
   [-ConnectionModeInSecondaryRole <AvailabilityReplicaConnectionModeInSecondaryRole>]
   [-SeedingMode <AvailabilityReplicaSeedingMode>]
   [-BackupPriority <Int32>]
   [-ReadOnlyRoutingList <String[]>]
   [-ReadonlyRoutingConnectionUrl <String>]
   [-LoadBalancedReadOnlyRoutingList <String[][]>]
   [-InputObject] <AvailabilityReplica>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Set-SqlAvailabilityReplica cmdlet 设置或修改可用性副本的各种属性。 在承载主副本的服务器实例上运行此 cmdlet。

示例

示例 1：修改副本可用性模式和自动故障转移

PS C:\> Set-SqlAvailabilityReplica -AvailabilityMode "SynchronousCommit" -FailoverMode Automatic -Path "SQLSERVER:\Sql\PrimaryServer\InstanceName\AvailabilityGroups\MainAG\AvailabilityReplicas\Replica02"

此命令修改名为 MainAG 的可用性组中名为 Replica02 的副本，以使用 synchronous-commit 可用性模式并支持 automatic failover。

示例 2：修改副本以支持强制手动故障转移

PS C:\> Set-SqlAvailabilityReplica -AvailabilityMode AsynchronousCommit -FailoverMode Manual -Path "SQLSERVER:\Sql\PrimaryServer\InstanceName\AvailabilityGroups\MainAG\AvailabilityReplicas\Replica02"

此命令修改名为 MainAG 的可用性组中名为 Replica02 的副本，以使用 asynchronous-commit 可用性模式，并且仅支持 forced manual failover，这可能会导致数据丢失。

示例 3：允许辅助角色中的所有连接

PS C:\> Set-SqlAvailabilityReplica -ConnectionModeInSecondaryRole AllowAllConnections -Path "SQLSERVER:\Sql\PrimaryServer\InstanceName\AvailabilityGroups\MainAG\AvailabilityReplicas\Replica02"

此命令修改可用性组中的副本 Replica02MainAG 以允许辅助角色中的所有连接。 这样，便可以将只读数据处理工作负载卸载到次要副本。

示例 4：为只读路由配置主副本和辅助副本

PS C:\> Set-Location "SQLSERVER:\SQL\PrimaryServer\default\AvailabilityGroups\MainAG"
PS C:\> $PrimaryReplica = Get-Item "AvailabilityReplicas\PrimaryServer"
PS C:\> $SecondaryReplica = Get-Item "AvailabilityReplicas\SecondaryServer"
PS C:\> Set-SqlAvailabilityReplica -ReadOnlyRoutingConnectionUrl "TCP://PrimaryServer.domain.com:5022" -InputObject $PrimaryReplica
PS C:\> Set-SqlAvailabilityReplica -ReadOnlyRoutingConnectionUrl "TCP://SecondaryServer.domain.com:5022" -InputObject $SecondaryReplica
PS C:\> Set-SqlAvailabilityReplica -ReadOnlyRoutingList "SecondaryServer","PrimaryServer" -InputObject $PrimaryReplica

第一个命令将位置更改为 SQLSERVER：提供程序中的位置。

第四个命令将只读路由 URL 分配给主副本。 然后，它会在主副本上设置只读路由列表。

示例 5：修改备份优先级

PS C:\> Set-SqlAvailabilityReplica -BackupPriority 60 -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG\AvailabilityReplicas\Replica02"

此命令将可用性副本 Replica02 的备份优先级设置为 60。 托管主副本的服务器实例使用此优先级来确定哪个副本应在可用性组中的数据库上为自动备份请求提供服务。 选择优先级最高的副本。

参数

-AccessToken

用于向 SQL Server 进行身份验证的访问令牌，作为用户/密码或 Windows 身份验证的替代方法。

例如，这可用于使用 Service Principal 或 Managed Identity连接到 SQL Azure DB 和 SQL Azure Managed Instance。

要使用的参数可以是表示令牌的字符串，也可以是运行 Get-AzAccessToken -ResourceUrl https://database.windows.net返回的 PSAccessToken 对象。

此参数是模块 v22 中的新增参数。

类型:	PSObject
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-AvailabilityMode

指定副本可用性模式。

可以指定一个值 $Null。

类型:	AvailabilityReplicaAvailabilityMode
接受的值:	AsynchronousCommit, SynchronousCommit, Unknown, ConfigurationOnly
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-BackupPriority

指定执行备份中副本的所需优先级。 此参数的可接受值为 0 到 100 的整数。 在联机和可用的副本集中，具有最高优先级的副本执行备份。

值为零（0）表示副本不是候选副本。

类型:	Int32
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

类型:	SwitchParameter
别名:	cf
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-ConnectionModeInPrimaryRole

指定可用性副本在主角色中处理连接的方式。 此参数的可接受值为：

• AllowReadWriteConnections。 允许读/写连接。
• AllowAllConnections。 允许所有连接。

类型:	AvailabilityReplicaConnectionModeInPrimaryRole
接受的值:	AllowAllConnections, AllowReadWriteConnections, Unknown
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ConnectionModeInSecondaryRole

指定在辅助角色中时可用性副本如何处理连接。 此参数的可接受值为：

• AllowNoConnections。 禁止连接。
• AllowReadIntentConnectionsOnly。 仅允许读取意向连接。
• AllowAllConnections。 允许所有连接。

类型:	AvailabilityReplicaConnectionModeInSecondaryRole
接受的值:	AllowNoConnections, AllowReadIntentConnectionsOnly, AllowAllConnections, Unknown
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Encrypt

连接到 SQL Server 时要使用的加密类型。

此值映射到 Microsoft.Data.SqlClient 驱动程序的 SqlConnection 对象的 Encrypt 属性 SqlConnectionEncryptOption。

在模块的 v22 中，默认为 Optional（为了与 v21 兼容）。 在模块的 v23+ 中，默认值为“必需”，这可能会为现有脚本创建中断性变更。

此参数是模块 v22 中的新增参数。

类型:	String
接受的值:	Mandatory, Optional, Strict
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-EndpointUrl

指定数据库镜像终结点的 URL。 此 URL 是以下形式的 TCP 地址：TCP://system-address:port

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FailoverMode

指定故障转移模式。

可以指定一个值 $Null。

类型:	AvailabilityReplicaFailoverMode
接受的值:	Automatic, Manual, External, Unknown
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-HostNameInCertificate

用于验证 SQL Server TLS/SSL 证书的主机名。 如果为强制加密启用了 SQL Server 实例，并且想要使用主机名/shortname 连接到实例，则必须传递此参数。 如果省略此参数，则必须将完全限定域名（FQDN）传递给 -ServerInstance 才能连接到为强制加密启用的 SQL Server 实例。

此参数是模块 v22 中的新增参数。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-InputObject

将可用性组指定为副本所属的可用性组对象。

类型:	AvailabilityReplica
Position:	1
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-LoadBalancedReadOnlyRoutingList

指定负载均衡的只读路由列表。

路由列表是负载均衡集的列表，而负载均衡集又是副本列表。

例如，传递类似于

@（'Server1'，'Server2'），@（'Server3'），@（'Server4'）

表示传递 3 个负载均衡集的内容：1 个副本（Server1 和 Server2）和 2 个副本（分别只有一个（Server3 和 Server4）。

在运行时，SQL Server 将按顺序查看所有负载均衡集，直到找到一个集，以便至少在副本上可用并将其用于负载均衡。

因此，在上面的示例中，如果 Server1 和 Server2 都不可用，但 Server3 是，SQL Server 将选取 Server3。

此 cmdlet 仅设置只读路由列表，并且不检查指定副本的可用性。

类型:	String[][]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Path

指定副本所属的可用性组的路径。 如果未指定此参数，此 cmdlet 将使用当前工作位置。

类型:	String
Position:	1
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ProgressAction

确定 PowerShell 如何响应脚本、cmdlet 或提供程序生成的进度更新，例如由 Write-Progress cmdlet 生成的进度栏。 Write-Progress cmdlet 创建显示命令状态的进度栏。

类型:	ActionPreference
别名:	proga
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ReadonlyRoutingConnectionUrl

指定在路由到副本进行只读连接时要使用的完全限定域名（FQDN）和端口，如以下示例所示：TCP://DBSERVER8.manufacturing.Contoso.com:7024

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ReadOnlyRoutingList

指定副本服务器名称的有序列表，该列表表示通过此可用性副本重定向只读连接时要使用的连接控制器的探测序列。 如果可用性副本是可用性组的当前主副本，则此参数适用。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Script

指示此 cmdlet 返回执行此 cmdlet 执行的任务的 Transact-SQL 脚本。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SeedingMode

指定初始种子设定次要副本的方式。

允许的值：

• 自动。 启用直接种子设定。 此方法将通过网络种子设定次要副本。 此方法不需要在副本上备份和还原主数据库的副本。
• 手动。 指定手动种子设定。 此方法要求在主副本上创建数据库的备份，并在辅助副本上手动还原该备份。

类型:	AvailabilityReplicaSeedingMode
接受的值:	Automatic, Manual
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SessionTimeout

指定在连接失败之前，在主副本与此副本之间等待响应的时间（以秒为单位）。

类型:	Int32
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-TrustServerCertificate

指示通道是否在绕过证书链以验证信任的同时进行加密。

在模块的 v22 中，默认为 $true（为了与 v21 兼容）。 在模块的 v23+ 中，默认值将为“$false”，这可能会为现有脚本创建中断性变更。

此参数是模块 v22 中的新增参数。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:	SwitchParameter
别名:	wi
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

输入

Microsoft.SqlServer.Management.Smo.AvailabilityReplica

相关链接

• New-SqlAvailabilityReplica
• Remove-SqlAvailabilityReplica
• Test-SqlAvailabilityReplica