Test-SqlAvailabilityGroup

评估可用性组的运行状况。

语法

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

说明

Test-SqlAvailabilityGroup cmdlet 评估可用性组的运行状况。 此 cmdlet 评估基于 SQL Server 策略的管理策略。 若要运行此 cmdlet,必须具有CONNECTVIEW SERVER STATEVIEW ANY DEFINITION用户权限。

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

示例

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

PS C:\> Test-SqlAvailabilityGroup -Path "SQLSERVER:\Sql\Server\InstanceName\AvailabilityGroups\MainAG"

此命令评估名为 MainAG 的可用性组的运行状况。 该命令返回摘要。

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

PS C:\> Get-ChildItem "SQLSERVER:\Sql\Server\InstanceName\AvailabilityGroups" | Test-SqlAvailabilityGroup

此命令获取 SQLSERVER:提供程序中指定位置具有可用性副本的所有可用性组。 该命令使用管道运算符将它们传递到当前 cmdlet。 该 cmdlet 评估每个可用性组的运行状况。

示例 3:显示可用性组的每个策略的结果

PS C:\> Test-SqlAvailabilityGroup -Path "SQLSERVER:\Sql\Server\InstanceName\AvailabilityGroups\MainAG" -ShowPolicyDetails

此命令评估名为 MainAG 的可用性组的运行状况。 此命令指定 ShowPolicyDetails 参数。 因此,它显示运行的每个基于策略的管理策略的评估结果。

示例 4:显示可用性组的用户定义策略的结果

PS C:\> Test-SqlAvailabilityGroup -Path "SQLSERVER:\Sql\Server\InstanceName\AvailabilityGroups\MainAG" -AllowUserPolicies

此命令评估名为 MainAG 的可用性组的运行状况。 此命令在此评估中包含用户定义的策略。

示例 5:获取具有错误状态的组

PS C:\> Get-ChildItem "SQLSERVER:\Sql\Server\InstanceName\AvailabilityGroups" | Test-SqlAvailabilityGroup | Where-Object { $_.HealthState -eq "Error" }

此命令获取 SQLSERVER:提供程序中指定位置具有可用性副本的所有可用性组。 该命令使用管道运算符将它们传递到当前 cmdlet。 该 cmdlet 评估每个可用性组的运行状况。 该命令将这些结果传递给 Where-Object cmdlet,该 cmdlet 基于 HealthState 属性返回结果。

参数

-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

将可用性组数组指定为 AvailabilityGroup 对象。 此 cmdlet 评估此参数指定的可用性组的运行状况。

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

-NoRefresh

指示不会刷新 PathInputObject 参数指定的对象。

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

-Path

指定此 cmdlet 计算的可用性组的路径。 如果未指定此参数,此 cmdlet 将使用当前工作位置。

类型: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.AvailabilityGroup[]