Megosztás a következőn keresztül:

Azure API Management fejlesztői portál – gyakori kérdések

  • Cikk

A KÖVETKEZŐKRE VONATKOZIK: Fejlesztő | Alapszintű | Alapszintű v2 | Standard | Standard v2 | Prémium

Mi a teendő, ha olyan funkciókra van szükségem, amelyek nem támogatottak a portálon?

Az alábbi lehetőségek állnak rendelkezésére:

  • Kis testreszabások esetén egy beépített widgettel adhat hozzá egyéni HTML-t. Az egyéni HTML-kód widget jelenleg nem érhető el az API Management v2 szintjeiben.

  • A nagyobb testreszabások érdekében hozzon létre és töltsön fel egy egyéni widgetet a felügyelt fejlesztői portálra. Az egyéni widgetek jelenleg nem érhetők el az API Management v2 szintjeiben.

  • A fejlesztői portál önkiszolgáló üzemeltetése csak akkor, ha módosítania kell a fejlesztői portál kódbázisának magját.

  • Nyisson meg egy funkciókérést a GitHub-adattárban.

További információ a fejlesztői portál funkcióinak testreszabásáról és kibővítéséről .

Rendelkezhetek több fejlesztői portállal egy API Management szolgáltatásban?

Egy felügyelt portál és több saját üzemeltetésű portál is lehet. Az összes portál tartalma ugyanabban az API Management szolgáltatásban van tárolva, így azok azonosak lesznek. Ha meg szeretné különböztetni a portálok megjelenését és funkcióit, saját egyéni widgetekkel üzemeltetheti őket, amelyek dinamikusan testre szabják a futtatókörnyezet lapjait, például az URL-cím alapján.

Támogatja a portál az Azure Resource Manager-sablonokat, és/vagy kompatibilis az API Management DevOps Resource Kittel?

Szám

A portál tartalma az API Management biztonsági mentési/visszaállítási funkciójával van mentve?

Szám

Engedélyezni kell további virtuális hálózati kapcsolatokat a felügyelt portál függőségeihez?

A legtöbb esetben - nem.

Ha az API Management szolgáltatás egy belső virtuális hálózaton található, a fejlesztői portál csak a hálózaton belülről érhető el. A felügyeleti végpont gazdagépének nevét a szolgáltatás belső VIP-címére kell feloldani a portál felügyeleti felületének eléréséhez használt gépről. Győződjön meg arról, hogy a felügyeleti végpont regisztrálva van a DNS-ben. Hibás konfiguráció esetén a következő hibaüzenet jelenik meg: Unable to start the portal. See if settings are specified correctly in the configuration (...).

Ha az API Management szolgáltatás egy belső virtuális hálózaton található, és az Application Gatewayen keresztül éri el az internetről, győződjön meg arról, hogy engedélyezi a kapcsolatot a fejlesztői portállal és az API Management felügyeleti végpontjaival. Előfordulhat, hogy le kell tiltania a webalkalmazási tűzfalszabályokat. További részletekért tekintse meg ezt a dokumentációs cikket .

Hozzárendeltem egy egyéni API Management-tartományt, és a közzétett portál nem működik

A tartomány frissítése után újra közzé kell tennie a portált a módosítások érvénybe lépéséhez.

Hozzáadtam egy identitásszolgáltatót, és nem látom a portálon

Miután konfigurált egy identitásszolgáltatót (például Azure AD, Azure AD B2C), újra közzé kell tennie a portált a módosítások érvénybe lépéséhez. Győződjön meg arról, hogy a fejlesztői portál oldalai tartalmazzák az OAuth gomb widgetet.

Beállítottam a delegálást, és a portál nem használja

A delegálás beállítása után újra közzé kell tennie a portált a módosítások érvénybe lépéséhez.

A többi API Management-konfigurációs módosítás nem lett propagálása a fejlesztői portálon

A legtöbb konfigurációmódosításhoz (például virtuális hálózat, bejelentkezés, termékfeltételek) újra közzé kell tennie a portált.

CORS-hiba jelenik meg az interaktív konzol használatakor

Az interaktív konzol ügyféloldali API-kérést küld a böngészőből. A CORS-probléma megoldásához adjon hozzá egy CORS-szabályzatot az API-khoz, vagy konfigurálja a portált CORS-proxy használatára. További információ: Cors engedélyezése interaktív konzolhoz az API Management fejlesztői portálján.

CORS-hibát kapok az egyéni HTML-kód widget használatakor

Ha az egyéni HTML-kód widgetet használja a környezetében, cors-hiba jelenhet meg a widget által betöltött IFrame használatakor. Ez a probléma azért fordul elő, mert az IFrame a fejlesztői portáltól eltérő forrásból származó tartalmat szolgál ki. A probléma elkerülése érdekében használhat helyette egy egyéni widgetet.

Milyen engedélyekre van szükségem a fejlesztői portál szerkesztéséhez?

Ha a Oops. Something went wrong. Please try again later. portál felügyeleti módban való megnyitásakor hibaüzenet jelenik meg, előfordulhat, hogy nem rendelkezik a szükséges engedélyekkel (Azure RBAC).

A portálhoz a hatókör /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1engedélyére Microsoft.ApiManagement/service/users/token/action van szükség.

A következő PowerShell-szkripttel létrehozhat egy szerepkört a szükséges engedélyekkel. Ne felejtse el módosítani a paramétert <subscription-id> .

#New Portals Admin Role 
Import-Module Az 
Connect-AzAccount 
$contributorRole = Get-AzRoleDefinition "API Management Service Contributor" 
$customRole = $contributorRole 
$customRole.Id = $null
$customRole.Name = "APIM New Portal Admin" 
$customRole.Description = "This role gives the user ability to log in to the new Developer portal as administrator" 
$customRole.Actions = "Microsoft.ApiManagement/service/users/token/action" 
$customRole.IsCustom = $true 
$customRole.AssignableScopes.Clear() 
$customRole.AssignableScopes.Add('/subscriptions/<subscription-id>') 
New-AzRoleDefinition -Role $customRole

A szerepkör létrehozása után az Azure Portal hozzáférés-vezérlési (IAM) szakaszában bármely felhasználónak megadhatja. Ha ezt a szerepkört egy felhasználóhoz rendeli, az engedélyt a szolgáltatás hatókörében rendeli hozzá. A felhasználó sas-jogkivonatokat hozhat létre a szolgáltatás bármely felhasználója nevében. Ezt a szerepkört legalább a szolgáltatás rendszergazdájához kell rendelni. Az alábbi PowerShell-parancs bemutatja, hogyan rendelheti hozzá a szerepkört a legalacsonyabb hatókörű felhasználóhoz user1 , hogy ne adjon szükségtelen engedélyeket a felhasználónak:

New-AzRoleAssignment -SignInName "user1@contoso.com" -RoleDefinitionName "APIM New Portal Admin" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1"

Miután megadta az engedélyeket egy felhasználónak, a felhasználónak ki kell jelentkeznie, és újra be kell jelentkeznie az Azure Portalra az új engedélyek érvénybe lépéséhez.

A hiba jelenik meg Unable to start the portal. See if settings are specified correctly (...)

Ez a hiba akkor jelenik meg, ha egy GET hívás https://<management-endpoint-hostname>/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.ApiManagement/service/xxx/contentTypes/document/contentItems/configuration?api-version=2018-06-01-preview meghiúsul. A hívást a portál felügyeleti felülete adja ki a böngészőből.

Ha az API Management szolgáltatás egy virtuális hálózaton található, tekintse meg a virtuális hálózatok csatlakozási kérdését.

A híváshibát okozhatja egy TLS/SSL-tanúsítvány is, amely egy egyéni tartományhoz van rendelve, és a böngésző nem megbízható. Kockázatcsökkentésként eltávolíthatja a felügyeleti végpont egyéni tartományát. Az API Management egy megbízható tanúsítvánnyal vissza fog esni az alapértelmezett végpontra.

Mi a portál böngészőtámogatása?

Böngésző Támogatott
Apple Safari Igen1
Google Chrome Igen1
Microsoft Edge Igen1
Microsoft Internet Explorer Nem
Mozilla Firefox Igen1

1 A két legújabb éles verzió támogatott.

A saját üzemeltetésű portál helyi fejlesztése már nem működik

Ha a fejlesztői portál helyi verziója nem tud adatokat menteni vagy lekérni a tárfiókból vagy az API Management-példányból, előfordulhat, hogy az SAS-jogkivonatok lejártak. Ezt új jogkivonatok létrehozásával javíthatja. Útmutatásért tekintse meg a fejlesztői portál önkiszolgáló üzemeltetésére vonatkozó oktatóanyagot.

Hogyan tiltsa le a regisztrációt a fejlesztői portálon?

Ha nincs szüksége a fejlesztői portálon alapértelmezés szerint engedélyezett regisztrációs funkciókra, letilthatja az alábbi lépésekkel:

  1. Az Azure Portalon keresse meg az API Management-példányt.

  2. A menü Fejlesztői portál területén válassza az Identitások lehetőséget.

  3. Törölje a listában megjelenő összes identitásszolgáltatót. Jelölje ki az egyes szolgáltatókat, válassza a helyi menüt (...), majd a Törlés lehetőséget.

    Identitásszolgáltatók törlése

  4. Lépjen a fejlesztői portál felügyeleti felületére.

  5. Távolítsa el a regisztrációs hivatkozásokat és a navigációs elemeket a portál tartalmában. A portál tartalmának testreszabásával kapcsolatos információkért tekintse meg az oktatóanyagot: A fejlesztői portál elérése és testreszabása.

  6. Módosítsa a Regisztrációs lap tartalmát, hogy eltávolítsa az identitásadatok megadásához használt mezőket, ha a felhasználók közvetlenül hozzá navigálnak.

    Ha szükséges, törölje a Regisztrációs lapot. Jelenleg a contentItem REST API-kkal listázhatja és törölheti ezt a lapot.

  7. Mentse a módosításokat, és tegye közzé újra a portált.

Hogyan távolíthatom el az API Management szolgáltatás számára kiépített fejlesztői portál tartalmát?

Adja meg a szükséges paramétereket a szkriptben a scripts.v3/cleanup.bat GitHub fejlesztői portál adattárában, és futtassa a szkriptet

cd scripts.v3
.\cleanup.bat
cd ..

Hogyan engedélyezi az egyszeri bejelentkezéses (SSO) hitelesítést a saját üzemeltetésű fejlesztői portálon?

Más hitelesítési módszerek mellett a fejlesztői portál támogatja az egyszeri bejelentkezést (SSO). Ha ezzel a módszerrel szeretne hitelesítést végezni, a lekérdezési paraméter jogkivonatával kell hívást kezdeményeznie /signin-sso :

https://contoso.com/signin-sso?token=[user-specific token]

Felhasználói jogkivonatok létrehozása

Felhasználóspecifikus jogkivonatokat (beleértve a rendszergazdai jogkivonatokat) az API Management REST API Közös hozzáférésű jogkivonat lekérése műveletével hozhat létre.

Feljegyzés

A jogkivonatnak URL-kódolásúnak kell lennie.

Kapcsolódó tartalom

További információ a fejlesztői portálról:

Tallózás más erőforrások között: