Esercitazione: Definire metadati personalizzati

Questa esercitazione illustra come definire metadati personalizzati per organizzare le API e altre informazioni nel centro API. È possibile usare metadati personalizzati e predefiniti per la ricerca e il filtro e per applicare gli standard di governance nell'organizzazione.

Per altre informazioni sui metadati nel Centro API di Azure, vedere:

• Concetti chiave - Metadati
• Usare i metadati per la governance delle API

Questa esercitazione illustra come usare il portale di Azure per:

• Definire metadati personalizzati nel centro API
• Visualizzare lo schema dei metadati

Prerequisiti

• Un centro API nella sottoscrizione di Azure. Per crearne uno, vedere Avvio rapido: Creare il centro API.

Definire i metadati

Qui si definiscono due esempi di metadati personalizzati: Linea di business e Rivolto al pubblico; se si preferisce, definire altri metadati propri. Quando si aggiungono o aggiornano API e altre informazioni nell'inventario, impostare i valori per i metadati predefiniti personalizzati ed eventuali comuni.

Importante

Non includere informazioni sensibili, riservate o personali nei titoli (nomi) dei metadati definiti. Questi titoli sono visibili nei log di monitoraggio usati da Microsoft per migliorare la funzionalità del servizio. Tuttavia, altri dettagli e valori dei metadati sono dati dei clienti protetti.

1. Accedere al portale di Azure e quindi passare al centro API.

2. Nel menu della barra laterale, in Asset, selezionare Metadati>+ Nuovi metadati.

3. Nella scheda Dettagli immettere informazioni sui metadati.

   1. Per Titolo immettere Line of business.

   2. Facoltativamente, immettere una descrizione.

   3. Selezionare il tipo Scelte predefinite e immettere scelte come Marketing, Finance, IT, Sales e così via. Facoltativamente, abilitare Consenti selezione di più valori. Seleziona Avanti.

   

4. Nella scheda Assegnazioni selezionare Obbligatorio per le API. Selezionare Facoltativo per Distribuzioni e ambienti. È possibile aggiungere queste entità nelle esercitazioni successive. Seleziona Avanti.

   

5. Nella scheda Rivedi e crea esaminare le impostazioni e selezionare Crea.

   I metadati vengono aggiunti all'elenco nella pagina Metadati .

6. Selezionare + Nuovi metadati per aggiungere un altro esempio.

7. Nella scheda Dettagli immettere informazioni sui metadati.

   1. Per Titolo immettere Visibile al pubblico.

   2. Selezionare tipo Boolean.

8. Nella scheda Assegnazioni selezionare Obbligatorio per le API. Selezionare Non applicabile per Distribuzioni e ambienti.

9. Nella scheda Rivedi e crea esaminare le impostazioni e selezionare Crea.

   I metadati vengono aggiunti all'elenco.

Visualizzare lo schema dei metadati

È possibile visualizzare e scaricare lo schema JSON per i metadati definiti nel centro API. Lo schema include metadati predefiniti e personalizzati.

1. Nel menu a sinistra, sotto Assets, selezionare Metadata>Visualizza schema metadati.

2. Selezionare Visualizza schema dei metadati> e API per visualizzare lo schema dei metadati per le API, che include metadati predefiniti e personalizzati. È anche possibile visualizzare lo schema dei metadati definito per le distribuzioni e gli ambienti nel centro API.

   

Passo successivo

Aggiungere API all'inventario nel centro API.

Registrare le API nell'inventario API