Abilitare e visualizzare la visualizzazione del portale del Centro API di Azure - Estensione VS Code

Questo articolo illustra come fornire agli sviluppatori aziendali l'accesso alla visualizzazione del portale di Centro API di Azure nell'estensione Visual Studio Code per Centro API di Azure. Usando la visualizzazione del portale, gli sviluppatori possono individuare le API nel centro API di Azure, visualizzare le definizioni delle API e, facoltativamente, generare client API quando non hanno accesso per gestire il centro API stesso o aggiungere API all'inventario. L'accesso alla visualizzazione del portale del Centro API viene gestito usando Microsoft Entra ID e il controllo degli accessi in base al ruolo di Azure.

Prerequisiti

Per gli amministratori del Centro API

• Un centro API nella sottoscrizione di Azure. Se non ne è già stato creato uno, vedere Avvio rapido: Creare il centro API.

• Autorizzazioni per creare una registrazione dell'app in un tenant di Microsoft Entra associato alla sottoscrizione di Azure e autorizzazioni per concedere l'accesso ai dati nel centro API.

Per sviluppatori di app

• Estensione Centro API di Azure per Visual Studio Code

Le estensioni di Visual Studio Code seguenti sono facoltative:

• Estensione Microsoft Kiota : per generare client API
• GitHub Copilot e GitHub Copilot Chat, forniti con l'accesso a GitHub Copilot , per usare gli strumenti del modello linguistico in modalità agente per l'individuazione delle API

Passaggi per gli amministratori del Centro API per abilitare l'accesso alla visualizzazione del portale del Centro API

Le sezioni seguenti illustrano i passaggi per consentire agli amministratori del Centro API di consentire agli sviluppatori aziendali di accedere alla visualizzazione del portale del Centro API.

Creare la registrazione dell'app Microsoft Entra

Configurare prima di tutto una registrazione dell'app nel tenant di Microsoft Entra ID. La registrazione dell'app consente al portale di Centro API di accedere ai dati dal centro API per conto di un utente connesso.

Il Centro API può configurare automaticamente la registrazione dell'app oppure è possibile creare manualmente la registrazione dell'app.

Configurare automaticamente la registrazione dell'app

Per configurare automaticamente la registrazione dell'app, seguire questa procedura:

1. Nel portale di Azure passare al centro API.
2. Nel menu a sinistra selezionare Impostazioni del portale> del Centro API.
3. Nella scheda Provider di identità selezionare Avvia configurazione.
4. Selezionare Salva e pubblica.

Configurare manualmente la registrazione dell'app

Per creare manualmente la registrazione dell'app, seguire questa procedura:

1. Nel portale di Azure passare aRegistrazioni dell'app>.

2. Selezionare + Nuova registrazione.

3. Nella pagina Registra un'applicazione impostare i valori come segue:

   1. Impostare Nome su un nome significativo, ad esempio api-center-portal
   2. In Tipi di account supportati, selezionare Account in questa directory organizzativa (tenant singolo).
   3. In URI di reindirizzamento selezionare Applicazione a pagina singola (SPA) e impostare l'URI. Immettere l'URI della distribuzione del portale di Centro API nel formato seguente: https://<service-name>.portal.<location>.azure-apicenter.ms. Sostituire <service name> e <location> con il nome del centro API e la posizione in cui è distribuita, ad esempio: https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Selezionare Registra.

Configurare URI di reindirizzamento aggiuntivi per l'estensione di VS Code

Quando si abilita la visualizzazione del portale di Centro API nell'estensione Visual Studio Code per Centro API, configurare anche gli URI di reindirizzamento seguenti nella registrazione dell'app:

1. Nel portale di Azure passare alla registrazione dell'app.

2. Nella pagina Gestisci>autenticazione selezionare Aggiungi una piattaforma e selezionare Applicazioni per dispositivi mobili e desktop.

3. Configurare i tre URI di reindirizzamento personalizzati seguenti:
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   Sostituire <application-client-id> con l'ID applicazione (client) dell'app. È possibile trovare questo valore nella pagina Panoramica della registrazione dell'app.

Abilitare l'accesso al portale del Centro API per utenti e gruppi di Microsoft Entra

Gli sviluppatori aziendali devono accedere con un account Microsoft per visualizzare il portale del Centro API. Se necessario, aggiungere o invitare sviluppatori al tenant di Microsoft Entra.

Per abilitare l'accesso, assegnare agli utenti o ai gruppi nell'organizzazione il ruolo di Azure API Center Data Reader, limitato al centro API dell'organizzazione.

Per i prerequisiti e i passaggi dettagliati per assegnare un ruolo a utenti e gruppi, vedere Assegnare ruoli di Azure tramite il portale di Azure. Brevi passaggi sotto:

1. Nel portale di Azure passare al centro API.
2. Nel menu a sinistra selezionare Controllo di accesso (IAM)>+ Aggiungi assegnazione di ruolo.
3. Nel riquadro Aggiungi assegnazione di ruolo impostare i valori come segue:
   1. Nella pagina Ruolo cercare e selezionare Lettore dati del Centro API di Azure. Selezionare Avanti.
   2. Nella pagina Membri, in Assegna accesso a, selezionare Utente, gruppo o entità servizio>+ Seleziona membri.
   3. Nella pagina Seleziona membri cercare e selezionare gli utenti o i gruppi a cui assegnare il ruolo. Fare clic su Seleziona e quindi su Avanti.
   4. Rivedere l'assegnazione di ruolo e selezionare Rivedi + Assegna.

Dopo aver configurato l'accesso al portale, gli utenti configurati possono accedere al portale e visualizzare le API nel centro API.

Passaggi per gli sviluppatori aziendali per accedere alla visualizzazione del portale del Centro API

Gli sviluppatori possono seguire questi passaggi per connettersi e accedere a una visualizzazione del portale di Centro API usando l'estensione Visual Studio Code. Le impostazioni per la connessione al centro API devono essere fornite dall'amministratore del Centro API. Dopo la connessione, gli sviluppatori possono individuare e usare le API nel centro API.

Connettersi a un centro API

1. In Visual Studio Code, nella barra delle attività a sinistra selezionare Centro API.

   

2. Usare la scorciatoia da tastiera CTRL+MAIUSC+P per aprire la Palette dei comandi. Digitare Centro API di Azure: connettersi a un Centro API e premere INVIO.

3. Rispondere alle richieste di immettere le informazioni seguenti:

   1. L'URL di runtime del centro API, nel formato <service name>.data.<region>.azure-apicenter.ms (non anteporre il prefisso con https://). Esempio: contoso-apic.data.eastus.azure-apicenter.ms. Questo URL di runtime viene visualizzato nella pagina Panoramica del centro API nella visualizzazione del portale di Azure.

   2. ID applicazione (client) dalla registrazione dell'app configurata dall'amministratore nella sezione precedente.

   3. ID della directory (tenant) dalla registrazione dell'app configurata dall'amministratore nella sezione precedente.

   Suggerimento

   Un amministratore del Centro API deve fornire i dettagli di connessione precedenti agli sviluppatori o fornire un collegamento diretto nel formato seguente:
   vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

   Dopo la connessione al centro API, il nome del centro API viene visualizzato nella visualizzazione del portale del Centro API.

4. Per visualizzare le API nel centro API, sotto il nome del centro API selezionare Accedi ad Azure. L'accesso è consentito con un account Microsoft a cui è assegnato il ruolo lettore dati di Centro API di Azure nel centro API.

   

5. Dopo l'accesso, selezionare API per elencare le API nel Centro API. Espandere un'API per esplorare le relative versioni e definizioni.

   

6. Ripetere i passaggi precedenti per connettersi a più centri API, se è configurato l'accesso.

Individuare e usare le API nella visualizzazione del portale di Centro API

La visualizzazione del portale di Centro API consente agli sviluppatori aziendali di individuare i dettagli dell'API e avviare lo sviluppo di client API. Gli sviluppatori possono accedere alle funzionalità seguenti facendo clic con il pulsante destro del mouse su una definizione API nella visualizzazione del portale del Centro API:

• Esportare il documento di specifica dell'API - Esportare una specifica API da una definizione e quindi scaricarla come file
• Generare il client API : usare l'estensione Microsoft Kiota per generare un client API per la lingua preferita
• Genera Markdown - Genera documentazione API nel formato Markdown
• Documentazione di OpenAPI : visualizzare la documentazione per una definizione dell'API e provare le operazioni in un'interfaccia utente di Swagger (disponibile solo per le definizioni OpenAPI)

Usare gli strumenti del modello linguistico

Gli sviluppatori con accesso alla visualizzazione del portale di Centro API possono aggiungere strumenti del modello linguistico del Centro API da usare in modalità agente di GitHub Copilot. Altre informazioni sull'uso degli strumenti in modalità agente.

Gli strumenti del Centro API possono essere usati in modalità agente per cercare API e versioni api, definizioni api e specifiche, distribuzioni e altro ancora usando i prompt del linguaggio naturale.

Per aggiungere e usare gli strumenti della modalità del linguaggio del Centro API in modalità agente di GitHub Copilot:

1. Connettersi a un centro API come descritto in una sezione precedente.

2. Apri GitHub Copilot Chat in Visual Studio Code.

3. Impostare la modalità di Chat di GitHub Copilot su Agent.

4. Selezionare l'icona Strumenti nella finestra della chat.

   

5. Selezionare uno o più strumenti del Centro API da rendere disponibili nella chat.

   

6. Immettere una richiesta nella finestra di chat per usare gli strumenti disponibili. Per esempio:

   Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.
   

7. Esaminare le risposte di GitHub Copilot Chat. Continuare con la conversazione per perfezionare i risultati o porre domande di completamento.

Risoluzione dei problemi

Non è possibile accedere ad Azure

Se gli utenti a cui è stato assegnato il ruolo lettore dati di Centro API di Azure non possono completare il flusso di accesso dopo aver selezionato Accedi ad Azure nella visualizzazione del portale del Centro API, potrebbe verificarsi un problema con la configurazione della connessione.

Controllare le impostazioni nella registrazione dell'app configurata in Microsoft Entra ID. Verificare i valori dell'ID applicazione (client) e dell'ID della directory (tenant) nella registrazione dell'app e nell'URL di runtime del centro API. Configurare quindi di nuovo la connessione al centro API.

Contenuti correlati

• Compilare e registrare API con l'estensione Centro API di Azure per Visual Studio Code

• Procedure consigliate per il Controllo degli accessi in base al ruolo di Azure

• Registrare un provider di risorse