Freigeben über

AgentInstance aktualisieren

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.

Aktualisieren sie die Eigenschaften eines agentInstance-Objekts . Sie können auch das agentCardManifest aktualisieren, das dem 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 mit einer unterstützten Rollenberechtigung zugewiesen werden. 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 zu aktualisierende 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 Die Liste der Besitzerbezeichner für den Agent instance kann Benutzer oder Dienstprinzipale sein. Erforderlich.
managedBy Zeichenfolge Anwendungsbezeichner, der diesen Agent verwaltet. Optional.
originatingStore Zeichenfolge Name des Speichers/Systems, aus dem/dem der Agent stammt. Optional.
createdBy Zeichenfolge Der Benutzer, der den Agent erstellt hat, instance (schreibgeschützt). Optional.
displayName Zeichenfolge Anzeigename für den Agent-instance. Erforderlich.
sourceAgentId Zeichenfolge Ursprünglicher Agentbezeichner aus dem Quellsystem. Optional.
agentIdentityBlueprintId Zeichenfolge Agent-Identitäts-Blaupausenbezeichner. Optional.
agentIdentityId Zeichenfolge Identitätsbezeichner des Entra-Agents. Optional.
agentUserId Zeichenfolge Benutzer-ID, die dem Agent zugeordnet ist. Optional.
createdDateTime DateTimeOffset Zeitstempel beim Erstellen instance des Agents (schreibgeschützt). Optional.
lastModifiedDateTime DateTimeOffset Zeitstempel der letzten Änderung (schreibgeschützt). Optional.
url Zeichenfolge Endpunkt-URL für den 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 den Agent instance (geschützt, Signatur, Header). Optional.

Antwort

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

Beispiele

Beispiel 1: Aktualisieren von 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://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"
        ]
      }
    ]
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content

Beispiel 2: Aktualisieren einer agentInstance, um auf einen vorhandenen 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: Aktualisieren von displayName

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
  • Last updated on