Správa klíčů rozhraní API

Galerie prostředí PowerShell podporuje vytváření více klíčů rozhraní API pro zajištění podpory řady požadavků na publikování. Klíč rozhraní API se může vztahovat na jeden nebo více balíčků, uděluje konkrétní oprávnění a má datum vypršení platnosti.

Důležité

Uživatelé, kteří publikovali na Galerie prostředí PowerShell před zavedením klíčů rozhraní API s vymezeným oborem, budou mít úplný přístupový klíč rozhraní API. Úplné přístupové klíče nemají vylepšení zabezpečení integrovaná do klíčů rozhraní API s vymezeným oborem. Platnost úplných přístupových klíčů nikdy nevyprší a platí pro všechno, co vlastní uživatel. Pokud tento klíč odstraníte, nebude možné ho znovu vytvořit.

Následující obrázek ukazuje možnosti dostupné při vytváření klíče rozhraní API s vymezeným oborem.

V tomto příkladu jsme vytvořili klíč rozhraní API s názvem AzureRMDataFactory. Tuto hodnotu klíče je možné použít k nabízení balíčků s názvy, které začínají na AzureRM.DataFactory a jsou platné po dobu 365 dnů. Jedná se o typický scénář, kdy různé týmy ve stejné organizaci pracují na různých balíčcích. Členové týmu mají klíč, který jim uděluje oprávnění ke konkrétnímu balíčku, na který pracují. Hodnota vypršení platnosti zabraňuje použití zastaralých nebo zapomenutých klíčů.

Použití vzorů globů

Pokud pracujete na více balíčcích, můžete použít vzory globbingu, aby se více balíčkům jako skupině spárovaly. Oprávnění ke klíči rozhraní API se vztahují na všechny nové balíčky, které odpovídají vzoru globu. Například předchozí příklad používá hodnotu Glob Pattern AzureRM.DataFactory*. Pomocí tohoto klíče můžete odeslat balíček s názvem AzureRm.DataFactoryV2.Netcore, protože balíček odpovídá vzoru globu.

Bezpečné vytvoření klíčů rozhraní API

Z důvodu zabezpečení se nově vytvořená hodnota klíče nikdy nezobrazuje na obrazovce a je k dispozici pouze pomocí tlačítka Kopírovat, jak je znázorněno níže.

Důležité

Hodnotu klíče rozhraní API můžete zkopírovat pouze okamžitě po jejím vytvoření nebo aktualizaci. Nezobrazí se a po aktualizaci stránky nebude znovu přístupný. Pokud ztratíte hodnotu klíče, musíte použít příkaz Znovu vygenerovat a po vygenerování klíče zkopírovat.

Oprávnění ke klíči a vypršení platnosti

Klíče rozhraní API s vymezeným oborem můžou přiřadit některá z následujících oprávnění:

• Nabízení nových balíčků
• Nabízení nových nebo aktualizačních balíčků
• Zrušení seznamu balíčků

Platnost každého nového klíče vyprší. Hodnota vypršení platnosti se měří ve dnech. Možné hodnoty pro vypršení platnosti jsou:

• 1 den
• 90 dnů
• 180 dnů
• 270 dní
• 365 dnů (výchozí)

Tato nastavení nelze po vytvoření klíče změnit. Nemůžete vytvořit nový klíč, jehož platnost nikdy nevyprší.

Úprava a odstranění existujících klíčů rozhraní API

Některá nastavení existujícího klíče můžete změnit. Jak už jsme uvedli, nemůžete změnit obor zabezpečení pro existující klíč rozhraní API ani změnit vypršení platnosti. Změnitelné možnosti jsou zobrazené na následujícím snímku obrazovky:

Pokud chcete změnit balíčky řízené klíčem, můžete zvolit jednotlivé balíčky ze seznamu nebo změnit vzor globu.

Kliknutím na Znovu vygenerovat vytvoříte novou hodnotu klíče. Stejně jako při počátečním vytvoření klíče musíte hodnotu klíče zkopírovat hned po jeho aktualizaci. Možnost Kopírovat nebude po opuštění této stránky dostupná.

Po kliknutí na Odstranit se zobrazí potvrzovací zpráva. Jakmile se klíč odstraní, bude nepoužitelný.

Vypršení platnosti klíče

Deset dní před vypršením platnosti odešle Galerie prostředí PowerShell držiteli klíče rozhraní API e-mail s upozorněním. Po vypršení platnosti je klíč nepoužitelný. V horní části stránky správy klíčů rozhraní API se zobrazí zpráva upozornění, které klíče už nejsou platné. Můžete vygenerovat novou hodnotu klíče.