Partilhar via

Executar a verificação de metadados

  • Artigo

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

Para obter a lista dos metadados de artefato e subartefato que a verificação de metadados retorna, consulte a documentação da API Admin - WorkspaceInfo GetScanResult.

A seguir estão as APIs do scanner. Apoiam nuvens públicas e soberanas.

Importante

O aplicativo que você desenvolve para verificação pode autenticar 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 sob uma entidade de serviço, não deve haver permissões necessárias para o consentimento de administrador do Power BI definidas em seu aplicativo. Para obter mais informações, consulte Habilitar a autenticação da entidade de serviço para APIs de administração somente leitura.

Etapa 1: Executar uma verificação completa

Chame espaços de trabalho/modificados sem o parâmetro modifiedSince para obter a lista completa de IDs de espaço de trabalho no locatário. Essa verificação recupera todos os espaços de trabalho no locatário, incluindo espaços de trabalho pessoais e espaços de trabalho compartilhados. Se desejar excluir espaços de trabalho pessoais da verificação, use o parâmetro workspaces/modified excludePersonalWorkspaces .

Divida a lista em blocos de 100 espaços de trabalho, no máximo.

Para cada bloco de 100 espaços de trabalho:

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

Nota

Não podem ser feitas mais de 16 chamadas em simultâneo. O chamador deve aguardar uma resposta bem-sucedida/falha da verificação da API scanStatus antes de invocar outra chamada.

Se alguns metadados que você esperava receber não forem retornados, verifique com o administrador do Fabric se ele ativou todas as opções de administrador relevantes.

Use o URI do cabeçalho de local que você recebeu ao chamar workspaces/getInfo e faça uma pesquisa em workspaces/scanStatus/{scan_id} até que o status retornado seja "Succeeded". Esse status significa que o resultado da verificação está pronto. Recomenda-se usar um intervalo de sondagem de 30 a 60 segundos. No cabeçalho do local, você também recebe o URI para chamar na próxima etapa. Use-o somente depois que o status for "Aprovado".

Use o URI do cabeçalho de local que você recebeu ao chamar workspaces/scanStatus/{scan-id} e leia os dados usando workspaces/scanResult/{scan_id}. Os dados contêm a lista de espaços de trabalho, informações do 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 espaços de trabalho e os metadados e linhagem de seus ativos, é recomendável executar apenas verificações incrementais que façam referência à verificação anterior que você fez.

Chame espaços de trabalho/modificados com o parâmetro modifiedSince definido para a hora de início da última verificação para obter os espaços de trabalho 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 espaços de trabalho e obtenha os dados para esses espaços de trabalho alterados usando as três chamadas de API, workspaces/getInfo, workspaces/scanStatus/{scan_id} e workspaces/scanResult/{scan_id}, conforme descrito na Etapa 1.

Considerações e limitações

  • modelos semânticos que não foram atualizados ou republicados serão retornados em respostas de API, mas sem suas informações e expressões de subartefatos. Por exemplo, o nome do modelo semântico e a linhagem são incluídos na resposta, mas não os nomes de tabela e coluna do modelo semântico.
  • modelos semânticos contendo apenas tabelas DirectQuery retornarão metadados de subartefato somente se algum tipo de ação tiver sido executada no modelo semântico, como alguém criando um relatório sobre ele, alguém exibindo um relatório com base nele, etc.
  • Conjuntos de dados em tempo real, modelos semânticos com segurança em nível de objeto, modelos semânticos com uma conexão em tempo real com AS-Azure e AS local e conjuntos de dados de fidelidade total do Excel não são suportados para metadados de subartefatos. Para conjuntos de dados sem suporte, a resposta retorna o motivo para não obter os metadados do subartefato do conjunto de dados. Ele é encontrado em um campo chamado schemaRetrievalError, por exemplo, schemaRetrievalError: Unsupported request. O conjunto de dados RealTime não é suportado.
  • A API não retorna metadados de subartefato para modelos semânticos maiores que 1 GB em espaços de trabalho compartilhados. Em espaços de trabalho Premium, não há limitação de tamanho em modelos semânticos.

Licenciamento

A verificação de metadados não requer licença especial. Ele funciona para todos os metadados do seu locatário, incluindo os de itens localizados em espaços de trabalho não Premium.

Conteúdos relacionados