Set-SqlHADREndpoint

设置数据库镜像终结点的属性。

语法

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

说明

Set-SqlHADREndpoint cmdlet 更改数据库镜像终结点的属性。

示例

示例 1:设置数据库镜像终结点的端口号

PS C:\> Set-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance\Endpoints\MainDbmEndpoint" -Port 5050

此命令将名为 MainDbmEndpoint 的数据库镜像终结点的端口号设置为 5050 名为 Computer\Instance的服务器实例。

示例 2:启动数据库镜像终结点

PS C:\> Set-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance\Endpoints\MainDbmEndpoint" -State Started

此命令启动服务器实例 Computer\Instance上名为 MainDbmEndpoint 的数据库镜像终结点。

参数

-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

指定终结点加密设置。

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

-EncryptionAlgorithm

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

注意:RC4 算法仅支持向后兼容性。 只有在数据库处于兼容级别 90100时,才能使用 RC4RC4_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

指定要修改的终结点。 这必须是数据库镜像终结点。

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

-IpAddress

指定终结点将侦听的 IP 地址。

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

-Owner

指定终结点的所有者。

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

-Path

指定数据库镜像终结点的路径。 如果未指定,则使用当前工作位置。

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

-Port

指定终结点用于侦听连接的 TCP 端口号。

类型: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

-State

指定终结点的状态。

类型:EndpointState
接受的值:Started, Stopped, Disabled
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.Endpoint

输出

SMO.Endpoint