Export-ODataEndpointProxy

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 dla operacji tworzenia, odczytu, aktualizacji i usuwania (CRUD), akcji innych niż CRUD i manipulowania skojarzeniami.

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ć rzeczownik lub nazwy czasowników poleceń cmdlet, aby były zgodne z wytycznymi dotyczącymi nazewnictwa poleceń cmdlet 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 usługi sieci Web w handlu detalicznym

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 detalicznej. 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ótową, która mapuje nazwę kolekcji zasobów na żądaną rzeczownik dla zestawu poleceń cmdlet. W tym przykładzie Products jest nazwą kolekcji zasobów, a Towar jest wartością rzędu. Aby zezwolić na połączenia z lokacjami spoza protokołu 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ł.

Type:SwitchParameter
Position:10
Default value:None
Accept pipeline input:True
Accept wildcard characters: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.

Type:SwitchParameter
Position:11
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-CmdletAdapter

Określa kartę cmdlet. Dopuszczalne wartości tego parametru to: ODataAdapter i NetworkControllerAdapter.

Type:String
Accepted values:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Position:6
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-CreateRequestMethod

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

Type:String
Accepted values:Put, Post, Patch
Position:4
Default value:None
Accept pipeline input:True
Accept wildcard characters: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ń.

Type:PSCredential
Position:3
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-CustomData

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

Type:Hashtable
Position:9
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Force

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

Type:SwitchParameter
Position:8
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Headers

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

Type:Hashtable
Position:12
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-MetadataUri

Określa identyfikator URI metadanych punktu końcowego.

Type:String
Position:2
Default value:None
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters: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 wartość polecenia cmdlet to wartość .

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 wynikową wartością polecenia cmdlet. Wygenerowane nazwy poleceń cmdlet mogą nie być zgodne z wytycznymi dotyczącymi nazewnictwa poleceń cmdlet 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 dotyczące programowania.

Type:Hashtable
Position:7
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-UpdateRequestMethod

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

Type:String
Accepted values:Put, Post, Patch
Position:5
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Uri

Określa identyfikator URI punktu końcowego.

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False