Zarządzanie kluczami interfejsu APIManaging API keys

Galeria programu PowerShell obsługuje tworzenie wielu kluczy interfejsu API do obsługuje szeroką gamę publikowania wymagania.The PowerShell Gallery supports creating multiple API keys to support a range of publishing requirements. Klucz interfejsu API można zastosować do co najmniej jeden pakiet, udziela określone uprawnienia i ma datę wygaśnięcia.An API key can apply to one or more packages, grants specific privileges, and has an expiration date.

Ważne

Użytkownicy, którzy są publikowane w galerii programu PowerShell, przed wprowadzeniem o określonym zakresie klucze interfejsu API będzie mieć "pełnego dostępu do interfejsu API key".Users who published to the PowerShell Gallery prior to the introduction of scoped API keys will have a "Full access API key". Klucze pełny dostęp nie mają poprawki zabezpieczeń wbudowanych w zakresie klucze interfejsu API.The full access keys do not have the security improvements built into scoped API keys. Klucze pełny dostęp do nigdy nie wygasa i Zastosuj do wszystkich posiadanych przez użytkownika.The full access keys never expires and apply to everything owned by the user. Jeśli usuniesz ten klucz, nie można utworzyć ponownie.If you delete this key, it cannot be recreated.

Na poniższej ilustracji przedstawiono opcje dostępne podczas tworzenia zakresu klucz interfejsu API.The following image shows the options available when creating a scoped API key.

Tworzenie kluczy interfejsu API

W tym przykładzie utworzyliśmy klucza interfejsu API o nazwie AzureRMDataFactory.In this example, we created an API key named AzureRMDataFactory. Ta wartość klucza może służyć do wypychania pakietów, których nazwy zaczynają się od "AzureRM.DataFactory" i jest ważny przez 365 dni.This key value can be used to push packages with names that begin with 'AzureRM.DataFactory' and is valid for 365 days. Jest to typowy scenariusz, gdy różne zespoły w obrębie tej samej organizacji działają na różnych pakietach.This is a typical scenario when different teams within the same organization work on different packages. Członkowie zespołu mają klucz, który przyznaje im uprawnienia dla określonego pakietu, które działają z.The members of the team have a key that grants them privileges for the specific package they work on. Wartość wygaśnięcia uniemożliwia użycie starych lub zapomniane kluczy.The expiration value prevents the use of stale or forgotten keys.

Przy użyciu wzorców globUsing glob patterns

Jeśli pracujesz na wielu pakietów, można użyć wzorców obsługi symboli wieloznacznych do dopasowania wielu pakietów jako grupa.If you work on multiple packages, you can use globbing patterns to match multiple packages as a group. Uprawnienia klucza interfejsu API dotyczą wszystkie nowe pakiety pasujących do wzorca glob.API key permissions apply to all new packages matching the glob pattern. Na przykład w poprzednim przykładzie użyto wzorzec Glob wartość "AzureRM.DataFactory*".For example, the previous example uses a Glob Pattern value of 'AzureRM.DataFactory*'. Możesz wypychać pakietu o nazwie "AzureRm.DataFactoryV2.Netcore" przy użyciu tego klucza, ponieważ pakiet jest zgodny ze wzorcem glob.You can push a package named 'AzureRm.DataFactoryV2.Netcore' using this key since the package matches the glob pattern.

Bezpiecznie Utwórz klucze interfejsu APICreate API keys securely

Dla bezpieczeństwa nowo utworzoną wartość klucza nigdy nie są wyświetlane na ekranie i jest dostępna tylko z przycisku kopiowania, jak pokazano poniżej.For security, a newly created key value is never shown on the screen and is only available with the Copy button, as shown below.

Uzyskiwanie nową wartość klucza interfejsu API

Ważne

Wartość klucza interfejsu API można kopiować tylko natychmiast po utworzeniu, lub Odśwież go.You can only copy the API key value immediately after creating or refreshing it. Nie będą wyświetlane i nie będzie dostępny ponownie po odświeżeniu strony.It will not be displayed, and will not be accessible again after the page is refreshed. Jeśli zgubisz wartości klucza, należy użyć Wygeneruj ponownie klucz i skopiuj klucz, po zostanie ponownie wygenerowany.If you lose the key value, you must use Regenerate, and copy the key after it is regenerated.

Uprawnienia klucza i wygaśnięciaKey permissions and expiration

O określonym zakresie klucze interfejsu API można przypisać dowolny z następujących uprawnień:Scoped API keys can assign any of the following permissions:

  • Wypychanie nowych pakietówPush new packages
  • Wypychanie nowych lub pakietów aktualizacjiPush new or update packages
  • Wyrejestrowanie pakietówUnlist packages

Co nowego klucza ma wygaśnięcia.Every new key has an expiration. Wartość dla wygaśnięcia jest mierzony w dniach.The expiration value is measured in days. Możliwe wartości dla wygaśnięcia to:The possible values for expiration are:

  • 1 dzień1 day
  • 90 dni90 days
  • 180 dni180 days
  • 270 dni270 days
  • 365 dni (ustawienie domyślne)365 days (default)

Nie można zmienić tych ustawień, gdy klucz zostanie utworzony.These settings cannot be changed once the key is created. Nie można utworzyć nowego klucza, który nigdy nie wygasa.You cannot create a new key that never expires.

Edytowanie i usuwanie istniejących kluczy interfejsu APIEditing and deleting existing API keys

Można zmienić niektórych ustawień istniejącego klucza.You can change some settings of an existing key. Jak wspomniano wcześniej nie można zmodyfikować zakresu zabezpieczeń dla istniejącego klucza interfejsu API lub zmienić czas wygaśnięcia.As previously noted, you cannot modify the security scope for an existing API key or change the expiration. Opcje mogły być zmieniane są wyświetlane w poniższy zrzut ekranu:The changeable options are shown in the following screenshot:

Uzyskiwanie nową wartość klucza interfejsu API

Aby zmienić pakietów kontrolowane za pomocą klucza, można wybrać indywidualnych pakietów z listy lub zmień wzorzec glob.To change the packages controlled by a key, you can choose individual packages from the list or change the glob pattern.

Klikając ponownie wygenerować tworzy nową wartość klucza.Clicking Regenerate creates a new key value. Tak samo jak w przypadku początkowo utworzono klucz, należy najpierw kopiowania wartość klucza natychmiast po jego aktualizacji.Just like when you initially created the key, you must Copy the key value immediately after updating it. Kopiowania opcja jest niedostępna, gdy opuścisz tę stronę.The Copy option is not available once you leave this page.

Klikając Usuń zostanie wyświetlony komunikat potwierdzenia.Clicking Delete displays a confirmation message. Po usunięciu klucz będzie można jej używać.Once a key is deleted, it will be unusable.

Data wygaśnięcia kluczaKey expiration

Dziesięć dni przed wygaśnięciem, galerii programu PowerShell wysyła ostrzegawcza wiadomość e-mail właściciela konta, klucza interfejsu API.Ten days before the expiration, the PowerShell Gallery sends a warning email the account holder of the API key. Po wygaśnięciu klucza jest bezużyteczny.After expiration, the key is unusable. Ostrzeżenie jest wyświetlane u góry strony zarządzania kluczami interfejsu API, które są wyświetlane klucze, które nie są już prawidłowe.A warning message is displayed at the top of the API key management page showing which keys are no longer valid. Można wygenerować nową wartość klucza.You can generate a new key value.