Condividi tramite

Sincronizzare le API da un'istanza di Gestione API

  • Articolo

Questo articolo illustra come creare un collegamento a un'istanza di Gestione API in modo che le API delle istanze siano costantemente aggiornate nell'inventario del centro API.

Informazioni sul collegamento di un'istanza di Gestione API

Anche se è possibile usare l'interfaccia della riga di comando di Azure per importare API su richiesta da Azure Gestione API al Centro API di Azure, il collegamento di un'istanza di Gestione API abilita la sincronizzazione continua in modo che l'inventario API rimanga aggiornato.

Quando si collega un'istanza di Gestione API come origine API, si verifica quanto segue:

  1. Tutte le API e, facoltativamente, le definizioni API (specifiche), dall'istanza di Gestione API vengono aggiunte all'inventario del centro API.
  2. Configurare un ambiente di tipo Azure Gestione API nel centro API.
  3. Viene creata una distribuzione associata per ogni definizione dell'API sincronizzata da Gestione API.

Gestione API API vengono sincronizzate automaticamente con il centro API ogni volta che vengono modificate le impostazioni delle API esistenti (ad esempio, vengono aggiunte nuove versioni), vengono create nuove API o le API vengono eliminate. Questa sincronizzazione è unidirezionale tra Gestione API e il centro API di Azure, ovvero gli aggiornamenti api nel centro API non vengono sincronizzati con l'istanza di Gestione API.

Nota

  • Esistono limiti per il numero di istanze di Gestione API collegate (origini API).
  • Gli aggiornamenti delle API in Gestione API in genere si sincronizzano con il centro API entro pochi minuti, ma la sincronizzazione può richiedere fino a 24 ore.

Entità sincronizzate da Gestione API

È possibile aggiungere o aggiornare le proprietà e la documentazione dei metadati nel centro API per aiutare gli stakeholder a individuare, comprendere e usare le API sincronizzate. Altre informazioni sulle proprietà predefinite e personalizzate dei metadati del Centro API di Azure.

La tabella seguente illustra le proprietà delle entità che possono essere modificate nel Centro API di Azure e le proprietà determinate in base ai relativi valori in un'istanza di Azure Gestione API collegata. Inoltre, gli identificatori di sistema o delle risorse delle entità nel Centro API di Azure vengono generati automaticamente e non possono essere modificati.

Entità Proprietà configurabili nel Centro API Proprietà determinate in Gestione API
API riepilogo
lifecycleStage
termsOfService
Licenza
externalDocumentation
customProperties		 title
description
kind
Versione dell'API lifecycleStage title
Ambiente title
description
kind
server.managementPortalUri
onboarding
customProperties		 server.type
Distribuzione title
description
server
state
customProperties		 server.runtimeUri

Per informazioni dettagliate sulle proprietà, vedere le informazioni di riferimento sull'API REST del Centro API di Azure.

Prerequisiti

  • Un centro API nella sottoscrizione di Azure. Se non ne è stato creato uno, vedere Guida introduttiva: Creare il centro API.

  • Un'istanza di Azure Gestione API, nella stessa sottoscrizione o in una sottoscrizione diversa. L'istanza deve trovarsi nella stessa directory.

  • Per l'interfaccia della riga di comando di Azure:

    Nota

    I comandi az apic richiedono l'estensione dell'interfaccia della riga di comando di Azure apic-extension. Se non sono stati usati comandi az apic, l'estensione può essere installata in modo dinamico quando si esegue il primo comando az apic oppure è possibile installarla manualmente. Altre informazioni sulle estensioni dell'interfaccia della riga di comando di Azure.

    Vedere le note sulla versione per le modifiche e gli aggiornamenti più recenti in apic-extension.

    Nota

    Gli esempi di comandi dell'interfaccia della riga di comando di Azure riportati in questo articolo possono essere eseguiti in PowerShell o in una shell bash. Se necessario, a causa di una sintassi di variabile diversa, vengono forniti esempi di comandi separati per le due shell.

Aggiungere un'identità gestita nel centro API

Per questo scenario, il centro API usa un'identità gestita per accedere alle API nell'istanza di Gestione API. A seconda delle esigenze, configurare un'identità gestita assegnata dal sistema o una o più identità gestite assegnate dall'utente.

Gli esempi seguenti illustrano come configurare un'identità gestita assegnata dal sistema usando il portale di Azure o l'interfaccia della riga di comando di Azure. A livello generale, i passaggi di configurazione sono simili per un'identità gestita assegnata dall'utente.

  1. Nel portale, passare al centro API.
  2. Nel menu a sinistra, in Sicurezzaselezionare Identità gestite.
  3. Selezionare Sistema assegnato e impostare lo stato su Sì.
  4. Seleziona Salva.

Assegnare l'identità gestita al ruolo lettore del servizio Gestione API

Per consentire l'importazione delle API, assegnare all'identità gestita del centro API il ruolo Lettore del servizio Gestione API nell'istanza di Gestione API. È possibile usare il portale o l'interfaccia della riga di comando di Azure.

  1. Nel portale, andare all'istanza di API Management.
  2. Nel menu a sinistra selezionare Controllo di accesso (IAM).
  3. Selezionare + Aggiungi assegnazione di ruolo.
  4. Nella pagina Aggiungi assegnazione di ruolo, impostare i valori come segue:
    1. Nella scheda Ruolo, selezionare Lettore del servizio Gestione API.
    2. Nella scheda Membri, in Assegnare l'accesso a - Selezionare Identitàgestita>+ Seleziona membri.
    3. Nella pagina Seleziona identità, gestite selezionare l'identità gestita assegnata dal sistema del centro API aggiunto nella sezione precedente. Fare clic su Seleziona.
    4. Seleziona Rivedi + assegna.

È possibile collegare un'istanza di Gestione API usando il portale.

  1. Nel portale, passare al centro API.
  2. In Asset selezionare Ambienti.
  3. Selezionare Collegamenti (anteprima)>+ Nuovo collegamento.
  4. Nella pagina Collegare il servizio azure Gestione API:
    1. Selezionare il servizio Sottoscrizione, Gruppo di risorse e Azure Gestione API da collegare.
    2. In Dettagli collegamento immettere un identificatore.
    3. In Dettagli ambiente immettere un titolo ambiente (nome), tipo di ambiente e descrizione facoltativa dell'ambiente.
    4. In Dettagli API selezionare una fase del ciclo di vita per le API sincronizzate. È possibile aggiornare questo valore per le API dopo l'aggiunta al centro API. Selezionare anche se sincronizzare le definizioni api.
  5. Selezionare Crea.

Screenshot del collegamento di un servizio Gestione API di Azure nel portale.

L'ambiente viene aggiunto nel centro API. Le API Gestione API vengono importate nell'inventario del centro API.

Screenshot dell'elenco di ambienti nel portale.

Mentre un'istanza di Gestione API è collegata, non è possibile eliminare le API sincronizzate dal centro API. Se necessario, è possibile eliminare il collegamento. Quando si elimina un collegamento:

  • Le API Gestione API sincronizzate nell'inventario del centro API vengono eliminate
  • L'ambiente e le distribuzioni associate all'istanza di Gestione API vengono eliminate

Per eliminare un collegamento Gestione API:

  1. Nel portale, passare al centro API.
  2. In Asset selezionare Collegamento ambienti>(anteprima).
  3. Selezionare il collegamento e quindi selezionare Elimina (icona del cestino).

Contenuto correlato