API-referencia Azure SRE-ügynökhöz

REST API-műveletek Azure SRE-ügynök programozott kezeléséhez és kezeléséhez.

Overview

Azure SRE-ügynök rest API-kat biztosít két rétegben. Az ügynökök és alerőforrásaik létrehozásához, konfigurálásához és törléséhez használja a vezérlősíkot (ARM ). Használja az adatsíkot futtatókörnyezeti műveletekhez, például csevegéshez, adattárkezeléshez és tudásfeltöltésekhez.

Authentication

Vezérlősík (ARM)

Standard Azure-hitelesítés – Azure CLI, szolgáltatásnév vagy felügyelt identitás:

# 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

Adatátviteli sík

Az adatsíkhoz külön jogkivonatra van szükség a célközönséggel 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-szerepkörök

Szerepkörök hozzárendelése a Azure portál, parancssori felület vagy ARM API használatával:

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

Vezérlősík (ARM) műveletei

API-verzió

2025-05-01-preview

Alap URL

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

Fűzze hozzá az elérési út utótagját a műveleti táblából, majd adja hozzá ?api-version=2025-05-01-preview lekérdezési paraméterként. Például: .../agents/{agentName}/start?api-version=2025-05-01-preview.

Ügynökerőforrás-műveletek

Ügynök tulajdonságai

Alerőforrások

Minden alerőforrás támogatja PUT a (létrehozás/frissítés) GETés DELETE a műveleteket.

Segéderőforrás törzsének formátumai

Az összekötők közvetlen tulajdonságokat használnak:

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

Más alerőforrások (készségek, segédanyagok, eszközök stb.) alap64 kódolású borítékot használnak:

# 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\"}}"

Összekötőtípusok

Adatsík-műveletek

Az adatsík API-val kezelheti a futó ügynököt, beleértve az üzenetek küldését, a jóváhagyások kezelését, a tudás feltöltését, valamint az adattárak, a horgok és az eseményindítók konfigurálását.

Alap URL

Get from ARM:

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

Minden adatsík elérési útja ezzel $ENDPOINT/api/...kezdődik: .

Szálak és csevegés

Jóváhagyások

Kódtárak

Tudás (ügynökmemória)

HTTP-eseményindítók

Kampók

Kiterjesztett ügynökkonfiguráció

Az adatsíkon keresztül kezelheti a segédeket, eszközöket, összekötőket, készségeket, kéréseket és beépülő modulokat:

Minden erőforrás támogatja PUTa , GET, PATCHés DELETE a metódusokat.

Valós idejű streamelés

Az ügynök a SignalR-t használja valós idejű csevegés-streameléshez:

Csatlakozzon a SignalR ügyfélkódtárával ugyanazzal a tulajdonosi jogkivonattal.

Examples

Ügynöktulajdonságok lekérése

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

Az összes összekötő listázása

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

Szálak listázása adatsíkon keresztül

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"

Kódtár hozzáadása adatsíkon keresztül

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

Kapcsolódó tartalom

• ARM-sablon referenciája: Teljes tulajdonságséma a Microsoft Learn-en
• Deploy with Infrastructure as Code: Ügynöktelepítés automatizálása Bicep, Terraform vagy PowerShell használatával
• Hálózati követelmények: A tűzfal engedélyezi az API-végpontok listáját
• Díjszabás és számlázás: API-alapú műveletek költségei