Skip to main content

Azure managed identity with BYOK

SDK Copilot BYOK (bring your own key) принимает статические API-ключи, но Azure развертываниях часто используют Managed Identity (Entra ID) вместо долгоживущих ключей. Поскольку SDK нативно не поддерживает Entra ID аутентификацию, вы можете использовать кратковременный токен носителя через поле конфигурации провайдера bearer_token.

В этом руководстве показано, как использовать DefaultAzureCredential из библиотеки Azure Identity для аутентификации с Azure AI Foundry моделями через Copilot SDK.

Принцип работы

Совместимая с OpenAI конечная точка Azure AI Foundry принимает носитель-токены из Entra ID вместо статических API-ключей. Шаблон:

  1. Используйте DefaultAzureCredential для получения токена для https://cognitiveservices.azure.com/.default области
  2. Передайте токен как bearer_token в конфигурации провайдера BYOK
  3. Обновите токен до истечения срока действия (токены обычно действительны ~1 час)

Диаграмма: диаграмма последовательностей, показывающая описанный процесс.

Пример Python

Необходимые условия

pip install github-copilot-sdk azure-identity

Основное использование

import asyncio
import os

from azure.identity import DefaultAzureCredential
from copilot import CopilotClient
from copilot.session import PermissionHandler, ProviderConfig

COGNITIVE_SERVICES_SCOPE = "https://cognitiveservices.azure.com/.default"

async def main():
    # Get a token using Managed Identity, Azure CLI, or other credential chain
    credential = DefaultAzureCredential()
    token = credential.get_token(COGNITIVE_SERVICES_SCOPE).token

    foundry_url = os.environ["AZURE_AI_FOUNDRY_RESOURCE_URL"]

    client = CopilotClient()
    await client.start()

    session = await client.create_session(
        on_permission_request=PermissionHandler.approve_all,
        model="gpt-4.1",
        provider=ProviderConfig(
            type="openai",
            base_url=f"{foundry_url.rstrip('/')}/openai/v1/",
            bearer_token=token,  # Short-lived bearer token
            wire_api="responses",
        ),
    )

    response = await session.send_and_wait("Hello from Managed Identity!")
    print(response.data.content)

    await client.stop()

asyncio.run(main())

Обновление токена для долгосрочных приложений

Жетоны предъявлятеля истекают (обычно после ~1 часа). Для серверов или долгоработающих агентов обновляйте токен перед созданием каждой сессии:

from azure.identity import DefaultAzureCredential
from copilot import CopilotClient
from copilot.session import PermissionHandler, ProviderConfig

COGNITIVE_SERVICES_SCOPE = "https://cognitiveservices.azure.com/.default"

class ManagedIdentityCopilotAgent:
    """Copilot agent that refreshes Entra ID tokens for Azure AI Foundry."""

    def __init__(self, foundry_url: str, model: str = "gpt-4.1"):
        self.foundry_url = foundry_url.rstrip("/")
        self.model = model
        self.credential = DefaultAzureCredential()
        self.client = CopilotClient()

    def _get_provider_config(self) -> ProviderConfig:
        """Build a ProviderConfig with a fresh bearer token."""
        token = self.credential.get_token(COGNITIVE_SERVICES_SCOPE).token
        return ProviderConfig(
            type="openai",
            base_url=f"{self.foundry_url}/openai/v1/",
            bearer_token=token,
            wire_api="responses",
        )

    async def chat(self, prompt: str) -> str:
        """Send a prompt and return the response text."""
        # Fresh token for each session
        session = await self.client.create_session(
            on_permission_request=PermissionHandler.approve_all,
            model=self.model,
            provider=self._get_provider_config(),
        )

        response = await session.send_and_wait(prompt)
        await session.disconnect()

        return response.data.content if response else ""

Node.js / пример TypeScript

import { DefaultAzureCredential } from "@azure/identity";
import { CopilotClient } from "@github/copilot-sdk";

const credential = new DefaultAzureCredential();
const tokenResponse = await credential.getToken(
  "https://cognitiveservices.azure.com/.default"
);

const client = new CopilotClient();

const session = await client.createSession({
  model: "gpt-4.1",
  provider: {
    type: "openai",
    baseUrl: `${process.env.AZURE_AI_FOUNDRY_RESOURCE_URL}/openai/v1/`,
    bearerToken: tokenResponse.token,
    wireApi: "responses",
  },
});

const response = await session.sendAndWait({ prompt: "Hello!" });
console.log(response?.data.content);

await client.stop();

Пример .NET

using Azure.Identity;
using GitHub.Copilot;

var credential = new DefaultAzureCredential();
var token = await credential.GetTokenAsync(
    new Azure.Core.TokenRequestContext(
        new[] { "https://cognitiveservices.azure.com/.default" }));

await using var client = new CopilotClient();
var foundryUrl = Environment.GetEnvironmentVariable("AZURE_AI_FOUNDRY_RESOURCE_URL");

await using var session = await client.CreateSessionAsync(new SessionConfig
{
    Model = "gpt-4.1",
    Provider = new ProviderConfig
    {
        Type = "openai",
        BaseUrl = $"{foundryUrl!.TrimEnd('/')}/openai/v1/",
        BearerToken = token.Token,
        WireApi = "responses",
    },
});

var response = await session.SendAndWaitAsync(
    new MessageOptions { Prompt = "Hello from Managed Identity!" });
Console.WriteLine(response?.Data.Content);

Конфигурация среды

ПеременнаяDescriptionПример
AZURE_AI_FOUNDRY_RESOURCE_URLURL ресурса Azure AI Foundryhttps://myresource.openai.azure.com

Не требуется переменная окружения ключа API — аутентификация осуществляется DefaultAzureCredentialс помощью , который автоматически поддерживает:

  • Управляемая идентичность (системно назначенная или пользовательская): для приложений, размещённых Azure
  • Azure CLI (az login): для местного развития
  • Переменные среды (AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET): для принципов сервисов
  • Идентификация рабочей нагрузки: для Kubernetes

См. документацию DefaultAzureCredential для полной цепочки учетных данных.

Когда следует использовать этот шаблон

ScenarioRecommendation
Azure-хостируемое приложение с управляемой идентичностью
✅ Используйте этот шаблон
App with existing Azure AD service principal
✅ Используйте этот шаблон
Местное развитие с az login
✅ Используйте этот шаблон
Не-Azure среда со статическим API-ключомИспользуйте автозаголовок
Доступна подписка GitHub CopilotИспользуйте автозаголовок

См. также