Export-ODataEndpointProxy

Moduł:

Microsoft.PowerShell.ODataUtils Module

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

Składnia

Default (domyślnie)

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 cmdlet Export-ODataEndpointProxy 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ślonej przez parametr OutputModule.

Export-ODataEndpointProxy generuje polecenia cmdlet do operacji tworzenia, odczytu, aktualizacji 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ótu, 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 Merchandise 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ł.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	10
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	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.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	11
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-CmdletAdapter

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

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Dopuszczalne wartości:	ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	6
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	por

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-CreateRequestMethod

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

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Dopuszczalne wartości:	Put, Post, Patch
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	4
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	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ń.

Właściwości parametru

Typ:	PSCredential
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	3
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-CustomData

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

Właściwości parametru

Typ:	Hashtable
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	9
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Force

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

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	8
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Headers

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

Właściwości parametru

Typ:	Hashtable
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	12
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-MetadataUri

Określa identyfikator URI metadanych punktu końcowego.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	2
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	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.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	1
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	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 skrótów @{Products = 'Merchandise'}Products jest nazwą kolekcji zasobów, która służy jako klucz. Towar jest wynikowym apletem 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 dotyczące programowania.

Właściwości parametru

Typ:	Hashtable
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	7
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-UpdateRequestMethod

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

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Dopuszczalne wartości:	Put, Post, Patch
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	5
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Uri

Określa identyfikator URI punktu końcowego.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	0
Obowiązkowe:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Wi

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Linki powiązane

• Biblioteka OData
• Co to jest protokół OData?
• Invoke-RestMethod (wywołaj metodę REST)