Test-MDISensorApiConnection

モジュール:
DefenderForIdentity Module

Identity Sensor API のDefenderへの接続を検証します。

構文

UseCurrentConfiguration (既定) 

Test-MDISensorApiConnection
    [<CommonParameters>]

BypassConfiguration 

Test-MDISensorApiConnection
    -SensorApiUrl <String>
    -SensorType <Classic|Modern>
    [-BypassConfiguration]
    [-ProxyUrl <String>]
    [-ProxyCredential <PSCredential>]
    [<CommonParameters>]

説明

この関数は、現在の構成を使用するか、カスタム パラメーターを使用して、Identity Sensor API のDefenderへの接続を検証します。

例

例 1

Test-MDISensorApiConnection

この例では、インストールされているセンサーの現在の構成を使用して、Identity Sensor API のDefenderへの接続をテストします。

例 2

$connectionParams = @{
    BypassConfiguration = $true
    SensorApiUrl        = 'https://contososensorapi.atp.azure.com'
    SensorType          = 'Classic'
    ProxyUrl            = 'https://myproxy.contoso.com:8080'
    ProxyCredential     = $credential
}
Test-MDISensorApiConnection @connectionParams

この例では、カスタム パラメーターを使用して Identity Sensor API のDefenderへの接続をテストします。

パラメーター

-BypassConfiguration

現在の構成をバイパスし、カスタム パラメーターを使用するようにパラメーターを切り替えます。

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

型:System.Management.Automation.SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

BypassConfiguration
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ProxyCredential

プロキシ サーバーに使用する資格情報を指定します。

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

型:System.Management.Automation.PSCredential
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

BypassConfiguration
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ProxyUrl

接続に使用するプロキシ サーバーの URL を指定します。

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

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

BypassConfiguration
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SensorApiUrl

テストする Identity Sensor API のDefenderの URL を指定します。

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

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

BypassConfiguration
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SensorType

デバイスにインストールまたはインストールする予定のセンサー バージョンを指定します。 次のいずれかの値を受け入れます。

  • Classic
  • Modern

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

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

BypassConfiguration
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

出力

System.Boolean

このコマンドレットは、Identity Sensor API のDefenderへの接続が成功した場合、または失敗した場合に$false$trueを返します。