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 APIs. 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 na Central de API do Azure, consulte:

• Conceitos-chave - Metadados
• Usar metadados para governança de API

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

• Definir metadados personalizados no seu centro de API
• Exibir o esquema de metadados

Pré-requisitos

• Um centro de API na sua subscrição do Azure. Para criar um, consulte Guia de início rápido: criar sua central de APIs.

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 internos personalizados e comuns.

Importante

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

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

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

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

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

   2. Opcionalmente, insira uma Descrição.

   3. Selecione o tipo Opções predefinidas e insira opções como Marketing, Finanças, TI, Vendas e assim por diante. Opcionalmente, ative Permitir seleção de vários valores. Selecione Avançar.

   

4. Na guia Atribuições , selecione Necessário para APIs. Selecione Opcional para implantações e ambientes. Você pode adicionar essas entidades em tutoriais posteriores. Selecione Avançar.

   

5. No separador Rever + criar , reveja as definiçõ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. Em Título, insira Voltado para o público.

   2. Selecione o tipo Booleano.

8. Na guia Atribuições , selecione Necessário para APIs. Selecione Não aplicável para implantações e ambientes.

9. No separador Rever + criar , reveja as definiçõ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 em seu centro de API. O esquema inclui metadados internos e personalizados.

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

2. Selecione Ver esquema de metadados>APIs para ver o esquema de metadados para APIs, que inclui metadados incorporados e personalizados. Você também pode exibir o esquema de metadados definido para implantações e ambientes em seu centro de API.

   

Próximo passo

Adicione APIs ao inventário no seu centro de APIs.

Registrar APIs em seu inventário de APIs