Hantera API-nycklar

PowerShell-galleriet har stöd för att skapa flera API-nycklar för att stödja en rad olika publiceringskrav. En API-nyckel kan gälla för ett eller flera paket, bevilja specifika behörigheter och har ett förfallodatum.

Viktigt

Användare som publicerade till PowerShell-galleriet innan api-nycklar med omfång introducerades har en "API-nyckel för fullständig åtkomst". De fullständiga åtkomstnycklarna har inte de säkerhetsförbättringar som är inbyggda i api-omfångsnycklar. De fullständiga åtkomstnycklarna upphör aldrig att gälla och gäller för allt som ägs av användaren. Om du tar bort den här nyckeln kan den inte återskapas.

Följande bild visar de alternativ som är tillgängliga när du skapar en API-nyckel med omfång.

I det här exemplet skapade vi en API-nyckel med namnet AzureRMDataFactory. Det här nyckelvärdet kan användas för att skicka paket med namn som börjar med "AzureRM.DataFactory" och som är giltiga i 365 dagar. Det här är ett typiskt scenario när olika team i samma organisation arbetar med olika paket. Medlemmarna i teamet har en nyckel som ger dem behörighet för det specifika paket som de arbetar med. Förfallovärdet förhindrar användning av inaktuella eller bortglömda nycklar.

Använda globmönster

Om du arbetar med flera paket kan du använda globbningsmönster för att matcha flera paket som en grupp. API-nyckelbehörigheter gäller för alla nya paket som matchar globmönstret. I föregående exempel används till exempel Glob Pattern-värdet "AzureRM.DataFactory*". Du kan push-överföra ett paket med namnet "AzureRm.DataFactoryV2.Netcore" med den här nyckeln eftersom paketet matchar globmönstret.

Skapa API-nycklar på ett säkert sätt

För säkerhet visas aldrig ett nyskapat nyckelvärde på skärmen och är endast tillgängligt med knappen Kopiera, som du ser nedan.

Viktigt

Du kan bara kopiera API-nyckelvärdet direkt efter att du har skapat eller uppdaterat det. Den visas inte och kommer inte att vara tillgänglig igen när sidan har uppdaterats. Om du förlorar nyckelvärdet måste du använda Återskapa och kopiera nyckeln när den har återskapats.

Nyckelbehörigheter och förfallodatum

Omfångs-API-nycklar kan tilldela någon av följande behörigheter:

• Skicka nya paket
• Push-överföra nya paket eller uppdateringspaket
• Lista över paket

Varje ny nyckel har en förfallotid. Förfallovärdet mäts i dagar. Möjliga värden för förfallodatum är:

• 1 dag
• 90 dagar
• 180 dagar
• 270 dagar
• 365 dagar (standard)

De här inställningarna kan inte ändras när nyckeln har skapats. Du kan inte skapa en ny nyckel som aldrig upphör att gälla.

Redigera och ta bort befintliga API-nycklar

Du kan ändra vissa inställningar för en befintlig nyckel. Som tidigare nämnts kan du inte ändra säkerhetsomfattningen för en befintlig API-nyckel eller ändra förfallodatumet. De ändringsbara alternativen visas på följande skärmbild:

Om du vill ändra de paket som styrs av en nyckel kan du välja enskilda paket i listan eller ändra globmönstret.

Om du klickar på Återskapa skapas ett nytt nyckelvärde. Precis som när du först skapade nyckeln måste du kopiera nyckelvärdet direkt efter att du har uppdaterat den. Alternativet Kopiera är inte tillgängligt när du lämnar den här sidan.

När du klickar på Ta bort visas ett bekräftelsemeddelande. När en nyckel har tagits bort kan den inte användas.

Nyckeln upphör att gälla

Tio dagar före förfallodatumet skickar PowerShell-galleriet ett varningsmeddelande till kontoinnehavaren av API-nyckeln. Efter förfallodatumet går det inte att använda nyckeln. Ett varningsmeddelande visas överst på sidan API-nyckelhantering som visar vilka nycklar som inte längre är giltiga. Du kan generera ett nytt nyckelvärde.