New-SqlHADREndpoint

在 SQL Server 实例上创建数据库镜像终结点。

语法

New-SqlHADREndpoint
   [-Port <Int32>]
   [-Owner <String>]
   [-Certificate <String>]
   [-IpAddress <IPAddress>]
   [-AuthenticationOrder <EndpointAuthenticationOrder>]
   [-Encryption <EndpointEncryption>]
   [-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
   [-Name] <String>
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-SqlHADREndpoint
   [-Port <Int32>]
   [-Owner <String>]
   [-Certificate <String>]
   [-IpAddress <IPAddress>]
   [-AuthenticationOrder <EndpointAuthenticationOrder>]
   [-Encryption <EndpointEncryption>]
   [-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
   [-Name] <String>
   [-InputObject] <Server>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

New-SqlHADREndpoint cmdlet 在 SQL Server 实例上创建数据库镜像终结点。 对于托管任何可用性组的可用性副本的每个服务器实例,都需要此终结点。 每个服务器实例只能有一个数据库镜像终结点。 如果服务器实例拥有数据库镜像终结点,请使用现有终结点。

示例

示例 1:创建数据库镜像终结点

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint"

此命令在位于指定路径的服务器实例上创建一个名为 MainEndpoint 的数据库镜像终结点。 此终结点使用默认端口,5022

示例 2:创建需要加密的数据库镜像终结点

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -Port 4022 -EncryptionAlgorithm Aes -Encryption Required

此命令在位于指定路径的服务器实例上创建一个名为 MainEndpoint 的数据库镜像终结点。 此终结点侦听端口 4022。 终结点使用 AES 算法进行加密,并且要求连接使用加密。

示例 3:创建使用证书加密的数据库镜像终结点

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -AuthenticationOrder Certificate -Certificate "EncryptionCertificate"

此命令在位于指定路径的服务器实例上创建一个名为 MainEndpoint 的数据库镜像终结点。 此终结点使用名为 EncryptionCertificate 的证书对连接进行身份验证。

示例 4:创建数据库镜像终结点脚本

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -Script

此命令输出 Transact-SQL 脚本,该脚本在位于指定路径的服务器实例上创建名为 MainEndpoint 的数据库镜像终结点。 该终结点实际上不是由此命令创建的。

参数

-AccessToken

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

例如,这可用于使用 Service PrincipalManaged Identity连接到 SQL Azure DBSQL Azure Managed Instance

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

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

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

-AuthenticationOrder

指定终结点使用的身份验证的顺序和类型。

如果指定的选项调用证书,则必须设置 Certificate 参数。

类型:EndpointAuthenticationOrder
接受的值:Ntlm, Kerberos, Negotiate, Certificate, NtlmCertificate, KerberosCertificate, NegotiateCertificate, CertificateNtlm, CertificateKerberos, CertificateNegotiate
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Certificate

指定终结点将用于对连接进行身份验证的证书的名称。 远终结点必须具有与证书私钥匹配的公钥的证书。

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

-Confirm

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

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需: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

-Encryption

指定终结点的加密选项。

默认值为 Required

类型:EndpointEncryption
接受的值:Disabled, Supported, Required
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EncryptionAlgorithm

指定终结点使用的加密形式。

默认情况下,终结点将使用 Aes 加密。

注意:RC4 算法仅支持向后兼容性。 当数据库处于兼容级别 90 或 100 时,只能使用 RC4 或 RC4_128 加密新材料,但不建议这样做。 为了提高安全性,请改用较新的算法,例如 AES 算法之一。

类型:EndpointEncryptionAlgorithm
接受的值:None, RC4, Aes, AesRC4, RC4Aes
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

指定在其中创建终结点的 SQL Server 实例的服务器对象。

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

-IpAddress

指定终结点的 IP 地址。 默认值为 ALL,指示侦听器接受任何有效 IP 地址上的连接。

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

-Name

指定终结点名称。

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

-Owner

指定终结点所有者的登录名。 默认情况下,这是当前登录名。

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

-Path

指定终结点的 SQL Server 实例的路径。 如果未指定,则使用当前工作位置。

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

-Port

指定终结点将侦听连接的 TCP 端口。 默认值为 5022

类型: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 返回执行任务的 Transact-SQL 脚本。

类型:SwitchParameter
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.Server

输出

SMO.Endpoint