AgentInstance.Read.All | Graph Permissions

Permission Details

Application Permission

Read all agent instances in Agent Registry

Allows the app to read all agent instances and their related collections in your organization's Agent Registry without a signed-in user.

Permission ID: 799a4732-85b8-4c67-b048-75f0e88a232b

Delegated Permission

Read agent instances in Agent Registry

Allows the app to read agent instances and their related collections in your organization's Agent Registry on behalf of the signed-in user.

Permission ID: 4c3c738a-2df0-4877-bf4a-f796950ff34c

Properties

Microsoft Graph beta exact-category-docs

Properties is shown from beta metadata because a stable v1.0 schema is not available for this resource mapping.

Property	Type	Description
`additionalInterfaces`	`agentInterface collection`	Additional interfaces/transports supported by the agent.
`agentIdentityBlueprintId`	`String`Nullable	Object ID of the agentIdentityBlueprint object.
`agentIdentityId`	`String`Nullable	Object ID of the agentIdentity object.
`agentUserId`	`String`Nullable	Object ID of the agentUser associated with the agent. Read-only.
`createdBy`	`String`Nullable	Object ID of the user or application that created the agent instance. Read-only.
`createdDateTime`	`DateTimeOffset`Nullable	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`Nullable	Timestamp of last modification.
`managedBy`	`String`Nullable	appId (referred to as Application (client) ID on the Microsoft Entra admin center) of the application managing this agent.
`originatingStore`	`String`Nullable	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`Nullable	Preferred transport protocol. The possible values are JSONRPC, GRPC, and HTTP+JSON.
`signatures`	`agentCardSignature collection`	Digital signatures for the agent instance.
`sourceAgentId`	`String`Nullable	Identifier of the agent in the original source system.

Showing 15 of 18 properties.

JSON Representation

Microsoft Graph beta exact-category-docs

JSON representation is shown from beta metadata because a stable v1.0 schema is not available for this resource mapping.

JSON representation

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

Relationships

Microsoft Graph beta exact-category-docs

Relationships is shown from beta metadata because a stable v1.0 schema is not available for this resource mapping.

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.
`additionalInterfaces`	`agentInterface collection`	Additional interfaces/transports supported by the agent.
`ownerIds`	`string collection`	List of object IDs for the owners of the agent instance.
`signatures`	`agentCardSignature collection`	Digital signatures for the agent instance.

Graph Methods

Delegated access App-only access

Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

No API methods available for this version.

Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/agentRegistry/agentInstances`
GET `/agentRegistry/agentInstances/{agentInstanceId}`
GET `/agentRegistry/agentInstances/{agentInstanceId}/agentCardManifest`
GET `/agentRegistry/agentInstances/{agentInstanceId}/collections`
POST `/agentRegistry/agentInstances/{agentInstanceId}/collections/{agentCollectionId}/members/$ref`

No Microsoft Learn PowerShell mapping available

Microsoft Graph PowerShell v1.0 commands are not available from refreshed Microsoft Learn PowerShell snippets for this permission.

No deterministic PowerShell command map is available for this permission.

Browse PowerShell docs

No Microsoft Learn PowerShell mapping available

Microsoft Graph PowerShell beta commands are not available from refreshed Microsoft Learn PowerShell snippets for this permission.

No deterministic PowerShell command map is available for this permission.

Browse PowerShell docs

Code Examples

C# / .NET SDK

Get agentInstance

View official example on Microsoft Learn

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.AgentRegistry.AgentInstances["{agentInstance-id}"].GetAsync();

JavaScript

Add agentInstance to agentCollection

View official example on Microsoft Learn

const options = {
	authProvider,
};

const client = Client.init(options);

const agentInstance = {
  '@odata.id': 'https://graph.microsoft.com/beta/agentRegistry/agentInstances(\'agent-instance-id\')'
};

await client.api('/agentRegistry/agentInstances/{agentInstanceId}/collections/{agentCollectionId}/members/$ref')
	.version('beta')
	.post(agentInstance);

PowerShell

Connect-MgGraph -Scopes "AgentInstance.Read.All"
Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/agentRegistry/agentInstances"

Python

Get agentInstance

View official example on Microsoft Learn

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.agent_registry.agent_instances.by_agent_instance_id('agentInstance-id').get()

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions or delegated permissions and search for AgentInstance.Read.All

4

Grant Admin Consent

Application permissions always require admin consent.