协议资源类型

命名空间：microsoft.graph

重要

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

表示租户的可自定义使用条款协议，该协议是使用 Azure Active Directory (Azure AD) 。 您可以使用以下方法根据你的方案创建和管理Azure Active Directory使用条款"功能。

Methods

方法	返回类型	说明
Create	协议	通过发布到协议集合创建新协议。
列表	协议 集合	获取协议对象集合。
Get	协议	读取协议对象的属性和关系。
更新	无	更新协议对象。
删除	无	删除协议对象。
列出接受	agreementAcceptance 集合	获取有关特定协议的接受记录的详细信息。
List agreementAcceptances	agreementAcceptance 集合	获取已登录用户的协议接受。
获取 agreementFile	agreementFile 集合	检索协议的默认文件的详细信息，包括语言和版本信息。
列出文件	agreementFileLocalization 集合	检索与协议相关的所有本地化文件。
创建 agreementFileLocalization	agreementFileLocalization	创建新的本地化协议文件。

属性

属性	类型	说明
displayName	字符串	协议的显示名称。 The 显示名称 is used for internal tracking of the agreement but is not shown to end users who view the agreement. 支持 $filter（eq）。
id	字符串	只读。 支持 $filter（eq）。
isPerDeviceAcceptanceRequired	布尔值	此设置使你能够要求最终用户在从其访问它的每个设备上接受此协议。 如果最终用户尚未注册设备，Azure AD注册设备。 支持 $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"
}