ESC
Type to search...

AgentInstance.ReadWrite.All

Export JSON
Export CSV
Copy URL
Print
ApplicationDelegated Read/Write All Resources

Allows the app to create, read, update, and delete all agent instances in your organization's Agent Registry without a signed-in user.

Delegated Access App-Only Access

Permission Details

Application Permission

Read and write all agent instances in Agent Registry

Allows the app to create, read, update, and delete all agent instances in your organization's Agent Registry without a signed-in user.

Delegated Permission Admin consent required

Read and write agent instances in Agent Registry

Allows the app to create, read, update, and delete agent instances in your organization's Agent Registry on behalf of the signed-in user.

Properties

Property Type Description
id string The unique identifier for an entity. Read-only.
url stringNullable Endpoint URL for the agent instance.
sourceAgentId stringNullable Identifier of the agent in the original source system.
originatingStore stringNullable Name of the store/system where agent originated. For example Copilot Studio.
displayName string Display name for the agent instance.
agentIdentityId stringNullable Object ID of the agentIdentity object.
lastModifiedDateTime date-timeNullable Timestamp of last modification.
createdDateTime date-timeNullable Timestamp when agent instance was created. Read-only.
additionalInterfaces microsoft.graph.agentInterface collection Additional interfaces/transports supported by the agent.
signatures microsoft.graph.agentCardSignature collection Digital signatures for the agent instance.
agentIdentityBlueprintId stringNullable Object ID of the agentIdentityBlueprint object.
agentCardManifest object The agent card manifest of the agent instance.
agentUserId stringNullable Object ID of the agentUser associated with the agent. Read-only.
preferredTransport stringNullable Preferred transport protocol. The possible values are JSONRPC, GRPC, and HTTP+JSON.
managedBy stringNullable appId (referred to as Application (client) ID on the Microsoft Entra admin center) of the application managing this agent.

Showing 15 of 18 properties. View all on Microsoft Learn →

JSON Representation

JSON representation
{
  "id": "String",
  "url": "String",
  "sourceAgentId": "String",
  "originatingStore": "String",
  "displayName": "String",
  "agentIdentityId": "String",
  "lastModifiedDateTime": "String",
  "createdDateTime": "String",
  "additionalInterfaces": "[...]",
  "signatures": "[...]",
  "agentIdentityBlueprintId": "String",
  "agentCardManifest": "{...}",
  "agentUserId": "String",
  "preferredTransport": "String",
  "managedBy": "String",
  "ownerIds": "array",
  "collections": "[...]",
  "createdBy": "String"
}

Graph Methods

Delegated access App-only access

No API methods available for this version.

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

No PowerShell cmdlets available for this version.

No PowerShell cmdlets available for this version.

Code Examples

C# / .NET SDK
// Install: dotnet add package Microsoft.Graph
// Install: dotnet add package Azure.Identity
using Microsoft.Graph;
using Azure.Identity;

// Delegated permissions - interactive user sign-in
var scopes = new[] { "AgentInstance.ReadWrite.All" };
var options = new InteractiveBrowserCredentialOptions
{
    ClientId = "YOUR_CLIENT_ID",
    TenantId = "YOUR_TENANT_ID",
    RedirectUri = new Uri("http://localhost")
};
var credential = new InteractiveBrowserCredential(options);
var graphClient = new GraphServiceClient(credential, scopes);

// Example: GET /me
var result = await graphClient.Me.GetAsync();
Console.WriteLine($"User: {result?.DisplayName}");

// Application permissions - daemon/service app
var tenantId = "YOUR_TENANT_ID";
var clientId = "YOUR_CLIENT_ID";
var clientSecret = "YOUR_CLIENT_SECRET";

var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
var graphClient = new GraphServiceClient(credential);

// Example: GET /users/{user-id}
var users = await graphClient.Users.GetAsync();
foreach (var user in users?.Value ?? [])
{
    Console.WriteLine($"User: {user.DisplayName}");
}
JavaScript / TypeScript
// npm install @azure/msal-browser @microsoft/microsoft-graph-client
import { PublicClientApplication } from "@azure/msal-browser";
import { Client } from "@microsoft/microsoft-graph-client";
import { AuthCodeMSALBrowserAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/authCodeMsalBrowser";

const msalConfig = {
    auth: {
        clientId: "YOUR_CLIENT_ID",
        authority: "https://login.microsoftonline.com/YOUR_TENANT_ID"
    }
};

const pca = new PublicClientApplication(msalConfig);
await pca.initialize();

// Delegated: Login with required scope
const loginResponse = await pca.loginPopup({
    scopes: ["AgentInstance.ReadWrite.All"]
});

const authProvider = new AuthCodeMSALBrowserAuthenticationProvider(pca, {
    account: loginResponse.account,
    scopes: ["AgentInstance.ReadWrite.All"],
    interactionType: "popup"
});

const graphClient = Client.initWithMiddleware({ authProvider });

// Example: GET /me
const result = await graphClient.api("/me").get();
console.log(result);

// Application: Use client credentials (Node.js backend only)
// npm install @azure/identity @microsoft/microsoft-graph-client
import { ClientSecretCredential } from "@azure/identity";
import { TokenCredentialAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/azureTokenCredentials";

const credential = new ClientSecretCredential(
    "YOUR_TENANT_ID",
    "YOUR_CLIENT_ID", 
    "YOUR_CLIENT_SECRET"
);

const authProvider = new TokenCredentialAuthenticationProvider(credential, {
    scopes: ["https://graph.microsoft.com/.default"]
});

const graphClient = Client.initWithMiddleware({ authProvider });
const result = await graphClient.api("/users").get();
console.log(result);
PowerShell
# Install Microsoft Graph PowerShell module
Install-Module Microsoft.Graph -Scope CurrentUser

# Delegated access - interactive sign-in
Connect-MgGraph -Scopes "AgentInstance.ReadWrite.All"

# Verify connection
Get-MgContext | Select-Object Account, TenantId, Scopes

# Example: GET /me
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/me"
$result | ConvertTo-Json -Depth 5

# Application access with certificate
$params = @{
    ClientId = "YOUR_CLIENT_ID"
    TenantId = "YOUR_TENANT_ID"
    CertificateThumbprint = "YOUR_CERT_THUMBPRINT"
}
Connect-MgGraph @params

# Or with client secret (not recommended for production)
# Connect-MgGraph -ClientSecretCredential $credential

# Example: GET /users
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/users"
$result | ConvertTo-Json -Depth 5

# Always disconnect when done
Disconnect-MgGraph
Python
# pip install msgraph-sdk azure-identity
from azure.identity import InteractiveBrowserCredential, ClientSecretCredential
from msgraph import GraphServiceClient
import asyncio

# Delegated permissions - interactive browser sign-in
credential = InteractiveBrowserCredential(
    client_id="YOUR_CLIENT_ID",
    tenant_id="YOUR_TENANT_ID"
)
scopes = ["AgentInstance.ReadWrite.All"]
client = GraphServiceClient(credential, scopes)

async def get_data():
    # Example: GET /me
    result = await client.me.get()
    print(f"User: {result.display_name}")
    return result

asyncio.run(get_data())

# Application permissions - client credentials
credential = ClientSecretCredential(
    tenant_id="YOUR_TENANT_ID",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET"
)
scopes = ["https://graph.microsoft.com/.default"]
client = GraphServiceClient(credential, scopes)

async def get_users():
    # Example: GET /users
    result = await client.users.get()
    for user in result.value:
        print(f"User: {user.display_name}")
    return result

asyncio.run(get_users())

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.ReadWrite.All

4

Grant Admin Consent

Application permissions always require admin consent. Click "Grant admin consent" in the Azure portal.