API-sleutels beheren

De PowerShell Gallery ondersteunt het maken van meerdere API-sleutels ter ondersteuning van een reeks publicatievereisten. Een API-sleutel kan worden toegepast op een of meer pakketten, verleent specifieke bevoegdheden en heeft een vervaldatum.

Belangrijk

Gebruikers die naar de PowerShell Gallery hebben gepubliceerd vóór de introductie van API-sleutels met een bereik, hebben een API-sleutel voor volledige toegang. De volledige toegangssleutels hebben niet de beveiligingsverbeteringen die zijn ingebouwd in api-sleutels met bereik. De volledige toegangssleutels verlopen nooit en zijn van toepassing op alles dat eigendom is van de gebruiker. Als u deze sleutel verwijdert, kan deze niet opnieuw worden gemaakt.

In de volgende afbeelding ziet u de opties die beschikbaar zijn bij het maken van een API-sleutel met bereik.

In dit voorbeeld hebben we een API-sleutel gemaakt met de naam AzureRMDataFactory. Deze sleutelwaarde kan worden gebruikt voor het pushen van pakketten met namen die beginnen met 'AzureRM.DataFactory' en is 365 dagen geldig. Dit is een typisch scenario wanneer verschillende teams binnen dezelfde organisatie aan verschillende pakketten werken. De leden van het team hebben een sleutel waarmee ze bevoegdheden krijgen voor het specifieke pakket waaraan ze werken. De vervaldatumwaarde voorkomt het gebruik van verouderde of vergeten sleutels.

Globpatronen gebruiken

Als u aan meerdere pakketten werkt, kunt u globbing-patronen gebruiken om meerdere pakketten als groep te vergelijken. API-sleutelmachtigingen zijn van toepassing op alle nieuwe pakketten die overeenkomen met het glob-patroon. In het vorige voorbeeld wordt bijvoorbeeld de waarde van het Glob-patroon 'AzureRM.DataFactory*' gebruikt. U kunt een pakket met de naam 'AzureRm.DataFactoryV2.Netcore' pushen met behulp van deze sleutel, omdat het pakket overeenkomt met het glob-patroon.

API-sleutels veilig maken

Voor de beveiliging wordt een zojuist gemaakte sleutelwaarde nooit weergegeven op het scherm en is deze alleen beschikbaar met de knop Kopiëren, zoals hieronder wordt weergegeven.

Belangrijk

U kunt de waarde van de API-sleutel alleen direct kopiëren nadat u deze hebt gemaakt of vernieuwd. Deze wordt niet weergegeven en is niet opnieuw toegankelijk nadat de pagina is vernieuwd. Als u de sleutelwaarde kwijtraakt, moet u Opnieuw genereren gebruiken en de sleutel kopiëren nadat deze opnieuw is gegenereerd.

Sleutelmachtigingen en vervaldatum

Api-sleutels met bereik kunnen een van de volgende machtigingen toewijzen:

• Nieuwe pakketten pushen
• Nieuwe pakketten pushen of bijwerken
• Niet-vermelde pakketten

Elke nieuwe sleutel heeft een vervaldatum. De verloopwaarde wordt gemeten in dagen. De mogelijke waarden voor verlooptijd zijn:

• 1 dag
• 90 dagen
• 180 dagen
• 270 dagen
• 365 dagen (standaard)

Deze instellingen kunnen niet worden gewijzigd nadat de sleutel is gemaakt. U kunt geen nieuwe sleutel maken die nooit verloopt.

Bestaande API-sleutels bewerken en verwijderen

U kunt enkele instellingen van een bestaande sleutel wijzigen. Zoals eerder vermeld, kunt u het beveiligingsbereik voor een bestaande API-sleutel niet wijzigen of de vervaldatum wijzigen. De veranderlijke opties worden weergegeven in de volgende schermopname:

Als u de pakketten wilt wijzigen die door een sleutel worden beheerd, kunt u afzonderlijke pakketten in de lijst kiezen of het glob-patroon wijzigen.

Als u op Opnieuw genereren klikt, wordt een nieuwe sleutelwaarde gemaakt. Net als bij het maken van de sleutel, moet u de sleutelwaarde direct na het bijwerken kopiëren . De optie Kopiëren is niet beschikbaar zodra u deze pagina verlaat.

Als u op Verwijderen klikt, wordt een bevestigingsbericht weergegeven. Zodra een sleutel is verwijderd, is deze onbruikbaar.

Vervaldatum van sleutel

Tien dagen vóór de vervaldatum stuurt de PowerShell Gallery een waarschuwingsmail naar de accounthouder van de API-sleutel. Na het verlopen is de sleutel onbruikbaar. Boven aan de pagina API-sleutelbeheer wordt een waarschuwingsbericht weergegeven waarin wordt opgegeven welke sleutels niet meer geldig zijn. U kunt een nieuwe sleutelwaarde genereren.