Compartilhar via

Criar e gerenciar um espaço de trabalho no Gerenciamento de API do Azure

APLICA-SE A: Premium

Configure um workspace para permitir que uma equipe de API gerencie e publique suas próprias APIs, fornecendo à equipe de plataforma de API as ferramentas para observar, governar e manter a plataforma de Gerenciamento de API. Depois de criar um espaço de trabalho e atribuir permissões, os colaboradores do workspace poderão criar e gerenciar suas próprias APIs, produtos, assinaturas e recursos relacionados.

Observação

  • Os recursos mais recentes do workspace são compatíveis com a API REST de Gerenciamento de API versão 2023-09-01-preview ou posterior.
  • Para obter considerações de preço, veja Preço do Gerenciamento de API.

Execute as etapas deste artigo para:

  • Criar um ambiente de Gerenciamento de API e associar um portal de entrada do ambiente usando o portal do Azure
  • Opcionalmente, isole o gateway de workspace em uma rede virtual do Azure
  • Atribua permissões ao espaço de trabalho

Observação

  • Atualmente, a criação de um gateway de workspace é uma operação de longa duração que pode levar 3 horas ou mais para ser finalizada.
  • A associação de vários workspaces a um gateway de workspace só está disponível para gateways de workspace criados após 15 de abril de 2025. Saiba mais sobre gateways de workspace compartilhados.

Pré-requisitos

  • Uma instância de Gerenciamento de API. Se precisar, crie um em uma camada com suporte.
  • Função de proprietário ou colaborador no grupo de recursos em que a instância de Gerenciamento de API é implantada ou permissões equivalentes para criar recursos no grupo de recursos.
  • (Opcional) Uma sub-rede em uma nova ou existente rede virtual do Azure para isolar o tráfego de entrada e saída do gateway de espaço de trabalho. Para obter opções de configuração e requisitos, consulte Requisitos de recursos de rede para gateways de workspace.

Criar um espaço de trabalho - portal

  1. Entre no portal do Azure e navegue até a sua instância do Gerenciamento de API.

  2. No menu à esquerda, em APIs, selecione Workspaces>+ Adicionar.

  3. Na guia Noções básicas, insira um Nome de exibição descritivo, Nome do recurso e Descrição opcional para o workspace. Selecione Avançar.

  4. Na aba Gateway, configure as configurações do gateway do workspace.

    Captura de tela da criação de um gateway de workspace no portal.

    • Selecione Criar novo para criar um novo gateway de workspace ou selecione Usar existente para associar o workspace a um gateway existente que tenha outros workspaces implantados nele.

    • Se você optar por criar um novo gateway:

      • Em Detalhes do gateway, insira um nome de gateway e selecione o número de Unidades de escala. Os custos do gateway são baseados no número de unidades. Para obter mais informações, consulte preço de Gerenciamento de API.

      • Em Rede, selecione uma Configuração de rede para seu gateway de workspace.

        Importante

        Planeje cuidadosamente a configuração de rede do workspace. Você não pode alterar a configuração de rede depois de criar o workspace.

      • Se você selecionar acesso público de entrada, acesso privado de saída (integração de rede virtual) ou acesso privado de entrada, acesso privado de saída (injeção de rede virtual), selecione uma rede virtual e uma sub-rede para isolar o gateway de workspace ou crie um novo. Para obter os requisitos de rede, confira os Requisitos de recursos de rede para gateways de workspace.

  5. Selecione Avançar. Depois de concluir a validação, selecione Criar.

    Observação

    A criação de uma nova porta de entrada do espaço de trabalho, caso selecionada, pode levar várias horas para ser concluída. Para acompanhar o progresso da implantação no portal do Azure, acesse o grupo de recursos do gateway. No menu esquerdo em Configurações, selecione Implantações.

Após a conclusão da implantação, o novo workspace aparece na lista na página Workspaces. Selecione o workspace para gerenciar suas configurações e recursos.

Observação

  • Para exibir o nome do host do runtime do gateway e outros detalhes do gateway, selecione o workspace no portal. Em Implantação + infraestrutura, selecione Gateways e o nome do gateway do espaço de trabalho.
  • Enquanto o gateway de workspace estiver sendo criado, as chamadas de runtime para as APIs do workspace não serão bem-sucedidas.

Atribuir usuários ao workspace - portal

Depois de criar um workspace, atribua permissões aos usuários para gerenciar os recursos do workspace. Cada usuário do espaço de trabalho deve receber uma função RBAC de espaço de trabalho com escopo de serviço e uma função RBAC com escopo de espaço de trabalho ou conceder permissões equivalentes usando funções personalizadas.

Para gerenciar o gateway do espaço de trabalho, recomendamos também atribuir aos usuários do workspace uma função RBAC fornecida pelo Azure com escopo para o gateway do espaço de trabalho.

Observação

Para facilitar o gerenciamento, configure grupos do Microsoft Entra para atribuir permissões de workspace a vários usuários.

Atribuir uma função com escopo de serviço

  1. Entre no portal do Azure e navegue até a sua instância do Gerenciamento de API.

  2. No menu à esquerda, selecione Controle de acesso (IAM)>+ Adicionar.

  3. Atribuir uma das seguintes funções com escopo de serviço a cada membro do espaço de trabalho:

    • Desenvolvedor de API do Espaço de Trabalho de Serviço de Gerenciamento de API
    • Gerente de Produtos da API do Workspace do Serviço de Gerenciamento de API

Atribuir uma função no escopo do espaço de trabalho

  1. No menu da instância do Gerenciamento de API em APIs, selecione Workspaces> e o nome do workspace que você criou.

  2. Na janela Workspace, selecione Controle de acesso (IAM)>+ Adicionar.

  3. Atribua uma das seguintes funções com escopo do espaço de trabalho aos membros do espaço de trabalho para que eles possam gerenciar APIs de espaço de trabalho e outros recursos.

    • Leitor do Workspace do Gerenciamento de API
    • Contribuidor do Espaço de Trabalho de Gerenciamento de API
    • Desenvolvedor de API do Workspace de Gerenciamento de API
    • Gerente de Produtos da API do Workspace do Gerenciamento de API

Atribuir uma função com escopo de gateway

  1. Entre no portal do Azure e navegue até a sua instância do Gerenciamento de API.

  2. No menu à esquerda, em APIs, selecione Workspaces> o nome do seu workspace.

  3. No menu à esquerda do workspace, selecione Gateways e selecione o gateway do espaço de trabalho.

  4. No menu à esquerda, selecione Controle de acesso (IAM)>+ Adicionar.

  5. Atribua uma das seguintes funções a cada membro do workspace. No mínimo, recomendamos atribuir a função Leitor para exibir as configurações do gateway. Proprietários e Colaboradores podem gerenciar as configurações do gateway, incluindo o dimensionamento do gateway.

    • Proprietário
    • Colaborador
    • Leitor

Habilitar as configurações de diagnóstico para monitorar APIs do ambiente de trabalho.

Defina as configurações para coletar logs do Azure Monitor para o workspace e enviá-los para um workspace do Log Analytics para que a equipe do workspace possa monitorar suas próprias APIs enquanto a equipe da plataforma de API pode acessar logs centralizados para a instância de Gerenciamento de API. Confira o seguinte diagrama:

Diagrama do registro federado no Gerenciamento de APIs.

Para coletar logs do Azure Monitor para o espaço de trabalho, as configurações de diagnóstico são necessárias nos níveis de serviço e de espaço de trabalho.

  1. Primeiro, habilite uma configuração de diagnóstico no nível de serviço para coleta de logs de gateway de Gerenciamento de API, se uma configuração ainda não estiver habilitada. Recomendamos enviar logs para um espaço de trabalho do Log Analytics. Para obter mais informações, consulte Definir configurações de diagnóstico para o Gerenciamento de API.

  2. Em seguida, habilite uma configuração de diagnóstico no nível do workspace para enviar logs de gateway de Gerenciamento de API para o mesmo workspace do Log Analytics. Essa configuração coleta logs de todos os gateways associados ao espaço de trabalho.

    Importante

    Uma configuração de diagnóstico no nível do serviço configura o registro em log na instância de Gerenciamento de API, incluindo workspaces que têm uma configuração de diagnóstico no nível do workspace habilitada. Se você não habilitar uma configuração de diagnóstico no nível do workspace, os logs de gateway do workspace não serão coletados ou agregados no Log Analytics.

    Observação

    Por padrão, os membros da equipe do espaço de trabalho atribuídos às funções RBAC internas do espaço de trabalho não têm permissões para editar as configurações de diagnóstico em um espaço de trabalho. A equipe da plataforma de API tem essas permissões.

Para definir uma configuração de diagnóstico de workspace para a coleção de logs de gateway no nível do workspace:

  1. Entre no portal do Azure e navegue até a sua instância do Gerenciamento de API.

  2. No menu à esquerda, em APIs, selecione Workspaces> o nome do seu workspace.

  3. No menu à esquerda dos workspaces, em Monitoramento, selecione Configurações de diagnóstico>+ Adicionar configuração de diagnóstico.

  4. Na página Configuração de diagnóstico, insira ou selecione detalhes para a configuração:

    1. Nome da configuração de diagnóstico: insira um nome descritivo.
    2. Grupos de categorias: opcionalmente, faça uma seleção para seu cenário.
    3. Em Categorias: selecione Logs relacionados ao Gateway ApiManagement para coletar logs de gateway para APIs neste workspace.
    4. Em Detalhes do Destino, selecione para enviar logs para o mesmo workspace do Azure Log Analytics especificado na configuração de diagnóstico no nível do serviço e em outras configurações de diagnóstico no nível do workspace.
    5. Clique em Salvar.

Observação

  • Atualmente, somente os logs de gateway podem ser coletados para workspaces.
  • Acesse logs no nível do workspace navegando até Monitoramento>Logs no menu à esquerda do workspace.

Introdução ao seu workspace

Dependendo da função no ambiente de trabalho, os usuários podem ter permissões para criar APIs, produtos, assinaturas e outros recursos, ou podem ter acesso somente leitura a alguns ou todos eles.

Para começar a gerenciar, proteger e publicar APIs em um workspace, confira as diretrizes a seguir.

Recurso Guia
Apis Tutorial: Importar e publicar sua primeira API
Produtos Tutorial: Criar e publicar um produto
Assinaturas Assinaturas no Gerenciamento de API do Azure

Criar assinaturas no Gerenciamento de API
Políticas Tutorial: Transformar e proteger sua API

Políticas no Gerenciamento de API do Azure

Definir e editar as políticas de Gerenciamento de API
Valores nomeados Gerenciar segredos usando valores nomeados
Back-ends Usar back-ends no Gerenciamento de API do Azure
Fragmentos de política Reutilizar configurações de política em suas definições de política Gerenciamento de API
Esquemas Validar conteúdo
Grupos Criar e usar grupos para gerenciar contas de desenvolvedor
Notificações Como configurar notificações e modelos de notificação

Conteúdo relacionado