resourcePolicyRoot: evaluatePolicy

名前空間: microsoft.graph

重要

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

resourcePolicyRoot を使用して、指定された API 要求のインライン Rego ポリシーを評価します。

このアクションでは、シミュレートされた API 要求は実行されません。 報告された効果と要求がブロックされるかどうかは別々に返されます。 isResultDetailed が false の場合でも、ポリシーの読み込みまたは評価エラーが詳細コレクションのエントリの errorDetails プロパティに表示されることがあります。

API の可用性

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) ResourcePolicyEvaluation.Read.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション ResourcePolicyEvaluation.Read.All 注意事項なし。

重要

職場または学校アカウントを使用して委任されたアクセスの場合、サインインしたユーザーには、サポートされている Microsoft Entra ロール 、またはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 リソース ポリシー エバリュエーター は、この操作でサポートされる最小特権ロールです。

HTTP 要求

POST /admin/resourcePolicy/evaluatePolicy

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

リクエストの本文で、次のパラメーターを指定します。

パラメーター 型 説明
役割 String 必須です。 評価する文字列化された Rego ポリシー。
resourceUri String 必須です。 評価する要求またはリソースの URI ( /beta/applications など)。
httpMethod requestHttpMethod 必須です。 シミュレートされた要求の HTTP メソッド。 使用可能な値: post、patch、put、get、delete、unknownFutureValue。
resourceBody Json 必須です。 シミュレートされた要求の JSON 本文。 この null 許容パラメーターは null に設定できます。
scope String 省略可能。 評価スコープ。 既定値は / (テナント) です。
params Json 省略可能。 インライン ポリシーの宣言された paramsSchema に対して検証された JSON パラメーター値。 パラメーター スキーマが宣言されていない場合、値の指定は拒否されます。
fetchResponses fetchResponse コレクション 省略可能。 シミュレートされたフェッチ応答。 ライブ フェッチ動作の場合は、省略するか null を送信します。 指定されたコレクション ( [] を含む) を使用すると、正確な relativePathUri 照合を使用して厳密なシミュレーションが可能になります。
enforcementMode enforcementMode 省略可能。 シミュレートする強制モード。 既定値は doNotEnforce です。 使用可能な値: doNotEnforce、enforce、unknownFutureValue。
isResultDetailed ブール値 省略可能。 詳細な成功したポリシー結果を要求するかどうか。 既定値は false です。 この値に関係なく、エラーを含む詳細を返すことができます。
includeNormalizedRequestInput ブール値 省略可能。 ポリシー エンジンの入力ドキュメントを応答に含めるかどうか。 既定値は false です。

応答

成功した場合、このアクションは応答本文で 200 OK と policiesEvaluationResult オブジェクトを返します。

例

例 1: 準拠要求を評価する

要求

POST https://graph.microsoft.com/beta/admin/resourcePolicy/evaluatePolicy
Content-Type: application/json

{
  "policy": "package graph.require_application_name[\"1.0.0\"]\n\n__metadata__ := {\n  \"title\": \"Require an application name\",\n  \"description\": \"Require applications to have a display name\",\n  \"category\": \"identityAndTenant\",\n  \"selector\": {\n    \"resourceName\": \"microsoft.graph.application\",\n    \"operations\": [\n      \"create\",\n      \"updateOrUpsert\"\n    ]\n  }\n}\n\ndefault deny := {\"result\": false, \"reasons\": []}\n\ndeny := {\"result\": true, \"reasons\": [\"A display name is required.\"]} if {\n  object.get(input.resource, \"displayName\", \"\") == \"\"\n}\n",
  "resourceUri": "/beta/applications",
  "httpMethod": "post",
  "resourceBody": {
    "displayName": "Contoso application"
  },
  "enforcementMode": "doNotEnforce",
  "isResultDetailed": false
}

応答

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.policiesEvaluationResult",
  "resourceUri": "/beta/applications",
  "httpMethod": "post",
  "appliedPoliciesEffects": "compliant",
  "isBlocked": false,
  "message": "Resource is compliant with assigned policies.",
  "normalizedRequestInput": null,
  "details": []
}

例 2: 強制が無効になっている非準拠の結果を検査する

ポリシーには、アプリケーションの表示名が必要です。 シミュレートされた要求で空の displayName を指定すると、ポリシーは denyを報告します。 応答にはポリシーの理由が含まれており、enforcementMode が doNotEnforce であるため、isBlocked はfalseです。

要求

POST https://graph.microsoft.com/beta/admin/resourcePolicy/evaluatePolicy
Content-Type: application/json

{
  "policy": "package graph.require_application_name[\"1.0.0\"]\n\n__metadata__ := {\n  \"title\": \"Require an application name\",\n  \"description\": \"Require applications to have a display name\",\n  \"category\": \"identityAndTenant\",\n  \"selector\": {\n    \"resourceName\": \"microsoft.graph.application\",\n    \"operations\": [\n      \"create\",\n      \"updateOrUpsert\"\n    ]\n  }\n}\n\ndefault deny := {\"result\": false, \"reasons\": []}\n\ndeny := {\"result\": true, \"reasons\": [\"A display name is required.\"]} if {\n  object.get(input.resource, \"displayName\", \"\") == \"\"\n}\n",
  "resourceUri": "/beta/applications",
  "httpMethod": "post",
  "resourceBody": {
    "displayName": ""
  },
  "enforcementMode": "doNotEnforce",
  "isResultDetailed": true
}

応答

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.policiesEvaluationResult",
  "resourceUri": "/beta/applications",
  "httpMethod": "post",
  "appliedPoliciesEffects": "deny",
  "isBlocked": false,
  "message": "Resource is non-compliant with policies: PolicyEvaluation.",
  "normalizedRequestInput": null,
  "details": [
    {
      "@odata.type": "#microsoft.graph.policiesEvaluationDetail",
      "assignmentUniqueName": "PolicyEvaluation",
      "assignedPolicyDisplayName": "Require an application name",
      "appliedPolicyEffects": "deny",
      "enforcementMode": null,
      "reasons": [
        "A display name is required."
      ],
      "errorDetails": null
    }
  ]
}

例 3: シミュレートされたフェッチ応答を使用してポリシーを評価する

このポリシーでは、 fetchAsPolicy() を使用してターゲット アプリケーションの所有者を読み取り、更新の前に少なくとも 1 人の所有者が必要です。 fetchResponses コレクションは、空の所有者コレクションを持つシミュレートされた 200 OK 応答を提供するため、ポリシーはdenyレポートします。 enforcementMode が enforce であるため、isBlocked はtrueです。

シミュレートされた各応答では、 relativePathUri、 コード、 データを指定します。 relativePathUri は、API のバージョンやクエリ文字列など、ポリシーのフェッチ呼び出しで使用される URI と完全に一致する必要があります。 fetchResponses を指定すると厳密なシミュレーションが可能になります。一致する応答がないフェッチでは、ライブ Microsoft Graph 読み取りにフォールバックする代わりにエラーが生成されます。

アプリケーションの更新は実行されず、所有者は Microsoft Graph から読み取られません。

要求

POST https://graph.microsoft.com/beta/admin/resourcePolicy/evaluatePolicy
Content-Type: application/json

{
  "policy": "package graph.require_application_owner[\"1.0.0\"]\n\n__metadata__ := {\n  \"title\": \"Require an application owner\",\n  \"description\": \"Require applications to have an owner before updates\",\n  \"category\": \"identityAndTenant\",\n  \"selector\": {\n    \"resourceName\": \"microsoft.graph.application\",\n    \"operations\": [\"updateOrUpsert\"]\n  }\n}\n\ndefault deny := {\"result\": false, \"reasons\": []}\n\ndeny := {\"result\": true, \"reasons\": [\"The application must have at least one owner.\"]} if {\n  not has_owner\n}\n\nhas_owner if {\n  owners := fetchAsPolicy({\n    \"relativePathUri\": sprintf(\n      \"/%s/applications/%s/owners?$select=id\",\n      [input.request.apiVersion, input.request.resourceKeys.id]\n    )\n  })\n  owners.code == 200\n  count(owners.data.value) > 0\n}\n",
  "resourceUri": "/beta/applications/8b1c4b61-8369-42e5-8f6c-624d27dfba20",
  "httpMethod": "patch",
  "resourceBody": {
    "displayName": "Contoso application"
  },
  "fetchResponses": [
    {
      "relativePathUri": "/beta/applications/8b1c4b61-8369-42e5-8f6c-624d27dfba20/owners?$select=id",
      "code": 200,
      "data": {
        "value": []
      }
    }
  ],
  "enforcementMode": "enforce",
  "isResultDetailed": true
}

応答

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.policiesEvaluationResult",
  "resourceUri": "/beta/applications/8b1c4b61-8369-42e5-8f6c-624d27dfba20",
  "httpMethod": "patch",
  "appliedPoliciesEffects": "deny",
  "isBlocked": true,
  "message": "Resource is non-compliant with policies: PolicyEvaluation.",
  "normalizedRequestInput": null,
  "details": [
    {
      "@odata.type": "#microsoft.graph.policiesEvaluationDetail",
      "assignmentUniqueName": "PolicyEvaluation",
      "assignedPolicyDisplayName": "Require an application owner",
      "appliedPolicyEffects": "deny",
      "enforcementMode": "enforce",
      "reasons": [
        "The application must have at least one owner."
      ],
      "errorDetails": null
    }
  ]
}