ワークフロー リソースの種類

  • [アーティクル]

名前空間: microsoft.graph.identityGovernance

重要

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

ライフサイクル ワークフローを使用して作成されたワークフローを表します。 ワークフローは、実行条件によってトリガーされると、タスクを使用してライフサイクル管理プロセスの一部を自動化します。 これらのタスクは組み込みのタスクでも、Azure Logic Apps と統合されたカスタム タスク拡張機能を使用してカスタム タスクを呼び出すことができます。

テナントには最大 100 個のワークフローを作成できます。

workflowBase から継承します。

メソッド

メソッド 戻り値の種類 説明
ワークフローをリスト microsoft.graph.identityGovernance.workflow コレクション ワークフロー オブジェクトとそのプロパティの一覧を取得します。
ワークフローの作成 microsoft.graph.identityGovernance.workflow 新しい ワークフロー オブジェクトを作成します。
ワークフローを取得する microsoft.graph.identityGovernance.workflow ワークフロー オブジェクトのプロパティとリレーションシップを読み取ります。
ワークフローの更新 microsoft.graph.identityGovernance.workflow ワークフロー オブジェクトのプロパティを更新します。
ワークフローの削除 なし ワークフロー オブジェクトを削除します。
スコープ内のユーザーを一覧表示する microsoft.graph.user コレクション ワークフロー オブジェクトの実行条件のスコープ内にあるユーザーの一覧を取得します。
削除されたワークフローを取得する microsoft.graph.identityGovernance.workflow 削除されたワークフローを取得 します。
ワークフローを完全に削除する なし ワークフロー オブジェクトを完全に削除します。
削除されたワークフローを一覧表示する microsoft.graph.identityGovernance.workflow コレクション 削除された ワークフロー オブジェクトとそのプロパティの一覧を取得します。
アクティブ 化 なし ワークフローをオンデマンドで実行します。
workflowVersion を作成する microsoft.graph.identityGovernance.workflowVersion 新しい workflowVersion オブジェクトを作成します。
復元 microsoft.graph.identityGovernance.workflow 削除されたワークフローを復元します。
実行の一覧表示 microsoft.graph.identityGovernance.run コレクション ワークフローの 実行 の一覧を取得します。
タスクを取得する microsoft.graph.identityGovernance.task コレクション ワークフロー内の タスク のプロパティを取得します。
List tasks microsoft.graph.identityGovernance.task コレクション ワークフロー内の タスク オブジェクトの一覧を取得します。
バージョンを一覧表示する microsoft.graph.identityGovernance.workflowVersion コレクション ワークフローのワークフロー バージョンの一覧を取得します。

プロパティ

プロパティ 型 説明
category microsoft.graph.identityGovernance.lifecycleWorkflowCategory このテンプレートを使用して作成されたワークフローでサポートされる HR 関数のカテゴリ。 ワークフローは 1 つのカテゴリにのみ属できます。 使用可能な値は、 joiner、、 leaver、 moverですunknownFutureValue。 workflowBase から継承されます。 必須です。

サポート ($filtereq,ne) と$orderby
createdDateTime DateTimeOffset が workflow 作成されたとき。 workflowBase から継承されます。

$filter(lt、legt、negeeq) と をサポートします。$orderby
deletedDateTime DateTimeOffset ワークフローが削除されたとき。

$filter(lt、legt、negeeq) と をサポートします。$orderby
説明 String の workflow説明。 workflowBase から継承されます。 省略可能です。
displayName String の表示名 workflow。 workflowBase から継承されます。 必須です。

(、ne) と をorderbyサポートします$filter。eq
executionConditions microsoft.graph.identityGovernance.workflowExecutionConditions ワークフローを実行するタイミングと、スコープ内のサブジェクト セットを識別する条件を記述する条件。 workflowBase から継承されます。 必須。
id String 特定のワークフローに個別に対処するために使用される識別子。

(、ne) と を$orderbyサポートします$filter。eq
isEnabled ブール値 ワークフローが有効か無効か。 この設定が の場合、ワークフローは trueオンデマンドで実行することも、 isSchedulingEnabled が の場合は trueスケジュールに従って実行することもできます。 workflowBase から継承されます。 省略可能です。 既定値は true です。

(、ne) と をorderByサポートします$filter。eq
isSchedulingEnabled ブール型 の場合 true、ライフサイクル ワークフロー エンジンは 、テナント設定によって定義されたスケジュールに基づいてワークフローを実行します。 無効なワークフローに対しては指定できません true ( isEnabled は falseです)。 workflowBase から継承されます。 省略可能です。 既定値は false です。

(、ne) と をorderByサポートします$filter。eq
lastModifiedDateTime DateTimeOffset が最後に workflow 変更された日時。 workflowBase から継承されます。

$filter(lt、legt、negeeq) と をサポートします。$orderby
nextScheduleRunDateTime DateTimeOffset 実行条件に一致するユーザーが存在する場合、スケジュール間隔に基づいて、 が次に実行されることが予想される日付時刻 workflow 。

(,gt) と を$orderbyサポートします$filter。lt
version Int32 ワークフローの現在のバージョン番号。 ワークフローの初回作成時の値は 1 です。

$filter(lt、legt、negeeq) と をサポートします。$orderby

リレーションシップ

リレーションシップ 型 説明
createdBy user ワークフロー オブジェクトを作成したMicrosoft Entra ユーザーの一意識別子。 workflowBase から継承されます。

(、ne) と を$expandサポートします$filter。eq
executionScope microsoft.graph.user コレクション ワークフロー オブジェクトを最後に変更したMicrosoft Entra ID の一意識別子。
lastModifiedBy user ワークフロー オブジェクトを最後に変更したユーザー。 workflowBase から継承されます。

(、ne) と を$expandサポートします$filter。eq
実行 microsoft.graph.identityGovernance.run コレクション ワークフローが実行されます。
taskReports microsoft.graph.identityGovernance.taskReport コレクション ワークフロー オブジェクト内のタスクのタスク実行データの集計を表します。
tasks microsoft.graph.identityGovernance.task コレクション ワークフロー オブジェクト内で実行する構成済みタスクとその実行シーケンスを表します。 workflowBase から継承されます。 必須です。
userProcessingResults microsoft.graph.identityGovernance.userProcessingResult コレクション ユーザーごとのワークフロー実行結果。
versions microsoft.graph.identityGovernance.workflowVersion コレクション 使用可能なワークフロー バージョン。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "@odata.type": "#microsoft.graph.identityGovernance.workflow",
  "category": "String",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "executionConditions": {
    "@odata.type": "microsoft.graph.identityGovernance.workflowExecutionConditions"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "deletedDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "isEnabled": "Boolean",
  "isSchedulingEnabled": "Boolean",
  "nextScheduleRunDateTime": "String (timestamp)",
  "version": "Integer"
}