changeNotification リソース タイプ

名前空間: microsoft.graph

Microsoft Graph サブスクリプションのサブスクライバー (アプリ) に送信される通知を表します。 このリソースのすべてのプロパティは読み取り専用です。

詳細については、「 Microsoft Graph を使用して変更通知を取得する」を参照してください。

メソッド

なし。

プロパティ

注:
changeType プロパティは必須であり、変更通知にのみ存在します。 lifecycleEvent プロパティは必須であり、ライフサイクル通知にのみ存在します。 これら 2 つのプロパティは相互に排他的です。通知にはそのうちの 1 つだけが含まれます。

プロパティ 型 説明
changeType changeType 変更通知を発行する変更の種類を示します。 必須で、変更通知にのみ存在します。 lifecycleEvent と同時に使用することはできません。 使用可能な値: created、updated、deleted、unknownFutureValue。 unknownFutureValue は、将来の拡張性のために予約された進化可能な列挙型 Sentinel です。 この追加では、新しい通知変更の種類が導入されたり、既存の通知配信が変更されたりすることはありません。
clientState string サブスクリプション要求で送信された clientState プロパティの値 (存在する場合)。 最大の長さは、255 文字です。 クライアントは、clientState プロパティの値を比較することで、変更通知がサービスから送信されたかどうかをチェックできます。 サブスクリプションで送信された clientState プロパティの値は、各変更通知で受け取った clientState プロパティの値と比較されます。 省略可能。
encryptedContent changeNotificationEncryptedContent (プレビュー)変更通知に添付された暗号化されたコンテンツ。 サブスクリプション要求中に encryptionCertificate と includeResourceData が定義され、リソースでサポートされている場合にのみ提供されます。 省略可能。
id string 通知の一意の ID。 省略可能。
lifecycleEvent lifecycleEventType ライフサイクル通知の種類。 必須であり、ライフサイクル通知にのみ存在します。 changeType と同時に使用することはできません。 サポートされている値: missed、 subscriptionRemoved、 reauthorizationRequired。
resource String https://graph.microsoft.com に関連する変更通知を生成したリソースの URI。 必須です。
resourceData resourceData このプロパティの内容は、サブスクリプションの対象となるリソースの種類に応じて異なります。 省略可能。
subscriptionExpirationDateTime DateTimeOffset サブスクリプションの有効期限が切れるとき。 必須です。
subscriptionId Guid 通知を生成したサブスクリプションの一意の ID。必須。
tenantId Guid 変更通知の送信元のテナントの一意識別子。 必須です。

リレーションシップ

なし。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "@odata.type": "#microsoft.graph.changeNotification",
  "changeType": "String",
  "clientState": "String",
  "encryptedContent": {
    "@odata.type": "microsoft.graph.changeNotificationEncryptedContent"
  },
  "id": "String (identifier)",
  "lifecycleEvent": "String",
  "resource": "String",
  "resourceData": {
    "@odata.type": "microsoft.graph.resourceData"
  },
  "subscriptionExpirationDateTime": "String (timestamp)",
  "subscriptionId": "Guid",
  "tenantId": "Guid"
}