Gerir chaves de API

  • Artigo

O Galeria do PowerShell suporta a criação de várias chaves de API para suportar uma série de requisitos de publicação. Uma chave de API pode ser aplicada a um ou mais pacotes, concede privilégios específicos e tem uma data de expiração.

Importante

Os utilizadores que publicaram no Galeria do PowerShell antes da introdução das chaves de API no âmbito terão uma "Chave de API de acesso total". As chaves de acesso completas não têm as melhorias de segurança incorporadas em chaves de API no âmbito. As chaves de acesso completas nunca expiram e aplicam-se a tudo o que pertence ao utilizador. Se eliminar esta chave, esta não poderá ser recriada.

A imagem seguinte mostra as opções disponíveis ao criar uma chave de API no âmbito.

Criar chaves de API

Neste exemplo, criámos uma chave de API com o nome AzureRMDataFactory. Este valor chave pode ser utilizado para enviar pacotes com nomes que comecem por "AzureRM.DataFactory" e é válido durante 365 dias. Este é um cenário típico quando diferentes equipas na mesma organização trabalham em pacotes diferentes. Os membros da equipa têm uma chave que lhes concede privilégios para o pacote específico em que trabalham. O valor de expiração impede a utilização de chaves obsoletas ou esquecidas.

Utilizar padrões glob

Se trabalhar em vários pacotes, pode utilizar padrões de recortar para corresponder a vários pacotes como um grupo. As permissões de chave de API aplicam-se a todos os novos pacotes que correspondam ao padrão glob. Por exemplo, o exemplo anterior utiliza um valor de Padrão Glob de "AzureRM.DataFactory*". Pode emitir um pacote com o nome "AzureRm.DataFactoryV2.Netcore" com esta chave, uma vez que o pacote corresponde ao padrão glob.

Criar chaves de API de forma segura

Para segurança, um valor de chave recentemente criado nunca é apresentado no ecrã e só está disponível com o botão Copiar, conforme mostrado abaixo.

Obter o novo valor da chave de API

Importante

Só pode copiar o valor da chave de API imediatamente após criá-lo ou atualizá-lo. Não será apresentado e não voltará a estar acessível depois de a página ser atualizada. Se perder o valor da chave, tem de utilizar Regenerar e copiar a chave depois de ser regenerada.

Permissões e expiração de chaves

As chaves de API no âmbito podem atribuir qualquer uma das seguintes permissões:

  • Emitir novos pacotes
  • Emitir pacotes novos ou atualizados
  • Anular a lista de pacotes

Cada nova chave tem uma expiração. O valor de expiração é medido em dias. Os valores possíveis para expiração são:

  • 1 dia
  • 90 dias
  • 180 dias
  • 270 dias
  • 365 dias (predefinição)

Estas definições não podem ser alteradas depois de a chave ser criada. Não pode criar uma nova chave que nunca expire.

Editar e eliminar chaves de API existentes

Pode alterar algumas definições de uma chave existente. Como indicado anteriormente, não pode modificar o âmbito de segurança de uma chave de API existente ou alterar a expiração. As opções alteráveis são apresentadas na seguinte captura de ecrã:

Editar o valor da chave de API

Para alterar os pacotes controlados por uma chave, pode escolher pacotes individuais na lista ou alterar o padrão glob.

Clicar em Regenerar cria um novo valor chave. Tal como quando criou a chave inicialmente, tem de Copiar o valor da chave imediatamente após a atualização. A opção Copiar não está disponível depois de sair desta página.

Clicar em Eliminar apresenta uma mensagem de confirmação. Assim que uma chave for eliminada, será inutilizável.

Expiração da chave

Dez dias antes da expiração, o Galeria do PowerShell envia um e-mail de aviso ao titular da conta da chave de API. Após a expiração, a chave é inutilizável. É apresentada uma mensagem de aviso na parte superior da página de gestão de chaves de API que mostra as chaves que já não são válidas. Pode gerar um novo valor chave.