Export-ODataEndpointProxy
Vygeneruje modul, který obsahuje rutiny pro správu koncového bodu OData.
Syntaxe
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
Rutina Export-ODataEndpointProxy
používá metadata koncového bodu OData k vygenerování modulu, který obsahuje rutiny, které můžete použít ke správě tohoto koncového bodu OData. Modul je založený na CDXML. Jakmile tato rutina vygeneruje modul, uloží tento modul do cesty a názvu souboru určeného parametrem OutputModule .
Export-ODataEndpointProxy
generuje rutiny pro operace vytvoření, čtení, aktualizace a odstranění (CRUD), akce bez cruD a manipulaci s přidružením.
Export-ODataEndpointProxy
vygeneruje jeden soubor CDXML na prostředek koncového bodu. Tyto soubory CDXML můžete upravit po vygenerování modulu. Pokud například chcete změnit podstatná jména nebo názvy sloves rutin tak, aby odpovídaly pokynům pro pojmenování rutin prostředí Windows PowerShell, můžete soubor upravit.
Každá rutina v vygenerovaném modulu musí obsahovat parametr ConnectionURI , aby se mohl připojit ke koncovému bodu, který modul spravuje.
Příklady
Příklad 1: Vygenerování modulu pro správu koncového bodu maloobchodní webové služby
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'}
Tento příkaz vygeneruje modul pro správu koncového bodu maloobchodní služby. Příkaz určuje identifikátor URI koncového bodu a identifikátor URI metadat koncového bodu. Příkaz také poskytuje výstupní cestu a název modulu skriptu jako hodnotu parametru OutputModule . Pro hodnotu parametru ResourceNameMapping poskytuje příkaz hashtable, který mapuje název kolekce prostředků na požadované podstatné jméno pro sadu rutin. V tomto příkladu je název kolekce prostředků a merchem je podstatné jméno. Pokud chcete povolit připojení k jiným webům než SSL, na rozdíl od PROTOKOLU HTTPS, přidejte parametr AllowUnsecureConnection .
Parametry
-AllowClobber
Označuje, že tato rutina nahrazuje existující modul.
Typ: | SwitchParameter |
Position: | 10 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-AllowUnsecureConnection
Označuje, že se tento modul může připojit k identifikátorům URI, které nejsou zabezpečené protokolem SSL. Modul může spravovat weby HTTP kromě webů HTTPS.
Typ: | SwitchParameter |
Position: | 11 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-CmdletAdapter
Určuje adaptér rutiny. Přijatelné hodnoty pro tento parametr jsou: ODataAdapter a NetworkControllerAdapter.
Typ: | String |
Přípustné hodnoty: | ODataAdapter, NetworkControllerAdapter, ODataV4Adapter |
Position: | 6 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Confirm
Před spuštěním rutiny zobrazí výzvu k potvrzení.
Typ: | SwitchParameter |
Aliasy: | cf |
Position: | Named |
Default value: | False |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-CreateRequestMethod
Určuje metodu požadavku. Přijatelné hodnoty pro tento parametr jsou: PUT, POST a PATCH.
Typ: | String |
Přípustné hodnoty: | Put, Post, Patch |
Position: | 4 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Credential
Určuje uživatelský účet, který má přístup ke koncovému bodu OData. Výchozí hodnota je aktuální uživatel. Pokud vzdálený počítač používá systém Windows Vista nebo novější verzi operačního systému Windows, rutina vás vyzve k zadání přihlašovacích údajů.
Typ: | PSCredential |
Position: | 3 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-CustomData
Určuje hashovací tabulku vlastních dat.
Typ: | Hashtable |
Position: | 9 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Force
Označuje, že tato rutina přepíše existující vygenerovaný modul se stejným názvem v existující Modules
složce.
Typ: | SwitchParameter |
Position: | 8 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Headers
Určuje hlavičky webového požadavku. Zadejte tabulku hash nebo slovník.
Typ: | Hashtable |
Position: | 12 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-MetadataUri
Určuje identifikátor URI metadat koncového bodu.
Typ: | String |
Position: | 2 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-OutputModule
Určuje cestu a název modulu, do kterého tato rutina uloží vygenerovaný modul příkazů proxy serveru.
Tato rutina zkopíruje binární modul, manifest modulu a formátovací soubor (pokud je k dispozici) do zadané složky. Pokud zadáte pouze název modulu, Export-ODataEndpointProxy
uloží modul do $HOME\Documents\WindowsPowerShell\Modules
složky. Pokud zadáte cestu, rutina v této cestě vytvoří složku modulu.
Typ: | String |
Position: | 1 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ResourceNameMapping
Určuje hashovací tabulku, která obsahuje mapování, která umožňují přizpůsobit vygenerované rutiny. V této hashtable je klíčem název kolekce prostředků. Požadovaná podstatná jméno rutiny je hodnota.
Například v tabulce @{Products = 'Merchandise'}
hash je products název kolekce prostředků, který slouží jako klíč. Merchem je výsledné jméno rutiny. Vygenerované názvy rutin nemusí odpovídat pokynům pro pojmenování rutin prostředí Windows PowerShell. Soubor CDXML prostředku můžete upravit tak, aby po vytvoření modulu změnil názvy rutin. Další informace najdete v tématu Pokyny pro vývoj se silnými doporučeními.
Typ: | Hashtable |
Position: | 7 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-UpdateRequestMethod
Určuje metodu žádosti o aktualizaci. Přijatelné hodnoty pro tento parametr jsou: PUT, POST a PATCH.
Typ: | String |
Přípustné hodnoty: | Put, Post, Patch |
Position: | 5 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Uri
Určuje identifikátor URI koncového bodu.
Typ: | String |
Position: | 0 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-WhatIf
Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.
Typ: | SwitchParameter |
Aliasy: | wi |
Position: | Named |
Default value: | False |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |