Compartilhar via

Executar verificação de metadados

  • Artigo

O breve passo a passo a seguir mostra como usar as APIs do scanner para recuperar metadados dos itens do Fabric de sua organização. Ele pressupõe que um administrador do Fabric configurou a verificação de metadados em sua organização.

Para obter a lista de metadados de artefato e subartefato que a verificação de metadados retorna, confira a documentação da API de Administração – WorkspaceInfo GetScanResult.

Veja a seguir as APIs do scanner. Elas dão suporte a nuvens públicas e soberanas.

Importante

O aplicativo que você desenvolve para verificação pode ser autenticado usando um token de acesso de administrador delegado padrão ou uma entidade de serviço. Os dois caminhos de autenticação são mutuamente exclusivos. Ao executar em uma entidade de serviço, não deverá haver permissões necessárias para o administrador do Power BI definidas em seu aplicativo. Para obter mais informações, confira Habilitar a autenticação de entidade de serviço para APIs de administração somente leitura.

Etapa 1: executar uma verificação completa

Chame workspaces/modified sem o parâmetro modifiedSince para obter a lista completa de IDs de workspace no locatário. Esse exame recupera todos os workspaces no locatário, incluindo os pessoais e os compartilhados. Se você quiser excluir workspaces pessoais do exame, use o parâmetro excludePersonalWorkspaces de workspaces/modified.

Divida a lista em partes de no máximo 100 workspaces.

Para cada parte de 100 workspaces:

Chame workspaces/getInfo para disparar uma chamada de verificação para esses 100 workspaces. Você receberá a scanId na resposta a ser usada nas próximas etapas. No cabeçalho de localização, você também receberá o URI (Uniform Resource Identifier) a ser chamado para a próxima etapa.

Observação

É possível fazer no máximo 16 chamadas simultaneamente. O chamador deve aguardar uma resposta da API scanStatus informando êxito/falha da verificação dessa API antes de invocar outra chamada.

Se alguns metadados que você espera receber não retornarem, verifique com o administrador do Fabric se ele habilitou todas as opções de administração relevantes.

Use o URI do cabeçalho de local que você recebeu ao chamar workspaces/getInfo e faça uma sondagem em workspaces/scanStatus/{scan_id} até que o status retornado seja "Êxito". Esse status significa que o resultado da verificação está pronto. É recomendável usar um intervalo de sondagem de 30 a 60 segundos. No cabeçalho de localização, você também receberá o URI a ser chamado na próxima etapa. Use-o apenas depois do status ser "Bem-sucedido".

Use o URI do cabeçalho de local recebido da chamada a workspaces/scanStatus/{scan-id} e leia os dados usando workspaces/scanResult/{scan_id}. Os dados contêm a lista de workspaces, informações de item e outros metadados com base nos parâmetros passados na chamada workspaces/getInfo.

Etapa 2: executar uma verificação incremental

Agora que você tem todos os workspaces e os metadados e a linhagem de seus ativos, é recomendável executar apenas verificações incrementais que fazem referência à verificação anterior que você fez.

Chame workspaces/modified com o parâmetro modifiedSince definido como a hora de início da última verificação para obter os workspaces que foram alterados e que, portanto, exigem outra verificação. O parâmetro modifiedSince deve ser definido para uma data nos últimos 30 dias.

Divida essa lista em partes de até 100 workspaces e receba os dados desses workspaces alterados usando as três chamadas à API, workspaces/getInfo, workspaces/scanStatus/{scan_id} e workspaces/scanResult/{scan_id}, conforme descrito na Etapa 1.

Considerações e limitações

  • Os modelos semânticos que não foram atualizados ou republicados serão retornados em respostas à API, mas sem suas informações e expressões de subartefato. Por exemplo, o nome e a linhagem do modelo semântico são incluídos na resposta, mas não verá os nomes de tabela e de coluna do conjunto de dados.
  • Os modelos semânticos que contêm apenas tabelas DirectQuery retornarão metadados de subartefatos somente se algum tipo de ação tiver sido executado no modelo semântico, como alguém compilando um relatório sobre ele, alguém visualizando um relatório baseado nele etc.
  • Modelos semânticos em tempo real, modelos semânticos com segurança em nível de objeto, conjuntos de dados com uma conexão dinâmica com AS-Azure e AS local e conjuntos de dados de fidelidade total do Excel não têm suporte para metadados de subartefato. Para conjuntos de dados não compatíveis, a resposta retorna o motivo da não obtenção dos metadados de subartefato do conjunto de dados. Ele é encontrado em um campo chamado schemaRetrievalError, por exemplo, schemaRetrievalError: Solicitação não suportada. Não há suporte para o conjunto de dados RealTime.
  • A API não retorna metadados de subartefato para modelos semânticos maiores do que 1 GB em workspaces compartilhados. Em workspaces Premium, não há limite de tamanho em modelos semânticos.

Licenciamento

A verificação de metadados não exige uma licença especial. Isso funciona para todos os metadados do locatário, incluindo os dos artefatos localizados nos Espaços de trabalho não Premium.

Conteúdo relacionado