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

Na API Management, os grupos são utilizados para gerir a visibilidade dos produtos para os programadores. 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.

A Gestão de API tem os seguintes grupos de sistema imutáveis:

• Administradores – os administradores da subscrição do Azure são membros deste grupo. Os administradores gerem as instâncias de serviço de API Management, criando as APIs, as operações e os produtos que são utilizados pelos programadores. Não pode adicionar utilizadores a este grupo.

  Nota

  Você pode alterar as configurações de e-mail do administrador que são usadas nas notificações enviadas aos desenvolvedores a partir 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.

   

2. Na página Serviços 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.

   Depois que o grupo é criado, ele é adicionado à lista Grupos .

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

   • Para excluir o grupo, clique no 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.

   

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.

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.

   

4. Pressione Select.

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

Passos seguintes

• Depois que um desenvolvedor é adicionado a um grupo, ele pode exibir e assinar os produtos associados a esse grupo. Para obter mais informações, consulte Como criar e publicar um produto no Gerenciamento de API do Azure.
• Você pode controlar como o conteúdo do portal do desenvolvedor aparece para diferentes usuários e grupos que você configurou. Saiba mais sobre visibilidade e controles de acesso no portal do desenvolvedor.
• Saiba como gerenciar as configurações de e-mail do administrador que são usadas em notificações para desenvolvedores da sua instância de Gerenciamento de API.