Tutorial: Definir metadados personalizados

Este tutorial explica como definir metadados personalizados para ajudá-lo a organizar suas APIs e outras informações em seu centro de API. Você pode usar metadados personalizados e internos para pesquisa e filtragem e para impor padrões de governança em sua organização.

Para obter mais informações sobre metadados no Centro de API do Azure, consulte:

• Principais conceitos – Metadados
• Usar metadados para governança de API

Neste tutorial, você aprenderá a usar o portal do Azure para:

• Definir metadados personalizados na central de APIs
• Exibir o esquema de metadados

Pré-requisitos

• Um centro de API na sua assinatura do Azure. Para criar um, consulte Início Rápido: Criar seu centro de API.

Definir metadados

Aqui você define dois exemplos de metadados personalizados: linha de negócios e voltado para o público; se preferir, defina outros metadados próprios. Ao adicionar ou atualizar APIs e outras informações em seu inventário, defina valores para metadados personalizados e quaisquer metadados internos padrão.

Importante

Não inclua informações confidenciais ou pessoais nos títulos (nomes) dos metadados que você definir. Esses títulos ficam visíveis nos logs de monitoramento utilizados pela Microsoft para melhorar a funcionalidade do serviço. Entretanto, outros detalhes e valores de metadados são seus dados de cliente protegidos.

1. Entre no portal do Azure e navegue até o centro de API.

2. No menu da barra lateral, em Ativos, selecione Metadados>+ Novos metadados.

3. Na guia Detalhes , insira informações sobre os metadados.

   1. Para Título, insira Linha de negócios.

   2. Se quiser, insira uma Descrição.

   3. Selecione opções predefinidas de tipo e insira opções como Marketing, Finanças, TI, Vendas e assim por diante. Opcionalmente, habilite Permitir seleção de vários valores. Selecione Próximo.

   

4. Na guia Atribuições , selecione Obrigatório para APIs. Selecione Opcional para Implantações e Ambientes. Você pode adicionar essas entidades em tutoriais posteriores. Selecione Próximo.

   

5. Na guia Revisar + criar , examine as configurações e selecione Criar.

   Os metadados são adicionados à lista na página Metadados .

6. Selecione + Novos metadados para adicionar outro exemplo.

7. Na guia Detalhes , insira informações sobre os metadados.

   1. Para Título, insira voltado para o público.

   2. Selecione o tipo booliano.

8. Na guia Atribuições , selecione Obrigatório para APIs. Selecione Não aplicável para Implantações e Ambientes.

9. Na guia Revisar + criar , examine as configurações e selecione Criar.

   Os metadados são adicionados à lista.

Exibir esquema de metadados

Você pode exibir e baixar o esquema JSON para os metadados definidos no centro de API. O esquema inclui metadados internos e personalizados.

1. No menu à esquerda, em Recursos, selecione Metadados>Ver esquema de metadados.

2. Selecione Exibir esquema de metadados>APIs para ver o esquema de metadados para APIs, que inclui metadados pré-definidos e personalizados. Você também pode exibir o esquema de metadados definido para implantações e ambientes no centro de API.

   

Próxima etapa

Adicione APIs ao inventário no centro de API.

Registrar APIs no estoque de API