Aggiunta o aggiornamento dei valori

Completato

Questa unità descrive i modelli di criteri che è possibile applicare per impostare i valori dei dati nella richiesta all'API e nella relativa risposta. Lo scenario più comune prevede l'impostazione dei valori richiesti dall'API nel corpo, nell'intestazione o nella query della richiesta in modo che il creatore non debba specificare queste informazioni. I criteri sono caratterizzati da una certa flessibilità di gestione delle varie attività correlate all'impostazione dei dati nella richiesta e nella risposta. Sono disponibili i seguenti modelli di criteri, finalizzati all'impostazione dei valori dei dati:

  • Imposta proprietà: per aggiungere o aggiornare una proprietà in un oggetto o una raccolta.

  • Imposta parametro stringa di query: per aggiungere o aggiornare un parametro nella stringa di query.

  • Imposta intestazione HTTP: per aggiungere o aggiornare un valore nell'intestazione della richiesta e/o della risposta.

Uso del modello di criteri Imposta proprietà

Il modello di criteri Imposta proprietà può essere usato per impostare o aggiornare i valori nel corpo degli oggetti richiesta o risposta. È possibile impostare un valore costante usando un valore di stringa o un'espressione mediante @body() per recuperare un altro valore esistente dall'oggetto corpo. L'esempio seguente mostra come impostare un valore costante nel corpo della risposta.

Se si osserva la risposta dopo l'implementazione del modello di criteri, verrà visualizzato un risultato simile all'immagine seguente.

L'esempio precedente mostra che l'operazione ListInvoice restituisce un oggetto con una proprietà invoices che è un array di oggetti invoice. Per impostare la proprietà prefix su ciascun oggetto invoice dell'array invoices, è necessario modificare l'oggetto padre o il percorso della raccolta in modo che sia simile all'immagine seguente.

L'output restituito dopo aver apportato tale modifica è simile all'immagine seguente.

È anche possibile fare riferimento ad altri valori già impostati nel corpo. Ad esempio, l'immagine seguente mostra che la proprietà FullValue comprende la proprietà Prefix.

Si noti che il campo Valore da aggiungere contiene l'espressione {@body().Prefix} per recuperare il valore del prefisso dal corpo. Per garantirne il corretto funzionamento, è necessario racchiudere l'espressione tra parentesi graffe ({expression}).

L'espressione funziona correttamente in questo campo solo se si fa riferimento a @body. L'uso di altre espressioni, ad esempio @connectionProperties, @headers o @queryParameters, non è supportato.

Uso del modello di criteri Imposta parametro stringa di query

Il modello di criteri Imposta parametro stringa di query può essere usato per aggiungere o aggiornare i parametri di query nella richiesta. Poiché la stringa di query interessa solo la richiesta, non è necessario impostare il valore Esegui criterio su. A differenza del criterio Imposta proprietà che imposta sempre il valore anche se esiste, questo criterio è configurabile. È possibile impostare l'azione, se il parametro esiste, su una delle opzioni seguenti:

  • Sostituisci: sostituisce il valore esistente.

  • Ignora: il valore esistente non viene sostituito.

  • Aggiungi: il valore del modello di criteri viene aggiunto al valore esistente.

Questa funzionalità consente di controllare quando il valore viene usato e rappresenta un metodo valido per specificare valori predefiniti. Un esempio di questo approccio è rappresentato dal connettore Microsoft Outlook, che include un criterio Imposta parametro stringa di query per impostare il relativo parametro $top sul valore predefinito 50. L'esempio seguente mostra l'aspetto del modello di criteri.

Si noti che per il valore Azione se esiste un parametro di query viene usata l'opzione Ignora per garantire che questo criterio venga usato solo come criterio predefinito.

Uso del modello di criteri Imposta intestazione HTTP

È possibile usare il modello di criteri Imposta intestazione HTTP per aggiungere o aggiornare i valori nell'intestazione della richiesta, della risposta o dell'errore. Analogamente a quanto indicato per il modello di criteri Imposta parametro stringa di query, è possibile scegliere l'azione se il valore esiste già. Il modello di criteri si usa soprattutto per impostare i valori di intestazione previsti dall'API, ad esempio l'identificazione del mittente, ETag per il rilevamento delle modifiche o le intestazioni di chiavi API speciali che non vengono gestite dalle normali impostazioni del connettore. Ad esempio, il connettore Servizi cognitivi di Azure usa un modello di criteri Set header per impostare il valore dell'intestazione X-Ms-Sender su App per la logica di Microsoft Azure. L'esempio seguente mostra l'aspetto di questo modello di criteri.

L'uso di questi modelli di criteri consente di impostare i valori previsti dall'API. È inoltre possibile usarli per impostare valori nella risposta che potrebbero semplificare l'uso dei dati da parte del creatore. Questi criteri possono essere usati anche per impostare i valori predefiniti quando non sono stati specificati. È possibile usare più criteri in un ordine specifico per creare valori più complessi.