Referensi API untuk agen SRE Azure

Operasi REST API untuk mengelola dan berinteraksi dengan agen SRE Azure secara terprogram.

Overview

Azure SRE Agent menyediakan REST API pada dua lapisan. Gunakan sarana kontrol (ARM) untuk membuat, mengonfigurasi, dan menghapus agen dan sub-sumber dayanya. Gunakan sarana data untuk operasi runtime seperti obrolan, manajemen repositori, dan unggahan pengetahuan.

Authentication

Sarana kontrol (ARM)

Autentikasi Azure standar - Azure CLI, perwakilan layanan, atau identitas terkelola:

# 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

Bidang data

Bidang data memerlukan token terpisah dengan audiens 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"

Peran RBAC

Tetapkan peran dengan menggunakan portal Azure, CLI, atau ARM API:

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

Operasi sarana kontrol (ARM)

Versi API

2025-05-01-preview

URL Dasar

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

Tambahkan akhiran jalur dari tabel operasi, lalu tambahkan ?api-version=2025-05-01-preview sebagai parameter kueri. Misalnya: .../agents/{agentName}/start?api-version=2025-05-01-preview.

Operasi sumber daya agen

Properti agen

Sub-sumber daya

Semua dukungan PUT sub-sumber daya (buat/perbarui), GET, dan DELETE operasi.

Format isi sub-sumber daya

Konektor menggunakan properti langsung:

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

Sub-sumber daya lainnya (keterampilan, subagen, alat, dan sebagainya) menggunakan amplop berkode base64:

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

Jenis konektor

Operasi sarana data

Gunakan API sarana data untuk berinteraksi dengan agen yang sedang berjalan, termasuk mengirim pesan, mengelola persetujuan, mengunggah pengetahuan, dan mengonfigurasi repositori, kait, dan pemicu.

URL Dasar

Dapatkan dari ARM:

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

Semua jalur sarana data dimulai dengan $ENDPOINT/api/....

Utas dan obrolan

Persetujuan

Repositori kode

Pengetahuan (memori agen)

Pemicu HTTP

Hook

Konfigurasi agen yang diperluas

Kelola subagen, alat, konektor, keterampilan, perintah, dan plugin melalui sarana data:

Semua sumber daya mendukung PUTmetode , GET, PATCH, dan DELETE .

Streaming waktu nyata

Agen menggunakan SignalR untuk streaming obrolan real time:

Sambungkan dengan menggunakan pustaka klien SignalR dengan token pembawa yang sama.

Examples

Mendapatkan properti agen

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

Mencantumkan semua konektor

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

Mencantumkan utas melalui sarana data

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"

Menambahkan repositori kode melalui bidang data

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

Konten terkait

• referensi templat ARM: Skema properti lengkap di Microsoft Learn
• Deploy dengan Infrastruktur sebagai Kode: Mengotomatiskan penyebaran agen menggunakan Bicep, Terraform, atau PowerShell
• Persyaratan jaringan: Daftar izin firewall untuk titik akhir API
• Harga dan penagihan: Biaya untuk operasi berbasis API