Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
APLICA-SE A: Premium
Configure um espaço de trabalho para permitir que uma equipe de API gerencie e produza suas próprias APIs, ao mesmo tempo em que fornece à equipe da 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 espaço de trabalho podem criar e gerenciar suas próprias APIs, produtos, assinaturas e recursos relacionados.
Nota
- Os recursos mais recentes do espaço de trabalho são suportados na API REST de Gerenciamento de API versão 2023-09-01-preview ou posterior.
- Para obter considerações sobre preços, consulte Preços de gerenciamento de API.
Siga as etapas neste artigo para:
- Criar um espaço de trabalho de Gerenciamento de API e associar um gateway de espaço de trabalho usando o portal do Azure
- Opcionalmente, isole o gateway de espaço de trabalho em uma rede virtual do Azure
- Atribuir permissões ao espaço de trabalho
Nota
- Atualmente, a criação de um gateway de espaço de trabalho é uma operação de longa execução que pode levar até 3 horas ou mais para ser concluída.
- A associação de vários espaços de trabalho a um gateway de espaço de trabalho está disponível apenas para gateways de espaço de trabalho criados após 15 de abril de 2025. Saiba mais sobre gateways de espaço de trabalho compartilhado.
Pré-requisitos
- Uma instância de gerenciamento de API. Se precisar, crie um em uma camada suportada.
- Função de Proprietário ou Colaborador no grupo de recursos onde 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 rede virtual do Azure nova ou existente para isolar o tráfego de entrada e saída do gateway de espaço de trabalho. Para opções e requisitos de configuração, consulte Requisitos de recursos de rede para gateways de espaço de trabalho.
Criar um espaço de trabalho - portal
Entre no portal do Azure e navegue até sua instância de Gerenciamento de API.
No menu à esquerda, em APIs, selecione Espaços de trabalho+>Adicionar.
Na guia Noções básicas , insira um Nome para exibição descritivo, Nome do recurso e Descrição opcional para o espaço de trabalho. Selecione Avançar.
Na guia Gateway, defina as configurações para o gateway do espaço de trabalho.
Selecione Criar novo para criar um novo gateway de espaço de trabalho ou selecione Usar existente para associar o espaço de trabalho a um gateway existente que tenha outros espaços de trabalho implantados nele.
Se você optar por criar um novo gateway:
Em Detalhes do gateway, insira um novo nome de gateway e selecione o número de Unidades de escala. Os custos do gateway baseiam-se no número de unidades. Para obter mais informações, consulte Preços do Gerenciamento de API.
Em Rede, selecione uma Configuração de rede para o gateway do espaço de trabalho.
Importante
Planeje cuidadosamente a configuração de rede do seu espaço de trabalho. Não é possível alterar a configuração de rede depois de criar o espaço de trabalho.
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 espaço de trabalho ou crie um novo. Para requisitos de rede, consulte Requisitos de recursos de rede para gateways de espaço de trabalho.
Selecione Avançar. Após a conclusão da validação, selecione Criar.
Nota
A criação de um novo gateway de espaço de trabalho, caso seja essa a opção escolhida, pode demorar várias horas para ser concluída. Para acompanhar o progresso da implantação no portal do Azure, vá para o grupo de recursos do gateway. No menu à esquerda, em Configurações, selecione Implantações.
Após a conclusão da implantação, o novo espaço de trabalho aparece na lista na página Espaços de trabalho . Selecione o espaço de trabalho para gerenciar suas configurações e recursos.
Nota
- Para exibir o nome do host do tempo de execução do gateway e outros detalhes do gateway, selecione o espaço de trabalho no portal. Em Implantação + infraestrutura, selecione Gateways e selecione o nome do gateway do espaço de trabalho.
- Enquanto o gateway de espaço de trabalho estiver sendo criado, as chamadas de tempo de execução para as APIs do espaço de trabalho não terão êxito.
Atribuir usuários ao espaço de trabalho - portal
Depois de criar um espaço de trabalho, atribua permissões aos usuários para gerenciar os recursos do espaço de trabalho. 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 receber permissões equivalentes usando funções personalizadas.
Para gerenciar o gateway de espaço de trabalho, recomendamos também atribuir aos usuários do espaço de trabalho uma função RBAC fornecida pelo Azure com escopo para o gateway de espaço de trabalho.
Nota
Para facilitar o gerenciamento, configure os grupos do Microsoft Entra para atribuir permissões de espaço de trabalho a vários usuários.
- Para obter uma lista de funções de espaço de trabalho internas, consulte Como usar o controle de acesso baseado em função no Gerenciamento de API.
- Para conhecer as etapas para atribuir uma função, consulte Atribuir funções do Azure usando o portal.
Atribuir uma função com escopo de serviço
Entre no portal do Azure e navegue até sua instância de Gerenciamento de API.
No menu à esquerda, selecione Controle de acesso (IAM)>+ Adicionar.
Atribua uma das seguintes funções com escopo de serviço a cada membro do espaço de trabalho:
- Espaço de trabalho do serviço de gerenciamento de API Desenvolvedor de API
- Gestor de Produtos da API do Workspace do Serviço de Gestão de API
Atribuir uma função com escopo de espaço de trabalho
No menu da sua instância de Gerenciamento de API, em APIs, selecione Espaços de trabalho> o nome do espaço de trabalho que você criou.
Na janela Espaço de trabalho , selecione Controle de acesso (IAM)>+ Adicionar.
Atribua uma das seguintes funções com escopo de 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 de espaço de trabalho de gerenciamento de API
- Colaborador do espaço de trabalho de gerenciamento de API
- Espaço de trabalho de gerenciamento de API Desenvolvedor de API
- Gestor de Produto de API do Espaço de Trabalho de Gestão de API
Atribuir uma função com escopo de gateway
Entre no portal do Azure e navegue até sua instância de Gerenciamento de API.
No menu à esquerda, em APIs, selecione Espaços de trabalho> o nome do seu espaço de trabalho.
No menu esquerdo do espaço de trabalho, selecione Gateways e selecione o gateway do espaço de trabalho.
No menu à esquerda, selecione Controle de acesso (IAM)>+ Adicionar.
Atribua uma das seguintes funções a cada membro do espaço de trabalho. 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
- Contribuidor
- Leitor
Habilitar configurações de diagnóstico para monitorar APIs de espaço de trabalho
Configure as configurações para coletar logs do Azure Monitor para o espaço de trabalho e enviá-los para um espaço de trabalho do Log Analytics para que a equipe do espaço de trabalho 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. Veja o diagrama a seguir:
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 espaço de trabalho:
Primeiro, habilite uma configuração de diagnóstico no nível de serviço para a coleta de logs de gateway de Gerenciamento de API, se uma configuração ainda não estiver habilitada. Recomendamos o envio de logs para um espaço de trabalho do Log Analytics. Para obter mais informações, consulte Definir configurações de diagnóstico para gerenciamento de API.
Em seguida, habilite uma configuração de diagnóstico no nível do espaço de trabalho para enviar logs do gateway de Gerenciamento de API para o mesmo espaço de trabalho do Log Analytics. Essa configuração coleta logs para todos os gateways associados ao espaço de trabalho.
Importante
Uma configuração de diagnóstico ao nível de serviço configura a monitorização de logs da instância de Gestão de API, incluindo espaços de trabalho que têm uma configuração de diagnóstico ao nível de espaço de trabalho habilitada. Se você não habilitar uma configuração de diagnóstico no nível do espaço de trabalho, os logs do gateway do espaço de trabalho não serão coletados ou agregados ao Log Analytics.
Nota
Por padrão, os membros da equipa de trabalho a que foram atribuídas as funções RBAC predefinidas do espaço de trabalho não têm permissões para editar as configurações de diagnóstico num espaço de trabalho. A equipe da plataforma API tem essas permissões.
Para definir uma configuração de diagnóstico de espaço de trabalho para a coleção de logs de gateway no nível do espaço de trabalho:
Entre no portal do Azure e navegue até sua instância de Gerenciamento de API.
No menu à esquerda, em APIs, selecione Espaços de trabalho> o nome do seu espaço de trabalho.
No menu esquerdo dos espaços de trabalho, em Monitoramento, selecione Configurações de diagnóstico>+ Adicionar configuração de diagnóstico.
Na página Configuração de diagnóstico , insira ou selecione detalhes para a configuração:
- Nome da configuração de diagnóstico: insira um nome descritivo.
- Grupos de categorias: opcionalmente, faça uma seleção para o seu cenário.
- Em Categorias: Selecione Logs relacionados ao ApiManagement Gateway para coletar logs de gateway para APIs neste espaço de trabalho.
- Em Detalhes do destino, selecione para enviar logs para o mesmo espaço de trabalho do Azure Log Analytics especificado na configuração de diagnóstico de nível de serviço e em outras configurações de diagnóstico no nível de espaço de trabalho.
- Selecione Guardar.
Nota
- Atualmente, apenas os logs de gateway podem ser coletados para espaços de trabalho.
- Aceda aos registos ao nível do espaço de trabalho navegando para Monitorização>Registos no menu esquerdo do espaço de trabalho.
Introdução ao seu espaço de trabalho
Dependendo de sua função no espaço 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 a todos eles.
Para começar a gerenciar, proteger e publicar APIs em um espaço de trabalho, consulte as diretrizes a seguir.