Microsoft Graph 连接器 SDK 常见模型

项目
03/17/2023

本文介绍 Microsoft Graph 连接器 SDK 中使用的常见模型。

CustomConfiguration

搜索管理员在创建连接期间提供特定于连接器的自定义配置信息。平台不管理配置的结构和格式。连接器开发人员可以使用他们选择的格式。

属性	类型	说明
configuration	string	将配置信息作为字符串保存。连接器应能够解释字符串的内容。

AuthenticationType 枚举成员

下表列出了 AuthenticationType 枚举的成员。

成员	值	说明
匿名	0	无需身份验证即可访问数据源。
基本	1	用于访问数据源的用户名和密码形式的基本身份验证。
Windows	2	基于 Windows Active Directory 的身份验证支持用户名、密码和域信息。
oAuth2ClientCredential	3	使用客户端凭据进行基于 OAuth2 的身份验证。它支持应用程序 ID 和应用程序机密。

AuthenticationData

包含管理员提供的用于访问数据源的凭据，包括身份验证类型、数据源 URL 和凭据数据。

属性	类型	说明
authType	AuthenticationType	此对象中保留的身份验证信息的类型。
DatasourceUrl	string	用于访问数据源的 URL 或路径 - 需要爬网的资源的路径。示例：数据库的连接字符串。
basicCredential	BasicCredential	用于访问数据源的用户名和密码形式的凭据。此属性将设置为 windowsCredential 的独占，当设置此属性时， authType 将设置为 Basic。
windowsCredential	WindowsCredential	用于访问数据源的 Windows AD 用户名、密码和域形式的凭据。此属性将设置为 basicCredential 的独占，并且当设置此属性时， authType 将设置为 Windows。
oAuth2ClientCredential	oAuth2ClientCredential	基于用于访问数据源的 OAuth 客户端凭据的应用 ID 和应用机密形式的凭据。此属性将设置为 oAuth2ClientCredential 独占，当设置此属性时， authType 将设置为 oAuth2ClientCredential 。

BasicCredential

表示基本凭据模型。

属性	类型	说明
username	string	用于访问数据源的用户名。
秘密	string	用于访问数据源的用户名的机密。

WindowsCredential

表示 Windows 凭据模型。

属性	类型	说明
username	string	用于访问数据源的用户名。
秘密	string	用于访问数据源的用户名的机密。
domain	string	帐户的 Active Directory 域。如果管理员未显式提供，则此属性保留计算机名称的值。

oAuth2ClientCredential

表示 OAuth2 客户端凭据的凭据模型。

属性	类型	说明
appId	string	OAuth2 应用程序的应用程序 ID/客户端 ID。
appSecret	String	OAuth2 应用程序的应用程序机密/客户端密码。
oAuth2ClientCredentialResponse	oAuth2ClientCredentialResponse	包含与 OAuth 令牌相关的详细信息。此属性将设置为连接器在第一次验证身份验证调用成功后发送的响应。

oAuth2ClientCredentialResponse

表示来自 OAuth2 令牌请求的身份验证服务器的响应模型。此模型中存在的字段是 OAuth2 文档中指定的常见响应字段。此外，当身份验证服务器支持 OpenIDConnect 时，可以设置 idToken。

属性	类型	说明
accessToken	string	来自身份验证服务器的访问令牌。
refreshToken	string	如果身份验证服务器发送刷新令牌，则为刷新令牌。
tokenType	string	令牌的类型 - 通常是 OAuth 的持有者令牌。
expiresIn	uint64	Unix 时间戳中令牌的到期时间。
范围	string	如果身份验证服务器发送令牌，则令牌支持的范围。
idToken	string	如果身份验证服务器支持打开 ID 连接，则为 ID 令牌。

OperationResult

OperationResult 枚举包含操作结果的可能值。

成员	值	说明
成功	0	操作成功，没有任何错误。
PartialSuccess	1	操作成功，但有一条警告消息要处理。
ValidationFailure	2	一个或多个验证失败。
AuthenticationIssue	3	提供的凭据不起作用。
DatasourceError	4	数据源读取错误。
NetworkError	5	网络操作错误。
已取消	6	取消令牌取消了操作。
TokenExpired	7	在平台发送到连接器的令牌过期时在 OAuth 流中使用。在爬网过程中，在收到此状态时，平台将触发刷新令牌流，并在 ConnectorOAuthService 中调用 RefreshAccessToken 方法。

OperationStatus

表示操作的状态，包括错误/警告和重试详细信息。此模型是 ConnectionManagementService 和 ConnectorCrawlerService 中所有 API 的响应的一部分。

属性	类型	说明
result	OperationResult	操作的结果。
statusMessage	string	可用于日志记录和监视目的的自定义消息。
retryInfo	RetryDetails	重试框架要使用的信息，以便对失败的操作重试相同的操作。如果操作成功或部分成功，它将忽略。

RetryType 枚举成员

此枚举用于定义在发生错误时重试的策略。

成员	值	说明
NoRetry	0	无需重试。
标准	1	将进行具有线性等待时间的标准重试。
ExponentialBackOff	2	将按指数退避重试。

RetryDetails

此模型用于传达需要重试的重试策略。

属性	类型	说明
type	RetryType	重试类型定义错误所需的重试策略类型。
numberOfRetries	uint32	要针对异常执行的重试次数。
pauseBetweenRetriesInMilliseconds	uint64	在标准重试的情况下，获取重试之间的暂停。
backoffCoefficient	float	获取用于计算指数退避的系数。
backoffRate	float	获取在指数回退计算中使用的回退率。

DataSourceSchema

表示表示数据源中数据实体的属性的架构。有关详细信息，请参阅架构资源类型。

属性	类型	说明
PropertyList	重复 SourcePropertyDefinition	表示在数据源中定义项的属性列表。

SourcePropertyType 枚举成员

成员	值	说明
String	0	类型为 string 的属性。
Int64	1	类型为 int64 的属性 (long) 。
双精度	2	类型为 double 的属性。
日期时间	3	类型为 DateTime 的属性。
Boolean	4	类型为布尔值的属性。
StringCollection	5	字符串类型的数组或集合类型的属性。
Int64Collection	6	长类型的数组或集合类型的属性。
DoubleCollection	7	双精度类型的数组或集合类型的属性。
DateTimeCollection	8	DateTime 类型的数组或集合类型的属性。

SearchAnnotations 枚举成员

成员	值	说明
无	0	None
IsSearchable	1	如果属性是可搜索的，则其值将添加到全文索引中。当用户执行搜索时，如果其中一个可搜索字段或其内容中有搜索命中，则返回结果。例如，如果该属性为“Author”，则搜索“Smith”将返回其 Author 属性包含“Smith”的项目。
IsQueryable	2	如果某个属性可查询，则可以使用知识查询语言 (KQL) 对其进行查询。 KQL 由一个或多个自由文本关键词（单词或短语）或属性限制组成。属性名称必须包含在查询中：在查询本身中指定或以编程方式包含在查询中。可将前缀与通配符 (*) 搭配使用。例如，如果属性为“Author”，则搜索查询可以是“Author： Smith”
IsRetrievable	4	如果属性可检索，它可以在搜索结果中返回其值。要添加到显示模板或从查询返回并在搜索结果中相关的任何属性都必须可检索。将大属性或过多属性标记为可检索将增加搜索延迟。是可选择的并选择相关属性。
IsContent	8	Content 属性用于标识可编制全文索引的属性。管理员将在可用属性中进行选择，哪个属性应被视为该特定连接的内容。有关详细信息，请参阅 Content 属性。
IsRefinable	16	如果属性是可精简的，管理员可以在 Microsoft 搜索结果页上将其配置为自定义筛选器。无法搜索可优化属性。

SearchPropertyLabel

搜索属性标签是由 Microsoft 发布的已知标记，你可以针对架构中的属性添加这些标记。添加语义标签有助于各种 Microsoft 产品了解属性并提供更好的体验。有关详细信息，请参阅语义标签。

SearchPropertyLabel 枚举成员

成员	值	说明
标题	0	要在搜索和其他体验中显示的项的标题。
URL	1	数据源中项的目标 URL。
CreatedBy	2	数据源中项创建者的姓名。
LastModifiedBy	3	数据源中项的最近编辑者的姓名。
作者	4	所有在数据源中参与/协作处理项的人员的姓名。
CreatedDateTime	5	在数据源中创建项的日期和时间。
LastModifiedDateTime	6	上次在数据源中修改项的日期和时间。
FileName	7	对于文件，该文件的名称位于数据源中。
FileExtension	8	对于文件，该文件的扩展名位于数据源中。
LastModifiedByUpn	9	最近编辑数据源中项的人员的 UPN。
CreatedByUpn	10	在数据源中创建项的人员的 UPN。
AuthorsUpn	11	参与/协作处理数据源中项的所有人员的 UPN。
UnknownFutureValue	12	为了面向未来，请遵循 Microsoft Graph 可进化枚举。在此枚举下方添加所有新枚举，直到主 API 版本更改。
ContainerName	13	容器名称。
ContainerUrl	14	容器 URL。
IconUrl	15	图标 URL。

SourcePropertyDefinition

为数据源中的项定义单个源属性。有关架构属性定义的详细信息，请参阅属性资源类型。

属性	类型	说明
name	string	属性的名称。
type	SourcePropertyType	属性的数据类型。
defaultSearchAnnotations	uint32	属性的默认搜索注释。
requiredSearchAnnotations	uint32	所需的搜索批注。某些属性（如 ID ）始终设置为 isQueryable`true` 和 isRetrievable`true`。
defaultSemanticLabels	重复的 SearchPropertyLabel	源属性的语义标签列表。
以	int32	此源属性的顺序。由 UI 用于对搜索结果进行排序。可选。
标签	string	此源属性的标签。由搜索结果 UI 用来显示标签 (用户可读名称) 。可选。
别名	重复字符串	此源属性的别名列表。可选。