Como usar contas de serviço no Espaço Gerenciado do Azure para Grafana

Neste guia, saiba como usar contas de serviço. As contas de serviço são usadas para executar operações automatizadas e autenticar aplicativos no Grafana com a API do Grafana.

Os casos de uso comuns incluem:

• Provisionamento ou configuração de dashboards
• Agendando relatórios
• Definindo alertas
• Configurando um provedor de autenticação SAML externo
• Interagindo com o Grafana sem entrar como usuário

Pré-requisitos

• Uma conta do Azure com uma assinatura ativa. Crie uma conta gratuitamente.
• Um espaço de trabalho do Espaço Gerenciado do Azure para Grafana. Caso ainda não tenha, crie um worskpace do Azure Managed Grafana.

Habilitar contas de serviço

Se o workspace existente do Grafana não tiver contas de serviço habilitadas, habilite-as atualizando as configurações de preferência do workspace do Grafana usando o portal do Azure ou a CLI do Azure.

Portal

1. No portal do Azure, em Configurações, selecione Configuração e, em seguida, em chaves de API e contas de serviço, selecione Habilitar.

   

2. Selecione Salvar para confirmar se deseja habilitar chaves de API e contas de serviço no Espaço Gerenciado do Azure para Grafana.

CLI do Azure

1. A extensão da CLI do Espaço Gerenciado do Azure para Grafana 0.3.0 ou superior é necessária. Para atualizar sua extensão, execute az extension update --name amg.

2. Execute o comando az grafana update para habilitar a criação de chaves de API e contas de serviço em uma instância existente do Espaço Gerenciado do Azure para Grafana. No comando a seguir, substitua <azure-managed-grafana-name> pelo nome da instância do Espaço Gerenciado do Azure para Grafana a ser atualizada.

   az grafana update --name <azure-managed-grafana-name> ---service-account Enabled
   

Criar uma conta de serviço

Siga as etapas abaixo para criar uma nova conta de serviço do Grafana e listar as contas de serviço existentes:

Interface do Usuário do Grafana

1. Vá para o ponto de extremidade do workspace do Grafana e selecione Usuários e acesse>Contas de serviço no menu à esquerda e Adicionar a conta de serviço.

   

2. Insira um Nome de exibição e uma Função para sua nova conta de serviço do Grafana nas opções Nenhuma função básica, Visualizador, Editor ou Administradore selecione Criar. Nenhuma função é atribuída por padrão.

3. Depois que a conta de serviço é criada, o Grafana exibe informações sobre a nova conta de serviço, incluindo sua data de criação, tokens existentes e permissões associadas a ela. Você criará um primeiro token em uma próxima etapa.

4. Opcionalmente, selecione Contas de serviço no menu esquerdo para exibir uma lista de todas as contas de serviço em seu workspace do Grafana.

CLI do Azure

1. Execute o comando az grafana service-account create para criar uma conta de serviço. Substitua os espaços reservados <azure-managed-grafana-name>, <service-account-name> e <role> por suas próprias informações.

   Funções disponíveis: Admin, Editor, Viewer.

   az grafana service-account create --name <azure-managed-grafana-name> --service-account <service-account-name> --role <role>
   

2. Execute o comando az grafana service-account list para obter uma lista de todas as contas de serviço que pertencem a uma determinada instância do Espaço Gerenciado do Azure para Grafana. Substitua <azure-managed-grafana-name> pelo nome do workspace do Espaço Gerenciado do Azure para Grafana

   az grafana service-account list --name <azure-managed-grafana-name> --output table
   

   Exemplo de saída:

   AvatarUrl             IsDisabled    Login        Name        OrgId    Role    Tokens
   --------------------  ------------  -----------  ----------  -------  ------  --------
   /avatar/abc12345678   False         sa-account1  account1    1        Viewer  0
   

3. Execute o comando az grafana service-account show para obter os detalhes de uma conta de serviço. Substitua <azure-managed-grafana-name> e <service-account-name> pelas suas informações.

   az grafana service-account show --name <azure-managed-grafana-name> --service-account <service-account-name>
   

Adicionar um token de conta de serviço

Depois de criar uma conta de serviço, adicione um ou mais tokens de acesso. Os tokens de acesso são cadeias de caracteres geradas usadas para autenticar com a API do Grafana sem usar um nome de usuário e uma senha. Cada token está associado a permissões específicas, permitindo que você controle o nível de acesso concedido a diferentes usuários ou aplicativos. Os tokens podem ser criados, gerenciados e revogados conforme necessário.

Interface do Usuário do Grafana

Na interface do usuário do Grafana:

1. Para criar um token de conta de serviço, selecione Adicionar token de conta de serviço.

2. Use o Nome de exibição gerado automaticamente ou insira um nome de sua escolha. Por padrão, a data de validade é definida como um dia após a data de criação. Opcionalmente, atualize a Data de validade sugerida ou selecione Sem prazo de validade.

   

3. Selecione Gerar token. O token é exibido apenas uma vez, portanto, certifique-se de copiá-lo e salvá-lo com segurança. Se você perder esse token, precisará gerar um novo.

4. O token agora está listado nos detalhes da conta de serviço.

CLI do Azure

Na CLI do Azure:

1. Crie um token da conta de serviço do Grafana com az grafana service-account token create. Substitua os espaços reservados <azure-managed-grafana-name>, <service-account-name> e <token-name> por suas próprias informações.

   Opcionalmente, defina um tempo de validade:

   Parâmetro	Descrição	Exemplo
   --time-to-live	Os tokens têm um dia de validade por padrão. Opcionalmente, desabilite ou edite o tempo de validade para desabilitar o token após um determinado tempo. Use s para segundos, m para minutos, h para horas, d para dias, w para semanas, M para meses ou y para anos.	15d

   az grafana service-account token create --name <azure-managed-grafana-name> --service-account <service-account-name> --token <token-name> --time-to-live 15d
   

2. Anote o token gerado e salve-o com segurança. Se você perder esse token, precisará gerar um novo.

3. Execute o comando az grafana service-account token list para obter uma lista de todos os tokens que pertencem a uma determinada conta de serviço. Substitua os espaços reservados <azure-managed-grafana-name> e <service-account-name> por suas próprias informações.

   az grafana service-account token list --name <azure-managed-grafana-name> --service-account <service-account-name> --output table
   

   Exemplo de saída:

   Created               Expiration            HasExpired    Name    SecondsUntilExpiration
   --------------------  --------------------  ------------  ------  ------------------------
   2024-11-05T15:09:24Z  2024-11-06T14:48:51Z  False         token1  84388.80530215
   

Editar uma conta de serviço

Nesta seção, você aprenderá a atualizar uma conta de serviço do Grafana.

Interface do Usuário do Grafana

Ações:

• Para editar o nome, selecione a conta de serviço e, em Informações, selecione Editar.
• Para editar a função, selecione a conta de serviço e, em Informações, selecione a função e escolha outro nome de função.
• Para desabilitar uma conta de serviço, selecione uma conta de serviço e, na parte superior da página, selecione Desabilitar conta de serviço e, em seguida, selecione Desabilitar conta de serviço para confirmar. Contas de serviço desabilitadas podem ser reabilitadas selecionando Habilitar conta de serviço.

A notificação Conta de serviço atualizada é exibida instantaneamente.

CLI do Azure

Editar uma conta de serviço com az grafana service-account update. Substitua os espaços reservados <azure-managed-grafana-name>e <service-account-name> pelas próprias informações e use um ou vários dos seguintes parâmetros:

Parâmetro	Descrição
--is-disabled	Insira --is-disabled true desabilitar uma conta de serviço ou --is-disabled false para habilitar uma conta de serviço.
--name	Insira outro nome para sua conta de serviço.
--role	Insira outra função para sua conta de serviço. Funções disponíveis: Admin, Editor, Viewer.

az grafana service-account update --name <azure-managed-grafana-name> --service-account <service-account-name> --role <role> --enabled false

Para desabilitar uma conta de serviço, execute o comando az grafana update e use a opção --is-disabled true. Para habilitar uma conta de serviço, use --is-disabled false.

az grafana update --service-account Disabled --name <service-account-name>

Excluir uma conta de serviço

Interface do Usuário do Grafana

Para excluir uma conta de serviço do Grafana, selecione uma conta de serviço e, na parte superior da página, selecione Excluir conta de serviço e selecione Excluir conta de serviço para confirmar. A exclusão de uma conta de serviço é final e uma conta de serviço não pode ser recuperada depois de excluída.

CLI do Azure

Para excluir uma conta de serviço, execute o comando az grafana service-account delete. Substitua os espaços reservados <azure-managed-grafana-name> e <service-account-name> por suas próprias informações.

az grafana service-account delete --name <azure-managed-grafana-name> --service-account <service-account-name>

Excluir um token da conta de serviço

Interface do Usuário do Grafana

Para excluir um token de conta de serviço, selecione uma conta de serviço e, em Tokens, selecione Excluir (x). Selecione Excluir para confirmar.

CLI do Azure

Para excluir uma conta de serviço, execute o comando az grafana service-account token delete. Substitua os espaços reservados <azure-managed-grafana-name>, <service-account-name> e <token-name> por suas próprias informações.

az grafana service-account token delete --name <azure-managed-grafana-name> --service-account <service-account-name> --token <token-name>

Próximas etapas

Neste guia de instruções, você aprendeu a criar e gerenciar contas de serviço e tokens para executar operações automatizadas no Espaço Gerenciado do Azure para Grafana. Quando estiver pronto, explore mais artigos:

Habilitar a redundância de zona