agreementFile 资源类型

命名空间：microsoft.graph

重要

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

表示租户使用 Microsoft Entra ID 管理的可自定义使用条款协议文件。 它包含有关协议文件的元数据， (例如名称、语言以及它是否是默认文件) 。

继承自 agreementFileProperties。

方法

方法	返回类型	说明
获取 agreementFile	agreementFile	读取 agreementFile 对象的属性和关系。
列出 agreementFiles	agreementFile 集合	获取 agreementFile 对象及其属性的列表。
创建 agreementFile	agreementFile	创建新的 agreementFile 对象。
列出本地化	agreementFileLocalization 集合	从本地化导航属性获取 agreementFileLocalization 资源。

属性

属性	类型	说明
createdDateTime	DateTimeOffset	表示文件创建时间的日期时间。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 只读。 继承自 agreementFileProperties。
displayName	String	协议的策略文件的本地化显示名称。 本地化的显示名称会显示给查看协议的最终用户。 继承自 agreementFileProperties。
fileData	agreementFileData	表示使用条款 PDF 文档的数据。 此为只读属性。 继承自 agreementFileProperties。
fileName	String	协议文件的名称 (，例如，TOU.pdf) 。 此为只读属性。 继承自 agreementFileProperties。
id	String	agreementFileVersion 对象的标识符。 此为只读属性。 继承自 agreementFileProperties。
isDefault	布尔值	如果没有任何语言与客户端首选项匹配，则指示这是否是默认协议文件。 如果未将任何文件标记为默认文件，则第一个文件被视为默认文件。 此为只读属性。 继承自 agreementFileProperties。
isMajorVersion	布尔值	指示协议文件是否为主要版本更新。 主要版本更新使协议对相应语言的接受无效。 继承自 agreementFileProperties。
language	String	格式为“languagecode2-country/regioncode2”的协议文件的语言。 “languagecode2”是派生自 ISO 639-1 的小写双字母代码，而“country/regioncode2”派生自 ISO 3166，通常由两个大写字母或 BCP-47 语言标记组成。 例如，美国英语为 en-US。 此为只读属性。 继承自 agreementFileProperties。

关系

关系	类型	说明
定位	agreementFileLocalization 集合	附加到协议的使用条款协议文件的本地化版本。

JSON 表示形式

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

{
  "fileData": {"@odata.type": "microsoft.graph.agreementFileData"},
  "fileName": "String",
  "id": "String (identifier)",
  "isDefault": true,
  "language": "String"
}