Atualizar agentInstance

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Importante

Próxima mudança nas APIs do Agent Registry

A partir de maio de 2026, as APIs de Registro de Agente no Microsoft Graph serão substituídas pelas APIs de Registro de Agente da plataforma Microsoft Agent 365. Essa alteração consolida as experiências de gerenciamento de agentes para facilitar a observação, o controle e a segurança de todos os agentes em seu locatário. Recomendamos que você planeje migrar para as novas APIs baseadas no Agent 365 quando elas forem lançadas. Saiba mais sobre a convergência do Registro de Agente com o Microsoft Agent 365.

Atualize as propriedades de um objeto agentInstance . Você também pode atualizar o agentCardManifest associado à instância do agente incluindo o manifesto no corpo da solicitação.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) AgentInstance.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AgentInstance.ReadWrite.All AgentInstance.ReadWrite.ManagedBy

Importante

Ao usar permissões delegadas, o usuário autenticado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação.

O Administrador de Registro do Agente é a função com menos privilégios com suporte para essa operação.

Solicitação HTTP

PATCH /agentRegistry/agentInstances/{agentInstanceId}

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça apenas os valores das propriedades a serem atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base nas alterações de outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade Tipo Descrição
ownerIds String collection Lista de identificadores de proprietário para a instância do agente, podem ser usuários ou entidades de serviço. Obrigatório.
managedBy Cadeia de caracteres Identificador de aplicativo gerenciando este agente. Opcional.
originatingStore Cadeia de caracteres Nome do repositório/sistema em que o agente se originou. Opcional.
createdBy Cadeia de caracteres Usuário que criou a instância do agente (somente leitura). Opcional.
displayName Cadeia de caracteres Nome de exibição da instância do agente. Obrigatório.
sourceAgentId Cadeia de caracteres Identificador de agente original do sistema de origem. Opcional.
agentIdentityBlueprintId Cadeia de caracteres Identificador de blueprint de identidade do agente. Opcional.
agentIdentityId Cadeia de caracteres Entra identificador de identidade do agente. Opcional.
agentUserId Cadeia de caracteres Identificador de usuário associado ao agente. Opcional.
createdDateTime DateTimeOffset Carimbo de data/hora em que a instância do agente foi criada (somente leitura). Opcional.
lastModifiedDateTime DateTimeOffset Carimbo de data/hora da última modificação (somente leitura). Opcional.
url Cadeia de caracteres URL do ponto de extremidade para a instância do agente. Opcional.
preferredTransport Cadeia de caracteres Protocolo de transporte preferencial (JSONRPC, GRPC, HTTP+JSON). Opcional.
additionalInterfaces Coleção AgentInterface Interfaces/transportes adicionais suportados pelo agente (url, transporte). Opcional.
Assinaturas Coleção AgentCardSignature Assinaturas digitais para a instância do agente (protegido, assinatura, cabeçalho). Opcional.

Resposta

Se for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto agentInstance atualizado no corpo da resposta.

Exemplos

Exemplo 1: Atualizar o agentCardManifest em um agentInstance

Solicitação

O exemplo a seguir mostra uma solicitação. A solicitação também criará o agentCardManifest se ele ainda não existir.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 2: Atualizar um agentInstance para fazer referência a um agentCardManifest existente

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 3: atualizar displayName

Solicitação

O exemplo a seguir mostra uma solicitação.

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

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content