协议资源类型

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示使用Microsoft Entra ID 治理创建和管理的租户的可自定义使用条款协议。 可以根据方案使用以下方法创建和管理Microsoft Entra使用条款功能。

方法

方法	返回类型	说明
创建	合同	通过发布到协议集合来创建新协议。
List	协议 集合	获取协议对象集合。
Get	合同	读取协议对象的属性和关系。
更新	无	更新协议对象。
删除	无	删除协议对象。

属性

属性	类型	说明
displayName	String	协议的显示名称。 显示名称用于对协议进行内部跟踪，但不会向查看协议的最终用户显示。 支持 $filter（eq）。
id	String	只读。 支持 $filter（eq）。
isPerDeviceAcceptanceRequired	布尔值	此设置使你能够要求最终用户在访问协议的每台设备上接受此协议。 最终用户需要在 Microsoft Entra ID 中注册其设备（如果尚未注册）。 支持 $filter（eq）。
isViewingBeforeAcceptanceRequired	布尔值	指示用户在接受协议之前是否必须展开协议。 支持 $filter（eq）。
termsExpiration	termsExpiration	所有用户的到期计划和协议频率。 支持 $filter（eq）。
userReacceptRequiredFrequency	持续时间	用户必须重新接受使用条款的持续时间。 该值在持续时间内以 ISO 8601 格式表示。

关系

关系	类型	说明
承兑	agreementAcceptance 集合	此为只读属性。 有关接受本协议的信息。
file	agreementFile	链接到本协议的默认 PDF。
files	agreementFileLocalization 集合	链接到本协议的 PDF。 注意： 此属性正在弃用。 请改用 file 属性。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "@odata.type": "#microsoft.graph.agreement",
  "id": "String (identifier)",
  "displayName": "String",
  "termsExpiration": {
    "@odata.type": "microsoft.graph.termsExpiration"
  },
  "userReacceptRequiredFrequency": "String (duration)",
  "isViewingBeforeAcceptanceRequired": "Boolean",
  "isPerDeviceAcceptanceRequired": "Boolean"
}

相关内容

• Microsoft Entra使用条款