Azure PIM CLI (azpim)

Uma ferramenta de interface de linha de comando para gerenciar ativações de funções do Azure Privileged Identity Management (PIM) diretamente do seu terminal.

Recursos

• 🔐 Ativação de Funções - Ative rapidamente funções elegíveis do Azure PIM
• 🔓 Desativação de Funções - Desative funções ativas quando não forem mais necessárias
• 📋 Menu Interativo - Interface amigável orientada por menus
• ✨ Interface Bonita - Experiência de terminal refinada com spinners e cores
• 🔄 Suporte a Múltiplas Funções - Ative ou desative várias funções de uma só vez
• 📊 Acompanhamento de Status - Feedback em tempo real sobre o status de ativação/desativação
• 💾 Predefinições - Salve e reutilize configurações de ativação/desativação
• ⭐ Favoritos - Marque assinaturas como favoritas para acesso rápido
• 🗃️ Cache de Assinaturas - Cache automático de assinaturas (TTL de 6 horas) para inicialização mais rápida
• 🚀 Modo Não Interativo - Flags de CLI para scripts e automação
• 🔔 Notificações de Atualização - Verificações automáticas de atualização com comportamento configurável
• 📤 Saída JSON - Saída legível por máquina para integração com outras ferramentas
• 👤 Isolamento de Dados por Usuário - Configuração e cache armazenados por ID de usuário do Azure

Pré-requisitos

Antes de usar o azpim, certifique-se de ter:

1. Node.js (v18 ou superior)
2. Azure CLI instalado e configurado
3. Conta do Azure com funções elegíveis para PIM

Configuração da Azure CLI

# Instalar a Azure CLI (se não estiver instalada)
# Veja: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli

# Fazer login no Azure
az login

# Verificar se está logado
az account show

Instalação

Instalação Global (Recomendada)

# Usando npm
npm install -g azpim

# Usando pnpm
pnpm add -g azpim

# Usando yarn
yarn global add azpim

Após a instalação, o comando azpim estará disponível globalmente.

Migrando do azp-cli

Se você usava o azp-cli anteriormente, suas predefinições estão armazenadas em ~/.config/azp-cli/ (ou %APPDATA%\azp-cli\ no Windows). Para migrar:

1. Copie seu presets.json para o novo local: ~/.config/azpim/ (ou %APPDATA%\azpim\)
2. Desinstale o pacote antigo: npm uninstall -g azp-cli

A partir do Código Fonte (Desenvolvimento)

# Clonar o repositório
git clone https://github.com/tapanmeena/azpim.git
cd azpim

# Instalar dependências
pnpm install

# Compilar o projeto
pnpm build

# Vincular globalmente para desenvolvimento
npm link

Uso

Executando a CLI

# Após instalação global
azpim

# Ou com comandos específicos
azpim activate
azpim deactivate
azpim preset list
azpim update

# Modo de desenvolvimento (a partir do código fonte)
pnpm dev

Comandos

Comando	Alias	Descrição
activate	a	Ativar uma função no Azure PIM (padrão)
deactivate	d	Desativar uma função no Azure PIM
preset	-	Gerenciar predefinições reutilizáveis
favorites	fav	Gerenciar assinaturas favoritas
check-update	update, upgrade	Verificar se há uma versão mais recente
help	-	Exibir informações de ajuda

Flags Globais:

• --debug - Ativar log de depuração
• --version - Mostrar número da versão

Subcomandos de Predefinições

Comando	Descrição
preset list	Listar todas as predefinições disponíveis
preset show	Mostrar detalhes de uma predefinição específica
preset add	Adicionar uma nova predefinição (assistente interativo)
preset edit	Editar uma predefinição existente (assistente interativo)
preset remove	Remover uma predefinição

Subcomandos de Favoritos

Comando	Descrição
favorites list	Listar todas as assinaturas favoritas
favorites add	Adicionar uma assinatura aos favoritos
favorites remove	Remover uma assinatura dos favoritos
favorites clear	Limpar todos os favoritos
favorites export	Exportar favoritos para um arquivo
favorites import	Importar favoritos de um arquivo
favorites refresh	Atualizar o cache de assinaturas

Atualizações

Você pode verificar se há uma versão mais recente disponível:

azpim update
# alias
azpim upgrade

Notas:

• azpim update sai com código 0 quando atualizado, 2 quando uma atualização está disponível e 1 em caso de erro.
• --check-only - Apenas verificar e imprimir o status sem mostrar instruções de atualização.
• --output json retorna uma resposta estruturada adequada para scripts.
• Por padrão, azpim activate e azpim deactivate também mostrarão uma breve dica "atualização disponível" (apenas modo texto) no máximo uma vez por dia.
• Desative as verificações de atualização via AZPIM_NO_UPDATE_NOTIFIER=1 (ou AZPIM_DISABLE_UPDATE_CHECK=1).

O cache de verificação de atualização é armazenado junto com as predefinições no diretório de configuração:

• macOS/Linux: ~/.config/azpim/update-check.json (ou $XDG_CONFIG_HOME/azpim/update-check.json)
• Windows: %APPDATA%\azpim\update-check.json

Modo Não Interativo (Automação)

Use flags para ativar ou desativar funções do PIM diretamente, sem passar pelo menu interativo, perfeito para scripts e fluxos de trabalho CI/CD.

Exemplos de Ativação

# Ativar uma única função pelo nome (não interativo)
azpim activate --non-interactive --yes \
   --subscription-id <SUBSCRIPTION_GUID> \
   --role-name "Owner" \
   --duration-hours 2 \
   --justification "Break-glass for incident" \
   --output json

# Ativar múltiplas funções (repetir --role-name)
azpim activate --non-interactive --yes \
   --subscription-id <SUBSCRIPTION_GUID> \
   --role-name "Contributor" \
   --role-name "User Access Administrator"

# Se um nome de função corresponder a várias funções elegíveis (diferentes escopos),
# --non-interactive gerará erro a menos que você permita explicitamente ativar todas as correspondências
azpim activate --non-interactive --yes \
   --subscription-id <SUBSCRIPTION_GUID> \
   --role-name "Contributor" \
   --allow-multiple

# Visualizar o que aconteceria sem enviar solicitações
azpim activate --non-interactive --dry-run \
   --subscription-id <SUBSCRIPTION_GUID> \
   --role-name "Contributor" \
   --output json

Exemplos de Desativação

# Desativar funções específicas
azpim deactivate --non-interactive --yes \
   --subscription-id <SUBSCRIPTION_GUID> \
   --role-name "Owner" \
   --justification "Task completed"

# Desativar em todas as assinaturas (omitir subscription-id)
azpim deactivate --non-interactive --yes \
   --role-name "Contributor" \
   --allow-multiple

Flags Disponíveis

Flags comuns (ativar/desativar):