Mettre à jour agentInstance

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Importante

Modification à venir des API du registre de l’agent

À compter de mai 2026, les API du registre des agents dans Microsoft Graph seront remplacées par les API du registre des agents optimisées par Microsoft Agent 365. Ce changement consolide les expériences de gestion des agents pour faciliter l’observation, la gouvernance et la sécurisation de tous les agents de votre client. Nous vous recommandons de planifier la migration vers les nouvelles API basées sur l’Agent 365 dès leur publication. En savoir plus sur la convergence du registre d’agents avec Microsoft Agent 365.

Mettez à jour les propriétés d’un objet agentInstance . Vous pouvez également mettre à jour l’agentCardManifest associé à l’instance de l’agent en l’incluant dans le corps de la demande.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) AgentInstance.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application AgentInstance.ReadWrite.All AgentInstance.ReadWrite.ManagedBy

Importante

Lors de l’utilisation des autorisations déléguées, l’utilisateur authentifié doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé qui accorde les autorisations requises pour cette opération.

Administrateur de registre d’agent est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

PATCH /agentRegistry/agentInstances/{agentInstanceId}

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Propriété Type Description
ownerIds String collection Liste des identificateurs de propriétaire pour l’instance de l’agent, peuvent être des utilisateurs ou des principaux du service. Obligatoire.
managedBy String Identificateur de l’application gérant cet agent. Facultatif.
originatingStore String Nom du magasin/système d’où provient l’agent. Facultatif.
createdBy String Utilisateur qui a créé l’instance d’agent (lecture seule). Facultatif.
displayName String Nom complet de l’instance de l’agent. Obligatoire.
sourceAgentId String Identificateur d’agent d’origine du système source. Facultatif.
agentIdentityBlueprintId String Identificateur de blueprint d’identité d’agent. Facultatif.
agentIdentityId String Identificateur d’identité de l’agent Entra. Facultatif.
agentUserId String Identifiant utilisateur associé à l’agent. Facultatif.
createdDateTime DateTimeOffset Horodatage de la création de l’instance d’agent (lecture seule). Facultatif.
lastModifiedDateTime DateTimeOffset Horodatage de la dernière modification (lecture seule). Facultatif.
url Chaîne URL de point de terminaison de l’instance de l’agent. Facultatif.
préféréTransport String Protocole de transport préféré (JSONRPC, GRPC, HTTP+JSON). Facultatif.
additionalInterfaces collection agentInterface Interfaces/transports supplémentaires pris en charge par l’agent (url, transport). Facultatif.
signatures numériques collection agentCardSignature Signatures numériques pour l’instance de l’agent (protégé, signature, en-tête). Facultatif.

Réponse

En cas de réussite, cette méthode renvoie un 200 OK code de réponse et un objet agentInstance mis à jour dans le corps de la réponse.

Exemples

Exemple 1 : mettre à jour agentCardManifest dans un agentInstance

Demande

L’exemple suivant illustre une demande. La demande crée également l’agentCardManifest s’il n’existe pas déjà.

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

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 2 : mettre à jour un agentInstance pour référencer un agentCardManifest existant

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 3 : Mettre à jour displayName

Demande

L’exemple suivant illustre une demande.

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

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

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content