Test-SqlAvailabilityReplica

评估可用性副本的运行状况。

语法

Test-SqlAvailabilityReplica
    [-ShowPolicyDetails]
    [-AllowUserPolicies]
    [-NoRefresh]
    [[-Path] <String[]>]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Test-SqlAvailabilityReplica
    [-ShowPolicyDetails]
    [-AllowUserPolicies]
    [-NoRefresh]
    [-InputObject] <AvailabilityReplica[]>
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

Test-SqlAvailabilityReplica cmdlet 通过评估基于 SQL Server 策略的管理 (PBM) 策略来评估可用性副本的运行状况。 必须具有CONNECTVIEW SERVER STATEVIEW ANY DEFINITION权限才能执行此 cmdlet。

Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.

示例

示例 1:评估可用性副本的运行状况

PS C:\> Test-SqlAvailabilityReplica -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAg\AvailabilityReplicas\MainReplica"

此命令评估可用性组中命名MainReplicaMainAg的可用性副本的运行状况,并输出简短摘要。

示例 2:评估可用性组中所有可用性副本的运行状况

PS C:\> Get-ChildItem "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAg\AvailabilityReplicas" | Test-SqlAvailabilityReplica

此命令评估命名 MainAg 的可用性组中所有可用性副本的运行状况,并输出每个副本的简短摘要。

示例 3:评估每个 PBM 策略的可用性副本的运行状况

PS C:\> Test-SqlAvailabilityReplica -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAg\AvailabilityReplicas\MainReplica" -ShowPolicyDetails

此命令评估可用性组中命名MainReplicaMainAg的可用性副本的运行状况,并输出执行的每个 PBM 策略的评估结果。

示例 4:评估可用性副本的运行状况并包括用户定义的策略

PS C:\> Test-SqlAvailabilityReplica -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAg\AvailabilityReplicas\MainReplica" -AllowUserPolicies

此命令评估可用性组中命名 MainReplica 的可用性副本的 MainAg 运行状况。 此评估中包含用户定义的策略。

示例 5:显示处于错误状态的所有可用性副本

PS C:\> Get-ChildItem "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAg\AvailabilityReplicas" | Test-SqlAvailabilityReplica | Where-Object { $_.HealthState -eq "Error" }

此命令显示处于可用性组中运行状况ErrorMainAg的所有可用性副本。

参数

-AccessToken

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

例如,这可用于连接 SQL Azure DB 和使用 SQL Azure Managed InstanceService PrincipalManaged Identity 请参阅本页底部的引用)

在常见情况下,使用类似 (Get-AzAccessToken -ResourceUrl https://database.windows.net).Token 内容(需要 Az.Accounts 模块)获取此参数

参数的类型可以是 string (明文标记)或 SecureString (由较新版本的 Get-AzAccessToken cmdlet 返回的加密令牌)。

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

-AllowUserPolicies

指示此 cmdlet 运行在 AlwaysOn 策略类别中找到的用户策略。

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

-Confirm

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

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

-Encrypt

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

此值映射到 Encrypt Microsoft.Data.SqlClient 驱动程序的 SqlConnection 对象上的属性 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

指定要评估的可用性副本数组。

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

-NoRefresh

指示此 cmdlet 不会手动刷新 PathInputObject 参数指定的对象。

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

-Path

指定一个或多个可用性副本的路径。 此参数是可选的。 如果未指定,则使用当前工作位置。

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

-ShowPolicyDetails

指示显示此 cmdlet 执行的每个策略评估的结果。 该 cmdlet 为每个策略评估输出一个对象。 此对象包含描述计算结果的字段。

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

-TrustServerCertificate

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

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

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

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

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

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

输入

Microsoft.SqlServer.Management.Smo.AvailabilityReplica[]