Export-ODataEndpointProxy
產生模組,其中包含用來管理 OData 端點的 Cmdlet。
語法
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>]
Description
Cmdlet Export-ODataEndpointProxy
會使用 OData 端點的元數據來產生模組,其中包含可用來管理該 OData 端點的 Cmdlet。 模組是以CDXML為基礎。 此 Cmdlet 產生模組之後,它會將該模組儲存至 OutputModule 參數所指定的路徑和檔名。
Export-ODataEndpointProxy
會產生建立、讀取、更新和刪除 (CRUD) 作業、非 CRUD 動作和關聯操作的 Cmdlet。
Export-ODataEndpointProxy
為每個端點資源產生一個CDXML檔案。 您可以在產生模組之後編輯這些CDXML檔案。 例如,如果您想要變更 Cmdlet 的名詞或動詞名稱,以配合 Windows PowerShell Cmdlet 命名指導方針,您可以修改檔案。
所產生模組中的每個 Cmdlet 都必須包含 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 參數的值,此命令會提供哈希表,將資源集合名稱對應至 Cmdlet 集合所需的名詞。 在此範例中,Products 是資源集合名稱,而 [商品 ] 是名詞。 若要允許連線到非 SSL 網站,HTTP,而不是 HTTPS,請新增 AllowUnsecureConnection 參數。
參數
-AllowClobber
表示此 Cmdlet 會取代現有的模組。
類型: | SwitchParameter |
Position: | 10 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-AllowUnsecureConnection
指出此模組可以連線到未受 SSL 保護的 URI。 此模組除了 HTTPS 網站之外,還可以管理 HTTP 網站。
類型: | SwitchParameter |
Position: | 11 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-CmdletAdapter
指定 Cmdlet 配接器。 此參數可接受的值為:ODataAdapter 和 NetworkControllerAdapter。
類型: | String |
接受的值: | ODataAdapter, NetworkControllerAdapter, ODataV4Adapter |
Position: | 6 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Confirm
執行 Cmdlet 之前先提示您確認。
類型: | SwitchParameter |
別名: | cf |
Position: | Named |
預設值: | False |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-CreateRequestMethod
指定要求方法。 此參數可接受的值為:PUT、POST 和 PATCH。
類型: | String |
接受的值: | Put, Post, Patch |
Position: | 4 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Credential
指定可存取 OData 端點的用戶帳戶。 預設值為目前的使用者。 如果遠端電腦執行 Windows Vista 或更新版本的 Windows 作業系統,Cmdlet 會提示您輸入認證。
類型: | PSCredential |
Position: | 3 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-CustomData
指定自訂數據的哈希表。
類型: | Hashtable |
Position: | 9 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Force
指出此 Cmdlet 會覆寫現有資料夾中相同名稱 Modules
的現有產生的模組。
類型: | SwitchParameter |
Position: | 8 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Headers
指定 Web 要求的標頭。 輸入哈希表或字典。
類型: | Hashtable |
Position: | 12 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-MetadataUri
指定端點元數據的 URI。
類型: | String |
Position: | 2 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-OutputModule
指定此 Cmdlet 儲存所產生 Proxy 命令模組的路徑和模組名稱。
如果適用,此 Cmdlet 會將二進位模組、模組指令清單和格式化檔案複製到指定的資料夾。 如果您只指定模組的名稱, Export-ODataEndpointProxy
請將模組儲存在 $HOME\Documents\WindowsPowerShell\Modules
資料夾中。 如果您指定路徑,Cmdlet 會在該路徑中建立模組資料夾。
類型: | String |
Position: | 1 |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-ResourceNameMapping
指定哈希表,其中包含可讓您自定義所產生 Cmdlet 的對應。 在此哈希表中,資源集合名稱是索引鍵。 所需的 Cmdlet 名詞是 值。
例如,在哈希表中 @{Products = 'Merchandise'}
, Products 是做為索引鍵的資源集合名稱。 商品 是產生的 Cmdlet 名詞。 產生的 Cmdlet 名稱可能不符合 Windows PowerShell Cmdlet 命名指導方針。 您可以在此 Cmdlet 建立模組之後,修改資源 CDXML 檔案來變更 Cmdlet 名稱。 如需詳細資訊,請參閱 強烈建議開發指導方針。
類型: | Hashtable |
Position: | 7 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-UpdateRequestMethod
指定更新要求方法。 此參數可接受的值為:PUT、POST 和 PATCH。
類型: | String |
接受的值: | Put, Post, Patch |
Position: | 5 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Uri
指定端點的 URI。
類型: | String |
Position: | 0 |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。
類型: | SwitchParameter |
別名: | wi |
Position: | Named |
預設值: | False |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |