Como criar e utilizar grupos para gerir contas de programador na Gestão de API do Azure

APLICA-SE A: Developer | Básico | Básico v2 | Padrão | Padrão v2 | Prémio

No Gerenciamento de API, os grupos são usados para gerenciar a visibilidade dos produtos para os desenvolvedores no portal do desenvolvedor. Os produtos são primeiro tornados visíveis para grupos e, em seguida, os programadores nesses grupos podem ver e subscrever os produtos associados aos grupos.

O Gerenciamento de API tem os seguintes grupos imutáveis:

  • Administradores - Grupo interno que contém apenas a conta de e-mail do administrador fornecida no momento da criação do serviço. A sua composição é gerida pelo sistema; Os usuários não podem ser adicionados ou removidos do grupo. O objetivo principal da conta de administrador é acessar a interface administrativa do portal do desenvolvedor para personalizar e publicar o conteúdo do portal. Qualquer usuário que tenha permissões do RBAC do Azure para personalizar o portal do desenvolvedor pode se autenticar como administrador para personalizar o portal.

    Nota

    A qualquer momento, um proprietário de serviço pode atualizar as configurações de e-mail do administrador que são usadas nas notificações da sua instância de Gerenciamento de API.

  • Programadores – os utilizadores autenticados do portal do programador enquadram-se neste grupo. Os programadores são os clientes que criam aplicações utilizando as suas APIs. Os programadores têm acesso ao portal do programador e criam aplicações que chamam as operações de uma API

  • Convidados – os utilizadores não autenticados do portal do programador, tais como potenciais clientes que visitam o portal do programador de uma instância de API Management, enquadram-se neste grupo. Estes podem ter determinados acessos só de leitura, como a capacidade de ver APIs mas não de as chamar.

Além desses grupos de sistema, os administradores podem criar grupos personalizados ou usar grupos externos em locatários associados do Microsoft Entra. É possível utilizar grupos personalizados e externos em conjunto com grupos de sistema para dar aos programadores acesso e visibilidade a produtos de API. Por exemplo, pode criar um grupo personalizado para os programadores associados a uma organização parceira específica e permitir-lhes o acesso às APIs a partir de um produto que contém apenas APIs relevantes. Um utilizador pode ser membro de mais do que um grupo.

Este guia mostra como os administradores de uma instância de Gerenciamento de API podem adicionar novos grupos e associá-los a produtos e desenvolvedores.

Além de criar e gerenciar grupos no portal do Azure, você pode criar e gerenciar seus grupos usando a entidade Grupo de API REST de Gerenciamento de API.

Pré-requisitos

Conclua as tarefas neste artigo: Criar uma instância de Gerenciamento de API do Azure.

Vá para a sua instância de Gestão de API

  1. No portal do Azure, procure e selecione serviços de Gerenciamento de API.

    Selecionar serviços de gerenciamento de API

  2. Na página Serviços de Gerenciamento de API, selecione sua instância de Gerenciamento de API.

    Selecione sua instância de Gerenciamento de API

Criar um grupo

Esta seção mostra como adicionar um novo grupo à sua conta de Gerenciamento de API.

  1. Selecione a guia Grupos à esquerda da tela.

  2. Clique em +Adicionar.

  3. Insira um nome exclusivo para o grupo e uma descrição opcional.

  4. Selecione Criar.

    Captura de ecrã a mostrar a criação de um grupo no portal. Depois que o grupo é criado, ele é adicionado à lista Grupos .

    • Para editar o Nome ou Descrição do grupo, clique no nome do grupo e selecione Configurações

    • Para excluir o grupo, selecione o nome do grupo e pressione Delete.

Agora que o grupo é criado, ele pode ser associado a produtos e desenvolvedores.

Associar um grupo a um produto

  1. Selecione a guia Produtos à esquerda.

  2. Clique no nome do produto desejado.

  3. Pressione Access control>+ Add group.

  4. Selecione o grupo que deseja adicionar.

    Captura de ecrã a mostrar a adição de um grupo a um produto no portal.

Depois que um produto é associado a um grupo, os desenvolvedores desse grupo podem visualizar e assinar o produto.

Nota

Para adicionar grupos do Microsoft Entra, consulte Como autorizar contas de desenvolvedor usando a ID do Microsoft Entra no Gerenciamento de API do Azure.

Para remover um grupo do produto, clique em Excluir.

Captura de ecrã a mostrar a remoção de um grupo de um produto no portal.

Associar grupos a desenvolvedores

Esta seção mostra como associar grupos a membros.

  1. Selecione o separador Grupos à esquerda do ecrã e, em seguida, selecione um grupo.

  2. Selecione Membros+ Adicionar>.

  3. Selecione um membro.

    Captura de ecrã a mostrar a adição de um membro a um grupo no portal.

  4. Pressione Select.

Depois que a associação for adicionada entre o desenvolvedor e o grupo, você poderá visualizá-la na guia Usuários .