resourcePolicyRoot: evaluatePolicy

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Evaluate an inline Rego policy for a provided API request using resourcePolicyRoot.

Esta acción no realiza la solicitud de API simulada. El efecto notificado y si la solicitud se bloquearía se devuelven por separado. Los errores de carga o evaluación de directivas pueden aparecer en la propiedad errorDetails de las entradas de la colección de detalles incluso cuando isResultDetailed es false.

Disponibilidad de API

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ❌ ❌ ❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) ResourcePolicyEvaluation.Read.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación ResourcePolicyEvaluation.Read.All No disponible.

Importante

Para el acceso delegado con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación. El Evaluador de directivas de recursos es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

POST /admin/resourcePolicy/evaluatePolicy

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione los parámetros siguientes.

Parámetro Tipo Description
directiva Cadena Obligatorio. La directiva Rego restringida para evaluar.
resourceUri Cadena Obligatorio. El URI de la solicitud o recurso a evaluar, como /beta/applications.
httpMethod requestHttpMethod Obligatorio. El método HTTP de la solicitud simulada. Los valores posibles son: post, patch, put, get, delete, unknownFutureValue.
resourceBody Json Obligatorio. El cuerpo JSON de la solicitud simulada. Este parámetro que acepta valores NULL se puede establecer en null.
ámbito String Opcional. El alcance de la evaluación. El valor predeterminado es / (el inquilino).
parámetros Json Opcional. Valores del parámetro JSON validados con el paramsSchema declarado de la directiva insertada. Si no se declara ningún esquema de parámetros, se rechaza el suministro de valores.
fetchResponses Colección fetchResponse Opcional. Respuestas de captura simuladas. Omitir o enviar valor NULL para el comportamiento de captura en vivo. Una colección proporcionada, que incluye [], permite la simulación estricta mediante la coincidencia exacta de relativePathUri .
modo de aplicación modo de aplicación Opcional. El modo de cumplimiento para simular. El valor predeterminado es doNotEnforce. Los valores posibles son: doNotEnforce, enforce, unknownFutureValue.
isResultDetailed Booleano Opcional. Si se deben solicitar resultados detallados de la directiva correctos. El valor predeterminado es false. Independientemente de este valor se pueden devolver detalles que contengan errores.
includeNormalizedRequestInput Booleano Opcional. Si se debe incluir el documento de entrada del motor de directivas en la respuesta. El valor predeterminado es false.

Respuesta

Si se realiza correctamente, esta acción devuelve 200 OK un objeto policiesEvaluationResult en el cuerpo de la respuesta.

Ejemplos

Ejemplo 1: Evaluación de una solicitud compatible

Solicitud

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
}

Respuesta

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": []
}

Ejemplo 2: Inspeccionar un resultado no compatible con la aplicación deshabilitada

La directiva requiere un nombre para mostrar de la aplicación. El displayName vacío de la solicitud simulada hace que la directiva notifique deny. La respuesta incluye el motivo de la directiva, y isBlocked se debe false a que enforcementMode es doNotEnforce.

Solicitud

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
}

Respuesta

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
    }
  ]
}

Ejemplo 3: Evaluar una directiva con una respuesta de captura simulada

La directiva debe fetchAsPolicy() leer a los propietarios de la aplicación de destino y requiere al menos un propietario antes de una actualización. La colección fetchResponses proporciona una respuesta simulada 200 OK con una colección de propietarios vacía, por lo que la directiva informa .deny Because enforcementMode is enforce, isBlocked is true.

Cada respuesta simulada especifica relativePathUri, código y datos. El relativePathUri debe coincidir exactamente con el URI usado por la llamada de captura de la directiva, incluida la versión de API y la cadena de consulta. Proporcionar fetchResponses permite una simulación estricta: una recuperación sin respuesta coincidente produce un error en lugar de volver a una lectura de Microsoft Graph en vivo.

La actualización de la aplicación no se realiza y los propietarios no se leen desde Microsoft Graph.

Solicitud

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
}

Respuesta

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
    }
  ]
}