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: Basic v2 | Standard v2 | Premium | Premium v2
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.
Note
- New! A funcionalidade workspaces está agora disponível nos níveis Basic v2 e Standard v2, além dos níveis Premium e Premium v2. Os espaços de trabalho nos níveis v2 podem ser associados ou ao gateway gerido predefinido do API Management ou a um recurso de gateway do espaço de trabalho separado, proporcionando flexibilidade na forma como configura e dimensiona os seus espaços de trabalho. Para informações sobre o roteiro de suporte a níveis de espaços de trabalho, consulte o artigo do blogue.
- Para obter considerações sobre preços, consulte Preços de gerenciamento de API.
Siga as etapas neste artigo para:
- Crie um espaço de trabalho do API Management associado ao gateway gerido predefinido da instância ou a um gateway de espaço de trabalho novo ou existente.
- Opcionalmente, isole um gateway de espaço de trabalho numa rede virtual do Azure.
- Atribuir permissões ao espaço de trabalho.
Note
- Atualmente, criar um gateway de espaço de trabalho é uma operação de longa duração que pode demorar até três horas ou mais a 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.
Prerequisites
- Uma instância de gerenciamento de API. Se precisares de um, cria-o num nível suportado.
- 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 numa rede virtual Azure nova ou existente para isolar o tráfego de entrada e saída de um 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.
- (Opcional, para associar o gateway gerido predefinido a uma área de trabalho) Um cliente REST para invocar a API REST do API Management.
Crie um espaço de trabalho e associe o gateway gerido predefinido - API REST
Pode criar um espaço de trabalho que encaminhe o tráfego da API através do gateway gerido predefinido do serviço, em vez de para um gateway de espaço de trabalho. Esta opção evita o custo extra e a complexidade de um recurso gateway separado. O tráfego API passa pelo nome de host padrão do serviço (por exemplo, <service-name>.azure-api.net).
Note
Atualmente, criar um espaço de trabalho e associar o gateway gerido predefinido é uma operação suportada apenas nos escalões v2 e através da API REST do API Management.
Use o Workspace - Criar ou Atualizar a API REST para criar um espaço de trabalho.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}?api-version=2024-05-01
Authorization: Bearer {token}
Content-Type: application/json
{
"properties": {
"displayName": "my workspace",
"description": "Workspace using default managed gateway",
"serveOn": "workspaceAndDefault"
}
}
Substituir:
-
{subscriptionId}com a sua ID de subscrição do Azure -
{resourceGroupName}com o nome do grupo de recursos da sua instância de Gestão de API -
{serviceName}com o nome da sua instância de Gestão de API -
{workspaceId}com um identificador de espaço de trabalho único (alfanumérico, hífens permitidos)
Uma resposta bem-sucedida retorna HTTP 201 Created que inclui o recurso do espaço de trabalho. Por defeito, o espaço de trabalho encaminha o tráfego API através do nome de host predefinido do serviço.
Depois de criado o espaço de trabalho, proceda a Atribuir utilizadores ao portal do espaço de trabalho para configurar permissões de acesso.
Crie um espaço de trabalho e associe um portal de espaço de trabalho - portal
Entre no portal do Azure e vá para 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.
Important
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.
Note
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.
Note
- Para ver o nome do anfitrião do runtime 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 do workspace está a ser criado, as chamadas em tempo de execução para as APIs do workspace não têm sucesso.
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 utilizador do espaço de trabalho deve ter atribuídas tanto uma função RBAC ao nível do serviço como uma função RBAC ao nível do espaço de trabalho, ou receber permissões equivalentes através de funções personalizadas.
Se o espaço de trabalho utilizar um recurso de gateway do espaço de trabalho, atribua também aos utilizadores do espaço de trabalho uma função RBAC fornecida pelo Azure com âmbito no gateway do espaço de trabalho.
Note
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 vá para 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 âmbito no 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 um dos seguintes papéis com âmbito de espaço de trabalho aos membros do espaço de trabalho para que possam gerir APIs e outros recursos do espaço de trabalho:
- 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 âmbito no gateway
Entre no portal do Azure e vá para 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, atribua a função de Leitor para ver as definições do gateway. Proprietários e Contribuintes podem gerir as definições do gateway, incluindo a escalabilidade do gateway.
- Owner
- Contributor
- Reader
Habilitar configurações de diagnóstico para monitorar APIs de espaço de trabalho
Configure as definições para recolher os registos do Azure Monitor para o espaço de trabalho e enviá-los para um espaço de trabalho do Log Analytics. A equipa de workspace pode monitorizar as suas próprias APIs, enquanto a equipa da plataforma de API pode aceder a registos centralizados para a instância de Gestão de APIs. Veja o diagrama a seguir:
Para recolher registos do Azure Monitor para o espaço de trabalho, precisa de definições de diagnóstico tanto ao nível do serviço como do espaço de trabalho:
Primeiro, ativa uma definição de diagnóstico ao nível do serviço para a recolha dos registos do gateway de Gestão de API, caso uma definição ainda não esteja ativada. Envie registos para um espaço de trabalho de Log Analytics. Para obter mais informações, consulte Definir configurações de diagnóstico para gerenciamento de API.
Depois, ative uma configuração de diagnóstico ao nível da área de trabalho para enviar os registos do gateway do API Management para a mesma área de trabalho do Log Analytics. Essa configuração coleta logs para todos os gateways associados ao espaço de trabalho.
Important
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 não ativar uma definição de diagnóstico ao nível do espaço de trabalho, os registos do gateway do espaço de trabalho não são recolhidos nem agregados no Log Analytics.
Note
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 vá para 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 definição de Diagnóstico, introduza ou selecione os detalhes da definiçã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 com o ApiManagement Gateway para recolher 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.
Note
- Atualmente, só é possível recolher registos do gateway para áreas de trabalho.
- Pode aceder aos registos ao nível do espaço de trabalho indo a Registos de Monitorização>no menu esquerdo do espaço de trabalho.
Comece a utilizar o seu espaço de trabalho
Dependendo do seu papel no espaço de trabalho, os utilizadores podem ter permissões para criar APIs, produtos, subscrições e outros recursos, ou podem ter acesso apenas de leitura a alguns ou a todos esses recursos.
Para começar a gerenciar, proteger e publicar APIs em um espaço de trabalho, consulte as diretrizes a seguir.