Test-SqlSmartAdmin

構文

ByPath (既定)

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

ByObject

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

説明

例

例 1: SQL Server スマート管理者の状態をテストする

PS C:\> cd SQLSERVER:\SQL\Computer\MyInstance
PS SQLSERVER:\SQL\Computer\MyInstance> Get-SqlSmartAdmin | Test-SqlSmartAdmin

例 2: SQL Server スマート管理者のテスト結果を評価する

PS C:\> cd SQLSERVER:\SQL\Computer\MyInstance
PS SQLSERVER:\SQL\Computer\MyInstance> $PolicyResults = Get-SqlSmartAdmin | Test-SqlSmartAdmin
PS SQLSERVER:\SQL\Computer\MyInstance> $PolicyResults.PolicyEvaluationDetails | select Name, Category, Result, Expression

例 3: SQL Server スマート管理者の状態を出力する

PS C:\> PS SQLSERVER:\SQL\COMPUTER\DEFAULT> (Get-SqlSmartAdmin).EnumHealthStatus()

number_of_storage_connectivity_errors: 0
number_of_sql_errors: 2
number_of_invalid_credential_errors: 0
number_of_other_errors : 0
number_of_corrupted_or_deleted_backups: 0
number_of_backup_loops: 2
number_of_retention_loops: 2

パラメーター

-AccessToken

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

これは、たとえば、SQL Azure DBまたはSQL Azure Managed Instanceを使用してService Principalに接続してManaged Identityするために使用できます。

使用するパラメーターには、トークンを表す文字列、または PSAccessToken を実行して返されるGet-AzAccessToken -ResourceUrl https://database.windows.net オブジェクトのいずれかを指定できます。

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

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

パラメーター セット

-AllowUserPolicies

このコマンドレットは、スマート管理者の警告ポリシーとエラー ポリシー カテゴリに含まれるユーザー ポリシーを実行することを示します。

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

パラメーター セット

-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

SmartAdmin オブジェクトの配列を指定します。 このオブジェクトを取得するには、Get-SqlSmartAdmin コマンドレットを使用します。

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

パラメーター セット

-NoRefresh

このコマンドレットは、 Path パラメーターまたは InputObject パラメーターで指定されたオブジェクトを手動で更新しないことを示します。

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

パラメーター セット

-Path

SQL Server インスタンスのパスを文字列配列として指定します。 このパラメーターの値を指定しない場合、コマンドレットは現在の作業場所を使用します。

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

パラメーター セット

-ShowPolicyDetails

このコマンドレットがポリシーの結果を表示することを示します。 このコマンドレットは、ポリシー評価ごとに 1 つのオブジェクトを出力します。 出力には、評価の結果 (ポリシーの名前、カテゴリ、正常性など) が含まれます。

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

パラメーター セット

-TrustServerCertificate

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

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

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

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

パラメーター セット

-WhatIf

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

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

パラメーター セット

CommonParameters

入力

Microsoft.SqlServer.Management.Smo.SmartAdmin

出力

Object

関連リンク

• Get-SqlSmartAdmin
• Set-SqlSmartAdmin