Dela via

Export-ODataEndpointProxy

Modul:
Microsoft.PowerShell.ODataUtils Module

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

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

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 (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.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:10
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument: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.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:11
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-CmdletAdapter

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

Parameteregenskaper

Typ:String
Standardvärde:None
Godkända värden:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:6
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Confirm

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-CreateRequestMethod

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

Parameteregenskaper

Typ:String
Standardvärde:None
Godkända värden:Put, Post, Patch
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:4
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument: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.

Parameteregenskaper

Typ:PSCredential
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:3
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-CustomData

Anger en hash-tabell med anpassade data.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:9
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Force

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:8
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Headers

Anger sidhuvudena för webbbegäran. Ange en hashtabell eller ordlista.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:12
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-MetadataUri

Anger URI för slutpunktens metadata.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:2
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument: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 sparar Export-ODataEndpointProxy modulen i mappen $HOME\Documents\WindowsPowerShell\Modules. Om du anger en sökväg skapar cmdleten modulmappen i den sökvägen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:1
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument: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 Products till exempel 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 utvecklingsriktlinjer.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:7
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-UpdateRequestMethod

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

Parameteregenskaper

Typ:String
Standardvärde:None
Godkända värden:Put, Post, Patch
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:5
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Uri

Anger slutpunktens URI.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:0
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-WhatIf

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.