Partilhar via

Criar e gerir uma área de trabalho na Gestão de API do Azure

  • Artigo

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 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.
  • Estamos introduzindo a capacidade de associar vários espaços de trabalho a um gateway de espaço de trabalho, ajudando as organizações a gerenciar APIs com espaços de trabalho a um custo mais baixo. Este recurso está sendo implementado a partir de dezembro de 2024 e pode não estar disponível para todos os serviços qualificados antes de janeiro. Mais informações

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 rede virtual e uma sub-rede do Azure existentes ou novas 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

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

  2. No menu à esquerda, em APIs, selecione Espaços de trabalho+> Adicionar.

  3. 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 Seguinte.

  4. Na guia Gateway, defina as configurações para o gateway de espaço de trabalho:

    • 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ç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 uma configuração de rede que inclua acesso à rede de entrada ou saída privada, 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.

  5. Selecione Seguinte. Após a conclusão da validação, selecione Criar.

Pode levar de vários minutos a até várias horas para criar o espaço de trabalho, o gateway do espaço de trabalho e os recursos relacionados. 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.

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

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

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

  3. 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
    • Gerenciador de produtos da API do espaço de trabalho do serviço de gerenciamento de API

Atribuir uma função com escopo de espaço de trabalho

  1. 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.

  2. Na janela Espaço de trabalho, selecione Controle de acesso (IAM)>+ Adicionar.

  3. 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
    • Gerenciador de produtos da API do espaço de trabalho de gerenciamento de API

Atribuir uma função com escopo de gateway

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

  2. No menu à esquerda, em APIs, selecione Espaços de trabalho> o nome do seu espaço de trabalho.

  3. No menu esquerdo do espaço de trabalho, 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 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
    • Contribuinte
    • Leitor

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.

Recurso Guia
APIs Tutorial: Importar e publicar a primeira API
Produtos Tutorial: criar e publicar um produto
Subscrições Subscrições na Gestão de API do Azure

Criar assinaturas no Gerenciamento de API
Políticas Tutorial: Transforme e proteja sua API

Políticas na Gestão de API do Azure

Definir ou editar políticas de Gerenciamento de API
Valores com nome Gerenciar segredos usando valores nomeados
Back-ends Usar back-ends no Gerenciamento de API do Azure
Fragmentos de políticas Reutilizar configurações de política em suas definições de política de 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údos relacionados