Share via


API-kulcsok kezelése

A PowerShell-galéria több API-kulcs létrehozását is támogatja a közzétételi követelmények széles körének támogatásához. Egy API-kulcs vonatkozhat egy vagy több csomagra, adott jogosultságokat biztosít, és lejárati dátummal rendelkezik.

Fontos

Azok a felhasználók, akik a hatókörrel rendelkező API-kulcsok bevezetése előtt tették közzé a PowerShell-galéria, "Teljes hozzáférésű API-kulccsal" rendelkeznek. A teljes hozzáférési kulcsok nem rendelkeznek a hatókörrel rendelkező API-kulcsokba beépített biztonsági fejlesztésekkel. A teljes hozzáférési kulcsok soha nem járnak le, és a felhasználó tulajdonában lévő összes elemre érvényesek. Ha törli ezt a kulcsot, az nem hozható létre újra.

Az alábbi képen a hatókörrel rendelkező API-kulcsok létrehozásakor elérhető lehetőségek láthatók.

API-kulcsok létrehozása

Ebben a példában létrehoztunk egy AzureRMDataFactory nevű API-kulcsot. Ez a kulcsérték olyan csomagok leküldésére használható, amelyek neve "AzureRM.DataFactory" kezdetű, és 365 napig érvényes. Ez egy tipikus forgatókönyv, amikor az egyazon szervezeten belüli különböző csapatok különböző csomagokon dolgoznak. A csapat tagjai rendelkeznek egy kulccsal, amely jogosultságokat biztosít számukra ahhoz a csomaghoz, amelyen dolgoznak. A lejárati érték megakadályozza az elavult vagy elfelejtett kulcsok használatát.

Glob-minták használata

Ha több csomagon dolgozik, a több csomag csoportként való megfeleltetéséhez használjon összecsukási mintákat. Az API-kulcsengedélyek a glob mintának megfelelő összes új csomagra vonatkoznak. Az előző példában például az "AzureRM.DataFactory*" Glob Pattern értéke szerepel. Ezzel a kulccsal leküldhet egy "AzureRm.DataFactoryV2.Netcore" nevű csomagot, mivel a csomag megegyezik a glob mintával.

API-kulcsok biztonságos létrehozása

A biztonság érdekében az újonnan létrehozott kulcsérték soha nem jelenik meg a képernyőn, és csak a Másolás gombbal érhető el, ahogy az alább látható.

Új API-kulcs értékének beszerzése

Fontos

Az API-kulcs értékét csak közvetlenül a létrehozása vagy frissítése után másolhatja. Nem jelenik meg, és a lap frissítése után nem lesz ismét elérhető. Ha elveszíti a kulcs értékét, az Újragenerálás parancsot kell használnia, és az újragenerálás után ki kell másolnia a kulcsot.

Kulcsengedélyek és lejárat

A hatókörrel rendelkező API-kulcsok a következő engedélyek bármelyikét hozzárendelhetik:

  • Új csomagok leküldése
  • Új vagy frissítési csomagok leküldése
  • Csomagok listának megszüntetése

Minden új kulcsnak lejárata van. A lejárati értéket napokban méri a függvény. A lejárat lehetséges értékei a következők:

  • 1 nap
  • 90 nap
  • 180 nap
  • 270 nap
  • 365 nap (alapértelmezett)

Ezek a beállítások a kulcs létrehozása után nem módosíthatók. Nem hozhat létre olyan új kulcsot, amely soha nem jár le.

Meglévő API-kulcsok szerkesztése és törlése

Egy meglévő kulcs egyes beállításait módosíthatja. Ahogy korábban említettük, a meglévő API-kulcsok biztonsági hatókörét nem módosíthatja, és nem módosíthatja a lejáratot. A módosítható beállítások az alábbi képernyőképen láthatók:

Az API-kulcs értékének szerkesztése

A kulcs által vezérelt csomagok módosításához választhatja ki az egyes csomagokat a listából, vagy módosíthatja a glob mintát.

Az Újragenerálás gombra kattintva létrehoz egy új kulcsértéket. Ugyanúgy, mint amikor először létrehozta a kulcsot, a frissítés után azonnal át kell másolnia a kulcs értékét. A Lap elhagyása után a Másolás lehetőség nem érhető el.

A Törlés gombra kattintva megjelenik egy megerősítést kérő üzenet. A kulcs törlése után az nem használható.

Kulcs lejárata

Tíz nappal a lejárat előtt a PowerShell-galéria figyelmeztető e-mailt küld az API-kulcs tulajdonosának. A lejárat után a kulcs nem használható. Az API-kulcskezelés oldalának tetején megjelenik egy figyelmeztető üzenet, amely jelzi, hogy mely kulcsok már nem érvényesek. Létrehozhat egy új kulcsértéket.