Aktualisieren von agentInstance

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Wichtig

Bevorstehende Änderung an den Agent-Registrierungs-APIs

Ab Mai 2026 werden die Agent-Registrierungs-APIs in Microsoft Graph durch die von Microsoft Agent 365 unterstützten Agent-Registrierungs-APIs ersetzt. Diese Änderung konsolidiert die Agent-Verwaltungsfunktionen, um die Beobachtung, Steuerung und Sicherung aller Agents in Ihrem Mandanten zu vereinfachen. Wir empfehlen, die Migration zu den neuen Agent 365-basierten APIs zu planen, sobald sie veröffentlicht werden. Erfahren Sie mehr über die Konvergenz der Agent-Registrierung mit Microsoft Agent 365.

Aktualisieren Sie die Eigenschaften eines agentInstance-Objekts . Sie können auch das agentCardManifest aktualisieren, das der Agent-Instance zugeordnet ist, indem Sie das Manifest in den Anforderungstext einschließen.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) AgentInstance.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application AgentInstance.ReadWrite.All AgentInstance.ReadWrite.ManagedBy

Wichtig

Bei Verwendung delegierter Berechtigungen muss dem authentifizierten Benutzer eine unterstützte Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle zugewiesen werden, die die für diesen Vorgang erforderlichen Berechtigungen erteilt.

Der Agent-Registrierungsadministrator ist die Rolle mit den geringsten Berechtigungen, die für diesen Vorgang unterstützt wird.

HTTP-Anforderung

PATCH /agentRegistry/agentInstances/{agentInstanceId}

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext nur die Werte für die zu aktualisierenden Eigenschaften an. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.

In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.

Eigenschaft Typ Beschreibung
ownerIds Zeichenfolgensammlung Liste der Besitzer-IDs für die Agent-Instance, kann Benutzer oder Dienstprinzipale sein. Erforderlich.
managedBy Zeichenfolge Anwendungsbezeichner, die diesen Agent verwaltet. Optional.
originatingStore Zeichenfolge Name des Speichers/Systems, aus dem der Agent stammt. Optional.
createdBy Zeichenfolge Benutzer, der die Agent-Instance erstellt hat (schreibgeschützt). Optional.
displayName Zeichenfolge Anzeigename für die Agent-Instance. Erforderlich.
sourceAgentId Zeichenfolge Ursprünglicher Agent-Bezeichner aus dem Quellsystem. Optional.
agentIdentityBlueprintId Zeichenfolge Blaupausenbezeichner der Agentidentität. Optional.
agentIdentityId Zeichenfolge Identitätsbezeichner des Entra-Agents. Optional.
agentUserId Zeichenfolge Benutzer-ID, die dem Agent zugeordnet ist. Optional.
createdDateTime DateTimeOffset Zeitstempel, wann die Agent-Instance erstellt wurde (schreibgeschützt). Optional.
lastModifiedDateTime DateTimeOffset Zeitstempel der letzten Änderung (schreibgeschützt). Optional.
url Zeichenfolge Endpoint URL for the agent instance. Optional.
preferredTransport Zeichenfolge Bevorzugtes Transportprotokoll (JSONRPC, GRPC, HTTP+JSON). Optional.
additionalInterfaces agentInterface-Sammlung Zusätzliche Schnittstellen/Transporte, die vom Agent unterstützt werden (URL, Transport). Optional.
Signaturen agentCardSignature-Sammlung Digitale Signaturen für die Agent-Instance (geschützt, Signatur, Kopfzeile). Optional.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 200 OK Antwortcode und ein aktualisiertes agentInstance-Objekt im Antworttext zurück.

Beispiele

Beispiel 1: Aktualisieren des agentCardManifest in einer agentInstance

Anforderung

Das folgende Beispiel zeigt eine Anfrage. Die Anforderung erstellt auch das agentCardManifest, wenn es noch nicht vorhanden ist.

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://contoso.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"
        ]
      }
    ]
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content

Beispiel 2: Aktualisieren einer agentInstance, um auf ein vorhandenes agentCardManifest zu verweisen

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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')"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content

Beispiel 3: displayName aktualisieren

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

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

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content