Architecture best practices for Azure API Management

Valutare le funzionalità del gateway per l'affidabilità e la ridondanza: Determinare il livello e le funzionalità di Gestione API necessari per soddisfare i requisiti di affidabilità del carico di lavoro per ogni ambiente.

Valutare le funzionalità di ridondanza del gateway, incluse le zone di disponibilità, più unità gateway, più aree e aree di lavoro. Queste funzionalità sono tutte supportate nel livello Premium. Il livello Developer, che non include un contratto di servizio, non è adatto per i carichi di lavoro di produzione. Prendere in considerazione i compromessi dell'adozione di funzionalità come la memorizzazione nella cache esterna che può introdurre potenziali punti di errore e colli di bottiglia delle prestazioni.

Esaminare le funzionalità di osservabilità: Prendere in considerazione le funzionalità di osservabilità del servizio, inclusi i log e le metriche di Monitoraggio di Azure, Application Insights, l'analisi predefinita e la diagnostica predefinita. Usare queste funzionalità per monitorare i segnali di affidabilità del carico di lavoro.

Si consideri ad esempio l'uso degli avvisi di Monitoraggio di Azure per segnalare potenziali problemi con il gateway di Gestione API o le relative dipendenze.

Esaminare le strategie di scalabilità: Definire i criteri per scalare il gateway aggiungendo unità per mantenere l'affidabilità del servizio. Valutare se ridimensionare in base a richieste, eccezioni o entrambe. Valutare l'impatto del ridimensionamento del componente gateway su altri componenti del carico di lavoro. Ad esempio, il suo effetto sullo spazio degli indirizzi di rete e sulle funzionalità di ridimensionamento dei back-end.

Isolare i carichi di lavoro critici: Determinare se è necessario l'isolamento del calcolo per soddisfare i requisiti del carico di lavoro, ad esempio la sovranità dei dati o l'ottimizzazione delle prestazioni, nelle API. Usare gateway dedicati per API critiche e gateway condivisi per API meno critiche.

Scegliere un approccio di isolamento, ad esempio usando un gateway dell'area di lavoro dedicato o un'istanza separata di Gestione API. Per più istanze, mantieni gli ambienti sincronizzati come parte delle tue pratiche di distribuzione sicura.

Allineamento dell'obiettivo del livello di servizio (SLO): Tenere conto dell'ambito del contratto di servizio del gateway quando si impostano i contratti di servizio del carico di lavoro. Il servizio fornisce il proprio contratto di servizio, ma è anche necessario tenere conto dell'affidabilità prevista di altri componenti del carico di lavoro, ad esempio i back-end dell'API.

Risolvere gli errori back-end: Pianificare gli errori di back-end previsti e imprevisti. Testare le esperienze client in questi scenari. Valutare i criteri del gateway per migliorare la resilienza e migliorare l'esperienza client. Concentrarsi su quote, limiti di frequenza, criteri di ripetizione dei tentativi, interruttori di circuito back-end, bilanciamento del carico e gestione delle eccezioni, come documentato nelle specifiche api.

Definire le strategie di test: Usare una soluzione di test, ad esempio Test di carico di Azure dall'interno della rete, per riflettere i carichi di lavoro di produzione effettivi. Don't rely on published throughput or other estimates which might not apply to your workload.

Pianificare il ripristino di emergenza: Esaminare le opzioni per il backup e il ripristino dell'infrastruttura e delle API del gateway. Le funzionalità di backup e ripristino predefinite potrebbero essere utili in alcuni scenari. Tuttavia, è possibile considerare anche opzioni gestite dai clienti, come strumenti APIOps e infrastruttura come codice (IaC). Sviluppare strategie per la gestione di altri dati di sistema, incluse le sottoscrizioni utente.

Stabilire una baseline di sicurezza: Esaminare la baseline di sicurezza per Gestione API e incorporare le misure applicabili nella baseline.

Proteggere la pipeline di distribuzione: Identificare i singoli utenti e i ruoli di controllo degli accessi in base al ruolo necessari per gestire la piattaforma del servizio, l'integrazione continua e le pipeline di distribuzione continua (CI/CD) e le singole API. Ensure that only authorized individuals have access to manage the service and its APIs.

Valutare la riservatezza dei dati: Se i dati sensibili passano attraverso richieste API e risposte nel gateway di Gestione API, garantire la protezione per tutto il ciclo di vita. Tenere conto dei requisiti di protezione dei dati diversi tra aree diverse. Valutare le funzionalità del servizio, ad esempio regioni multiple, per isolare dati specifici. Verificare anche se la strategia di memorizzazione nella cache è allineata a questi requisiti di isolamento.

Sviluppare strategie di segmentazione nei gateway condivisi: Se l'istanza di Gestione API ospita API per più team del carico di lavoro, usare le aree di lavoro per separare ruoli, reti ed eventualmente gateway. Questo approccio garantisce che ogni team abbia accesso e controllo appropriati sulle API gestite limitando l'accesso alle API di altri team.

Prendere in considerazione i controlli di rete: Identificare i requisiti e le opzioni per isolare o filtrare il traffico del gateway in ingresso e in uscita usando reti virtuali. Determinare se l'accesso al gateway può essere limitato tramite collegamento privato di Azure o se è necessario l'accesso pubblico al gateway. Valutare se l'architettura deve includere un web application firewall, ad esempio Web application firewall di Azure nel gateway applicazione di Azure o frontdoor di Azure, per ottenere l'isolamento di rete necessario e filtrare il traffico di rete.

Prendere in considerazione le funzionalità per l'autenticazione e l'autorizzazione dell'API: Valutare l'uso di provider di identità come Microsoft Entra ID, che include gruppi predefiniti o ID esterno di Microsoft Entra per visualizzare le richieste del gateway e abilitare l'autorizzazione OAuth per le API back-end.

Crittografare il traffico di rete: Identificare le versioni e le crittografie del protocollo TLS (Transport Layer Security) più sicure che i carichi di lavoro possono supportare. Non richiedere versioni TLS non sicure. Usa TLS 1.3 quando supportato dai tuoi client.

Eseguire la modellazione delle minacce in Gestione API e ridurre la superficie di attacco: Determinare se specifici componenti di Gestione API, ad esempio l'API di gestione diretta o l'accesso pubblico al portale per sviluppatori, possono essere disabilitati, limitati o rimossi.

Identificare i segreti richiesti dai carichi di lavoro: L'operazione gateway potrebbe richiedere certificati, chiavi API o altri valori segreti. Esaminare i requisiti e le funzionalità di Azure Key Vault per archiviare segreti e certificati. In alternativa, esaminare le funzionalità predefinite di Gestione API, ad esempio valori denominati e certificati gestiti.

Considerare il modello di costo di gestione delle API: Usare il calcolatore prezzi di Azure con i vantaggi e i criteri dell'account dell'organizzazione per SLA e scalabilità per sviluppare stime accurate dei costi dell'uso di un livello di servizio di gestione delle API. Determinare se è necessario un modello di chargeback e determinare come calcolarlo in base a metriche, tag e token.

The service cost model is mainly influenced by the service tier, number of units, and number of gateways. Valutare i costi aggiuntivi associati alla gestione di un'unità di riserva o all'implementazione di una configurazione di ripristino di emergenza attivo-passivo.

Se si implementano le aree di lavoro, valutare i costi dell'uso di gateway dell'area di lavoro separati e condivisi per soddisfare i requisiti distinti del flusso API di vari team o stakeholder dell'API.

Stimare i costi di ridimensionamento: Sviluppare criteri di scalabilità per mantenere un utilizzo elevato delle risorse del gateway. Valutare i costi di base in un ambiente di pre-produzione ed eseguire test per modellare i costi di scalabilità in base al traffico previsto del carico di lavoro.

Progettare una strategia di mitigazione per impedire l'uso improprio dei gateway, che potrebbe portare a una costosa espansione delle risorse oltre l'utilizzo preventivo.

Valutare le configurazioni e i criteri del servizio: Le funzionalità come il limite di velocità e la concorrenza limite possono essere usate come tecniche di ottimizzazione dei costi per gestire i carichi delle richieste.

Ottimizzare il posizionamento della logica: Valutare se i server back-end sono più convenienti per la logica di elaborazione o se il gateway deve gestire l'utilizzo delle risorse. Il gateway è un componente forte per l'implementazione di problematiche trasversali, ma può eseguire funzioni eccessive in determinati scenari. Identificare le attività di elaborazione delle richieste con un numero elevato di risorse eseguite dal gateway e determinare se lo spostamento di tale logica nei server back-end può ridurre i costi.

Esaminare le conoscenze e le competenze chiave necessarie per gestire il servizio: Le aree includono il ciclo di vita dell'API, i processi DevOps, la rete e la connettività, il monitoraggio e l'osservabilità e lo sviluppo software. Questo approccio include la configurazione dei criteri, gli unit test e la creazione di pipeline CI/CD.

Prendere in considerazione le esigenze della documentazione: Le organizzazioni devono impegnarsi a documentare i processi per la configurazione a livello di servizio e a livello di API, le operazioni del ciclo di vita e i diversi modelli di accesso per i team API.

Valutare gli strumenti standard per supportare le operazioni del servizio. Ad esempio, adottare metodi APIOps , ad esempio GitOps e CI/CD, per pubblicare LE API e gestire le configurazioni API. Usare gli strumenti IaC per le modifiche alla configurazione a livello di servizio. Progettare artefatti riutilizzabili che possono passare facilmente dagli ambienti di sviluppo all'ambiente di produzione. Prendere in considerazione l'integrazione di un linter come Spectral, autogestito o integrato in un servizio di Azure come centro API di Azure, nelle pipeline di approvazione api.

Determinare le metriche operative chiave e i log: Esaminare le metriche per la produzione. Queste metriche includono la capacità del gateway, l'utilizzo della CPU, l'utilizzo della memoria e il numero di richieste. Esaminare i log e gli strumenti di osservabilità, ad esempio Monitoraggio di Azure e Application Insights. Determinare le strategie e gli strumenti necessari per gestire efficacemente grandi volumi di dati osservazionali negli ambienti di produzione. Determinare le query che forniscono informazioni dettagliate interattive sia per l'operatore del gateway che per gli stakeholder che monitorano API ospitate specifiche.

Pianificare test regolari dei carichi di lavoro di produzione usando test di carico.

Identificare le attività operative oltre ai processi CI/CD o IaC che richiedono l'automazione. Pianificare l'automazione in aree come gestione del codice sorgente dei criteri di Gestione API, criteri di Azure e configurazioni specifiche del portale per sviluppatori.

Definire gli obiettivi di prestazioni: Le metriche chiave per valutare le prestazioni del gateway di Gestione API includono le metriche della capacità, ad esempio le percentuali di utilizzo della CPU e della memoria per l'infrastruttura del gateway, la durata della richiesta e la velocità effettiva delle richieste. Nelle distribuzioni con più aree definire gli obiettivi di prestazioni per ogni area. Il cliente deve definire soglie di ridimensionamento appropriate in base a modelli di traffico, carichi di lavoro API e tempi di ridimensionamento.

Raccogliere dati sulle prestazioni: Esaminare le funzionalità di analisi predefinite, metriche di Monitoraggio di Azure, log di Monitoraggio di Azure, Application Insights e Hub eventi per raccogliere e analizzare le prestazioni a diversi livelli di granularità.

Esaminare come identificare i problemi di prestazioni in tempo reale: Gli indicatori per i problemi di prestazioni in tempo reale includono la disponibilità del servizio di Azure, gli errori di risposta HTTP e gli errori generati nella sezione Diagnosticare e risolvere i problemi nel portale. Risolvere i problemi di prestazioni e disponibilità usando Application Insights, le query Kusto e le raccomandazioni della diagnostica di Gestione API nel portale di Azure.

Prestazioni dei test: Testare le prestazioni in condizioni di produzione usando test di carico.

Valutare i servizi adiacenti che potrebbero migliorare le prestazioni: I criteri di memorizzazione nella cache o una cache esterna possono migliorare le prestazioni di operazioni API specifiche. Il Front Door di Azure e il Gateway Applicazione sono scelte comuni per l'offload del TLS.

Esaminare i limiti e i vincoli documentati:Gestione API presenta limiti e vincoli. Esaminare i vincoli documentati e confrontarli con i requisiti del carico di lavoro per verificare se è necessario progettare una soluzione che eviti questi vincoli.