resourcePolicyRoot: evaluateAssignedPolicies

名前空間: microsoft.graph

重要

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

resourcePolicyRoot を使用して、指定された API 要求に適用可能な割り当て済みポリシーを評価します。

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

API の可用性

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

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

アクセス許可

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

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

重要

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

HTTP 要求

POST /admin/resourcePolicy/evaluateAssignedPolicies

要求ヘッダー

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

要求本文

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

パラメーター 型 説明
resourceUri String 必須です。 評価する要求またはリソースの URI ( /beta/applications など)。
httpMethod requestHttpMethod 必須です。 シミュレートされた要求の HTTP メソッド。 使用可能な値: post、patch、put、get、delete、unknownFutureValue。
resourceBody Json 必須です。 シミュレートされた要求の JSON 本文。 この null 許容パラメーターは null に設定できます。
scope String 省略可能。 評価スコープ。 既定値は / (テナント) です。
isResultDetailed ブール値 省略可能。 詳細な成功したポリシー結果を要求するかどうか。 既定値は false です。 この値に関係なく、エラーを含む詳細を返すことができます。
includeNormalizedRequestInput ブール値 省略可能。 ポリシー エンジンの入力ドキュメントを応答に含めるかどうか。 既定値は false です。

応答

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

例

これらの例では、テナントのスコープ / で次の有効な割り当てがあることを前提としています。 どちらのポリシーも、アプリケーションの作成操作と更新操作に適用されます。

割り当ての一意の名前 定義の一意の名前 ポリシー要件 強制モード
tenant_application_baseline require_application_name アプリケーションに空でない displayName があります。 doNotEnforce
tenant_application_audience require_single_tenant_application アプリケーションの signInAudience が AzureADMyOrg です。 enforce

例 1:割り当てられた複数のポリシーを評価する

シミュレートされた要求は、表示名とマルチテナント サインイン対象ユーザーを提供します。 名前ポリシーは compliant を報告し、対象ユーザー ポリシーは deny を報告します。 対象ユーザーのポリシーが適用されるため、集計結果は appliedPoliciesEffects が deny に設定され、 isBlocked が true に設定されています。

要求

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

{
  "resourceUri": "/beta/applications",
  "httpMethod": "post",
  "resourceBody": {
    "displayName": "Contoso application",
    "signInAudience": "AzureADMultipleOrgs"
  },
  "scope": "/",
  "isResultDetailed": true
}

応答

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

{
  "@odata.type": "#microsoft.graph.policiesEvaluationResult",
  "resourceUri": "/beta/applications",
  "httpMethod": "post",
  "appliedPoliciesEffects": "deny",
  "isBlocked": true,
  "message": "Resource is non-compliant with policies: require_single_tenant_application.",
  "normalizedRequestInput": null,
  "details": [
    {
      "@odata.type": "#microsoft.graph.policiesEvaluationDetail",
      "assignmentUniqueName": "tenant_application_baseline",
      "assignedPolicyDisplayName": "Require an application name",
      "appliedPolicyEffects": "compliant",
      "enforcementMode": "doNotEnforce",
      "reasons": null,
      "errorDetails": null
    },
    {
      "@odata.type": "#microsoft.graph.policiesEvaluationDetail",
      "assignmentUniqueName": "tenant_application_audience",
      "assignedPolicyDisplayName": "Require a single-tenant application",
      "appliedPolicyEffects": "deny",
      "enforcementMode": "enforce",
      "reasons": [
        "Applications must use the AzureADMyOrg sign-in audience."
      ],
      "errorDetails": null
    }
  ]
}

例 2: 正規化された要求入力を検査する

ポリシー エンジンに提供された入力を検査するには、 includeNormalizedRequestInput を true に設定します。 この例では、割り当てられている両方のポリシーを満たすアプリケーション更新プログラムを評価します。 正規化された入力には、API バージョン、呼び出し元の認証コンテキスト、URI セグメントとリソース キー、指定されたリソース本文が含まれます。 認証コンテキストの値は、評価 API の呼び出し元を反映します。

要求

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

{
  "resourceUri": "/beta/applications/8b1c4b61-8369-42e5-8f6c-624d27dfba20",
  "httpMethod": "patch",
  "resourceBody": {
    "displayName": "Contoso application",
    "signInAudience": "AzureADMyOrg"
  },
  "scope": "/",
  "isResultDetailed": true,
  "includeNormalizedRequestInput": 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": "compliant",
  "isBlocked": false,
  "message": "Resource is compliant with assigned policies.",
  "normalizedRequestInput": {
    "request": {
      "apiVersion": "beta",
      "authContext": {
        "isAppOnly": true,
        "appid": "bdf7919e-a1bd-46d6-b99d-446cc0116353",
        "tid": "f41b6369-cba8-48c9-bf58-1e066b0a46f0",
        "oid": "0d52b272-6161-49d5-a0e8-31082a0e7d19"
      },
      "uriSegments": [
        {
          "name": "applications",
          "type": "microsoft.graph.application",
          "keys": {
            "id": "8b1c4b61-8369-42e5-8f6c-624d27dfba20"
          }
        }
      ],
      "resourceKeys": {
        "id": "8b1c4b61-8369-42e5-8f6c-624d27dfba20"
      }
    },
    "resource": {
      "displayName": "Contoso application",
      "signInAudience": "AzureADMyOrg"
    }
  },
  "details": [
    {
      "@odata.type": "#microsoft.graph.policiesEvaluationDetail",
      "assignmentUniqueName": "tenant_application_baseline",
      "assignedPolicyDisplayName": "Require an application name",
      "appliedPolicyEffects": "compliant",
      "enforcementMode": "doNotEnforce",
      "reasons": null,
      "errorDetails": null
    },
    {
      "@odata.type": "#microsoft.graph.policiesEvaluationDetail",
      "assignmentUniqueName": "tenant_application_audience",
      "assignedPolicyDisplayName": "Require a single-tenant application",
      "appliedPolicyEffects": "compliant",
      "enforcementMode": "enforce",
      "reasons": null,
      "errorDetails": null
    }
  ]
}