Export-ODataEndpointProxy

リファレンス

モジュール:: Microsoft.PowerShell.ODataUtils

OData エンドポイントを管理するコマンドレットを含むモジュールを生成します。

構文

Export-ODataEndpointProxy
      [-Uri] <String>
      [-OutputModule] <String>
      [[-MetadataUri] <String>]
      [[-Credential] <PSCredential>]
      [[-CreateRequestMethod] <String>]
      [[-UpdateRequestMethod] <String>]
      [[-CmdletAdapter] <String>]
      [[-ResourceNameMapping] <Hashtable>]
      [-Force]
      [[-CustomData] <Hashtable>]
      [-AllowClobber]
      [-AllowUnsecureConnection]
      [[-Headers] <Hashtable>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Export-ODataEndpointProxy コマンドレットは、OData エンドポイントのメタデータを使用して、その OData エンドポイントの管理に使用できるコマンドレットを含むモジュールを生成します。モジュールは CDXML に基づいています。このコマンドレットは、モジュールを生成した後、OutputModule パラメーターで指定されたパスとファイル名にそのモジュールを保存します。

Export-ODataEndpointProxy では、作成、読み取り、更新、削除 (CRUD) 操作、非 CRUD アクション、および関連付け操作用のコマンドレットが生成されます。

Export-ODataEndpointProxy は、エンドポイントリソースごとに 1 つの CDXML ファイルを生成します。これらの CDXML ファイルは、モジュールの生成後に編集できます。たとえば、Windows PowerShell コマンドレットの名前付けガイドラインに合わせてコマンドレットの名詞名または動詞名を変更する場合は、ファイルを変更できます。

モジュールが管理するエンドポイントに接続するには、生成されたモジュール内のすべてのコマンドレットに ConnectionURI パラメーターを含める必要があります。

例

例 1: リテール Web サービスエンドポイントを管理するモジュールを生成する

PS C:\> Export-ODataEndpointProxy -Uri 'http://services.odata.org/v3/(S(snyobsk1hhutkb2yulwldgf1))/odata/odata.svc' -MetadataUri 'http://services.odata.org/v3/(S(snyobsk1hhutkb2yulwldgf1))/odata/odata.svc/$metadata' -AllowUnsecureConnection -OutputModule 'C:\Users\user\GeneratedScript.psm1' -ResourceNameMapping @{Products = 'Merchandise'}

このコマンドは、リテールサービスエンドポイントを管理するモジュールを生成します。このコマンドは、エンドポイントの URI とエンドポイントメタデータの URI を指定します。また、OutputModule パラメーターの値として、出力パスとスクリプトモジュール名も指定します。 ResourceNameMapping パラメーターの値に対して、コマンドは、リソースコレクション名をコマンドレットセットの目的の名詞にマップするハッシュテーブルを提供します。この例では、Products はリソースコレクション名、商品は名詞です。 HTTPS ではなく非 SSL サイト (HTTP) への接続を許可するには、allowUnsecureConnection パラメーター 追加します。

パラメーター

-AllowClobber

このコマンドレットが既存のモジュールを置き換えることを示します。

型:	SwitchParameter
配置:	10
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-AllowUnsecureConnection

このモジュールが SSL で保護されていない URI に接続できることを示します。このモジュールでは、HTTPS サイトに加えて HTTP サイトを管理できます。

型:	SwitchParameter
配置:	11
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-CmdletAdapter

コマンドレットアダプターを指定します。このパラメーターに使用できる値は、ODataAdapter と NetworkControllerAdapter です。

型:	String
指定可能な値:	ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
配置:	6
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CreateRequestMethod

要求メソッドを指定します。このパラメーターに使用できる値は、PUT、POST、PATCH です。

型:	String
指定可能な値:	Put, Post, Patch
配置:	4
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Credential

OData エンドポイントにアクセスできるユーザーアカウントを指定します。既定値は現在のユーザーです。リモートコンピューターで Windows Vista 以降のリリースの Windows オペレーティングシステムが実行されている場合、コマンドレットによって資格情報の入力が求められます。

型:	PSCredential
配置:	3
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-CustomData

カスタムデータのハッシュテーブルを指定します。

型:	Hashtable
配置:	9
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Force

このコマンドレットは、既存の Modules フォルダー内の同じ名前の既存の生成されたモジュールを上書きすることを示します。

型:	SwitchParameter
配置:	8
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Headers

Web 要求のヘッダーを指定します。ハッシュテーブルまたはディクショナリを入力します。

型:	Hashtable
配置:	12
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-MetadataUri

エンドポイントのメタデータの URI を指定します。

型:	String
配置:	2
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-OutputModule

このコマンドレットがプロキシコマンドの生成されたモジュールを保存するパスとモジュール名を指定します。

このコマンドレットは、バイナリモジュール、モジュールマニフェスト、および書式設定ファイル (該当する場合) を指定したフォルダーにコピーします。モジュールの名前のみを指定した場合は、Export-ODataEndpointProxy モジュールを $HOME\Documents\WindowsPowerShell\Modules フォルダーに保存します。パスを指定すると、コマンドレットはそのパスにモジュールフォルダーを作成します。

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceNameMapping

生成されたコマンドレットをカスタマイズできるマッピングを含むハッシュテーブルを指定します。このハッシュテーブルでは、リソースコレクション名がキーです。目的のコマンドレット名詞は値です。

たとえば、ハッシュテーブル @{Products = 'Merchandise'}では、Products はキーとして機能するリソースコレクション名です。商品は、結果として得られるコマンドレット名詞です。生成されたコマンドレット名は、Windows PowerShell コマンドレットの名前付けガイドラインに合わない可能性があります。リソース CDXML ファイルを変更して、このコマンドレットがモジュールを作成した後でコマンドレット名を変更できます。詳細については、「強く推奨される開発ガイドライン」を参照してください。

型:	Hashtable
配置:	7
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-UpdateRequestMethod

更新要求メソッドを指定します。このパラメーターに使用できる値は、PUT、POST、PATCH です。

型:	String
指定可能な値:	Put, Post, Patch
配置:	5
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Uri

エンドポイントの URI を指定します。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

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

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False