Zarządzanie kluczami interfejsu API

Galeria programu PowerShell obsługuje tworzenie wielu kluczy interfejsu API w celu obsługi szeregu wymagań dotyczących publikowania. Klucz interfejsu API może dotyczyć co najmniej jednego pakietu, udziela określonych uprawnień i ma datę wygaśnięcia.

Ważne

Użytkownicy, którzy opublikowali Galeria programu PowerShell przed wprowadzeniem kluczy interfejsu API o określonym zakresie, będą mieli "Pełny klucz interfejsu API dostępu". Klucze pełnego dostępu nie mają ulepszeń zabezpieczeń wbudowanych w klucze interfejsu API o określonym zakresie. Pełne klucze dostępu nigdy nie wygasają i mają zastosowanie do wszystkich elementów należących do użytkownika. Jeśli usuniesz ten klucz, nie można go ponownie utworzyć.

Na poniższej ilustracji przedstawiono opcje dostępne podczas tworzenia klucza interfejsu API o określonym zakresie.

W tym przykładzie utworzyliśmy klucz interfejsu API o nazwie AzureRMDataFactory. Ta wartość klucza może służyć do wypychania pakietów z nazwami rozpoczynającymi się od "AzureRM.DataFactory" i jest ważna przez 365 dni. Jest to typowy scenariusz, w przypadku gdy różne zespoły w tej samej organizacji pracują nad różnymi pakietami. Członkowie zespołu mają klucz, który przyznaje im uprawnienia do określonego pakietu, nad którymi pracują. Wartość wygaśnięcia uniemożliwia używanie nieaktualnych lub zapomnianych kluczy.

Używanie wzorców globu

Jeśli pracujesz nad wieloma pakietami, możesz użyć wzorców globbingu, aby dopasować wiele pakietów jako grupę. Uprawnienia klucza interfejsu API mają zastosowanie do wszystkich nowych pakietów pasujących do wzorca globu. Na przykład w poprzednim przykładzie użyto wartości wzorzec globu "AzureRM.DataFactory*". Możesz wypchnąć pakiet o nazwie "AzureRm.DataFactoryV2.Netcore" przy użyciu tego klucza, ponieważ pakiet jest zgodny ze wzorcem globu.

Bezpieczne tworzenie kluczy interfejsu API

W przypadku zabezpieczeń nowo utworzona wartość klucza nigdy nie jest wyświetlana na ekranie i jest dostępna tylko za pomocą przycisku Kopiuj, jak pokazano poniżej.

Ważne

Wartość klucza interfejsu API można skopiować bezpośrednio po jego utworzeniu lub odświeżeniu. Nie będzie on wyświetlany i nie będzie dostępny ponownie po odświeżeniu strony. Jeśli utracisz wartość klucza, musisz użyć opcji Regeneruj ponownie i skopiuj klucz po jego wygenerowaniu.

Uprawnienia klucza i wygaśnięcie

Klucze interfejsu API o określonym zakresie mogą przypisywać dowolne z następujących uprawnień:

• Wypychanie nowych pakietów
• Wypychanie nowych lub aktualizacji pakietów
• Wyrejesowywanie pakietów

Każdy nowy klucz ma wygaśnięcie. Wartość wygaśnięcia jest mierzona w dniach. Możliwe wartości wygaśnięcia to:

• 1 dzień
• 90 dni
• 180 dni
• 270 dni
• 365 dni (wartość domyślna)

Nie można zmienić tych ustawień po utworzeniu klucza. Nie można utworzyć nowego klucza, który nigdy nie wygasa.

Edytowanie i usuwanie istniejących kluczy interfejsu API

Możesz zmienić niektóre ustawienia istniejącego klucza. Jak wspomniano wcześniej, nie można zmodyfikować zakresu zabezpieczeń istniejącego klucza interfejsu API ani zmienić wygaśnięcia. Opcje umożliwiające zmianę są wyświetlane na poniższym zrzucie ekranu:

Aby zmienić pakiety kontrolowane przez klucz, możesz wybrać poszczególne pakiety z listy lub zmienić wzorzec globu.

Kliknięcie przycisku Wygeneruj ponownie powoduje utworzenie nowej wartości klucza. Podobnie jak w przypadku początkowego utworzenia klucza, należy skopiować wartość klucza natychmiast po jego zaktualizowaniu. Opcja Kopiuj nie jest dostępna po opuszczeniu tej strony.

Kliknięcie przycisku Usuń powoduje wyświetlenie komunikatu potwierdzającego. Po usunięciu klucza będzie on bezużyteczny.

Wygaśnięcie klucza

Dziesięć dni przed wygaśnięciem Galeria programu PowerShell wysyła ostrzeżenie e-mail właściciela konta klucza interfejsu API. Po wygaśnięciu klucz jest bezużyteczny. W górnej części strony zarządzania kluczami interfejsu API zostanie wyświetlony komunikat ostrzegawczy pokazujący, które klucze nie są już prawidłowe. Możesz wygenerować nową wartość klucza.