Informazioni su come configurare notifiche e modelli di notifica in Gestione API di Azure

Articolo
04/04/2024

Gestione API consente di configurare notifiche tramite posta elettronica per eventi specifici nonché di configurare modelli di posta elettronica da usare per comunicare con gli amministratori e gli sviluppatori di un'istanza di Gestione API. In questo articolo viene illustrato come configurare notifiche per gli eventi disponibili e viene offerta una panoramica sulla configurazione di modelli di posta elettronica usati per tali eventi.

Prerequisiti

Se non si dispone di un'istanza del servizio Gestione API, completare l'avvio rapido seguente: Creare un'istanza di Gestione API di Azure.

Passare all'istanza di Gestione API

Nel portale di Azure, cercare e selezionare Servizi Gestione API.
Nella pagina Servizi Gestione API selezionare l'istanza di Gestione API.

Configurare notifiche nel portale

Nel riquadro di spostamento sinistro dell'istanza di Gestione API selezionare Notifiche per visualizzare le notifiche disponibili.

L'elenco di eventi seguente può essere configurato per le notifiche.
- Richieste di sottoscrizione (che richiedono approvazione): i destinatari e gli utenti specificati riceveranno notifiche tramite e-mail sulle richieste di sottoscrizione per prodotti che richiedono approvazione.
- Nuove sottoscrizioni: i destinatari e gli utenti specificati riceveranno notifiche tramite e-mail sulle nuove sottoscrizioni a prodotti.
- BCC - I destinatari e gli utenti di posta elettronica specificati riceveranno copie per conoscenza nascosta di tutti i messaggi di posta elettronica inviati agli sviluppatori.
- Messaggio di chiusura account - I destinatari e gli utenti di posta elettronica specificati riceveranno notifiche tramite posta elettronica quando un account viene chiuso.
- Raggiungimento limite quota sottoscrizione: i destinatari e gli utenti specificati riceveranno notifiche tramite e-mail quando l'uso della sottoscrizione si avvicina al limite di quota di utilizzo.
  
  Nota
  
  Le notifiche vengono attivate solo dal criterio quota per sottoscrizione. Il criterio quota per chiave non genera notifiche.
Selezionare una notifica e specificare uno o più indirizzi e-mail per riceverla:
- Per aggiungere l'indirizzo e-mail dell'amministratore, selezionare + Aggiungi amministratore.
- Per aggiungere un altro indirizzo e-mail, selezionare + Aggiungi e-mail, immettere un indirizzo e-mail e selezionare Aggiungi.
- Continuare ad aggiungere indirizzi e-mail in base alle esigenze.

Configurare i modelli di notifica

Gestione API fornisce modelli di notifica per i messaggi di e-mail amministrativi inviati automaticamente agli sviluppatori quando accedono e usano il servizio. Sono forniti i modelli di notifica indicati di seguito:

Invio della raccolta di applicazioni approvato (deprecato)
Lettera di commiato sviluppatore
Notifica raggiungimento limite quota sviluppatore
Lettera di benvenuto per gli sviluppatori
Notifica delle modifiche tramite e-mail
Invita utente
Nuovo commento aggiunto a un problema (deprecato)
Conferma del nuovo account sviluppatore
Nuovo problema ricevuto (deprecato)
Nuova sottoscrizione attivata
Conferma di modifica della password
Richiesta sottoscrizione rifiutata
Richiesta sottoscrizione ricevuta

Ogni modello di posta elettronica ha un oggetto in testo normale e una definizione di corpo in formato HTML. Ogni elemento può essere personalizzato a piacimento.

Nota

Il contenuto HTML in un modello deve essere ben formato e rispettare la specifica XML. Il carattere   non è consentito.

Per visualizzare e configurare un modello di notifica nel portale:

Nel menu a sinistra selezionare Modelli di notifica.
Selezionare un modello di notifica e configurare il modello usando l'editor.
- L'elenco Parametri contiene un elenco di parametri che, se inseriti nell'oggetto o nel corpo, saranno sostituiti dal valore designato al momento dell'invio dell'e-mail.
- Per inserire un parametro, posizionare il cursore nel punto in cui si vuole inserire il parametro, quindi selezionare il nome del parametro.
Per salvare le modifiche apportate al modello di e-mail, fare clic su Salva oppure, per annullare le modifiche, fare clic su Ignora.

Configurazione delle impostazioni di posta elettronica

È possibile modificare le impostazioni generali di posta elettronica per le notifiche inviate dall'istanza di Gestione API. È possibile modificare l'indirizzo di posta elettronica dell'amministratore, il nome dell'organizzazione che invia le notifiche e l'indirizzo di posta elettronica di origine.

Importante

La modifica dell'indirizzo e-mail di origine può influire sulla capacità dei destinatari di ricevere e-mail. Vedere le considerazioni nella sezione seguente.

Per modificare le impostazioni di e-mail:

Nel menu a sinistra selezionare Modelli di notifica.
Selezionare Impostazioni di e-mail.
Nella pagina Impostazioni di e-mail generali immettere i valori per:
- E-mail amministratore: l'indirizzo e-mail per ricevere tutte le notifiche di sistema e altre notifiche configurate
- Nome dell'organizzazione: il nome dell'organizzazione da utilizzare nel portale per sviluppatori e per le notifiche
- Indirizzo e-mail di origine: il valore dell'intestazione From per le notifiche dall'istanza di Gestione API. Gestione API invia notifiche per conto di questo indirizzo di origine.
Seleziona Salva.

Considerazioni sulla modifica dell'indirizzo e-mail di origine

I destinatari delle notifiche tramite e-mail da Gestione API potrebbero essere interessati quando si modifica l'indirizzo e-mail di origine.

Modifica dell'indirizzo Da: quando si modifica l'indirizzo e-mail di origine (ad esempio, in no-reply@contoso.com), l'intestazione di indirizzo From diventa noreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Ciò è dovuto al fatto che l'e-mail viene inviata da Gestione API e non dal server di e-mail dell'indirizzo e-mail di origine.
E-mail impostata su Posta indesiderata o Spam: alcuni destinatari potrebbero non ricevere le notifiche tramite e-mail da Gestione API o le e-mail potrebbero essere inviate alla cartella Posta indesiderata o Spam. Ciò può verificarsi a seconda delle impostazioni di autenticazione delle e-mail SPF o DKIM dell'organizzazione:
- Autenticazione SPF: l'e-mail potrebbe non superare più l'autenticazione SPF dopo aver modificato il dominio dell'indirizzo e-mail di origine. Per garantire l'autenticazione SPF e la consegna delle e-mail, creare il seguente record TXT nel database DNS del dominio specificato nell'indirizzo e-mail. Ad esempio, se l'indirizzo e-mail è noreply@contoso.com, contattare l'amministratore di contoso.com per aggiungere il record TXT seguente: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"
- Autenticazione DKIM: per generare una firma valida per DKIM per l'autenticazione tramite e-mail, Gestione API richiede la chiave privata associata al dominio dell'indirizzo e-mail di origine. Tuttavia, non è attualmente possibile caricare questa chiave privata in Gestione API. Pertanto, per assegnare una firma valida, Gestione API usa la chiave privata associata al dominio mail.windowsazure.com.

Condividi tramite