Workspaces do Gerenciamento de API do Azure

  • Artigo

APLICA-SE A: Premium

No Gerenciamento de API, os workspaces permitem que as equipes de desenvolvimento de API descentralizadas gerenciem e produzam suas próprias APIs, enquanto uma equipe central da plataforma de API mantém a infraestrutura do Gerenciamento de API. Cada workspace contém APIs, produtos, assinaturas e entidades relacionadas que são acessíveis somente aos colaboradores do workspace. O acesso é controlado por meio do RBAC (controle de acesso baseado em função) do Azure.

Observação

Visão geral do cenário de exemplo

Uma organização que gerencia APIs usando o Gerenciamento de API do Azure pode ter várias equipes de desenvolvimento que desenvolvem, definem, mantêm e produzem diferentes conjuntos de APIs. Os workspaces permitem que essas equipes usem Gerenciamento de API para gerenciar e acessar suas APIs separadamente e independentemente do gerenciamento da infraestrutura de serviço.

Veja a seguir um fluxo de trabalho de amostra para criar e usar um workspace.

  1. Uma equipe central de plataforma de API que gerencia a instância de Gerenciamento de API cria um espaço de trabalho e atribui permissões aos colaboradores do espaço de trabalho usando funções do RBAC, por exemplo, permissões para criar ou ler recursos no espaço de trabalho.

  2. Uma equipe central da plataforma de API usa ferramentas de DevOps para criar um pipeline de DevOps para APIs nesse workspace.

  3. Os membros do workspace desenvolvem, publicam, produzem e mantêm APIs no workspace.

  4. A equipe central da plataforma de API gerencia a infraestrutura do serviço, como conectividade de rede, monitoramento, resiliência e imposição de políticas de todas as APIs.

Recursos do workspace

Os recursos a seguir podem ser gerenciados na versão prévia dos workspaces.

APIs e políticas

  • Criar e gerenciar APIs e operações de API, incluindo conjuntos de versões de API, revisões de API e políticas de API.

  • Aplicar uma política para todas as APIs em um workspace.

  • Descrever APIs com marcas do nível do espaço de trabalho ou do nível de serviço.

  • Defina valores nomeados, fragmentos de política e esquemas para solicitação e validação de resposta para uso em políticas com escopo de workspace.

Observação

Em um workspace, os escopos de política são os seguintes: todas as APIs (serviço) > Todas as APIs (workspace) > Produto > API > Operação de API

Usuários e grupos

  • Organize os usuários (do nível de serviço) em grupos em um workspace.

Produtos e assinaturas

  • Publicar APIs com produtos. As APIs em um espaço de trabalho podem fazer parte de um produto de nível de serviço ou de um produto no nível do espaço de trabalho. A visibilidade pode ser configurada com base na associação do usuário em um nível de espaço de trabalho ou em um grupo de nível de serviço.

  • Gerenciar o acesso às APIs com assinaturas. As assinaturas solicitadas a uma API ou produto dentro de um workspace são criadas nesse workspace.

  • Publicar APIs e produtos com o portal do desenvolvedor.

  • Gerenciar notificações administrativas por email relacionadas aos recursos no workspace.

Funções RBAC

O RBAC do Azure é usado para configurar as permissões dos colaboradores do workspace para ler e editar entidades no workspace. Para obter uma lista de funções, veja Como usar o controle de acesso baseado em função no Gerenciamento de API.

Os membros do espaço de trabalho devem receber uma função de escopo de serviço e uma função de escopo de espaço de trabalho ou receber permissões equivalentes usando funções personalizadas. A função de escopo de serviço habilita a referência de recursos do nível de serviço a partir dos recursos do nível de espaço de trabalho. Por exemplo, organize um usuário em um grupo no nível do espaço de trabalho para controlar a API e a visibilidade do produto.

Observação

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

Workspaces e outros recursos de Gerenciamento de API

  • Recursos de infraestrutura – Os recursos da infraestrutura da plataforma de Gerenciamento de API são gerenciados apenas no nível de serviço, não no nível do workspace. Esses recursos incluem:

    • Conectividade de rede privada

    • Gateways de API, incluindo colocação em escala, locais e gateways auto-hospedados

  • Referências de recursos – os recursos em um espaço de trabalho podem referenciar outros recursos no espaço de trabalho e usuários do nível de serviço. Eles não podem referenciar recursos de outro workspace.

    Por motivos de segurança, não é possível referenciar recursos de nível de serviço de políticas no nível do workspace (por exemplo, valores nomeados) ou por nomes de recursos, como backend-id na política set-backend-service.

  • Portal do desenvolvedor – os workspaces são um conceito administrativo e não são exibidos como tal para os consumidores do portal do desenvolvedor, inclusive por meio da interface do usuário do portal do desenvolvedor e da API subjacente. No entanto, APIs e produtos podem ser publicados de um workspace para o portal do desenvolvedor. Por isso, qualquer recurso usado pelo portal do desenvolvedor (por exemplo, uma API, produto, marca ou assinatura) precisa ter um nome de recurso exclusivo do Azure no serviço. Não pode haver nenhum recurso do mesmo tipo e com o mesmo nome de recurso do Azure no mesmo workspace, em outros workspaces ou no nível de serviço.

  • Excluir um workspace – excluir um workspace exclui todos os seus recursos filho (APIs, produtos e assim por diante).

Limitações de visualização

Atualmente, não há suporte para os seguintes recursos em workspaces:

  • Servidores de autorização (provedores de credenciais no gerenciador de credenciais)

  • Autorizações (conexões com provedores de credenciais no gerenciador de credenciais)

  • Back-ends

  • Certificados do cliente

  • Ferramentas atuais do DevOps para Gerenciamento de API

  • Diagnósticos

  • Agentes

  • APIs do GraphQL sintético

  • Identidade gerenciada atribuída pelo usuário

Portanto, atualmente, não há suporte para os seguintes cenários de amostra em workspaces:

  • Monitoramento de APIs com configuração específica do workspace

  • Gerenciamento de back-ends de API e importação de APIs de serviços do Azure

  • Validação de certificados de cliente

  • Usando o recurso gerenciador de credenciais (anteriormente chamado de autorizações)

  • Especificação de informações do servidor de autorização de API (por exemplo, para o portal do desenvolvedor)

  • As APIs de espaço de trabalho publicadas em gateways auto-hospedados

Importante

Todos os recursos em um serviço Gerenciamento de API precisam ter nomes exclusivos, mesmo que estejam localizados em workspaces diferentes.

Conteúdo relacionado