Microsoft Graph コネクタ SDK の一般的なモデル

[アーティクル]
12/06/2023

この記事では、Microsoft Graph コネクタ SDK で使用される一般的なモデルについて説明します。

CustomConfiguration

Search 管理は、接続の作成時にコネクタ固有のカスタム構成情報を提供します。プラットフォームでは、構成の構造と形式は管理されません。コネクタ開発者は、任意の形式を使用できます。

プロパティ	型	説明
configuration	string	構成情報を文字列として保持します。コネクタには、文字列の内容を解釈する機能が必要です。

AuthenticationType 列挙メンバー

次の表に、 AuthenticationType 列挙体のメンバーを示します。

メンバー	値	説明
匿名	0	データソースにアクセスするために認証は必要ありません。
Basic	1	データソースにアクセスするためのユーザー名とパスワードの形式の基本認証。
Windows	2	Windows Active Directory ベースの認証では、ユーザー名、パスワード、ドメイン情報がサポートされています。
oAuth2ClientCredential	3	クライアント資格情報を使用した OAuth2 ベースの認証。アプリケーション ID とアプリケーションシークレットをサポートします。

AuthenticationData

認証の種類、データソース URL、資格情報データなど、データソースにアクセスするために管理者が提供する資格情報が含まれます。

プロパティ	型	説明
authType	AuthenticationType	このオブジェクトに保持されている認証情報の種類。
DatasourceUrl	文字列	データソースにアクセスするための URL またはパス - クロールする必要があるリソースへのパス。例: データベースの接続文字列。
basicCredential	BasicCredential	データソースにアクセスするためのユーザー名とパスワードの形式の資格情報。このプロパティは windowsCredential に排他的に設定され、このプロパティが設定されている場合、 authType は Basic に設定されます。
windowsCredential	WindowsCredential	データソースにアクセスするための Windows AD ユーザー名、パスワード、ドメインの形式の資格情報。このプロパティは basicCredential に排他的に設定され、このプロパティが設定されている場合、 authType は Windows に設定されます。
oAuth2ClientCredential	oAuth2ClientCredential	データソースにアクセスするための OAuth クライアント資格情報ベースの認証のアプリ ID とアプリシークレットの形式の資格情報。このプロパティは oAuth2ClientCredential に排他的に設定され、このプロパティが設定されている場合、 authType は oAuth2ClientCredential に設定されます。

BasicCredential

基本的な資格情報モデルを表します。

プロパティ	型	説明
username	string	データソースにアクセスするためのユーザー名。
秘密	文字列	データソースにアクセスするためにユーザー名と共に使用するシークレット。

WindowsCredential

Windows 資格情報モデルを表します。

プロパティ	型	説明
username	string	データソースにアクセスするためのユーザー名。
秘密	string	データソースにアクセスするためにユーザー名と共に使用するシークレット。
domain	string	アカウントの Active Directory ドメイン。管理者が明示的に指定しない場合、このプロパティはコンピューター名の値を保持します。

oAuth2ClientCredential

OAuth2 クライアント資格情報の資格情報モデルを表します。

プロパティ	型	説明
appId	文字列	OAuth2 アプリケーションのアプリケーション ID/クライアント ID。
appSecret	String	OAuth2 アプリケーションのアプリケーションシークレット/クライアントシークレット。
oAuth2ClientCredentialResponse	oAuth2ClientCredentialResponse	OAuth トークン関連の詳細が含まれます。このプロパティは、最初の検証呼び出しが成功した後にコネクタが送信する応答に設定されます。

oAuth2ClientCredentialResponse

OAuth2 トークン要求の認証サーバーからの応答モデルを表します。このモデルに存在するフィールドは、OAuth2 ドキュメントで指定されている一般的な応答フィールドです。さらに、認証サーバーが OpenIDConnect をサポートしている場合は、idToken を設定できます。

プロパティ	型	説明
accessToken	string	認証サーバーからのアクセストークン。
refreshToken	string	認証サーバーから送信された場合の更新トークン。
Tokentype	string	トークンの種類 - 通常、OAuth のベアラートークン。
expiresIn	uint64	Unix タイムスタンプのトークンの有効期限。
scope	string	認証サーバーがトークンを送信する場合に、トークンでサポートされるスコープ。
idToken	string	認証サーバーがオープン ID 接続をサポートしている場合の ID トークン。

OperationResult

OperationResult 列挙には、操作結果に使用できる値が含まれています。

メンバー	値	説明
成功	0	操作はエラーなしで成功しました。
PartialSuccess	1	操作は成功ですが、処理する警告メッセージがあります。
ValidationFailure	2	1 つ以上の検証に失敗しました。
AuthenticationIssue	3	指定された資格情報が機能しませんでした。
DatasourceError	4	データソースの読み取りエラー。
NetworkError	5	ネットワーク操作エラー。
キャンセルされました	6	キャンセルトークンによって操作が取り消されました。
TokenExpired	7	OAuth フローで使用するには、プラットフォームによってコネクタに送信されたトークンの有効期限が切れています。クロール中に、この状態を受信すると、プラットフォームによって更新トークンフローがトリガーされ、ConnectorOAuthService で RefreshAccessToken メソッドが呼び出されます。
SkipItem	8	アイテムをスキップするときにクロールフローで使用する。

OperationStatus

エラー/警告、再試行の詳細など、操作の状態を表します。このモデルは、 ConnectionManagementService と ConnectorCrawlerService のすべての API の応答の一部です。

プロパティ	型	説明
result	OperationResult	操作の結果。
statusMessage	文字列	ログ記録と監視の目的で使用できるカスタムメッセージ。
retryInfo	RetryDetails	失敗した操作に対して同じ操作を再試行するために、フレームワークによって使用される再試行情報。操作が成功した場合、または部分的に成功した場合は無視されます。

RetryType 列挙メンバー

この列挙は、エラーが発生した場合に再試行するための戦略を定義するために使用されます。

メンバー	値	説明
NoRetry	0	再試行する必要はありません。
Standard	1	線形待機時間を使用した標準再試行が行われます。
ExponentialBackOff	2	指数バックオフによる再試行が行われます。

RetryDetails

このモデルは、再試行が必要な再試行ポリシーの通信に使用されます。

プロパティ	型	説明
type	RetryType	再試行の種類は、エラーに必要な再試行戦略の種類を定義します。
numberOfRetries	Uint32	例外に対して実行する再試行回数。
pauseBetweenRetriesInMilliseconds	uint64	標準再試行の場合に再試行間の一時停止を取得します。
backoffCoefficient	浮動小数点数	指数バックオフの計算で使用される係数を取得します。
backoffRate	浮動小数点数	指数バックオフの計算で使用される backoffRate を取得します。

DataSourceSchema

データソース内のデータエンティティを表すプロパティのスキーマを表します。詳細については、「スキーマリソースの種類」を参照してください。

プロパティ	型	説明
PropertyList	繰り返し SourcePropertyDefinition	データソース内の項目を定義するプロパティの一覧を表します。

SourcePropertyType 列挙メンバー

メンバー	値	説明
String	0	string 型のプロパティ。
Int64	1	int64 (long) 型のプロパティ。
倍精度浮動小数点数	2	double 型のプロパティ。
DateTime	3	DateTime 型のプロパティ。
ブール型	4	ブール型のプロパティ。
StringCollection	5	配列の型または文字列型のコレクションのプロパティ。
Int64Collection	6	配列の型または long 型のコレクションのプロパティ。
DoubleCollection	7	配列の型または double 型のコレクションのプロパティ。
DateTimeCollection	8	配列の型または DateTime 型のコレクションのプロパティ。

SearchAnnotations 列挙メンバー

メンバー	値	説明
なし	0	None
IsSearchable	1	プロパティが検索可能な場合、その値はフルテキストインデックスに追加されます。ユーザーが検索を実行すると、検索可能なフィールドまたはそのコンテンツのいずれかに検索ヒットがある場合、結果が返されます。たとえば、プロパティが "Author" の場合、"Smith" を検索すると、Author プロパティに "Smith" が含まれる項目が返されます。
IsQueryable	2	プロパティがクエリ可能な場合は、ナレッジクエリ言語 (KQL) を使用してクエリを実行できます。 KQL は、1つ以上のフリーテキストのキーワード (単語または語句) またはプロパティの制限から構成されます。クエリ自身で指定するか、プログラムでクエリに含めるかして、クエリにプロパティ名を含める必要があります。ワイルドカード演算子 (*) を使用して、一致するプレフィックスを使用できます。たとえば、プロパティが "Author" の場合、検索クエリには "Author: Smith" を指定できます。
IsRetrievable	4	プロパティが取得可能な場合は、検索結果でその値を返すことができます。表示テンプレートに追加するか、クエリから返し、検索結果に関連するプロパティを取得できる必要があります。大きいまたは多すぎるプロパティを取得可能としてマークすると、検索の待ち時間が長くなります。選択的にして、関連するプロパティを選択します。
IsContent	8	Content プロパティは、フルテキストインデックスを作成できるプロパティを識別することです。管理者は、使用可能なプロパティのうち、その特定の接続のコンテンツとして扱うプロパティを選択します。詳細については、「 Content プロパティ」を参照してください。
IsRefinable	16	プロパティが絞り込み可能な場合、管理者は Microsoft Search結果ページでカスタムフィルターとして構成できます。絞り込み可能なプロパティは検索できません。

SearchPropertyLabel

Searchプロパティラベルは、スキーマ内のプロパティに対して追加できる、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	source プロパティのセマンティックラベルの一覧。
順序	int32	このソースプロパティの順序。検索結果を並べ替える UI で使用されます。オプション。
ラベル	文字列	このソースプロパティのラベル。検索結果 UI でラベル (人間が判読できる名前) を表示するために使用されます。省略可能です。
エイリアス	繰り返し文字列	このソースプロパティのエイリアスの一覧。省略可能です。