Condividi tramite

Export-ODataEndpointProxy

Modulo:
Microsoft.PowerShell.ODataUtils Module

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

Sintassi

Default (Impostazione predefinita) 

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 cmdlet Export-ODataEndpointProxy 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 ConnectionURI 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 AllowUnsecureConnection.

Parametri

-AllowClobber

Indica che questo cmdlet sostituisce un modulo esistente.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:10
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:11
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-CmdletAdapter

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

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Valori accettati:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:6
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False
Alias:cfr

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-CreateRequestMethod

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

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Valori accettati:Put, Post, Patch
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:4
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Credential

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

Proprietà dei parametri

Tipo:PSCredential
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:3
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-CustomData

Specifica una tabella hash di dati personalizzati.

Proprietà dei parametri

Tipo:Hashtable
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:9
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Force

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

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:8
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Headers

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

Proprietà dei parametri

Tipo:Hashtable
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:12
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-MetadataUri

Specifica l'URI dei metadati dell'endpoint.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:2
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti: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 cartella $HOME\Documents\WindowsPowerShell\Modules. Se si specifica un percorso, il cmdlet crea la cartella del modulo in tale percorso.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:1
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti: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 .

Ad esempio, nella tabella hash @{Products = 'Merchandise'}, Products è il nome della raccolta di risorse che funge da chiave. Merchandise è 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.

Proprietà dei parametri

Tipo:Hashtable
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:7
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-UpdateRequestMethod

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

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Valori accettati:Put, Post, Patch
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:5
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Uri

Specifica l'URI dell'endpoint.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:0
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-WhatIf

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

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False
Alias:Wi

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.