Export-ODataEndpointProxy

  • Referens
Modul:
Microsoft.PowerShell.ODataUtils

Genererar en modul som innehåller cmdletar för att hantera en OData-slutpunkt.

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

Cmdleten Export-ODataEndpointProxy använder metadata för en OData-slutpunkt för att generera en modul som innehåller cmdletar som du kan använda för att hantera OData-slutpunkten. Modulen baseras på CDXML. När den här cmdleten genererar modulen sparar den modulen till sökvägen och filnamnet som anges av parametern OutputModule .

Export-ODataEndpointProxy genererar cmdletar för att skapa, läsa, uppdatera och ta bort åtgärder (CRUD), icke-CRUD-åtgärder och associationsmanipulation.

Export-ODataEndpointProxy genererar en CDXML-fil per slutpunktsresurs. Du kan redigera dessa CDXML-filer när modulen har genererats. Om du till exempel vill ändra substantiv- eller verbnamnen för cmdletarna så att de överensstämmer med namngivningsriktlinjerna för Windows PowerShell-cmdletar kan du ändra filen.

Varje cmdlet i en genererad modul måste innehålla en ConnectionURI-parameter för att kunna ansluta till slutpunkten som modulen hanterar.

Exempel

Exempel 1: Generera en modul för att hantera en slutpunkt för en butikswebbtjänst

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

Det här kommandot genererar en modul för att hantera en slutpunkt för detaljhandelstjänsten. Kommandot anger URI:n för slutpunkten och URI:n för slutpunktsmetadata. Kommandot innehåller också en utdatasökväg och skriptmodulnamn som värdet för parametern OutputModule . För värdet för parametern ResourceNameMapping tillhandahåller kommandot en hashtable som mappar resurssamlingens namn till önskat substantiv för cmdlet-uppsättningen. I det här exemplet är Products resurssamlingens namn och Merchandise är substantiv. Om du vill tillåta anslutningar till icke-SSL-webbplatser lägger DU till parametern AllowUnsecureConnection i stället för HTTPS.

Parametrar

-AllowClobber

Anger att den här cmdleten ersätter en befintlig modul.

Typ:SwitchParameter
Position:10
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-AllowUnsecureConnection

Anger att den här modulen kan ansluta till URI:er som inte är SSL-skyddade. Modulen kan hantera HTTP-webbplatser utöver HTTPS-webbplatser.

Typ:SwitchParameter
Position:11
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-CmdletAdapter

Anger cmdlet-adaptern. De acceptabla värdena för den här parametern är: ODataAdapter och NetworkControllerAdapter.

Typ:String
Godkända värden:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Position:6
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-CreateRequestMethod

Anger begärandemetoden. De acceptabla värdena för den här parametern är: PUT, POST och PATCH.

Typ:String
Godkända värden:Put, Post, Patch
Position:4
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Credential

Anger ett användarkonto som har åtkomst till OData-slutpunkten. Standardvärdet är den aktuella användaren. Om en fjärrdator kör Windows Vista eller en senare version av Windows-operativsystemet uppmanas du att ange autentiseringsuppgifter i cmdleten.

Typ:PSCredential
Position:3
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-CustomData

Anger en hash-tabell med anpassade data.

Typ:Hashtable
Position:9
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Force

Anger att den här cmdleten skriver över en befintlig genererad modul med samma namn i en befintlig Modules mapp.

Typ:SwitchParameter
Position:8
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Headers

Anger sidhuvudena för webbbegäran. Ange en hash-tabell eller ordlista.

Typ:Hashtable
Position:12
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-MetadataUri

Anger URI för slutpunktens metadata.

Typ:String
Position:2
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-OutputModule

Anger sökvägen och modulnamnet som den här cmdleten sparar den genererade modulen med proxykommandon till.

Den här cmdleten kopierar en binär modul, modulmanifest och formateringsfil, om tillämpligt, till den angivna mappen. Om du bara anger namnet på modulen Export-ODataEndpointProxy sparar du modulen $HOME\Documents\WindowsPowerShell\Modules i mappen . Om du anger en sökväg skapar cmdleten modulmappen i den sökvägen.

Typ:String
Position:1
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ResourceNameMapping

Anger en hashtable som innehåller mappningar som gör att du kan anpassa de genererade cmdletarna. I den här hashtabellen är resurssamlingens namn nyckeln. Det önskade cmdlet-substantivet är värdet.

I hash-tabellen @{Products = 'Merchandise'}är till exempel Produkter resurssamlingens namn som fungerar som nyckel. Merchandise är det resulterande cmdlet-substantivet. De genererade cmdlet-namnen kanske inte överensstämmer med namngivningsriktlinjerna för Windows PowerShell-cmdletar. Du kan ändra resursens CDXML-fil för att ändra cmdlet-namnen när den här cmdleten har skapat modulen. Mer information finns i Starkt uppmuntrade riktlinjer för utveckling.

Typ:Hashtable
Position:7
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-UpdateRequestMethod

Anger metoden för uppdateringsbegäran. De acceptabla värdena för den här parametern är: PUT, POST och PATCH.

Typ:String
Godkända värden:Put, Post, Patch
Position:5
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Uri

Anger slutpunktens URI.

Typ:String
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False