Udostępnij za pośrednictwem

Export-ODataEndpointProxy

  • Odwołanie
Moduł:
Microsoft.PowerShell.ODataUtils

Generuje moduł zawierający polecenia cmdlet do zarządzania punktem końcowym OData.

Składnia

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>]

Opis

Polecenie Export-ODataEndpointProxy cmdlet używa metadanych punktu końcowego OData do wygenerowania modułu zawierającego polecenia cmdlet, których można użyć do zarządzania tym punktem końcowym OData. Moduł jest oparty na formacie CDXML. Po wygenerowaniu tego polecenia cmdlet moduł zapisuje ten moduł w ścieżce i nazwie pliku określonego przez parametr OutputModule .

Export-ODataEndpointProxy Generuje polecenia cmdlet do operacji tworzenia, odczytu, aktualizowania i usuwania (CRUD), akcji innych niż CRUD i manipulowania skojarzeniem.

Export-ODataEndpointProxy generuje jeden plik CDXML na zasób punktu końcowego. Te pliki CDXML można edytować po wygenerowaniu modułu. Jeśli na przykład chcesz zmienić nazwy rzeczowników lub czasowników poleceń cmdlet w celu dostosowania ich do wytycznych dotyczących nazewnictwa poleceń cmdlet programu Windows PowerShell, możesz zmodyfikować plik.

Każde polecenie cmdlet w wygenerowanym module musi zawierać parametr ConnectionURI w celu nawiązania połączenia z punktem końcowym zarządzanym przez moduł.

Przykłady

Przykład 1. Generowanie modułu do zarządzania punktem końcowym detalicznej usługi internetowej

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'}

To polecenie generuje moduł do zarządzania punktem końcowym usługi handlu detalicznego. Polecenie określa identyfikator URI punktu końcowego i identyfikator URI metadanych punktu końcowego. Polecenie udostępnia również ścieżkę wyjściową i nazwę modułu skryptu jako wartość parametru OutputModule . Dla wartości parametru ResourceNameMapping polecenie udostępnia tabelę skrótów, która mapuje nazwę kolekcji zasobów na żądany rzeczownik dla zestawu poleceń cmdlet. W tym przykładzie Products jest nazwą kolekcji zasobów, a Towar jest ciołem. Aby zezwolić na połączenia z lokacjami innych niż SSL, protokół HTTP, w przeciwieństwie do protokołu HTTPS, dodaj parametr AllowUnsecureConnection .

Parametry

-AllowClobber

Wskazuje, że to polecenie cmdlet zastępuje istniejący moduł.

Typ:SwitchParameter
Position:10
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AllowUnsecureConnection

Wskazuje, że ten moduł może łączyć się z identyfikatorami URI, które nie są zabezpieczone za pomocą protokołu SSL. Moduł może zarządzać lokacjami HTTP oprócz witryn HTTPS.

Typ:SwitchParameter
Position:11
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-CmdletAdapter

Określa adapter poleceń cmdlet. Dopuszczalne wartości tego parametru to: ODataAdapter i NetworkControllerAdapter.

Typ:String
Dopuszczalne wartości:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Position:6
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-CreateRequestMethod

Określa metodę żądania. Dopuszczalne wartości tego parametru to PUT, POST i PATCH.

Typ:String
Dopuszczalne wartości:Put, Post, Patch
Position:4
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Credential

Określa konto użytkownika, które ma dostęp do punktu końcowego OData. Wartość domyślna to bieżący użytkownik. Jeśli na komputerze zdalnym jest uruchomiony system Windows Vista lub nowsza wersja systemu operacyjnego Windows, polecenie cmdlet wyświetli monit o podanie poświadczeń.

Typ:PSCredential
Position:3
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-CustomData

Określa tabelę skrótów danych niestandardowych.

Typ:Hashtable
Position:9
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Force

Wskazuje, że to polecenie cmdlet zastępuje istniejący wygenerowany moduł o tej samej nazwie w istniejącym Modules folderze.

Typ:SwitchParameter
Position:8
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Headers

Określa nagłówki żądania internetowego. Wprowadź tabelę skrótu lub słownik.

Typ:Hashtable
Position:12
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-MetadataUri

Określa identyfikator URI metadanych punktu końcowego.

Typ:String
Position:2
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-OutputModule

Określa ścieżkę i nazwę modułu, do którego to polecenie cmdlet zapisuje wygenerowany moduł poleceń serwera proxy.

To polecenie cmdlet kopiuje moduł binarny, manifest modułu i plik formatowania, jeśli ma to zastosowanie, do określonego folderu. Jeśli określisz tylko nazwę modułu, Export-ODataEndpointProxy zapisze moduł w folderze $HOME\Documents\WindowsPowerShell\Modules . Jeśli określisz ścieżkę, polecenie cmdlet utworzy folder modułu w tej ścieżce.

Typ:String
Position:1
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ResourceNameMapping

Określa tabelę skrótu zawierającą mapowania, które umożliwiają dostosowanie wygenerowanych poleceń cmdlet. W tej tabeli skrótu nazwa kolekcji zasobów jest kluczem. Żądana nazwa polecenia cmdlet jest wartością.

Na przykład w tabeli @{Products = 'Merchandise'}skrótów produkty to nazwa kolekcji zasobów, która służy jako klucz. Towar jest wynikowym nounem polecenia cmdlet. Wygenerowane nazwy poleceń cmdlet mogą nie być zgodne z wytycznymi dotyczącymi nazewnictwa poleceń cmdlet programu Windows PowerShell. Możesz zmodyfikować plik CDXML zasobu, aby zmienić nazwy poleceń cmdlet po utworzeniu modułu przez to polecenie cmdlet. Aby uzyskać więcej informacji, zobacz Zdecydowanie zachęcane wytyczne programistyczne.

Typ:Hashtable
Position:7
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-UpdateRequestMethod

Określa metodę żądania aktualizacji. Dopuszczalne wartości tego parametru to PUT, POST i PATCH.

Typ:String
Dopuszczalne wartości:Put, Post, Patch
Position:5
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Uri

Określa identyfikator URI punktu końcowego.

Typ:String
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False