Update agentInstance

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Важно!

Предстоящее изменение API реестра агентов

Начиная с мая 2026 г. API реестра агентов в Microsoft Graph будут заменены API реестра агентов на основе Microsoft Agent 365. Это изменение объединяет возможности управления агентами, упрощая наблюдение, управление и защиту всех агентов в клиенте. Мы рекомендуем запланировать переход на новые API на основе Agent 365 при их выпуске. Дополнительные сведения о конвергенции реестра агентов с Microsoft Agent 365.

Обновление свойств объекта agentInstance . Вы также можете обновить agentCardManifest, связанный с экземпляром агента, включив манифест в текст запроса.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) AgentInstance.ReadWrite.All Недоступно.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение AgentInstance.ReadWrite.All AgentInstance.ReadWrite.ManagedBy

Важно!

При использовании делегированных разрешений пользователю, прошедшему проверку подлинности, должна быть назначена поддерживаемая Microsoft Entra роль или пользовательская роль, которая предоставляет разрешения, необходимые для этой операции.

Администратор реестра агентов — это наименее привилегированная роль, поддерживаемая для этой операции.

HTTP-запрос

PATCH /agentRegistry/agentInstances/{agentInstanceId}

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите только значения свойств для обновления. Существующие свойства, которые не включены в текст запроса, сохраняют свои предыдущие значения или пересчитываются на основе изменений других значений свойств.

В следующей таблице указаны свойства, которые можно обновить.

Свойство Тип Описание
ownerIds Коллекция строк Список идентификаторов владельца для экземпляра агента может быть пользователем или субъектами-службами. Обязательно.
Managedby String Идентификатор приложения, управляющий этим агентом. Необязательный параметр.
originatingStore String Имя хранилища или системы, в которой был создан агент. Необязательный параметр.
createdBy String Пользователь, создавший экземпляр агента (только для чтения). Необязательный параметр.
displayName String Отображаемое имя экземпляра агента. Обязательно.
sourceAgentId String Исходный идентификатор агента из исходной системы. Необязательный параметр.
agentIdentityBlueprintId String Идентификатор схемы удостоверений агента. Необязательный параметр.
agentIdentityId String Entra идентификатора агента. Необязательный параметр.
agentUserId String Идентификатор пользователя, связанный с агентом. Необязательный параметр.
createdDateTime DateTimeOffset Метка времени создания экземпляра агента (только для чтения). Необязательный параметр.
lastModifiedDateTime DateTimeOffset Метка времени последнего изменения (только для чтения). Необязательный параметр.
url String URL-адрес конечной точки для экземпляра агента. Необязательный параметр.
preferredTransport String Предпочтительный транспортный протокол (JSONRPC, GRPC, HTTP+JSON). Необязательный параметр.
additionalInterfaces коллекция agentInterface Дополнительные интерфейсы и транспорты, поддерживаемые агентом (URL-адрес, транспорт). Необязательный параметр.
Подписи коллекция agentCardSignature Цифровые подписи для экземпляра агента (защищенные, сигнатура, заголовок). Необязательный параметр.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и обновленный объект agentInstance в теле отклика.

Примеры

Пример 1. Обновление agentCardManifest в agentInstance

Запрос

Ниже показан пример запроса. Запрос также создает 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://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"
        ]
      }
    ]
  }
}

Отклик

Ниже показан пример отклика.

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