agreement リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

テナントで作成および管理されるテナントのカスタマイズ可能な使用条件 (Azure Active Directory) をAzure AD。 以下の方法を使用して、シナリオに応じて、Azure Active Directory利用規約機能を作成および管理できます。

メソッド

メソッド	戻り値の型	説明
Create	契約	契約コレクションに投稿して、新しい契約を作成します。
リスト	契約 の収集	アグリーメント オブジェクト コレクションを取得します。
Get	契約	アグリーメント オブジェクトのプロパティとリレーションシップを読み取る。
Update	なし	アグリーメント オブジェクトを更新します。
Delete	なし	アグリーメント オブジェクトを削除します。
リストの受け入れ	agreementAcceptance コレクション	特定の契約の承諾レコードに関する詳細を取得します。
agreementAcceptances を一覧表示する	agreementAcceptance コレクション	サインインしているユーザーの同意を取得します。
AgreementFile を取得する	agreementFile コレクション	言語やバージョン情報など、契約の既定のファイルの詳細を取得します。
リスト ファイル	agreementFileLocalization コレクション	契約に関連するローカライズされたファイルを取得します。
AgreementFileLocalization の作成	agreementFileLocalization	ローカライズされた新しい契約ファイルを作成します。

プロパティ

プロパティ	型	説明
displayName	文字列	契約の名前を表示します。 表示名は、契約の内部追跡に使用されますが、契約を表示するエンド ユーザーには表示されません。 $filter (eq)をサポートしています。
id	String	読み取り専用です。 $filter (eq)をサポートしています。
isPerDeviceAcceptanceRequired	Boolean	この設定を使用すると、エンド ユーザーがアクセスしているすべてのデバイスでこの契約に同意する必要があります。 エンド ユーザーは、デバイスをまだ登録していない場合Azure ADにデバイスを登録する必要があります。 $filter (eq)をサポートしています。
isViewingBeforeAcceptanceRequired	Boolean	ユーザーが同意する前に契約を展開する必要があるかどうかを示します。 $filter (eq)をサポートしています。
termsExpiration	termsExpiration	すべてのユーザーの有効期限スケジュールと契約の頻度。 $filter (eq)をサポートしています。
userReacceptRequiredFrequency	期間	ユーザーが使用条件を再承諾する必要がある期間。 この値は、期間の ISO 8601 形式で表されます。

リレーションシップ

リレーションシップ	型	説明
受け入れ	agreementAcceptance コレクション	読み取り専用です。 本契約の承諾に関する情報。
file	agreementFile	この契約にリンクされている既定の PDF。
ファイル	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"
}