<serviceDebug>

[アーティクル]
06/08/2023

Windows Communication Foundation (WCF) サービスのデバッグおよびヘルプ情報機能を指定します。

configuration
  system.serviceModel
    behaviors
      <serviceBehaviors>
        behavior
          <serviceDebug>

構文

<serviceDebug httpHelpPageBinding="String"
              httpHelpPageBindingConfiguration="String"
              httpHelpPageEnabled="Boolean"
              httpHelpPageUrl="Uri"
              httpsHelpPageBinding="String"
              httpsHelpPageBindingConfiguration="String"
              httpsHelpPageEnabled="Boolean"
              httpsHelpPageUrl="Uri"
              includeExceptionDetailInFaults="Boolean" />

属性および要素

以降のセクションでは、属性、子要素、および親要素について説明します。

属性

属性	説明
httpHelpPageBinding	HTTP を利用してサービスヘルプページにアクセスする場合に使用するバインディングの種類を指定する文字列値。 System.ServiceModel.Channels.IReplyChannel をサポートする内部バインディング要素を使用したバインディングでのみサポートされます。さらに、バインディングの System.ServiceModel.Channels.MessageVersion プロパティが MessageVersion.None である必要があります。
httpHelpPageBindingConfiguration	このバインディングの追加の構成情報を参照する `httpHelpPageBinding` 属性に指定されるバインディングの名前を指定する文字列。同じ名前を `<bindings>` セクションに定義する必要があります。
httpHelpPageEnabled	WCF で、`httpHelpPageUrl` 属性により指定されたアドレスに HTML ヘルプページを公開するかどうかを制御するブール値。既定値は、`true` です。このプロパティを `false` に設定して、HTML ブラウザーに表示される HTML ヘルプページの公開を無効にできます。 HTML ヘルプページが、`httpHelpPageUrl` 属性により制御される場所に公開されるようにするには、この属性を `true` に設定する必要があります。さらに、次のいずれかの条件も満たす必要があります。 - `httpHelpPageUrl` 属性は、HTTP プロトコルスキームをサポートする絶対アドレスです。 - HTTP プロトコルスキームをサポートするサービスのベースアドレスがあります。 HTTP プロトコルスキームをサポートしない絶対アドレスが `httpHelpPageUrl` 属性に割り当てられている場合は例外がスローされますが、前の基準をどれも満たさないその他のシナリオでは、例外も HTML ヘルプページも表示されません。
httpHelpPageUrl	HTML ブラウザーを使用してエンドポイントを表示するときにユーザーが参照する、カスタム HTML ヘルプファイルの相対的または絶対的な HTTP ベースの URL を指定する URI。この属性を使用して、HTTP/Get 要求から返されるカスタム HTML ヘルプファイルを HTML ブラウザーなどから利用できます。 HTML ヘルプファイルの位置は、次のように解決されます。 1. この属性の値が相対アドレスの場合、HTML ヘルプファイルの位置は、HTTP 要求をサポートするサービスのベースアドレスにこのプロパティの値を加えた値になります。 2. この属性が絶対アドレスであり、HTTP 要求をサポートする場合は、HTML ヘルプファイルの位置はこのプロパティの値になります。 3. この属性の値が絶対値であっても HTTP 要求をサポートしていない場合は、例外がスローされます。この属性は、`httpHelpPageEnabled` 属性が `true` の場合にのみ有効です。
httpsHelpPageBinding	HTTPS を利用してサービスヘルプページにアクセスする場合に使用するバインディングの種類を指定する文字列値。 IReplyChannel をサポートする内部バインディング要素を使用したバインディングでのみサポートされます。さらに、バインディングの System.ServiceModel.Channels.MessageVersion プロパティが MessageVersion.None である必要があります。
httpsHelpPageBindingConfiguration	このバインディングの追加の構成情報を参照する `httpsHelpPageBinding` 属性に指定されるバインディングの名前を指定する文字列。同じ名前を `<bindings>` セクションに定義する必要があります。
httpsHelpPageEnabled	WCF で、`httpsHelpPageUrl` 属性により指定されたアドレスに HTML ヘルプページを公開するかどうかを制御するブール値。既定値は、`true` です。このプロパティを `false` に設定して、HTML ブラウザーに表示される HTML ヘルプページの公開を無効にできます。 HTML ヘルプページが、`httpsHelpPageUrl` 属性により制御される場所に公開されるようにするには、この属性を `true` に設定する必要があります。さらに、次のいずれかの条件も満たす必要があります。 - `httpsHelpPageUrl` 属性は、HTTPS プロトコルスキームをサポートする絶対アドレスです。 - HTTPS プロトコルスキームをサポートするサービスのベースアドレスがあります。 HTTPS プロトコルスキームをサポートしない絶対アドレスが `httpsHelpPageUrl` 属性に割り当てられている場合は例外がスローされますが、前の基準をどれも満たさないその他のシナリオでは、例外も HTML ヘルプページも表示されません。
httpsHelpPageUrl	HTML ブラウザーを使用してエンドポイントを表示するときにユーザーが参照する、カスタム HTML ヘルプファイルの相対的または絶対的な HTTPS ベースの URL を指定する URI。この属性を使用して、HTTPS/Get 要求から返されるカスタム HTML ヘルプファイルを HTML ブラウザーなどから利用できます。 HTML ヘルプファイルの場所は、次のように解決されます。 - このプロパティの値が相対アドレスの場合、HTML ヘルプファイルの位置は、HTTPS 要求をサポートするサービスのベースアドレスにこのプロパティの値を加えた値になります。 - このプロパティが絶対アドレスであり、HTTPS 要求をサポートする場合は、HTML ヘルプファイルの位置はこのプロパティの値になります。 - このプロパティの値が絶対値であっても HTTPS 要求をサポートしていない場合は、例外がスローされます。この属性は、`httpHelpPageEnabled` 属性が `true` の場合にのみ有効です。
includeExceptionDetailInFaults	デバッグの目的でクライアントに返される SOAP エラーの詳細に、マネージド例外情報を含めるかどうかを指定する値。既定では、 `false`です。この属性を `true` に設定すると、デバッグ目的でクライアントへのマネージド例外情報のフロー、および Web ブラウザーでサービスをブラウズするユーザー向けの HTML 情報ファイルの公開を有効にできます。注: マネージド例外情報をクライアントに返すことは、セキュリティリスクになる場合があります。これは、例外の詳細が、認証されていないクライアントによって使用可能な内部サービスの実装に関する情報を公開するためです。

子要素

なし。

親要素

要素	説明
<behavior>	動作の要素を指定します。

解説

例外が FaultContractAttribute を使用して宣言されていない場合でも、includeExceptionDetailInFaults を true に設定すると、サービスでは、アプリケーションコードによってスローされる例外を返すことができます。この設定は、サーバーが予期しない例外をスローしている場合のデバッグ時に役立ちます。この属性を使用すると、不明な例外がシリアル化された形式で返されるので、例外をより詳細に調べることができます。

注意事項

マネージド例外情報をクライアントに戻すことは、セキュリティリスクになり得ます。これは、例外の詳細が、非承認のクライアントで使用可能な内部サービスの実装についての情報を公開するからです。セキュリティの問題にかかわるため、この操作は制御されたデバッグシナリオでのみ行うことを強くお勧めします。アプリケーションを配置する場合は、includeExceptionDetailInFaults を false に設定する必要があります。

マネージド例外に関するセキュリティの問題の詳細については、「コントラクトおよびサービスのエラーの指定と処理」を参照してください。コードサンプルについては、「サービスデバッグ動作」を参照してください。

httpsHelpPageEnabled と httpsHelpPageUrl を設定して、ヘルプページを有効または無効にすることもできます。各サービスは、サービスの WSDL を取得するエンドポイントなど、サービスに関する情報が含まれるヘルプページをオプションで公開できます。これを有効にするには、httpHelpPageEnabled プロパティを true に設定します。これにより、サービスのベースアドレスへの GET 要求に対して、ヘルプページを返すことができます。このアドレスは、httpHelpPageUrl 属性を設定することで変更できます。また、HTTP の代わりに HTTPS を使用すると、このアドレスをセキュリティで保護できます。

省略可能な httpHelpPageBinding 属性および httpHelpPageBinding 属性を使用すると、サービスウェブページにアクセスするためのバインディングを構成できます。これらの属性が指定されていない場合、サービスヘルプページへのアクセスには、適切な既定のバインディグ (HTTP の場合は HttpTransportBindingElement、HTTPS の場合は HttpsTransportBindingElement) が使用されます。これらの属性は、組み込みの WCF バインディングでは使用できないことに注意してください。 xref:System.ServiceModel.Channels.IReplyChannel> をサポートする内部バインディング要素を使用したバインディングのみがサポートされます。さらに、バインディングの System.ServiceModel.Channels.MessageVersion プロパティが MessageVersion.None である必要があります。

<serviceDebug>

構文

属性および要素

属性

子要素

親要素

解説

関連項目

フィードバック

その他のリソース