データサービスの構成 (WCF Data Services)

[アーティクル]
02/24/2011

WCF Data Services では、Open Data Protocol (OData) フィードを公開するデータサービスを作成できます。これらのフィードには、さまざまなデータソースからのデータが含まれることがあります。WCF Data Services は、データプロバイダーを使用して、このデータを OData フィードとして公開します。これらのプロバイダーには、Entity Framework プロバイダー、リフレクションプロバイダー、およびカスタムデータサービスプロバイダーインターフェイスのセットがあります。プロバイダーの実装は、サービスのデータモデルを定義します。詳細については、「データサービスプロバイダー (WCF Data Services)」を参照してください。

WCF Data Services では、データサービスは、データサービスの種類がデータモデルのエンティティコンテナーである DataService クラスから継承するクラスです。このエンティティコンテナーには、データモデルのエンティティセットにアクセスするために使用される IQueryable を返す 1 つ以上のプロパティがあります。

データサービスの動作は、DataServiceConfiguration クラスのメンバー、および DataServiceConfiguration クラスの DataServiceBehavior プロパティからアクセスされる DataServiceBehavior クラスのメンバーによって定義されます。DataServiceConfiguration クラスは、Northwind データサービスの次の実装のように、データサービスによって実装される InitializeService メソッドに提供されます。

' This method is called only once to initialize service-wide policies.
Public Shared Sub InitializeService(ByVal config As DataServiceConfiguration)
    ' Set the access rules of feeds exposed by the data service, which is
    ' based on the requirements of client applications.
    config.SetEntitySetAccessRule("Customers", EntitySetRights.ReadSingle)
    config.SetEntitySetAccessRule("Employees", EntitySetRights.ReadSingle)
    config.SetEntitySetAccessRule("Orders", EntitySetRights.AllRead _
        And EntitySetRights.WriteAppend _
        And EntitySetRights.WriteMerge)
    config.SetEntitySetAccessRule("Order_Details", EntitySetRights.All)
    config.SetEntitySetAccessRule("Products", EntitySetRights.ReadMultiple)

    ' Set page size defaults for the data service.
    config.SetEntitySetPageSize("Orders", 20)
    config.SetEntitySetPageSize("Order_Details", 50)
    config.SetEntitySetPageSize("Products", 50)

    ' Paging requires v2 of the OData protocol.
    config.DataServiceBehavior.MaxProtocolVersion = _
        System.Data.Services.Common.DataServiceProtocolVersion.V2
End Sub

// This method is called only once to initialize service-wide policies.
public static void InitializeService(DataServiceConfiguration config)
{
    // Set the access rules of feeds exposed by the data service, which is
    // based on the requirements of client applications.
    config.SetEntitySetAccessRule("Customers", EntitySetRights.ReadSingle);
    config.SetEntitySetAccessRule("Employees", EntitySetRights.ReadSingle);
    config.SetEntitySetAccessRule("Orders", EntitySetRights.AllRead 
        & EntitySetRights.WriteAppend
        & EntitySetRights.WriteMerge);
    config.SetEntitySetAccessRule("Order_Details", EntitySetRights.All);
    config.SetEntitySetAccessRule("Products", EntitySetRights.ReadMultiple);

    // Set page size defaults for the data service.
    config.SetEntitySetPageSize("Orders", 20);
    config.SetEntitySetPageSize("Order_Details", 50);
    config.SetEntitySetPageSize("Products", 50);

    // Paging requires v2 of the OData protocol.
    config.DataServiceBehavior.MaxProtocolVersion =
        System.Data.Services.Common.DataServiceProtocolVersion.V2;
}

データサービス構成設定

DataServiceConfiguration クラスでは、以下のデータサービスの動作を指定できます。

メンバー	動作
AcceptCountRequests	$count パスセグメントおよび $inlinecount クエリオプションを使用してデータサービスに送信したカウント要求を無効にできます。詳細については、OData: URI 規則に関する Web ページを参照してください。
AcceptProjectionRequests	$select クエリオプションを使用してデータサービスに送信された要求のデータプロジェクションのサポートを無効にできます。詳細については、OData: URI 規則に関する Web ページを参照してください。
EnableTypeAccess	IDataServiceMetadataProvider インターフェイスを使用して定義された動的メタデータプロバイダーのメタデータでデータ型を公開します。
EnableTypeConversion	ペイロードに含まれている型を、要求で指定された実際のプロパティ型にデータサービスランタイムで変換するかどうかを指定できます。
InvokeInterceptorsOnLinkDelete	2 つのエンティティ間のリレーションシップリンクを削除するときに、関連エンティティで登録済みの変更インターセプターを呼び出すかどうかを指定できます。
MaxBatchCount	単一のバッチで許可される変更セットおよびクエリ操作の数を制限できます。詳細については、OData: バッチ処理に関する Web ページおよび「バッチ処理 (WCF Data Services)」を参照してください。
MaxChangesetCount	単一の変更セットに含めることができる変更の数を制限できます。詳細については、「方法: データサービスの結果のページングを有効にする (WCF Data Services)」を参照してください。
MaxExpandCount	$expand クエリ演算子を使用して 1 つの要求に含めることのできる関連エンティティの数を制限することによって応答のサイズを制限できます。詳細については、次のトピックを参照してください。、OData: URI 規則に関する Web ページおよび「遅延コンテンツの読み込み (WCF Data Services)」を参照してください。
MaxExpandDepth	$expand クエリ演算子を使用して 1 つの要求に含めることのできる関連エンティティのグラフの深度を制限することによって応答のサイズを制限できます。詳細については、次のトピックを参照してください。、OData: URI 規則に関する Web ページおよび「遅延コンテンツの読み込み (WCF Data Services)」を参照してください。
MaxObjectCountOnInsert	1 つの POST 要求に挿入できるエンティティの数を制限できます。
MaxProtocolVersion	データサービスによって使用される Atom プロトコルのバージョンを定義します。MaxProtocolVersion に DataServiceProtocolVersion の最大値よりも低い値を設定した場合、WCF Data Services の最新の機能はデータサービスにアクセスするクライアントで使用できなくなります。詳細については、次のトピックを参照してください。、「WCF Data Services の複数のバージョンの使用」を参照してください。
MaxResultsPerCollection	データフィードとして返される各エンティティセットのエンティティの数を制限することによって応答のサイズを制限できます。
RegisterKnownType	データサービスで認識される型のリストにデータ型を追加します。
SetEntitySetAccessRule	データサービスで使用可能なエンティティセットリソースへのアクセス権を設定します。アスタリスク (*) 値を名前パラメーターに使用すると、残りのすべてのエンティティセットへのアクセスを同じレベルに設定できます。エンティティセットへのアクセスを設定する場合は、クライアントアプリケーションに必要なデータサービスリソースへの最小アクセス特権を設定することをお勧めします。詳細については、「WCF Data Services のセキュリティ保護」を参照してください。特定の URI および HTTP アクションに必要な最小限のアクセス権の例については、「Minimum Resource Access Requirements」の表を参照してください。
SetEntitySetPageSize	エンティティセットリソースの最大ページサイズを設定します。詳細については、「方法: データサービスの結果のページングを有効にする (WCF Data Services)」を参照してください。
SetServiceOperationAccessRule	データサービスで定義されるサービス操作へのアクセス権を設定します。詳細については、「サービス操作 (WCF Data Services)」を参照してください。アスタリスク (*) 値を名前パラメーターに使用すると、残りのすべてのサービス操作へのアクセスを同じレベルに設定できます。サービス操作へのアクセスを設定する場合は、クライアントアプリケーションに必要なデータサービスリソースへの最小アクセス特権を設定することをお勧めします。詳細については、「WCF Data Services のセキュリティ保護」を参照してください。
UseVerboseErrors	この構成プロパティを使用すると、エラー応答メッセージで多くの情報を返すことによってデータサービスのトラブルシューティングを容易にすることができます。このオプションは、運用環境で使用することを目的としたものではありません。詳細については、「WCF Data Services の開発と配置」を参照してください。

最小限のリソースアクセス要件

次の表に、特定の操作を実行するために付与されている必要があるエンティティセットの最小限の権限を示します。パスの例は、クイックスタートの完了時に作成される Northwind データサービスに基づいています。EntitySetRights 列挙体および ServiceOperationRights 列挙体は FlagsAttribute を使用して定義されているので、論理和演算子を使用して 1 つのエンティティセットまたは操作に複数のアクセス許可を指定できます。詳細については、「方法: データサービスへのアクセスを有効にする (WCF Data Services)」を参照してください。

パス/アクション	GET	DELETE	MERGE	POST	PUT
`/Customers`	ReadMultiple	サポートなし	サポートなし	WriteAppend	サポートなし
`/Customers('ALFKI')`	ReadSingle	ReadSingle およびWriteDelete	ReadSingle およびWriteMerge	適用なし	ReadSingle およびWriteReplace
`/Customers('ALFKI')/Orders`	`Customers`: ReadSingle および `Orders`: ReadMultiple	サポートなし	サポートなし	`Customers`: ReadSingle および WriteMerge または WriteReplace および `Orders` : およびWriteAppend	サポートなし
`/Customers('ALFKI')/Orders(10643)`	`Customers`: ReadSingle および `Orders`:ReadSingle	`Customers`: ReadSingle および `Orders`: ReadSingle および WriteDelete	`Customers`: ReadSingle および `Orders`: ReadSingle および WriteMerge	サポートなし	`Customers`:ReadSingle および `Orders`: ReadSingle および WriteReplace
`/Orders(10643)/Customer`	`Customers`: ReadSingle および `Orders`:ReadSingle	`Customers`: ReadSingle および WriteDelete および `Orders`:ReadSingle	`Customers`: ReadSingle および WriteMerge および `Orders`:ReadSingle	`Customers`:WriteAppend および `Orders`: WriteAppend および ReadSingle	サポートなし
`/Customers('ALFKI')/$links/Orders`	`Customers`:ReadSingle および `Orders`:ReadMultiple	サポートなし	サポートなし	`Customers`: ReadSingle および WriteMerge または WriteReplace および `Orders`:ReadSingle	サポートなし
`/Customers('ALFKI')/$links/Orders(10643)`	`Customers`:ReadSingle および `Orders`:ReadSingle	`Customers`: ReadSingle および WriteMerge または WriteReplace および `Orders`:ReadSingle	サポートなし	サポートなし	サポートなし
`/Orders(10643)/$links/Customer`	`Customers`:ReadSingle および `Orders`:ReadSingle	`Orders`: ReadSingle および WriteMerge または WriteReplace	`Customers`:ReadSingle および `Orders`: ReadSingle および WriteMerge	サポートなし	`Customers`: ReadSingle; および `Orders`: ReadSingle および WriteReplace
`/Customers/$count`	ReadMultiple	サポートなし	サポートなし	サポートなし	サポートなし
`/Customers('ALFKI')/ContactName`	ReadSingle	サポートなし	WriteMerge	サポートなし	WriteReplace
`/Customers('ALFKI')/Address/StreetAddress/$value` 1	ReadSingle	WriteDelete	サポートなし	サポートなし	サポートなし
`/Customers('ALFKI')/ContactName/$value`	ReadSingle	ReadSingle およびWriteDelete	WriteMerge	サポートなし	WriteReplace
`/Customers('ALFKI')/$value` 2	ReadSingle	サポートなし	サポートなし	サポートなし	WriteReplace
`/Customers?$select=Orders/*&$expand=Orders`	`Customers`:ReadSingle および `Orders`:ReadMultiple	サポートなし	サポートなし	`Customers`:WriteAppend	サポートなし
`/Customers('ALFKI')?$select=Orders/*&$expand=Orders`	`Customers`:ReadSingle および `Orders`:ReadMultiple	サポートなし	サポートなし	サポートなし	サポートなし

1 この例では、Address は StreetAddress という名前のプロパティを持つ Customers エンティティの複合型プロパティを表します。Northwind データサービスによって使用されるモデルでは、この複合型は明示的に定義されていません。Entity Framework プロバイダーを使用してデータモデルを定義している場合、Entity Data Model ツールを使用して、このような複合型を定義できます。詳細については、「How to: Create and Modify Complex Types (Entity Data Model Tools)」を参照してください。

2 この URI は、バイナリラージオブジェクト (BLOB) を返すプロパティがメディアリンクエントリであるエンティティ (この場合、Customers) に属するメディアリソースとして定義されている場合にサポートされます。詳細については、「ストリーミングプロバイダー (WCF Data Services)」を参照してください。

バージョン管理の要件

次のデータサービス構成の動作には、OData プロトコルのバージョン 2 またはそれ以降のバージョンが必要です。

カウント要求のサポート。
射影の $select クエリオプションのサポート。

詳細については、「WCF Data Services の複数のバージョンの使用」を参照してください。

次の方法で共有

データサービスの構成 (WCF Data Services)

データサービス構成設定

最小限のリソースアクセス要件

バージョン管理の要件

参照

概念

その他のリソース

その他のリソース

次の方法で共有

データ サービスの構成 (WCF Data Services)

データ サービス構成設定

最小限のリソース アクセス要件

バージョン管理の要件

参照

概念

その他のリソース

その他のリソース

データサービスの構成 (WCF Data Services)

データサービス構成設定

最小限のリソースアクセス要件