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 workspace de Gerenciamento de API e um gateway de workspace usando o portal do Azure
- Opcionalmente, isole o gateway de workspace em uma rede virtual do Azure
- Atribuir permissões ao workspace
Observação
- Atualmente, a criação de um gateway de workspace é uma operação de execução prolongada que pode levar até 3 horas ou mais para ser concluída.
- Estamos introduzindo a capacidade de associar vários workspaces a um gateway de workspace, ajudando as organizações a gerenciar APIs com workspaces a um custo menor. Esse recurso será distribuído a partir de dezembro de 2024 e talvez não esteja disponível para todos os serviços qualificados antes de janeiro. Saiba mais
Pré-requisitos
- Uma instância de Gerenciamento de API. Se você 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 rede virtual e uma sub-rede do Azure existentes ou novas para isolar o tráfego de entrada e saída do gateway de workspace. Para obter opções de configuração e requisitos, confira os Requisitos de recursos de rede para gateways de workspace.
Criar um workspace - portal
Entre no portal do Azure e navegue até a sua instância do Gerenciamento de API.
No menu à esquerda, em APIs, selecione Workspaces>+ Adicionar.
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.
Na guia Gateway, defina as configurações para o gateway de workspace:
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 selecionadas. 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 uma configuração de rede que inclua acesso privado à rede de entrada ou de saída privada, selecione uma Rede virtual e Sub-rede para isolar o gateway do espaço de trabalho ou criar um novo. Para obter os requisitos de rede, confira os Requisitos de recursos de rede para gateways de workspace.
Selecione Avançar. Depois de concluir a validação, selecione Criar.
Pode levar de vários minutos a até várias horas para criar o workspace, o gateway do espaço de trabalho e os recursos relacionados. 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.
- Para obter uma lista de funções internas de workspace, veja Como usar o controle de acesso baseado em função no Gerenciamento de API.
- Para ver as etapas para atribuir uma função, veja 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é a sua instância do Gerenciamento de API.
No menu à esquerda, selecione Controle de acesso (IAM)>+ Adicionar.
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
No menu da instância do Gerenciamento de API em APIs, selecione Workspaces> e o nome do workspace que você criou.
Na janela Workspace, selecione Controle de acesso (IAM)>+ Adicionar.
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
- Colaborador do Workspace do 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
Entre no portal do Azure e navegue até a sua instância do Gerenciamento de API.
No menu à esquerda, em APIs, selecione Workspaces> o nome do seu workspace.
No menu à esquerda do workspace, 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 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
Introdução ao seu workspace
Dependendo da função no workspace, os usuários podem ter permissões para criar APIs, produtos, assinaturas e outros recursos, ou podem ter acesso somente leitura a parte disso ou a tudo isso.
Para começar a gerenciar, proteger e publicar APIs em um workspace, confira as diretrizes a seguir.