Test-SqlSmartAdmin

リファレンス

モジュール:: SQLServer

ポリシーベース管理 (PBM) ポリシー SQL Server評価して、スマート管理の正常性をテストします。

構文

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

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

説明

Test-SqlSmartAdmin コマンドレットは、ポリシーベース管理 (PBM) ポリシーを評価することで、SQL Server インスタンスのスマート管理の正常性SQL Serverテストします。

このコマンドレットでは、オブジェクトを返す、次の操作モードがサポートされます。

SQL Serverのインスタンスのパスを Path パラメーターに渡します。
Smo.Server オブジェクトを InputObject パラメーターに直接渡すか、パイプラインを介して渡します。

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

例

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

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

最初のコマンドは、ディレクトリを SQL インスタンスに変更します Computer\MyInstance。

例 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

最初のコマンドは、ディレクトリを SQL インスタンス Computer\MyInstance に変更します。

例 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

このコマンドは、ローカル SQL Server Smart 管理の状態を出力します。

パラメーター

-AccessToken

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

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

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

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

Type:	PSObject
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AllowUserPolicies

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Encrypt

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

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

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

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

Type:	String
Accepted values:	Mandatory, Optional, Strict
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HostNameInCertificate

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

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

Type:	SmartAdmin[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-NoRefresh

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

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

Type:	String[]
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ShowPolicyDetails

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TrustServerCertificate

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

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

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

Microsoft.SqlServer.Management.Smo.SmartAdmin[]

出力

このコマンドレットは、ポリシーの評価結果を出力します。

Test-SqlSmartAdmin

構文

説明

例

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

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

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

パラメーター

-AccessToken

-AllowUserPolicies

-Confirm

-Encrypt

-HostNameInCertificate

-InputObject

-NoRefresh

-Path

-ShowPolicyDetails

-TrustServerCertificate

-WhatIf

入力

出力

関連リンク

その他のリソース

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

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

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