Test-SqlAvailabilityGroup

構文

ByPath (既定)

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

ByObject

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

説明

例

例 1: 可用性グループの正常性を評価する

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

例 2: すべての可用性グループの正常性を評価する

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

例 3: 可用性グループの各ポリシーの結果を表示する

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

例 4: 可用性グループのユーザー定義ポリシーの結果を表示する

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

例 5: エラー状態のグループを取得する

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

パラメーター

-AccessToken

ユーザー/パスワードまたは Windows 認証の代わりに、SQL Server に対する認証に使用されるアクセス トークン。

これは、たとえば、SQL Azure DBまたはSQL Azure Managed Instanceを使用してService PrincipalとManaged Identityに接続するために使用できます (このページの下部にあるリファレンスを参照してください)。

一般的なシナリオでは、このパラメーターは (Get-AzAccessToken -ResourceUrl https://database.windows.net).Token (Az.Accounts モジュールが必要) などを使用して取得されます。

パラメーターの型は、 string (クリア テキスト トークン) または SecureString (Get-AzAccessToken コマンドレットの新しいバージョンによって返される暗号化されたトークン) のいずれかです。

パラメーターのプロパティ

パラメーター セット

-AllowUserPolicies

このコマンドレットは、Always On 可用性グループのポリシー カテゴリにあるユーザー ポリシーをテストすることを示します。

パラメーターのプロパティ

パラメーター セット

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

パラメーターのプロパティ

パラメーター セット

-Encrypt

SQL Server に接続するときに使用する暗号化の種類。

この値は、Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの Encrypt プロパティ SqlConnectionEncryptOption にマップされます。

モジュールの v22 では、既定値は Optional です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "必須" になり、既存のスクリプトに重大な変更が生じる可能性があります。

このパラメーターは、モジュールの v22 の新機能です。

パラメーターのプロパティ

パラメーター セット

-HostNameInCertificate

SQL Server TLS/SSL 証明書の検証に使われるホスト名。 SQL Server インスタンスで Force Encryption が有効になっていて、ホスト名/短縮名を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっている SQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。

このパラメーターは、モジュールの v22 の新機能です。

パラメーターのプロパティ

パラメーター セット

-InputObject

可用性グループオブジェクトとして可用性グループの配列を指定します。 このコマンドレットは、このパラメーターが指定する可用性グループの正常性を評価します。

パラメーターのプロパティ

パラメーター セット

-NoRefresh

Path または InputObject パラメーターで指定されたオブジェクトを更新しないことを示します。

パラメーターのプロパティ

パラメーター セット

-Path

このコマンドレットが評価する可用性グループのパスを指定します。 このパラメーターを指定しない場合、このコマンドレットは現在の作業場所を使用します。

パラメーターのプロパティ

パラメーター セット

-ShowPolicyDetails

このコマンドレットが実行する各ポリシー評価の結果を表示することを示します。 このコマンドレットは、ポリシー評価ごとに 1 つのオブジェクトを返します。 各ポリシー オブジェクトには、評価の結果が含まれます。 この情報には、ポリシーが渡されたかどうか、ポリシー名、およびポリシー カテゴリが含まれます。

パラメーターのプロパティ

パラメーター セット

-TrustServerCertificate

信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。

モジュールの v22 では、既定値は $true です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに重大な変更が生じる可能性があります。

このパラメーターは、モジュールの v22 の新機能です。

パラメーターのプロパティ

パラメーター セット

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

Microsoft.SqlServer.Management.Smo.AvailabilityGroup

関連リンク

• Join-SqlAvailabilityGroup
• New-SqlAvailabilityGroup
• Remove-SqlAvailabilityGroup
• Set-SqlAvailabilityGroup
• Switch-SqlAvailabilityGroup