API-referens för Azure SRE-agent

REST API-åtgärder för att hantera och interagera med Azure SRE Agent programmatiskt.

Overview

Azure SRE-agenten tillhandahåller REST-API:er i två lager. Använd kontrollplanet (ARM) för att skapa, konfigurera och ta bort agenter och deras underresurser. Använd dataplanet för körningsåtgärder som chatt, lagringsplatshantering och kunskapsuppladdningar.

Authentication

Kontrollplan (ARM)

Standard-Azure-autentisering – Azure CLI, tjänstens huvudnamn eller hanterade identitet:

# Interactive login
az login

# Service principal
az login --service-principal -u $APP_ID -p $SECRET --tenant $TENANT_ID

# Managed identity (from Azure VM or Container App)
az login --identity

Dataplanet

Dataplanet kräver en separat token med målgruppen https://azuresre.dev:

# Step 1: Get the agent's data plane endpoint
ENDPOINT=$(az rest -m GET \
  --url "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/agents/{agentName}?api-version=2025-05-01-preview" \
  --query properties.agentEndpoint -o tsv)

# Step 2: Get a data plane token
TOKEN=$(az account get-access-token \
  --resource https://azuresre.dev \
  --query accessToken -o tsv)

# Step 3: Call the data plane
curl -H "Authorization: Bearer $TOKEN" "$ENDPOINT/api/v1/threads"

RBAC-roller

Tilldela roller med hjälp av Azure-portalen, CLI eller ARM API:

az role assignment create \
  --assignee {userOrServicePrincipalId} \
  --role "SRE Agent Administrator" \
  --scope "/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.App/agents/{name}"

Arm-åtgärder (Control Plane)

API-version

2025-05-01-preview

Bas-URL

https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/agents/{agentName}

Lägg till sökvägssuffixet från operationstabellen och lägg sedan till ?api-version=2025-05-01-preview som en frågeparameter. Till exempel: .../agents/{agentName}/start?api-version=2025-05-01-preview.

Agentresursåtgärder

Agentegenskaper

Underresurser

Stöd för alla underresurser PUT (skapa/uppdatera), GEToch DELETE åtgärder.

Brödtextformat för underresurser

Anslutningsappar använder direkta egenskaper:

az rest -m PUT \
  --url "https://management.azure.com/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.App/agents/{agent}/DataConnectors/my-kusto?api-version=2025-05-01-preview" \
  --body '{
    "properties": {
      "name": "my-kusto",
      "dataConnectorType": "Kusto",
      "dataSource": "https://mycluster.eastus2.kusto.windows.net",
      "identity": "system"
    }
  }'

Andra underresurser (kunskaper, underagenter, verktyg och så vidare) använder ett base64-kodat kuvert:

# The spec is base64-encoded inside properties.value
SPEC='{"name":"my-tool","description":"Query Azure Resource Graph"}'
ENCODED=$(echo -n "$SPEC" | base64)

az rest -m PUT \
  --url "...Microsoft.App/agents/{agent}/tools/my-tool?api-version=2025-05-01-preview" \
  --body "{\"properties\":{\"value\":\"$ENCODED\"}}"

Anslutningstyper

Dataplansåtgärder

Använd dataplanets API för att interagera med en agent som körs, inklusive att skicka meddelanden, hantera godkännanden, ladda upp kunskap och konfigurera lagringsplatser, krokar och utlösare.

Bas-URL

Hämta från ARM:

ENDPOINT=$(az rest -m GET \
  --url "...Microsoft.App/agents/{name}?api-version=2025-05-01-preview" \
  --query properties.agentEndpoint -o tsv)

Alla dataplanssökvägar börjar med $ENDPOINT/api/....

Trådar och chatt

Godkännanden

Kodlagringsplatser

Kunskap (agentminne)

HTTP-utlösare

Hookar

Utökad agentkonfiguration

Hantera underagenter, verktyg, anslutningsappar, färdigheter, uppmaningar och plugin-program via dataplanet:

Alla resurser stöder PUTmetoder för , GET, PATCHoch DELETE .

Realtidsströmning

Agenten använder SignalR för chattströmning i realtid:

Anslut med hjälp av SignalR-klientbiblioteket med samma ägartoken.

Exempel

Hämta agentegenskaper

az rest -m GET \
  --url "https://management.azure.com/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.App/agents/{name}?api-version=2025-05-01-preview" \
  -o json

Visa alla anslutningar

az rest -m GET \
  --url "https://management.azure.com/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.App/agents/{name}/DataConnectors?api-version=2025-05-01-preview" \
  -o json

Visa en lista över trådar via dataplanet

TOKEN=$(az account get-access-token --resource https://azuresre.dev --query accessToken -o tsv)
ENDPOINT="https://{agentEndpoint}"

curl -s -H "Authorization: Bearer $TOKEN" "$ENDPOINT/api/v1/threads"

Lägga till en kodlagringsplats via dataplanet

curl -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  "$ENDPOINT/api/v2/repos/my-repo" \
  -d '{
    "properties": {
      "url": "https://github.com/myorg/myrepo",
      "type": "GitHub"
    }
  }'

Relaterat innehåll

• ARM-mallreferens: Fullständigt egenskapsschema på Microsoft Learn
• Distribution med infrastruktur som kod: Automatisera agentdistribution med Bicep, Terraform eller PowerShell
• Nätverkskrav: Listan över tillåtna brandväggar för API-slutpunkter
• Prissättning och fakturering: Kostnader för API-drivna åtgärder