Delen via

Export-ODataEndpointProxy

  • Referentie
Module:
Microsoft.PowerShell.ODataUtils

Hiermee wordt een module gegenereerd die cmdlets bevat voor het beheren van een OData-eindpunt.

Syntax

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

De Export-ODataEndpointProxy cmdlet gebruikt de metagegevens van een OData-eindpunt om een module te genereren die cmdlets bevat die u kunt gebruiken om dat OData-eindpunt te beheren. De module is gebaseerd op CDXML. Nadat deze cmdlet de module heeft gegenereerd, wordt die module opgeslagen in het pad en de bestandsnaam die is opgegeven door de parameter OutputModule .

Export-ODataEndpointProxy genereert cmdlets voor cruD-bewerkingen (create, read, update en delete), niet-CRUD-acties en koppelingsbewerkingen.

Export-ODataEndpointProxy genereert één CDXML-bestand per eindpuntresource. U kunt deze CDXML-bestanden bewerken nadat de module is gegenereerd. Als u bijvoorbeeld de naamwoordnamen of werkwoordnamen van de cmdlets wilt wijzigen zodat deze overeenkomen met de naamgevingsrichtlijnen voor Windows PowerShell-cmdlets, kunt u het bestand wijzigen.

Elke cmdlet in een gegenereerde module moet een Verbinding maken ionURI-parameter bevatten om verbinding te maken met het eindpunt dat door de module wordt beheerd.

Voorbeelden

Voorbeeld 1: Een module genereren voor het beheren van een eindpunt voor een retailwebservice

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

Met deze opdracht wordt een module gegenereerd voor het beheren van een service-eindpunt voor de detailhandel. Met de opdracht geeft u de URI van het eindpunt en de URI van de metagegevens van het eindpunt op. De opdracht biedt ook een uitvoerpad en scriptmodulenaam als de waarde van de parameter OutputModule . Voor de waarde van de parameter ResourceNameMapping biedt de opdracht een hashtabel waarmee de naam van de resourceverzameling wordt toegewezen aan het gewenste zelfstandig naamwoord voor de cmdlet-set. In dit voorbeeld is Producten de naam van de resourceverzameling en Merchandise is het zelfstandig naamwoord. Als u verbindingen met niet-SSL-sites wilt toestaan, voegt HTTP in plaats van HTTPS de parameter AllowUnsecure Verbinding maken ion toe.

Parameters

-AllowClobber

Geeft aan dat deze cmdlet een bestaande module vervangt.

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

-AllowUnsecureConnection

Geeft aan dat deze module verbinding kan maken met URI's die niet met SSL zijn beveiligd. De module kan HTTP-sites naast HTTPS-sites beheren.

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

-CmdletAdapter

Hiermee geeft u de cmdlet-adapter. De acceptabele waarden voor deze parameter zijn: ODataAdapter en NetworkControllerAdapter.

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

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-CreateRequestMethod

Hiermee geeft u de aanvraagmethode. De acceptabele waarden voor deze parameter zijn: PUT, POST en PATCH.

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

-Credential

Hiermee geeft u een gebruikersaccount op dat toegang heeft tot het OData-eindpunt. De standaardwaarde is de huidige gebruiker. Als op een externe computer Windows Vista of een latere versie van het Windows-besturingssysteem wordt uitgevoerd, wordt u door de cmdlet om referenties gevraagd.

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

-CustomData

Hiermee geeft u een hash-tabel van aangepaste gegevens.

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

-Force

Hiermee wordt aangegeven dat met deze cmdlet een bestaande gegenereerde module met dezelfde naam in een bestaande Modules map wordt overschreven.

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

-Headers

Hiermee geeft u de headers van de webaanvraag. Voer een hash-tabel of -woordenlijst in.

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

-MetadataUri

Hiermee geeft u de URI van de metagegevens van het eindpunt.

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

-OutputModule

Hiermee geeft u het pad en de modulenaam op waarnaar deze cmdlet de gegenereerde module van proxyopdrachten opslaat.

Met deze cmdlet kopieert u een binaire module, modulemanifest en opmaakbestand, indien van toepassing, naar de opgegeven map. Als u alleen de naam van de module opgeeft, Export-ODataEndpointProxy slaat u de module op in de $HOME\Documents\WindowsPowerShell\Modules map. Als u een pad opgeeft, maakt de cmdlet de modulemap in dat pad.

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

-ResourceNameMapping

Hiermee geeft u een hashtabel op die toewijzingen bevat waarmee u de gegenereerde cmdlets kunt aanpassen. In deze hashtabel is de naam van de resourceverzameling de sleutel. Het gewenste cmdlet-naamwoord is de waarde.

In de hashtabel @{Products = 'Merchandise'}is Producten bijvoorbeeld de naam van de resourceverzameling die als sleutel fungeert. Merchandise is het resulterende zelfstandig naamwoord. De gegenereerde cmdlet-namen zijn mogelijk niet afgestemd op de naamgevingsrichtlijnen voor Windows PowerShell-cmdlets. U kunt het CDXML-resourcebestand wijzigen om de cmdlet-namen te wijzigen nadat deze cmdlet de module heeft gemaakt. Zie Sterk aangemoedigde ontwikkelingsrichtlijnen voor meer informatie.

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

-UpdateRequestMethod

Hiermee geeft u de updateaanvraagmethode. De acceptabele waarden voor deze parameter zijn: PUT, POST en PATCH.

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

-Uri

Hiermee geeft u de URI van het eindpunt.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

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