New-SqlAvailabilityGroupListener
创建可用性组侦听器并将其附加到可用性组。
语法
New-SqlAvailabilityGroupListener
[-DhcpSubnet <String>]
[-StaticIp <String[]>]
[-Port <Int32>]
[-Name] <String>
[[-Path] <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-SqlAvailabilityGroupListener
[-DhcpSubnet <String>]
[-StaticIp <String[]>]
[-Port <Int32>]
[-Name] <String>
[-InputObject] <AvailabilityGroup>
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
New-SqlAvailabilityGroupListener cmdlet 创建可用性组侦听器,并将其附加到可用性组。 在承载主副本的服务器实例上运行此 cmdlet。
示例
示例 1:为可用性组创建侦听器
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG"
此命令为名为“MainAG”的可用性组创建名为“MainListener”的可用性组侦听器。 此侦听器使用 DHCP 获取虚拟 IP 地址。 在承载主副本的服务器实例上运行此命令。
示例 2:为具有非默认端口的可用性组创建侦听器
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG" -Port 1434
此命令为名为“MainAG”的可用性组创建名为“MainListener”的可用性组侦听器。 与前面的示例一样,此侦听器使用 DHCP 获取虚拟 IP 地址。 此示例分配其侦听的端口 1434。
示例 3:为使用 DHCP 的可用性组创建侦听器
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -DhcpSubnet "192.169.0.1/255.255.252.0" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG"
此命令为名为“MainAG”的可用性组创建名为“MainListener”的可用性组侦听器。 此侦听器使用 DHCP 获取指定子网中的虚拟 IP 地址。
示例 4:为使用静态地址的可用性组创建侦听器
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -StaticIp "192.168.3.1/255.255.252.0" -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG"
此命令为名为“MainAG”的可用性组创建名为“MainListener”的可用性组侦听器。 此侦听器使用 StaticIp 参数指定的 IPv4 地址作为其虚拟 IP 地址。
示例 5:创建创建侦听器的脚本
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG" -Script
此命令创建一个 Transact-SQL 脚本,该脚本为名为“MainAG”的可用性组创建名为“MainListener”的可用性组侦听器。 该命令不创建侦听器。
参数
-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 |
-Confirm
在运行 cmdlet 之前,提示你进行确认。
类型: | SwitchParameter |
别名: | cf |
Position: | Named |
默认值: | False |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DhcpSubnet
指定网络的 IPv4 地址和子网掩码。 侦听器使用 DHCP 确定此网络上的地址。 使用以下格式指定地址:192.168.0.1/255.255.255.0。
如果指定此参数,请不要指定 StaticIp 参数。
类型: | String |
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 |
-HostNameInCertificate
用于验证 SQL Server TLS/SSL 证书的主机名。 如果为强制加密启用了 SQL Server 实例,并且想要使用主机名/shortname 连接到实例,则必须传递此参数。 如果省略此参数,则必须将完全限定域名(FQDN)传递给 -ServerInstance 才能连接到为强制加密启用的 SQL Server 实例。
此参数是模块 v22 中的新增参数。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-InputObject
将可用性组指定为 AvailabilityGroup 对象,此 cmdlet 将侦听器附加到该对象。
类型: | AvailabilityGroup |
Position: | 2 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-Name
指定侦听器的名称。
类型: | String |
Position: | 1 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-Path
指定此 cmdlet 附加到侦听器的可用性组的路径。 如果未指定此参数,此 cmdlet 将使用当前工作位置。
类型: | String |
Position: | 2 |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Port
指定侦听器侦听连接的端口。 默认端口为 TCP 端口 1433。
类型: | Int32 |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ProgressAction
确定 PowerShell 如何响应脚本、cmdlet 或提供程序生成的进度更新,例如由 Write-Progress cmdlet 生成的进度栏。 Write-Progress cmdlet 创建显示命令状态的进度栏。
类型: | ActionPreference |
别名: | proga |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Script
指示此 cmdlet 返回执行此 cmdlet 执行的任务的 Transact-SQL 脚本。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-StaticIp
指定地址数组。 每个地址条目都是 IPv4 地址和子网掩码或 IPv6 地址。 侦听器侦听此参数指定的地址。
如果指定此参数,请不要指定 DhcpSubnet 参数。
类型: | String[] |
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.AvailabilityGroup