Export-ODataEndpointProxy
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 はリソース コレクション名、 Merchandise は名詞です。 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 |
関連リンク
PowerShell