activityBasedTimeoutPolicy リソースの種類

名前空間: microsoft.graph

重要

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

アクティビティ ベースのタイムアウト機能をサポートするアプリケーションの Web セッションのアイドル タイムアウトを制御できるポリシーを表します。 アプリケーションでは、非アクティブな期間が経過した後に自動サインアウトが適用されます。 この種類のポリシーは、organization レベルでのみ適用できます (isOrganizationDefault プロパティを にtrue設定します)。

stsPolicy から継承します。

メソッド

メソッド	戻り値の型	説明
activityBasedTimeoutPolicy を作成する	activityBasedTimeoutPolicy	activityBasedTimeoutPolicy オブジェクトを作成します。
activityBasedTimeoutPolicy を取得する	activityBasedTimeoutPolicy	activityBasedTimeoutPolicy オブジェクトのプロパティとリレーションシップを読み取ります。
アクティビティの一覧表示BasedTimeoutPolicies	activityBasedTimeoutPolicy	activityBasedTimeoutPolicy オブジェクトのプロパティとリレーションシップを読み取ります。
アクティビティの更新BasedTimeoutPolicy	なし	activityBasedTimeoutPolicy オブジェクトを更新します。
activityBasedTimeoutPolicy を削除する	なし	activityBasedTimeoutPolicy オブジェクトを削除します。

プロパティ

プロパティ	型	説明
id	String	このポリシーの一意識別子。 読み取り専用。
definition	String collection	このポリシーの規則と設定を定義する JSON 文字列を含む文字列コレクション。 このプロパティの JSON スキーマの詳細については、以下を参照してください。 必須です。
説明	String	このポリシーの説明。
displayName	String	このポリシーの表示名。 必須です。
isOrganizationDefault	ブール型	true に設定すると、このポリシーがアクティブになります。 同じポリシーの種類に対して多数のポリシーを使用できますが、organizationの既定値としてアクティブ化できるのは 1 つだけです。 省略可能です。既定値は false です。

アクティビティ ベースのタイムアウト ポリシー定義のプロパティ

以下のプロパティは、アクティビティ ベースのタイムアウト ポリシーを表す JSON オブジェクトを形成します。 この JSON オブジェクトは、定義プロパティに挿入するには、引用符がエスケープされた文字列に変換する必要があります。 JSON 形式の例を次に示します。

{
  "definition":["{\"ActivityBasedTimeoutPolicy\":{\"Version\":1,\"ApplicationPolicies\":[{\"ApplicationId\":\"default\",\"WebSessionIdleTimeout\":\"01:00:00\"},{\"ApplicationId\":\"c44b4083-3bb0-49c1-b47d-974e53cbdf3c\",\"WebSessionIdleTimeout\":\"00:15:00\"}]}}"]
}

注: これらのプロパティのすべての期間は、"dd.hh:mm:ss" 形式で指定されます。

注: "日数" で示されるプロパティの最大値は、示された日数の 1 秒足りない値です。 たとえば、1 日の最大値は "23:59:59" として指定されます。

プロパティ	型	説明
バージョン	整数	ポリシーのバージョン。 値を 1 に設定します。 必須です。
ApplicationPolicies	JSON オブジェクト	アプリケーション ポリシーのコレクション。 アプリケーション ポリシーは、ApplicationId と WebSessionIdleTimeout の組み合わせです。 ApplicationId: 許可される値: default: アクティビティ ベースのタイムアウト機能をサポートしているが、アプリケーション固有のオーバーライドがないすべてのアプリケーションにポリシーを適用します c44b4083-3bb0-49c1-b47d-974e53cbdf3c: ポリシーをAzure portalに適用します WebSessionIdleTimeout: ユーザーの Web セッションの有効期限が切れていると見なされるユーザー非アクティブ期間。 最小値は 5 分です。最大値は 1 日です。

リレーションシップ

なし

JSON 表記

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

{
  "definition": ["String"],
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": true
}