Os conectores do Microsoft Graph SDK contratam a API e os modelos do rastreador de conectores do Microsoft Graph
Os conectores do Microsoft Graph SDK contratam a API do rastreador de conectores e os modelos são chamados durante um rastreamento.
API do rastreador do conector
| Método | Parâmetros | Tipo de retorno | Descrição |
|---|---|---|---|
| GetCrawlStream | GetCrawlStreamRequest | CrawlStreamBit como um fluxo | Lê dados da fonte de dados. Esse método será chamado durante rastreamentos completos e periódicos em que todos os itens devem ser lidos da fonte de dados e retornados à plataforma. |
| GetIncrementalCrawlStream | GetIncrementalCrawlStreamRequest | IncrementalCrawlStreamBit como um fluxo | Lê dados da fonte de dados. Esse método é opcional e será chamado durante rastreamentos incrementais e retorna apenas as alterações incrementais nos itens desde o último rastreamento incremental. |
Modelos de rastreador de conector
A seguir estão os modelos de rastreador de conector.
GetCrawlStreamRequest
Modelo de solicitação para obter itens durante o rastreamento.
| Propriedade | Tipo | Descrição |
|---|---|---|
| customConfiguration | CustomConfiguration | Fornece dados de configuração para o conector. |
| Authenticationdata | Authenticationdata | Contém a URL de acesso à fonte de dados e as credenciais para acessá-la. |
| crawlProgressMarker | CrawlCheckpoint | Contém dados para identificar itens que foram processados no último rastreamento. O conector retorna as informações do item e o usa se a plataforma falhar durante o rastreamento. |
| Esquema | DataSourceSchema | Mostra o esquema da conexão. Essa propriedade também pode ser usada para definir o valor. |
CrawlStreamBit
O modelo de resposta que contém o item status indicando êxito ou falha e o indicador/ponto de verificação do item que está sendo rastreado durante o rastreamento completo ou periódico.
| Propriedade | Tipo | Descrição |
|---|---|---|
| status | OperationStatus | Mostra o status dos detalhes da operação e do erro. |
| crawlItem | CrawlItem | Mostra um único item rastreado da fonte de dados. |
| crawlProgressMarker | CrawlCheckpoint | Identifica o item rastreado da fonte de dados. |
GetIncrementalCrawlStreamRequest
Modelo de solicitação para obter itens durante um rastreamento incremental.
| Propriedade | Tipo | Descrição |
|---|---|---|
| customConfiguration | CustomConfiguration | Fornece dados de configuração para o conector. |
| Authenticationdata | Authenticationdata | Contém a URL de acesso à fonte de dados e as credenciais para acessá-la. |
| crawlProgressMarker | CrawlCheckpoint | Contém dados para identificar itens que foram processados no último rastreamento. O conector retorna as informações do item e o usa se a plataforma falhar durante o rastreamento. |
| Esquema | DataSourceSchema | Mostra o esquema da conexão. Essa propriedade também pode ser usada para definir o valor. |
| previousCrawlStartTimeInUtc | Carimbo de data/hora | Mostra a hora de início do rastreamento anterior em UTC. Esse valor pode ser usado no primeiro rastreamento incremental, mas as chamadas subsequentes devem usar o valor de ponto de verificação. |
IncrementalCrawlStreamBit
Modelo de resposta que contém o item, status indicando êxito/falhas se houver e o indicador/ponto de verificação do item que está sendo rastreado durante o rastreamento incremental.
| Propriedade | Tipo | Descrição |
|---|---|---|
| status | OperationStatus | Mostra o status dos detalhes da operação e do erro. |
| crawlItem | IncrementalCrawlItem | Mostra um único item rastreado da fonte de dados durante e rastreamento incremental. |
| crawlProgressMarker | CrawlCheckpoint | Identifica o último item rastreado da fonte de dados durante o último rastreamento incremental. |
Membros de enumeração ItemType para CrawlItem
Campos de enumeração para itens de rastreamento.
| Membro | Valor | Descrição |
|---|---|---|
| ContentItem | 0 | Itens de dados com conteúdo a ser ingerido. Por exemplo: conteúdo do site. |
| LinkItem | 1 | Vincule a um item de conteúdo que será usado em rastreamentos subsequentes. Por exemplo: links para um site ou uma pasta. |
CrawlItem
Representa uma entidade na fonte de dados. O tamanho máximo permitido é de 4 MB. Por exemplo: um arquivo, uma pasta ou um registro em uma tabela.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Itemid | string | Mostra a ID exclusiva que representa o item na fonte de dados. |
| contentItem | ContentItem | Mostra um item de dados com conteúdo a ser ingerido. Por exemplo: o conteúdo de um site. |
| linkItem | LinkItem | Vincule a um item de conteúdo que será usado em rastreamentos subsequentes. Por exemplo: um link para um site ou uma pasta. |
| Itemtype | ItemType | Mostra o tipo de item que está sendo enviado. Esse modelo deve ter um contentItem ou um conjunto linkItem e esse campo de enumeração deve corresponder a esse item. |
Observação
- As propriedades linkItem e contentItem são mutuamente exclusivas.
Membros de enumeração ItemType para IncrementalCrawlItem
Campos de enumeração para itens de rastreamento incremental.
| Membro | Valor | Descrição |
|---|---|---|
| ContentItem | 0 | Itens de dados com conteúdo a ser ingerido. Por exemplo: o conteúdo de um site. |
| LinkItem | 1 | Vincule a um item de conteúdo que será usado em rastreamentos subsequentes. Por exemplo: um link para um site ou uma pasta. |
| DeletedItem | 2 | Item que foi excluído da fonte de dados e deve ser excluído do índice. |
IncrementalCrawlItem
Representa uma entidade na fonte de dados. Por exemplo: um arquivo, uma pasta ou um registro em uma tabela.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Itemid | cadeia de caracteres | Mostra a ID exclusiva que representa o item na fonte de dados. |
| contentItem | ContentItem | Mostra um item de dados com conteúdo a ser ingerido. Por exemplo: o conteúdo de um site. |
| linkItem | LinkItem | Vincule a um item de conteúdo que será usado em rastreamentos subsequentes. Por exemplo: um link para um site ou uma pasta. |
| deletedItem | DeletedItem | Item que é excluído da fonte de dados e deve ser removido do índice. Se deletedItem estiver definido, contentItem ou linkItem não poderá ser definido. |
| Itemtype | ItemType | Mostra o tipo de item que está sendo enviado. Esse modelo deve ter um contentItem ou um conjunto linkItem e esse campo de enumeração deve corresponder a esse item. |
Observação
- As propriedades linkItem, contentItem e deletedItem são mutuamente exclusivas.
ContentItem
Item que contém o conteúdo da entidade de fonte de dados a ser ingerida. Por exemplo: o conteúdo de um site.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Propertyvalues | SourcePropertyValueMap | Contém a chave e os valores de cada propriedade no item. |
| accessList | Accesscontrollist | Restringe o acesso ao item a usuários ou grupos específicos. |
| conteúdo | Conteúdo | Mostra a propriedade de conteúdo do item que pode ser usado ao exibir os resultados da pesquisa. |
LinkItem
Item que atua como um link para outro item. Esses itens de link serão enviados novamente ao conector para recrawl; por exemplo, em um conteúdo de pasta, os arquivos serão itens de conteúdo e subpastas serão itens de link.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Metadados | cadeia de caracteres de mapa<, GenericType> | Contém os metadados necessários pelo conector para recrawl o item. |
DeletedItem
Representa um item que foi excluído da fonte de dados e precisa ser removido do índice.
Accesscontrollist
Restringe os usuários que podem ver os resultados da pesquisa.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Entradas | AccessControlEntry repetido | Mostra a matriz ou a coleção de entradas da lista de controle de acesso. |
Membros de enumeração AclAccessType
Membros de enumeração do tipo de lista de controle de acesso.
| Membro | Valor | Descrição |
|---|---|---|
| Nenhum | 0 | Indica o valor padrão: negar. |
| Conceder | 1 | A entrada é para usuários/grupos com acesso ao item. |
| Negar | 2 | A entrada é para usuários/grupos sem acesso ao item e substitui a concessão para qualquer usuário/grupo. |
Accesscontrolentry
Contém entradas de controle de acesso individuais.
| Propriedade | Tipo | Descrição |
|---|---|---|
| accessType | AclAccessType | Mostra o tipo de acesso da entidade que concede ou nega. |
| principal | Principal | Representa um grupo ou usuário com acesso definido. |
Membros de enumeração PrincipalType
Membros de enumeração do tipo principal.
| Membro | Valor | Descrição |
|---|---|---|
| PT_None | 0 | Indica o valor padrão: usuário. |
| Usuário | 1 | Tipo de usuário. |
| Agrupar | 2 | Tipo de grupo. |
| Todos | 3 | Grupo especial para conceder acesso a todos. |
| EveryoneExceptGuests | 4 | Grupo especial para conceder acesso a todos, exceto convidados. |
Membros de enumeração identitysource
Enumeração membros da fonte de identidade.
| Membro | Valor | Descrição |
|---|---|---|
| IS_None | 0 | Indica o valor padrão: Microsoft Entra ID. |
| AzureActiveDirectory | 1 | A origem da identidade é Microsoft Entra ID. |
Membros de enumeração IdentityType
Enumeração membros do tipo de identidade.
| Membro | Valor | Descrição |
|---|---|---|
| IT_None | 0 | Indica o valor padrão: (Azure ADId). |
| ActiveDirectorySId | 1 | SID (Identificador de segurança local) fornecido pelo Active Directory (AD). |
| UserPrincipalName | 2 | Nome da entidade de usuário (UPN). |
| AadId | 3 | Azure ADId. |
Principal
Estrutura para armazenar atributos da entidade (usuário/grupo).
| Propriedade | Tipo | Descrição |
|---|---|---|
| type | Principaltype | Tipo de entidade de segurança. |
| valor | cadeia de caracteres | Valor principal: o valor do SID, UPN, Azure ADId e assim por diante. |
| identitySource | IdentitySource | A origem da identidade. |
| Identitytype | IdentityType | Tipo de representação de identidade. |
| identitySourceProperties | cadeia de caracteres do mapa<, cadeia de caracteres> | Metadados sobre a fonte de identidade. |
SourcePropertyValueMap
Mapa da chave de propriedade de origem e seu valor na fonte de dados. Ele armazena o valor da propriedade de cada item.
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | cadeia de caracteres de mapa<, GenericType> | Contém a chave e os valores das propriedades do item. A chave é o nome da propriedade e o valor é valor da propriedade. Por exemplo, o conteúdo do arquivo tem propriedades como título, modifiedDate e assim por diante. As chaves de propriedades serão as próprias propriedades e seus valores serão o título do arquivo e da data modificada pelo arquivo, respectivamente. |
Membros de enumeração ContentType
Membros de enumeração do tipo de conteúdo.
| Membro | Valor | Descrição |
|---|---|---|
| Nenhum | 0 | Valor padrão. |
| Texto | 1 | Tipo de conteúdo de texto. |
| Html | 2 | Tipo de conteúdo HTML. |
Conteúdo
Valor da propriedade de conteúdo do item, usada para renderizar os resultados da pesquisa.
| Propriedade | Tipo | Descrição |
|---|---|---|
| contentType | ContentType | Tipo do conteúdo. |
| contentValue | cadeia de caracteres | Valor da propriedade de conteúdo. |
CrawlCheckpoint
Identifica o item que foi rastreado por último. Ele será salvo pela plataforma e o ponto de verificação do último lote de itens bem-sucedido será usado para retomar o rastreamento se houver uma falha ou falha. A plataforma enviará o ponto de verificação na API GetCrawlStream .
| Propriedade | Tipo | Descrição |
|---|---|---|
| Pagenumber | uint32 | Mostra o número da página para marcar o progresso do rastreamento. |
| Batchsize | uint32 | Contém o número de itens retornados em cada lote. Ele tem um valor constante de 1 porque cada item é transmitido individualmente. |
| customMarkerData | string | Dados personalizados necessários para identificar o último item rastreado da fonte de dados. |
GenericType
Modelo para manter os tipos de valores com suporte pela plataforma em determinados campos, como valores de propriedade de origem. Apenas um dos campos a seguir deve ser definido.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Stringvalue | string | Representa um valor de cadeia de caracteres. |
| intValue | int64 | Representa um valor int64 (longo). |
| Doublevalue | double | Representa um valor duplo. |
| dateTimeValue | google.protobuf.Timestamp | Representa um valor dateTime. |
| boolValue | bool | Representa um valor booleano. |
| stingCollectionValue | StringCollectionType | Representa uma coleção de cadeias de caracteres. |
| intCollectionValue | IntCollectionType | Representa uma coleção de int64 (long). |
| doubleCollectionValue | DoubleCollectionType | Representa uma coleção de duplo. |
| dateTimeCollectionValue | TimestampCollectionType | Representa uma coleção de dateTime. |
StringCollectionType
Coleção de cadeias de caracteres.
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | cadeia de caracteres repetida | Coleção ou matriz de cadeias de caracteres. |
IntCollectionType
Coleção de valores inteiros.
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | repetido int64 | Coleção ou matriz de valores int64 (longos). |
DoubleCollectionType
Coleção de valores duplos.
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | duplo repetido | Coleção ou matriz de valores duplos. |
TimestampCollectionType
Coleção de valores DateTime .
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | repetido google.protobuf.Timestamp | Coleção ou matriz de valores dateTime . |