次の方法で共有

エージェントの更新Instance

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

agentInstance オブジェクトのプロパティを更新します。 要求本文にマニフェストを含めることで、エージェント インスタンスに関連付けられている agentCardManifest を更新することもできます。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) AgentInstance.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション AgentInstance.ReadWrite.All AgentInstance.ReadWrite.ManagedBy

重要

委任されたアクセス許可を使用する場合、認証されたユーザーには、サポートされているMicrosoft Entra ロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 エージェント レジストリ管理者 は、この操作でサポートされる最小限の特権ロールです。

HTTP 要求

PATCH /agentRegistry/agentInstances/{agentInstanceId}

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、更新するプロパティの値 のみを 指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

プロパティ 型 説明
ownerIds String collection エージェント インスタンスの所有者識別子の一覧には、ユーザーまたはサービス プリンシパルを指定できます。 必須です。
managedBy 文字列 このエージェントを管理するアプリケーション識別子。 省略可能。
originatingStore 文字列 エージェントが発生したストア/システムの名前。 省略可能。
createdBy String エージェント インスタンスを作成したユーザー (読み取り専用)。 省略可能。
displayName 文字列 エージェント インスタンスの表示名。 必須です。
sourceAgentId 文字列 ソース システムからの元のエージェント識別子。 省略可能。
agentIdentityBlueprintId 文字列 エージェント ID ブループリント識別子。 省略可能。
agentIdentityId 文字列 Entra エージェント ID 識別子。 省略可能。
agentUserId 文字列 エージェントに関連付けられているユーザー識別子。 省略可能。
createdDateTime DateTimeOffset エージェント インスタンスが作成されたときのタイムスタンプ (読み取り専用)。 省略可能。
lastModifiedDateTime DateTimeOffset 最終変更のタイムスタンプ (読み取り専用)。 省略可能。
url String エージェント インスタンスのエンドポイント URL。 省略可能。
preferredTransport 文字列 優先トランスポート プロトコル (JSONRPC、GRPC、HTTP+JSON)。 省略可能。
additionalInterfaces agentInterface コレクション エージェントでサポートされる追加のインターフェイス/トランスポート (URL、トランスポート)。 省略可能。
署名 agentCardSignature コレクション エージェント インスタンスのデジタル署名 (保護、署名、ヘッダー)。 省略可能。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された agentInstance オブジェクトを返します。

例

例 1: agentInstance で agentCardManifest を更新する

要求

次の例は要求を示しています。 要求では、agentCardManifest がまだ存在しない場合も作成されます。

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

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content

例 2: agentInstance を更新して既存の agentCardManifest を参照する

要求

次の例は要求を示しています。

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

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content

例 3: displayName を更新する

要求

次の例は要求を示しています。

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

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

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content
  • Last updated on