Sdílet prostřednictvím

Povolení a zobrazení zobrazení portálu Azure API Center – rozšíření VS Code

Tento článek ukazuje, jak poskytnout podnikovým vývojářům přístup k zobrazení portálu Azure API Center v rozšíření Visual Studio Code pro Azure API Center. Pomocí zobrazení portálu můžou vývojáři zjišťovat rozhraní API v Centru rozhraní Azure API, zobrazovat definice rozhraní API a volitelně generovat klienty rozhraní API, pokud nemají přístup ke správě samotného centra rozhraní API nebo přidávat rozhraní API do inventáře. Přístup k zobrazení portálu API Center se spravuje pomocí ID Microsoft Entra a řízení přístupu na základě role v Azure.

Návod

Rozšíření editoru Visual Studio Code poskytuje více funkcí vývojářům, kteří mají oprávnění ke správě centra Azure API. Vývojáři rozhraní API můžou například zaregistrovat rozhraní API přímo v centru rozhraní API nebo pomocí kanálů CI/CD. Další informace

Požadavky

Pro správce centra rozhraní API

  • Centrum rozhraní API ve vašem předplatném Azure. Pokud jste ho ještě nevytvořili, přečtěte si článek Rychlý start: Vytvoření centra rozhraní API.

  • Oprávnění k vytvoření registrace aplikace v tenantovi Microsoft Entra přidruženém k vašemu předplatnému Azure a oprávnění k udělení přístupu k datům ve vašem centru rozhraní API.

Pro vývojáře aplikací

Následující rozšíření editoru Visual Studio Code jsou volitelná:

  • Rozšíření Microsoft Kiota – generování klientů rozhraní API
  • GitHub Copilot a GitHub Copilot Chat, který je k dispozici s přístupem k GitHub Copilotu – k používání nástrojů jazykového modelu v režimu agenta pro zjišťování rozhraní API

Postup pro správce centra rozhraní API pro povolení přístupu k zobrazení portálu API Center

Následující části obsahují postup pro správce centra rozhraní API, který umožňuje podnikovým vývojářům přístup k zobrazení portálu API Center.

Vytvoření registrace aplikace Microsoft Entra

Nejprve nakonfigurujte registraci aplikace v tenantovi Microsoft Entra ID. Registrace aplikace umožňuje portálu API Center přistupovat k datům z centra rozhraní API jménem přihlášeného uživatele.

Centrum API může registraci aplikace nastavit automaticky nebo můžete registraci aplikace vytvořit ručně.

Automatické nastavení registrace aplikace

Pokud chcete registraci aplikace nastavit automaticky, postupujte takto:

  1. Na webu Azure Portal přejděte do centra rozhraní API.
  2. V nabídce vlevo vyberteNastavení> API Center.
  3. Na kartě zprostředkovatele identity vyberte Zahájit nastavení.
  4. Na kartě Rychlé nastavení vyberte Uložit a publikovat.

Pokud potřebujete později získat přístup k registraci aplikace, najdete ji na portálu v části Registrace aplikací. Aplikace má následující formát: <api-center-name-apic-aad>.

Ruční nastavení registrace aplikace

Pokud chcete registraci aplikace vytvořit ručně, postupujte takto:

  1. Na webu Azure Portal přejděte do části Správaregistrací aplikací>>.

  2. Vyberte + Nová registrace.

  3. Na stránce Zaregistrovat aplikaci nastavte hodnoty následujícím způsobem:

    1. Nastavte Název na smysluplný název, například api-center-portal
    2. V části Podporované typy účtů vyberte Účty pouze v tomto adresáři organizace (<název> adresáře – jeden tenant).
    3. V URI přesměrovánívyberte jednostránkovou aplikaci (SPA) a nastavte URI. Zadejte identifikátor URI nasazení portálu API Center v následujícím formátu: https://<service-name>.portal.<location>.azure-apicenter.ms. Nahraďte <service name> a <location> názvem centra rozhraní API a umístěním, kam je nasazený, příklad: https://myapicenter.portal.eastus.azure-apicenter.ms.
    4. Vyberte Zaregistrovat.

Konfigurace dalších identifikátorů URI přesměrování pro rozšíření VS Code

Při povolování zobrazení portálu API Center v rozšíření Visual Studio Code pro api Center nakonfigurujte také následující identifikátory URI přesměrování v registraci aplikace:

  1. Na webu Azure Portal přejděte k registraci aplikace.

  2. Na stránce Spravovat>ověřování vyberte Přidat platformu a vyberte Mobilní a desktopové aplikace.

  3. Nakonfigurujte následující tři vlastní adresy URL pro přesměrování:
    https://vscode.dev/redirect
    http://localhost
    ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>

    Nahraďte <application-client-id> ID klienta této aplikace. Tuto hodnotu najdete na stránce Přehled registrace aplikace.

Umožněte přihlášení uživatelům a skupinám Microsoft Entra do portálu API Center.

Podnikoví vývojáři se musí přihlásit pomocí účtu Microsoft, aby viděli zobrazení portálu API Center pro vaše centrum rozhraní API. Pokud je to potřebné, přidejte nebo pozvěte vývojáře do tenanta Microsoft Entra.

Pokud chcete povolit přihlášení k portálu SLUŽBY API Center pro přístup k rozhraním API, přiřaďte uživatelům nebo skupinám ve vaší organizaci roli Čtenář dat služby Azure API Center , která je vymezená na centrum rozhraní API.

Důležité

Ve výchozím nastavení se vy a další správci centra rozhraní API musíte přihlásit, abyste měli přístup k rozhraním API na portálu API Center. Nezapomeňte přiřadit roli Čtenář dat ve službě Azure API Center sobě a dalším správcům.

Podrobné požadavky a kroky pro přiřazení role uživatelům a skupinám najdete v tématu Přiřazení rolí Azure pomocí webu Azure Portal. Stručné kroky:

  1. Na webu Azure Portal přejděte do centra rozhraní API.
  2. V nabídce vlevo vyberte Řízení přístupu (IAM)>+ Přidat přiřazení role.
  3. V podokně Přidat přiřazení role nastavte hodnoty následujícím způsobem:
    1. Na stránce Role vyhledejte a vyberte Azure API Center Data Reader. Vyberte Další.
    2. Na stránce Členové v Přiřadit přístup k vyberte Uživatel, skupina nebo instanční objekt>+ Vyberte členy.
    3. Na stránce Vyberte členy vyhledejte a vyberte uživatele nebo skupiny, ke kterému chcete roli přiřadit. Klikněte na Vybrat a pak na Další.
    4. Zkontrolujte přiřazení role a vyberte Zkontrolovat a přiřadit.

Poznámka:

Pokud chcete zjednodušit konfiguraci přístupu pro nové uživatele, doporučujeme přiřadit roli skupině Microsoft Entra a nakonfigurovat pravidlo dynamického členství ve skupině. Další informace najdete v tématu Vytvoření nebo aktualizace dynamické skupiny vMicrosoft Entra ID .

Po nakonfigurování přístupu k portálu se nakonfigurovaní uživatelé můžou přihlásit k portálu a zobrazit rozhraní API v centru rozhraní API.

Poznámka:

První uživatel, který se přihlásí k portálu, se zobrazí výzva k vyjádření souhlasu s oprávněními požadovanými registrací aplikace portálu API Center. Další nakonfigurovaní uživatelé pak nebudou vyzváni k vyjádření souhlasu.

Postup pro podnikové vývojáře pro přístup k zobrazení portálu API Center

Vývojáři se můžou pomocí tohoto postupu připojit k zobrazení portálu API Center a přihlásit se k němu pomocí rozšíření Visual Studio Code. Nastavení pro připojení k centru rozhraní API musí poskytnout správce centra rozhraní API. Po připojení můžou vývojáři zjišťovat a využívat rozhraní API v centru rozhraní API.

Připojení k centru rozhraní API

  1. V editoru Visual Studio Code na panelu aktivit na levé straně vyberte Centrum rozhraní API.

    snímek obrazovky s ikonou Centra rozhraní API na panelu aktivit.

  2. K otevření palety příkazů použijte klávesovou zkratku Ctrl+Shift+P . Zadejte Azure API Center: Připojte se k centru rozhraní API a stiskněte Enter.

  3. Odpovězte na výzvy k zadání následujících informací:

    1. Adresa URL runtime vašeho centra API ve formátu <service name>.data.<region>.azure-apicenter.ms (nepřidávejte předponu https://). Příklad: contoso-apic.data.eastus.azure-apicenter.ms. Tato adresa URL modulu runtime se zobrazí na stránce Přehled centra rozhraní API v zobrazení webu Azure Portal.

    2. ID aplikace (klienta) z registrace aplikace nakonfigurované správcem v předchozí části.

    3. ID adresáře (tenanta) z registrace aplikace nakonfigurované správcem v předchozí části.

    Návod

    Správce centra rozhraní API musí vývojářům poskytnout předchozí podrobnosti o připojení nebo poskytnout přímý odkaz v následujícím formátu:
    vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

    Po připojení k centru rozhraní API se název centra rozhraní API zobrazí v zobrazení portálu API Center.

  4. Pokud chcete zobrazit API v centru API, pod názvem centra API vyberte Přihlásit se k Azure. Přihlášení je povolené pomocí účtu Microsoft, který má přiřazenou roli Data Reader služby Azure API Center v centru rozhraní API.

    Snímek obrazovky se zobrazením portálu API Center v rozšíření API Center

  5. Po přihlášení vyberte API k zobrazení rozhraní API v centru API. Rozšířením rozhraní API prozkoumejte jeho verze a definice.

    Snímek obrazovky s definicemi rozhraní API Center API v rozšíření API Center

  6. Pokud je nakonfigurovaný přístup, zopakujte předchozí kroky a připojte se k více centerm rozhraní API.

Zjišťování a využívání rozhraní API v zobrazení portálu API Center

Zobrazení portálu API Center pomáhá podnikovým vývojářům zjišťovat podrobnosti rozhraní API a spouštět vývoj klientů rozhraní API. Vývojáři mají přístup k následujícím funkcím tak, že v zobrazení portálu API Center kliknou pravým tlačítkem na definici rozhraní API:

  • dokument specifikace rozhraní API pro export – Export specifikace rozhraní API z definice a jeho následné stažení jako souboru
  • Generovat klienta rozhraní API – pomocí rozšíření Microsoft Kiota vygenerujte klienta rozhraní API pro svůj oblíbený jazyk.
  • Generování Markdownu – Generování API dokumentace ve formátu Markdown
  • dokumentaci OpenAPI – Zobrazte dokumentaci pro definici rozhraní API a vyzkoušejte operace v uživatelském rozhraní Swagger (k dispozici pouze pro definice OpenAPI).

Použití nástrojů jazykového modelu

Vývojáři s přístupem k zobrazení portálu API Center můžou přidat nástroje jazykového modelu služby API Center pro použití v režimu agenta GitHub Copilotu. Přečtěte si další informace o používání nástrojů v režimu agenta.

Nástroje služby API Center je možné použít v režimu agenta, které vám pomůžou hledat rozhraní API a verze rozhraní API, definice rozhraní API a specifikace, nasazení a další možnosti s využitím výzev přirozeného jazyka.

Přidání a použití nástrojů jazykového režimu centra API v režimu agenta GitHub Copilotu:

  1. Připojte se k centru rozhraní API , jak je popsáno v předchozí části.

  2. Otevřete GitHub Copilot Chat v editoru Visual Studio Code.

  3. Nastavte režim GitHub Copilot Chatu na Agent.

  4. V okně chatu vyberte ikonu Nástroje .

    Snímek obrazovky s oknem chatu GitHub Copilot v editoru Visual Studio Code

  5. Vyberte jeden nebo více nástrojů centra API, které chcete mít k dispozici v chatu.

    Snímek obrazovky s výběrem nástrojů Centra rozhraní API v editoru Visual Studio Code

  6. Zadáním výzvy v okně chatu použijte dostupné nástroje. Například:

    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. Projděte si odpovědi z GitHub Copilot Chatu. Pokračujte v konverzaci a upřesněte výsledky nebo se ptejte na následné otázky.

Řešení problémů

Nejde se přihlásit k Azure

Pokud uživatelé, kteří mají přiřazenou roli Čtenář dat ve službě Azure API Center , nemůžou dokončit tok přihlášení po výběru možnosti Přihlásit se k Azure v zobrazení portálu API Center, může dojít k potížím s konfigurací připojení.

Zkontrolujte nastavení v registraci aplikace, kterou jste nakonfigurovali v ID Microsoft Entra. Potvrďte hodnoty ID aplikace (klienta) a ID adresáře (tenanta) v registraci aplikace a URL runtime centra rozhraní API. Pak znovu nastavte připojení k centru rozhraní API.

Související obsah

  • Last updated on