Condividi tramite

Export-ODataEndpointProxy

  • Riferimento
Modulo:
Microsoft.PowerShell.ODataUtils

Genera un modulo che contiene i cmdlet per gestire un endpoint OData.

Sintassi

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

Descrizione

Il Export-ODataEndpointProxy cmdlet usa i metadati di un endpoint OData per generare un modulo contenente i cmdlet che è possibile usare per gestire l'endpoint OData. Il modulo è basato su CDXML. Dopo aver generato il modulo, questo modulo viene salvato nel percorso e nel nome file specificato dal parametro OutputModule .

Export-ODataEndpointProxy genera cmdlet per operazioni di creazione, lettura, aggiornamento ed eliminazione (CRUD), azioni non CRUD e manipolazione dell'associazione.

Export-ODataEndpointProxy genera un file CDXML per ogni risorsa endpoint. È possibile modificare questi file CDXML dopo la generazione del modulo. Ad esempio, se si desidera modificare i nomi sostantivi o verbi dei cmdlet per allinearsi alle linee guida per la denominazione dei cmdlet di Windows PowerShell, è possibile modificare il file.

Ogni cmdlet in un modulo generato deve includere un parametro Connessione ionURI per connettersi all'endpoint gestito dal modulo.

Esempio

Esempio 1: Generare un modulo per gestire un endpoint di servizio Web al dettaglio

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

Questo comando genera un modulo per gestire un endpoint del servizio di vendita al dettaglio. Il comando specifica l'URI dell'endpoint e l'URI dei metadati dell'endpoint. Il comando fornisce anche un percorso di output e un nome del modulo script come valore del parametro OutputModule . Per il valore del parametro ResourceNameMapping , il comando fornisce una tabella hash che esegue il mapping del nome della raccolta di risorse al sostantivo desiderato per il set di cmdlet. In questo esempio Products è il nome della raccolta di risorse e Merchandise è il sostantivo. Per consentire le connessioni a siti non SSL, HTTP anziché HTTPS, aggiungere il parametro AllowUnsecure Connessione ion.

Parametri

-AllowClobber

Indica che questo cmdlet sostituisce un modulo esistente.

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

-AllowUnsecureConnection

Indica che questo modulo può connettersi agli URI non protetti da SSL. Il modulo può gestire i siti HTTP oltre ai siti HTTPS.

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

-CmdletAdapter

Specifica l'adattatore cmdlet. I valori accettabili per questo parametro sono: ODataAdapter e NetworkControllerAdapter.

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

-Confirm

Richiede conferma prima di eseguire il cmdlet.

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

-CreateRequestMethod

Specifica il metodo di richiesta. I valori accettabili per questo parametro sono: PUT, POST e PATCH.

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

-Credential

Specifica un account utente che ha accesso all'endpoint OData. L'impostazione predefinita è l'utente corrente. Se un computer remoto esegue Windows Vista o una versione successiva del sistema operativo Windows, il cmdlet richiede le credenziali.

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

-CustomData

Specifica una tabella hash di dati personalizzati.

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

-Force

Indica che questo cmdlet sovrascrive un modulo generato esistente con lo stesso nome in una cartella esistente Modules .

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

-Headers

Specifica le intestazioni della richiesta Web. Immettere una tabella hash o un dizionario.

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

-MetadataUri

Specifica l'URI dei metadati dell'endpoint.

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

-OutputModule

Specifica il percorso e il nome del modulo in cui questo cmdlet salva il modulo generato dei comandi proxy.

Questo cmdlet copia un modulo binario, un manifesto del modulo e un file di formattazione, se applicabile, nella cartella specificata. Se si specifica solo il nome del modulo, Export-ODataEndpointProxy salva il modulo nella $HOME\Documents\WindowsPowerShell\Modules cartella . Se si specifica un percorso, il cmdlet crea la cartella del modulo in tale percorso.

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

-ResourceNameMapping

Specifica una tabella hash che contiene mapping che consentono di personalizzare i cmdlet generati. In questa tabella hash il nome della raccolta di risorse è la chiave. Il sostantivo del cmdlet desiderato è il valore .

Nella tabella @{Products = 'Merchandise'}hash, ad esempio, Products è il nome della raccolta di risorse che funge da chiave. La merce è il sostantivo cmdlet risultante. I nomi dei cmdlet generati potrebbero non essere allineati alle linee guida per la denominazione dei cmdlet di Windows PowerShell. È possibile modificare il file CDXML della risorsa per modificare i nomi dei cmdlet dopo la creazione del modulo. Per altre informazioni, vedere Linee guida per lo sviluppo fortemente incoraggiate.

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

-UpdateRequestMethod

Specifica il metodo di richiesta di aggiornamento. I valori accettabili per questo parametro sono: PUT, POST e PATCH.

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

-Uri

Specifica l'URI dell'endpoint.

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

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

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