Compartir a través de

Actualizar agentInstance

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.

Actualice las propiedades de un objeto agentInstance . También puede actualizar el agentCardManifest asociado a la instancia del agente incluyendo el manifiesto en el cuerpo de la solicitud.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ❌ ❌ ❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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) AgentInstance.ReadWrite.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación AgentInstance.ReadWrite.All AgentInstance.ReadWrite.ManagedBy

Importante

Cuando se usan permisos delegados, al usuario autenticado se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Administrador del Registro de agente es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

PATCH /agentRegistry/agentInstances/{agentInstanceId}

Encabezados de solicitud

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

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione solo los valores de las propiedades que se van a actualizar. Las propiedades existentes que no se incluyen en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad.

En la tabla siguiente se especifican las propiedades que se pueden actualizar.

Propiedad Tipo Description
ownerIds Colección string Lista de identificadores de propietario para la instancia del agente, pueden ser usuarios o entidades de servicio. Obligatorio.
managedBy Cadena Identificador de aplicación que administra este agente. Opcional.
originatingStore Cadena Nombre del almacén o sistema donde se originó el agente. Opcional.
createdBy String Usuario que creó la instancia del agente (solo lectura). Opcional.
displayName Cadena Nombre para mostrar de la instancia del agente. Obligatorio.
sourceAgentId Cadena Identificador de agente original del sistema de origen. Opcional.
agentIdentityBlueprintId Cadena Identificador del plano técnico de identidad del agente. Opcional.
agentIdentityId Cadena Identificador de identidad del agente de Entra. Opcional.
agentUserId Cadena Identificador de usuario asociado al agente. Opcional.
createdDateTime DateTimeOffset Marca de tiempo cuando se creó la instancia del agente (solo lectura). Opcional.
lastModifiedDateTime DateTimeOffset Marca de tiempo de la última modificación (solo lectura). Opcional.
URL Cadena Dirección URL del punto de conexión de la instancia del agente. Opcional.
preferredTransport Cadena Protocolo de transporte preferido (JSONRPC, GRPC, HTTP+JSON). Opcional.
additionalInterfaces colección agentInterface Interfaces o transportes adicionales admitidos por el agente (dirección URL, transporte). Opcional.
Firmas colección agentCardSignature Firmas digitales para la instancia del agente (protegida, firma, encabezado). Opcional.

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y un objeto agentInstance actualizado en el cuerpo de la respuesta.

Ejemplos

Ejemplo 1: Actualización del agentCardManifest en una agentInstance

Solicitud

En el ejemplo siguiente se muestra la solicitud. La solicitud también crea el agentCardManifest si aún no existe.

PATCH https://graph.microsoft.com/beta/agentRegistry/agentInstances/{agentInstanceId}
Content-Type: application/json

{
  "agentCardManifest": {
    "ownerIds": [
      "0ef68a76-e247-41dd-947b-41282760a2ac"
    ],
    "originatingStore": "Copilot Studio",
    "displayName": "Conditional Access Agent Card",
    "description": "Manages organizational conditional access policies",
    "iconUrl": "https://example.com/icon.png",
    "provider": {
      "organization": "Test Organization",
      "url": "https://test.com"
    },
    "protocolVersion": "1.0",
    "version": "1.0.0",
    "documentationUrl": "https://example.com/docs",
    "capabilities": {
      "streaming": false,
      "pushNotifications": false,
      "stateTransitionHistory": true,
      "extensions": [
        {
          "uri": "https://contoso.example.com/a2a/capabilities/secureMessaging",
          "description": null,
          "required": false,
          "params": {
            "useHttps": true
          }
        }
      ]
    },
    "defaultInputModes": [
      "application/json"
    ],
    "defaultOutputModes": [
      "application/json",
      "text/html"
    ],
    "supportsAuthenticatedExtendedCard": true,
    "skills": [
      {
        "id": "threat-detection",
        "displayName": "Threat Detection",
        "description": "Detect security threats in real-time",
        "tags": [
          "security",
          "threat",
          "detection"
        ],
        "examples": [
          "Analyze this log for threats",
          "Check for malware"
        ],
        "inputModes": [
          "application/json",
          "text/plain"
        ],
        "outputModes": [
          "application/json",
          "text/html"
        ]
      }
    ]
  }
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content

Ejemplo 2: Actualizar una agentInstance para hacer referencia a un agente existenteCardManifest

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/beta/agentRegistry/agentInstances/{agentInstanceId}
Content-Type: application/json

{
  "agentCardManifest@odata.bind": "https://graph.microsoft.com/beta/agentRegistry/agentCardManifests('employee-assistant')"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content

Ejemplo 3: Actualizar displayName

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/beta/agentRegistry/agentInstances/{agentInstanceId}
Content-Type: application/json

{
  "displayName": "Teams Meeting Scheduler Agent"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content
  • Last updated on