次の方法で共有


Export-ODataEndpointProxy

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

構文

Default (既定)

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
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

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

-AllowUnsecureConnection

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

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

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

パラメーター セット

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

-CmdletAdapter

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

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

型:String
規定値:None
指定可能な値:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

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

-Confirm

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

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

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False
Aliases:cf

パラメーター セット

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

-CreateRequestMethod

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

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

型:String
規定値:None
指定可能な値:Put, Post, Patch
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

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

-Credential

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

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

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

パラメーター セット

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

-CustomData

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

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

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

パラメーター セット

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

-Force

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

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

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

パラメーター セット

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

-Headers

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

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

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

パラメーター セット

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

-MetadataUri

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

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

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

パラメーター セット

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

-OutputModule

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

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

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

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

パラメーター セット

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

-ResourceNameMapping

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

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

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

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

パラメーター セット

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

-UpdateRequestMethod

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

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

型:String
規定値:None
指定可能な値:Put, Post, Patch
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

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

-Uri

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

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

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

パラメーター セット

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

-WhatIf

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

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

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False
Aliases:ウィスコンシン

パラメーター セット

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

CommonParameters

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