Modelos comuns do SDK de conectores do Microsoft Graph
Este artigo descreve os modelos comuns utilizados no SDK de conectores do Microsoft Graph.
CustomConfiguration
O Administração de pesquisa fornece as informações de configuração personalizada específicas do conector durante a criação da ligação. A plataforma não gere a estrutura e o formato da configuração. Os programadores de conectores podem utilizar um formato à sua escolha.
| Propriedade | Tipo | Descrição |
|---|---|---|
| configuração | string | Contém as informações de configuração como uma cadeia. O conector deve ter a capacidade de interpretar o conteúdo da cadeia. |
AuthenticationType enumeration members (Membros de enumeração AuthenticationType)
A tabela seguinte lista os membros da enumeração AuthenticationType .
| Membro | Valor | Descrição |
|---|---|---|
| Anônimo | 0 | Não é necessária autenticação para aceder à origem de dados. |
| Básica | 1 | Autenticação Básica sob a forma de nome de utilizador e palavra-passe para aceder à origem de dados. |
| Windows | 2 | A autenticação baseada no Windows Active Directory suporta informações de domínio, nome de utilizador, palavra-passe e nome de utilizador. |
| oAuth2ClientCredential | 3 | Autenticação baseada em OAuth2 com credenciais de cliente. Suporta o ID da aplicação e o segredo da aplicação. |
AuthenticationData
Contém credenciais fornecidas pelo administrador para aceder à origem de dados, incluindo o tipo de autenticação, o URL da origem de dados e os dados das credenciais.
| Propriedade | Tipo | Descrição |
|---|---|---|
| authType | AuthenticationType | Tipo de informações de autenticação contidas neste objeto. |
| DatasourceUrl | cadeia de caracteres | URL ou caminho para aceder à origem de dados – caminho para o recurso que precisa de ser pesquisado. Exemplo: cadeia de ligação para uma base de dados. |
| basicCredential | BasicCredential | Credenciais sob a forma de nome de utilizador e palavra-passe para aceder à origem de dados. Esta propriedade será definida exclusivamente para windowsCredential e o authType será definido como Básico quando esta propriedade estiver definida. |
| windowsCredential | WindowsCredential | Credenciais sob a forma de nome de utilizador, palavra-passe e domínio do Windows AD para aceder à origem de dados. Esta propriedade será definida em exclusivo para basicCredential e o authType será definido como Windows quando esta propriedade estiver definida. |
| oAuth2ClientCredential | oAuth2ClientCredential | Credenciais sob a forma de ID da aplicação e segredo da aplicação para autenticação baseada em credenciais de cliente OAuth para aceder à origem de dados. Esta propriedade será definida em exclusivo para oAuth2ClientCredential e o authType será definido como oAuth2ClientCredential quando esta propriedade estiver definida. |
BasicCredential
Representa o modelo de credenciais básicas.
| Propriedade | Tipo | Descrição |
|---|---|---|
| username | string | Nome de utilizador para aceder à origem de dados. |
| segredo | string | Segredo a utilizar com o nome de utilizador para aceder à origem de dados. |
WindowsCredential
Representa o modelo de credenciais do Windows.
| Propriedade | Tipo | Descrição |
|---|---|---|
| username | cadeia de caracteres | Nome de utilizador para aceder à origem de dados. |
| segredo | string | Segredo a utilizar com o nome de utilizador para aceder à origem de dados. |
| domínio | string | Domínio do Active Directory da conta. Se não for fornecida explicitamente pelo administrador, esta propriedade contém o valor do nome do computador. |
oAuth2ClientCredential
Representa o modelo de credenciais para credenciais de cliente OAuth2.
| Propriedade | Tipo | Descrição |
|---|---|---|
| appId | cadeia de caracteres | ID da aplicação/ID de cliente da aplicação OAuth2. |
| appSecret | Cadeia de caracteres | Segredo da aplicação/segredo do cliente para a aplicação OAuth2. |
| oAuth2ClientCredentialResponse | oAuth2ClientCredentialResponse | Contém detalhes relacionados com o token OAuth. Esta propriedade será definida para a resposta que o conector envia após a primeira chamada de autenticação validada ser bem-sucedida. |
oAuth2ClientCredentialResponse
Representa o modelo de resposta do servidor de autenticação para o pedido de token OAuth2. Os campos presentes neste modelo são os campos de resposta comuns especificados na documentação do OAuth2. Além disso, o idToken pode ser definido quando os servidores de autenticação suportam o OpenIDConnect.
| Propriedade | Tipo | Descrição |
|---|---|---|
| accessToken | string | O token de acesso do servidor de autenticação. |
| refreshToken | string | O token de atualização se o servidor de autenticação o enviar. |
| tokenType | cadeia de caracteres | Tipo do token – normalmente Token de portador para OAuth. |
| expiresIn | int64 | A hora de expiração do token no carimbo de data/hora unix. |
| scope | cadeia de caracteres | Âmbitos suportados pelo token se o servidor de autenticação o enviar. |
| idToken | cadeia de caracteres | O token de ID se o servidor de autenticação suportar a ligação de ID aberto. |
OperationResult
A enumeração OperationResult contém os valores possíveis para os resultados da operação.
| Membro | Valor | Descrição |
|---|---|---|
| Êxito | 0 | A operação foi efetuada com êxito sem qualquer erro. |
| PartialSuccess | 1 | A operação é um êxito, mas há uma mensagem de aviso a ser processada. |
| ValidationFailure | 2 | Uma ou mais validações falharam. |
| AuthenticationIssue | 3 | As credenciais fornecidas não funcionaram. |
| DatasourceError | 4 | Erro de leitura da origem de dados. |
| NetworkError | 5 | Erro de operação de rede. |
| Cancelado | 6 | O token de cancelamento cancelou a operação. |
| TokenExpired | 7 | Para ser utilizado no fluxo OAuth quando o token enviado para o conector pela plataforma tiver expirado. Durante a pesquisa, ao receber este status, a plataforma acionará o fluxo do token de atualização e chamará o método RefreshAccessToken no ConnectorOAuthService. |
| SkipItem | 8 | Para ser utilizado no fluxo de pesquisa quando o item deve ser ignorado. |
OperationStatus
Representa o status de uma operação, incluindo erros/avisos e detalhes de repetição. Este modelo faz parte da resposta de todas as APIs em ConnectionManagementService e ConnectorCrawlerService.
| Propriedade | Tipo | Descrição |
|---|---|---|
| resultado | OperationResult | Resultado da operação. |
| statusMessage | cadeia de caracteres | Mensagem personalizada que pode ser utilizada para fins de registo e monitorização. |
| retryInfo | RetryDetails | Repita as informações a utilizar pela arquitetura para repetir a mesma operação para uma operação falhada. Se a operação for bem-sucedida ou for parcialmente bem-sucedida, será ignorada. |
RetryType enumeration members (Membros de enumeração RetryType)
Esta enumeração é utilizada para definir a estratégia para tentar novamente em caso de erros.
| Membro | Valor | Descrição |
|---|---|---|
| NoRetry | 0 | Não é necessário repetir. |
| Padrão | 1 | Será feita uma repetição padrão com tempo de espera linear. |
| ExponentialBackOff | 2 | Será feita uma repetição por trás exponencial. |
RetryDetails
Este modelo é utilizado para comunicar a política de repetição onde é necessária a repetição.
| Propriedade | Tipo | Descrição |
|---|---|---|
| type | RetryType | O tipo de repetição define o tipo de estratégia de repetição necessária para o erro. |
| numberOfRetries | int32 | Número de tentativas a realizar para a exceção. |
| pauseBetweenRetriesInMilliseconds | int64 | É colocado em pausa entre repetições em caso de repetições padrão. |
| backoffCoefficient | flutuação | Obtém o coeficiente utilizado no cálculo do Óntulo Exponencial. |
| taxa de retrocesso | flutuação | Obtém o backoffRate utilizado no cálculo de Trás Exponencial. |
DataSourceSchema
Representa o esquema das propriedades que representam uma entidade de dados na origem de dados. Para obter detalhes, veja o tipo de recurso de esquema.
| Propriedade | Tipo | Descrição |
|---|---|---|
| PropertyList | SourcePropertyDefinition repetida | Representa uma lista de propriedades que definem um item na origem de dados. |
Membros de enumeração SourcePropertyType
| Membro | Valor | Descrição |
|---|---|---|
| Cadeia de caracteres | 0 | Propriedade do tipo cadeia. |
| Int64 | 1 | Propriedade do tipo int64 (long). |
| Duplo | 2 | Propriedade do tipo duplo. |
| DateTime | 3 | Propriedade do tipo DateTime. |
| Booliano | 4 | Propriedade do tipo Booleano. |
| StringCollection | 5 | Propriedade do tipo de matriz ou coleção do tipo de cadeia. |
| Int64Collection | 6 | Propriedade do tipo de matriz ou coleção de tipo longo. |
| DoubleCollection | 7 | Propriedade do tipo de matriz ou coleção de tipo duplo. |
| DateTimeCollection | 8 | Propriedade do tipo de matriz ou coleção do tipo DateTime. |
SearchAnnotations enumeration members (Membros de enumeração searchAnnotations)
| Membro | Valor | Descrição |
|---|---|---|
| Nenhum | 0 | Nenhum |
| IsSearchable | 1 | Se uma propriedade for pesquisável, o respetivo valor é adicionado ao índice de texto completo. Quando um utilizador efetua uma pesquisa, os resultados são devolvidos se existir um resultado de pesquisa num dos campos pesquisáveis ou no respetivo conteúdo. Por exemplo, se a propriedade for "Autor", a pesquisa "Smith" devolve itens cuja propriedade Autor contém "Smith". |
| IsQueryable | 2 | Se uma propriedade for consultada, pode consultar a mesma com a Linguagem de Consulta de Conhecimento (KQL). KQL consiste em uma ou mais palavras-chave de texto livre (palavras ou frases) ou restrições de propriedade. O nome da propriedade deve ser incluído na consulta, sendo especificado diretamente na consulta ou incluído de maneira programática. Você pode usar a correspondência de prefixo com o operador de caractere curinga(*). Por exemplo, se a propriedade for "Autor", a consulta de pesquisa pode ser "Autor: Smith" |
| IsRetrievable | 4 | Se uma propriedade for recuperável, pode devolver o respetivo valor nos resultados da pesquisa. Qualquer propriedade que pretenda adicionar ao modelo de apresentação ou devolver da consulta e ser relevante nos resultados da pesquisa tem de ser recuperável. Marcar propriedades grandes ou demais como recuperáveis aumentará a latência de pesquisa. Seja seletivo e escolha propriedades relevantes. |
| IsContent | 8 | A propriedade content é para identificar uma propriedade que pode ser indexada em texto completo. Os administradores irão escolher entre as propriedades disponíveis, que devem ser a propriedade a tratar como conteúdo para essa ligação específica. Para obter detalhes, veja Propriedade do conteúdo. |
| IsRefinable | 16 | Se uma propriedade for refinável, um administrador pode configurá-la como um filtro personalizado na página de resultados do Microsoft Search. Uma propriedade refinável não pode ser pesquisável. |
Observação
Se uma ligação tiver as etiquetas semânticas Título e URL e qualquer propriedade de esquema na ligação estiver marcada como IsContent, o conteúdo do item é vetorizado no índice semântico.
SearchPropertyLabel
As etiquetas de propriedade de pesquisa são etiquetas bem conhecidas publicadas pela Microsoft que pode adicionar a uma propriedade no esquema. Adicionar um rótulo semântico ajuda vários produtos da Microsoft a entender a propriedade e fornecer uma experiência melhor. Para obter detalhes, veja Semânticas labels (Etiquetas semânticas).
SearchPropertyLabel enumeration members (Membros de enumeração SearchPropertyLabel)
| Membro | Valor | Descrição |
|---|---|---|
| Título | 0 | O título do item que pretende mostrar na pesquisa e noutras experiências. |
| Url | 1 | A URL de destino do item na fonte de dados. |
| CreatedBy | 2 | Nome da pessoa que criou o item na fonte de dados. |
| LastModifiedBy | 3 | Nome da pessoa que editou o item mais recentemente na fonte de dados. |
| Autores | 4 | Nome de todas as pessoas que participaram/colaboraram no item na fonte de dados. |
| DataeHoraDaCriação | 5 | Data e hora em que o item foi criado na origem de dados. |
| DataeHoraDaÚltimaModificação | 6 | Data e hora em que o item foi modificado pela última vez na origem de dados. |
| FileName | 7 | No caso de um ficheiro, o nome do ficheiro está na origem de dados. |
| FileExtension | 8 | No caso de um ficheiro, a extensão do ficheiro está na origem de dados. |
| LastModifiedByUpn | 9 | UPN da pessoa que editou recentemente o item na origem de dados. |
| CreatedByUpn | 10 | UPN da pessoa que criou o item na origem de dados. |
| AuthorsUpn | 11 | UPNs de todas as pessoas que participaram/colaboraram no item na origem de dados. |
| UnknownFutureValue | 12 | Para verificação futura, siga as enumerações evoluíveis do Microsoft Graph. Adicione todas as novas enumerações abaixo desta até que a versão principal da API seja alterada. |
| ContainerName | 13 | Nome do contêiner. |
| ContainerUrl | 14 | A URL do contêiner. |
| IconUrl | 15 | A URL de um ícone. |
SourcePropertyDefinition
Define uma propriedade de origem única para um item na origem de dados. Para obter detalhes sobre as definições de propriedades de esquema, veja Tipo de recurso de propriedade.
| Propriedade | Tipo | Descrição |
|---|---|---|
| name | string | Nome da propriedade . |
| type | SourcePropertyType | Tipo de dados da propriedade . |
| defaultSearchAnnotations | int32 | Anotações de pesquisa predefinidas para a propriedade . |
| requiredSearchAnnotations | int32 | Anotações de pesquisa necessárias. Determinadas propriedades, como o ID , estão sempre definidas como isQueryabletrue e isRetrievabletrue. |
| defaultSemanticLabels | SearchPropertyLabel repetida | Lista de etiquetas semânticas para a propriedade de origem. |
| encomenda | int32 | Ordem desta propriedade de origem. Utilizado pela IU para ordenar os resultados da pesquisa. Opcional. |
| rótulo | cadeia de caracteres | Etiqueta desta propriedade de origem. Utilizado pela IU dos resultados da pesquisa para apresentar a etiqueta (nome legível por humanos). Opcional. |
| aliases | cadeia repetida | Lista de aliases desta propriedade de origem. Opcional. |