Общие модели пакета SDK для соединителей Microsoft Graph
В этой статье описываются распространенные модели, используемые в пакете SDK соединителей Microsoft Graph.
CustomConfiguration
Поиск Администратор предоставляет сведения о пользовательской конфигурации соединителя во время создания подключения. Платформа не управляет структурой и форматом конфигурации. Разработчики соединителей могут использовать формат по своему выбору.
| Свойство | Тип | Описание |
|---|---|---|
| configuration | string | Содержит сведения о конфигурации в виде строки. Соединитель должен иметь возможность интерпретировать содержимое строки. |
Элементы перечисления AuthenticationType
В следующей таблице перечислены члены перечисления AuthenticationType .
| Элемент | Значение | Описание |
|---|---|---|
| Анонимный | 0 | Для доступа к источнику данных проверка подлинности не требуется. |
| Обычный | 1 | Обычная проверка подлинности в виде имени пользователя и пароля для доступа к источнику данных. |
| Windows | 2 | Проверка подлинности на основе Windows Active Directory поддерживает имя пользователя, пароль и сведения о домене. |
| oAuth2ClientCredential | 3 | Проверка подлинности на основе OAuth2 с учетными данными клиента. Он поддерживает идентификатор приложения и секрет приложения. |
AuthenticationData
Содержит учетные данные, предоставленные администратором для доступа к источнику данных, включая тип проверки подлинности, URL-адрес источника данных и данные учетных данных.
| Свойство | Тип | Описание |
|---|---|---|
| authType | AuthenticationType | Тип сведений о проверке подлинности, хранящиеся в этом объекте. |
| DatasourceUrl | string | URL-адрес или путь для доступа к источнику данных — путь к ресурсу, который необходимо выполнить обход. Пример. Строка подключения для базы данных. |
| basicCredential | BasicCredential | Учетные данные в виде имени пользователя и пароля для доступа к источнику данных. Для этого свойства будет присвоено монопольное значение windowsCredential, а для authType — значение Basic, если задано это свойство. |
| windowsCredential | WindowsCredential | Учетные данные в виде имени пользователя, пароля и домена Windows AD для доступа к источнику данных. Для этого свойства будет присвоено монопольное значение BasicCredential, а для authType будет присвоено значение Windows, когда это свойство задано. |
| oAuth2ClientCredential | oAuth2ClientCredential | Учетные данные в виде идентификатора приложения и секрета приложения для проверки подлинности на основе учетных данных клиента OAuth для доступа к источнику данных. Для этого свойства будет присвоено монопольное значение oAuth2ClientCredential , а для authType — значение oAuth2ClientCredential, если задано это свойство. |
BasicCredential
Представляет базовую модель учетных данных.
| Свойство | Тип | Описание |
|---|---|---|
| username | string | Имя пользователя для доступа к источнику данных. |
| секрет | string | Секрет, используемый с именем пользователя для доступа к источнику данных. |
WindowsCredential
Представляет модель учетных данных Windows.
| Свойство | Тип | Описание |
|---|---|---|
| username | string | Имя пользователя для доступа к источнику данных. |
| секрет | string | Секрет, используемый с именем пользователя для доступа к источнику данных. |
| domain | string | Домен Active Directory учетной записи. Если администратор явно не указал это свойство, это свойство содержит значение имени компьютера. |
oAuth2ClientCredential
Представляет модель учетных данных для учетных данных клиента OAuth2.
| Свойство | Тип | Описание |
|---|---|---|
| appId | string | Идентификатор приложения или клиента для приложения OAuth2. |
| appSecret | String | Секрет приложения или секрет клиента для приложения OAuth2. |
| oAuth2ClientCredentialResponse | oAuth2ClientCredentialResponse | Содержит сведения, связанные с маркером OAuth. Для этого свойства будет задан ответ, отправляемый соединителем после успешного выполнения первого вызова проверки подлинности. |
oAuth2ClientCredentialResponse
Представляет модель ответа от сервера проверки подлинности для запроса маркера OAuth2. Поля, представленные в этой модели, являются общими полями ответа, указанными в документации OAuth2. Кроме того, idToken можно задать, если серверы проверки подлинности поддерживают OpenIDConnect.
| Свойство | Тип | Описание |
|---|---|---|
| accessToken | строка | Маркер доступа с сервера проверки подлинности. |
| refreshToken | string | Маркер обновления, если сервер проверки подлинности отправляет его. |
| tokenType | string | Тип маркера — обычно маркер носителя для OAuth. |
| expiresIn | uint64 | Время окончания срока действия маркера в метке времени Unix. |
| область | string | Области, поддерживаемые маркером, если сервер проверки подлинности отправляет его. |
| idToken | string | Маркер идентификатора, если сервер проверки подлинности поддерживает открытое подключение по идентификаторам. |
OperationResult
Перечисление OperationResult содержит возможные значения для результатов операции.
| Элемент | Значение | Описание |
|---|---|---|
| Успешно | 0 | Операция выполнена успешно без ошибок. |
| PartialSuccess | 1 | Операция выполнена успешно, но есть предупреждающее сообщение, которое необходимо обработать. |
| ValidationFailure | 2 | Сбой одной или нескольких проверок. |
| AuthenticationIssue | 3 | Предоставленные учетные данные не работали. |
| DatasourceError | 4 | Ошибка чтения источника данных. |
| NetworkError | 5 | Ошибка сетевой операции. |
| Canceled. | 6 | Маркер отмены отменил операцию. |
| TokenExpired | 7 | Используется в потоке OAuth по истечении срока действия маркера, отправленного в соединитель платформой. Во время обхода, получив это состояние, платформа активирует поток маркеров обновления и вызовет метод RefreshAccessToken в ConnectorOAuthService. |
| SkipItem | 8 | Используется в потоке обхода контента при пропуске элемента. |
OperationStatus
Представляет состояние операции, включая ошибки и предупреждения и сведения о повторных попытках. Эта модель является частью ответа всех API в ConnectionManagementService и ConnectorCrawlerService.
| Свойство | Тип | Описание |
|---|---|---|
| result | OperationResult | Результат операции. |
| statusMessage | string | Пользовательское сообщение, которое можно использовать для ведения журнала и мониторинга. |
| retryInfo | RetryDetails | Сведения о повторных попытках, которые будут использоваться платформой для повтора той же операции для неудачной операции. Если операция выполнена успешно или частично успешно, она будет игнорироваться. |
Элементы перечисления RetryType
Это перечисление используется для определения стратегии повторных попыток в случае ошибок.
| Элемент | Значение | Описание |
|---|---|---|
| NoRetry | 0 | Повторная попытка не требуется. |
| Стандартный | 1 | Будет выполнена стандартная повторная попытка с линейным временем ожидания. |
| ExponentialBackOff | 2 | Будет выполнена повторная попытка по экспоненциальной задержке. |
RetryDetails
Эта модель используется для передачи политики повторных попыток, где требуется повторная попытка.
| Свойство | Тип | Описание |
|---|---|---|
| type | RetryType | Тип повторных попыток определяет тип стратегии повтора, необходимой для ошибки. |
| numberOfRetries | uint32 | Количество повторных попыток, которые необходимо выполнить для исключения. |
| pauseBetweenRetriesInMilliseconds | uint64 | Получает паузу между повторными попытками в случае стандартных повторных попыток. |
| backoffCoefficient | float | Возвращает коэффициент, используемый при вычислении экспоненциальной задержки. |
| backoffRate | float | Возвращает значение backoffRate, используемое при вычислении экспоненциальной задержки. |
DataSourceSchema
Представляет схему свойств, представляющих сущность данных в источнике данных. Дополнительные сведения см. в разделе Тип ресурса схемы.
| Свойство | Тип | Описание |
|---|---|---|
| PropertyList | повторение SourcePropertyDefinition | Представляет список свойств, определяющих элемент в источнике данных. |
Элементы перечисления SourcePropertyType
| Элемент | Значение | Описание |
|---|---|---|
| String | 0 | Свойство типа string. |
| Int64 | 1 | Свойство типа int64 (long). |
| Двойное с плавающей точкой | 2 | Свойство типа double. |
| DateTime | 3 | Свойство типа DateTime. |
| Логический | 4 | Свойство типа Boolean. |
| StringCollection | 5 | Свойство типа массива или коллекция строкового типа. |
| Int64Collection | 6 | Свойство типа массива или коллекции типа long. |
| DoubleCollection | 7 | Свойство типа массива или коллекции двойного типа. |
| DateTimeCollection | 8 | Свойство типа массива или коллекции типа DateTime. |
Элементы перечисления SearchAnnotations
| Элемент | Значение | Описание |
|---|---|---|
| Нет | 0 | Нет |
| IsSearchable | 1 | Если свойство доступно для поиска, его значение добавляется в полнотекстовый индекс. Когда пользователь выполняет поиск, результаты возвращаются при попадании в одно из доступных для поиска полей или его содержимое. Например, если свойство имеет значение "Author", поиск "Smith" возвращает элементы, свойство Author которых содержит "Smith". |
| IsQueryable | 2 | Если свойство доступно для запросов, вы можете выполнить запрос к нему с помощью языка запросов знаний (KQL). KQL состоит из одного или нескольких ключевых слов произвольного текста (слов или фраз) или ограничений свойств. Имя свойства должно быть включено в запрос, будучи либо указанным в самом запросе, либо включаемым в запрос программно. Вы можете использовать сопоставление префиксов с помощью оператора подстановочного знака(*). Например, если свойство имеет значение Author, поисковый запрос может иметь значение Author: Smith. |
| IsRetrievable | 4 | Если свойство можно получить, оно может вернуть его значение в результатах поиска. Любое свойство, которое вы хотите добавить в шаблон отображения или возвращать из запроса и быть релевантным в результатах поиска, должно быть извлечено. Пометка больших свойств или слишком большого количества свойств в качестве извлекаемых увеличит задержку поиска. Будьте внимательны и выбирайте нужные свойства. |
| IsContent | 8 | Свойство Content предназначено для идентификации свойства, которое может быть полнотекстово индексировано. Администраторы будут выбирать среди доступных свойств, которые должны быть свойством, которое будет рассматриваться как содержимое для этого конкретного подключения. Дополнительные сведения см. в разделе Свойство Содержимое. |
| IsRefinable | 16 | Если свойство можно уточнить, администратор может настроить его в качестве настраиваемого фильтра на странице результатов поиска (Майкрософт). Уточняемое свойство не может быть доступны для поиска. |
Примечание.
Если соединение имеет семантические метки Title и Url , а любое свойство схемы в соединении помечается как IsContent, содержимое элемента векторизируется в семантический индекс.
SearchPropertyLabel
Метки свойств поиска — это хорошо известные теги, опубликованные корпорацией Майкрософт, которые можно добавить к свойству в схеме. Добавление семантических меток позволяет различным продуктам Майкрософт понимать свойство и обеспечивать более удобное взаимодействие. Дополнительные сведения см. в разделе Семантические метки.
Элементы перечисления SearchPropertyLabel
| Элемент | Значение | Описание |
|---|---|---|
| Название | 0 | Заголовок элемента, который вы хотите отобразить в поиске и других интерфейсах. |
| Url | 1 | Целевой URL-адрес элемента в источнике данных. |
| CreatedBy | 2 | Имя пользователя, создавшего элемент в источнике данных. |
| LastModifiedBy | 3 | Имя пользователя, который последним изменил элемент в источнике данных. |
| авторов | 4 | Имена всех пользователей, которые совместно работали над элементом в источнике данных. |
| CreatedDateTime | 5 | Дата и время создания элемента в источнике данных. |
| LastModifiedDateTime | 6 | Дата и время последнего изменения элемента в источнике данных. |
| FileName | 7 | В случае файла имя файла находится в источнике данных. |
| FileExtension | 8 | В случае файла расширение файла находится в источнике данных. |
| LastModifiedByUpn | 9 | Имя участника-пользователя , который недавно редактировал элемент в источнике данных. |
| CreatedByUpn | 10 | Имя участника-пользователя , создавшего элемент в источнике данных. |
| AuthorsUpn | 11 | Имена участников-пользователей , которые участвовали в работе над элементом в источнике данных или сотрудничали в ней. |
| UnknownFutureValue | 12 | Для проверки правописания в будущем следует следовать расширяемым перечислениям Microsoft Graph. Добавьте все новые перечисления под этим до тех пор, пока не изменится основная версия API. |
| ContainerName | 13 | Имя контейнера. |
| ContainerUrl | 14 | URL-адрес контейнера. |
| IconUrl | 15 | URL-адрес значка. |
SourcePropertyDefinition
Определяет одно свойство источника для элемента в источнике данных. Дополнительные сведения об определениях свойств схемы см. в разделе Тип ресурса свойства.
| Свойство | Тип | Описание |
|---|---|---|
| name | string | Имя свойства. |
| type | SourcePropertyType | Тип данных свойства. |
| defaultSearchAnnotations | uint32 | Заметки поиска по умолчанию для свойства. |
| requiredSearchAnnotations | uint32 | Обязательные заметки поиска. Для некоторых свойств, таких как ID , всегда задано значение isQueryabletrue и isRetrievabletrue. |
| defaultSemanticLabels | повторение SearchPropertyLabel | Список семантических меток для исходного свойства. |
| порядок | int32 | Порядок этого исходного свойства. Используется пользовательским интерфейсом для сортировки результатов поиска. Необязательный параметр. |
| label | string | Метка этого исходного свойства. Используется в пользовательском интерфейсе результатов поиска для отображения метки (понятное для человека имя). Необязательный параметр. |
| Псевдонимы | повторяющаяся строка | Список псевдонимов этого исходного свойства. Необязательный параметр. |