Freigeben über

Export-ODataEndpointProxy

Modul:
Microsoft.PowerShell.ODataUtils Module

Generiert ein Modul, das Cmdlets zum Verwalten eines OData-Endpunkts enthält.

Syntax

Default (Standard) 

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

Beschreibung

Das cmdlet Export-ODataEndpointProxy verwendet die Metadaten eines OData-Endpunkts, um ein Modul zu generieren, das Cmdlets enthält, mit denen Sie diesen OData-Endpunkt verwalten können. Das Modul basiert auf CDXML. Nachdem dieses Cmdlet das Modul generiert hat, wird dieses Modul im Pfad und Dateinamen gespeichert, der durch den parameter OutputModule angegeben wird.

Export-ODataEndpointProxy generiert Cmdlets zum Erstellen, Lesen, Aktualisieren und Löschen (CRUD), Nicht-CRUD-Aktionen und Zuordnungsmanipulation.

Export-ODataEndpointProxy generiert eine CDXML-Datei pro Endpunktressource. Sie können diese CDXML-Dateien bearbeiten, nachdem das Modul generiert wurde. Wenn Sie z. B. die Nomen- oder Verbnamen der Cmdlets ändern möchten, um die Benennungsrichtlinien für Windows PowerShell-Cmdlets anzupassen, können Sie die Datei ändern.

Jedes Cmdlet in einem generierten Modul muss einen ConnectionURI Parameter enthalten, um eine Verbindung mit dem Endpunkt herzustellen, den das Modul verwaltet.

Beispiele

Beispiel 1: Generieren eines Moduls zum Verwalten eines Webdienstendpunkts für den Einzelhandel

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

Dieser Befehl generiert ein Modul zum Verwalten eines Einzelhandelsdienstendpunkts. Der Befehl gibt den URI des Endpunkts und den URI der Endpunktmetadaten an. Der Befehl stellt außerdem einen Ausgabepfad- und Skriptmodulnamen als Wert des OutputModule- Parameters bereit. Für den Wert des ResourceNameMapping-Parameters stellt der Befehl eine Hashtabelle bereit, die den Namen der Ressourcenauflistung dem gewünschten Substantiv für den Cmdlet-Satz zuordnet. In diesem Beispiel ist Products der Name der Ressourcenauflistung, und Merchandise ist das Substantiv. Um Verbindungen mit nicht-SSL-Websites zuzulassen, fügen Sie im Gegensatz zu HTTPS den AllowUnsecureConnection Parameter hinzu.

Parameter

-AllowClobber

Gibt an, dass dieses Cmdlet ein vorhandenes Modul ersetzt.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:10
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-AllowUnsecureConnection

Gibt an, dass dieses Modul eine Verbindung mit URIs herstellen kann, die nicht SSL-gesichert sind. Das Modul kann ZUSÄTZLICH zu HTTPS-Websites HTTP-Websites verwalten.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:11
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-CmdletAdapter

Gibt den Cmdlet-Adapter an. Die zulässigen Werte für diesen Parameter sind: ODataAdapter und NetworkControllerAdapter.

Parametereigenschaften

Typ:String
Standardwert:None
Zulässige Werte:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:6
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:vgl

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-CreateRequestMethod

Gibt die Anforderungsmethode an. Die zulässigen Werte für diesen Parameter sind: PUT, POST und PATCH.

Parametereigenschaften

Typ:String
Standardwert:None
Zulässige Werte:Put, Post, Patch
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:4
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Credential

Gibt ein Benutzerkonto an, das Zugriff auf den OData-Endpunkt hat. Der Standardwert ist der aktuelle Benutzer. Wenn ein Remotecomputer Windows Vista oder eine spätere Version des Windows-Betriebssystems ausführt, werden Sie vom Cmdlet zur Eingabe von Anmeldeinformationen aufgefordert.

Parametereigenschaften

Typ:PSCredential
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:3
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-CustomData

Gibt eine Hashtabelle mit benutzerdefinierten Daten an.

Parametereigenschaften

Typ:Hashtable
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:9
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Force

Gibt an, dass dieses Cmdlet ein vorhandenes generiertes Modul mit demselben Namen in einem vorhandenen Modules Ordner überschreibt.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:8
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Headers

Gibt die Kopfzeilen der Webanforderung an. Geben Sie eine Hashtabelle oder ein Wörterbuch ein.

Parametereigenschaften

Typ:Hashtable
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:12
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-MetadataUri

Gibt den URI der Metadaten des Endpunkts an.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:2
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-OutputModule

Gibt den Pfad- und Modulnamen an, in dem dieses Cmdlet das generierte Modul von Proxybefehlen speichert.

Dieses Cmdlet kopiert ggf. eine Binärmodul-, Modulmanifest- und Formatierungsdatei in den angegebenen Ordner. Wenn Sie nur den Namen des Moduls angeben, speichert Export-ODataEndpointProxy das Modul im Ordner $HOME\Documents\WindowsPowerShell\Modules. Wenn Sie einen Pfad angeben, erstellt das Cmdlet den Modulordner in diesem Pfad.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:1
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-ResourceNameMapping

Gibt eine Hashtabelle an, die Zuordnungen enthält, mit denen Sie die generierten Cmdlets anpassen können. In dieser Hashtabelle ist der Ressourcensammlungsname der Schlüssel. Das gewünschte Cmdlet-Substantiv ist der Wert.

In der Hashtabelle @{Products = 'Merchandise'}ist Products beispielsweise der Ressourcenauflistungsname, der als Schlüssel dient. Merchandise ist das resultierende Cmdlet-Substantiv. Die generierten Cmdlet-Namen richten sich möglicherweise nicht an die Benennungsrichtlinien für Windows PowerShell-Cmdlets. Sie können die CDXML-Ressourcendatei ändern, um die Cmdletnamen zu ändern, nachdem dieses Cmdlet das Modul erstellt hat. Weitere Informationen finden Sie unter stark geförderten Entwicklungsrichtlinien.

Parametereigenschaften

Typ:Hashtable
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:7
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-UpdateRequestMethod

Gibt die Updateanforderungsmethode an. Die zulässigen Werte für diesen Parameter sind: PUT, POST und PATCH.

Parametereigenschaften

Typ:String
Standardwert:None
Zulässige Werte:Put, Post, Patch
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:5
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Uri

Gibt den URI des Endpunkts an.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:0
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.