Partager via

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 .

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

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

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

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

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
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 d’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é avec une autorisation de rôle prise en charge. L’administrateur du Registre de l’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 l’autorisation.
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’agent instance, il peut s’agir d’utilisateurs ou de principaux de service. Obligatoire.
managedBy String Identificateur d’application gérant cet agent. Facultatif.
originatingStore String Nom du magasin/du système d’origine de l’agent. Facultatif.
createdBy String Utilisateur qui a créé l’agent instance (en lecture seule). Facultatif.
displayName String Nom d’affichage de la instance de l’agent. Obligatoire.
sourceAgentId String Identificateur d’agent d’origine du système source. Facultatif.
agentIdentityBlueprintId String Identificateur de blueprint d’identité de l’agent. Facultatif.
agentIdentityId String Identificateur d’identité de l’agent Entra. Facultatif.
agentUserId String Identificateur d’utilisateur associé à l’agent. Facultatif.
createdDateTime DateTimeOffset Horodatage lors de la création de l’instance de l’agent (en lecture seule). Facultatif.
lastModifiedDateTime DateTimeOffset Horodatage de la dernière modification (lecture seule). Facultatif.
url Chaîne URL du point de terminaison de l’agent instance. Facultatif.
preferredTransport 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 collection agentCardSignature Signatures numériques pour l’agent instance (protégé, signature, en-tête). Facultatif.

Réponse

Si elle réussit, 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://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"
        ]
      }
    ]
  }
}

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