Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a specific deployed instance of an AI agent in the Microsoft Entra Agent Registry. An agent instance is associated with an agentCardManifest that defines its capabilities, skills, and metadata. Agent instances can be organized into collections and are managed through the agentRegistry.
Inherits from entity.
Methods
| Method | Return type | Description |
|---|---|---|
| List | agentInstance collection | Get a list of the agentInstance objects and their properties. |
| Create | agentInstance | Create a new agentInstance object. |
| Get | agentInstance | Read the properties and relationships of agentInstance object. |
| Update | agentInstance | Update the properties of an agentInstance object. |
| Delete | None | Delete an agentInstance object. |
Properties
| Property | Type | Description |
|---|---|---|
| additionalInterfaces | agentInterface collection | Additional interfaces/transports supported by the agent. |
| agentIdentityBlueprintId | String | Object ID of the agentIdentityBlueprint object. |
| agentIdentityId | String | Object ID of the agentIdentity object. |
| agentUserId | String | Object ID of the agentUser associated with the agent. Read-only. |
| createdBy | String | Object ID of the user or application that created the agent instance. Read-only. |
| createdDateTime | DateTimeOffset | Timestamp when agent instance was created. Read-only. |
| displayName | String | Display name for the agent instance. |
| id | String | Unique identifier for the agent instance. Key. Inherited from entity. |
| lastModifiedDateTime | DateTimeOffset | Timestamp of last modification. |
| managedBy | String | appId (referred to as Application (client) ID on the Microsoft Entra admin center) of the application managing this agent. |
| originatingStore | String | Name of the store/system where agent originated. For example Copilot Studio. |
| ownerIds | String collection | List of object IDs for the owners of the agent instance. |
| preferredTransport | String | Preferred transport protocol. The possible values are JSONRPC, GRPC, and HTTP+JSON. |
| signatures | agentCardSignature collection | Digital signatures for the agent instance. |
| sourceAgentId | String | Identifier of the agent in the original source system. |
| url | String | Endpoint URL for the agent instance. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| agentCardManifest | agentCardManifest | The agent card manifest of the agent instance. |
| collections | agentCollection collection | The agent collections that the agent instance is a member of. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.agentInstance",
"id": "String (identifier)",
"ownerIds": [
"String"
],
"managedBy": "String",
"originatingStore": "String",
"createdBy": "String",
"displayName": "String",
"sourceAgentId": "String",
"agentIdentityBlueprintId": "String",
"agentIdentityId": "String",
"agentUserId": "String",
"createdDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"url": "String",
"preferredTransport": "String",
"additionalInterfaces": [
{
"@odata.type": "microsoft.graph.agentInterface"
}
],
"signatures": [
{
"@odata.type": "microsoft.graph.agentCardSignature"
}
]
}