AgentsOperations interface

Bir ajan uç noktası için yeni bir oturum oluşturur. Uç nokta, oturum mutasyona uğratma işlemleri için sağlanan izolasyon anahtarını kullanarak destekleyici ajan versiyonunu version_indicator çözer ve oturum sahipliğini uygular.

createSession: (agentName: string, versionIndicator: VersionIndicatorUnion, options?: AgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

Özellik Değeri

Koddan yeni bir ajan sürümü oluşturur. Kod zip'i yükler ve mevcut bir ajan için yeni bir sürüm oluşturur. Zip'in SHA-256 altıgen özeti bütünlük ve dedup için başlıkta sunulur x-ms-code-zip-sha256 . İstek gövdesi, JSON meta veri kısmı ve ikili kod kısmı (parça sırası önemsiz) içeren çok parçalı/form-veridir. Maksimum yükleme boyutu 250 MB'dir.

createVersionFromCode: (agentName: string, codeZipSha256: string, content: CreateAgentVersionFromCodeContent, options?: AgentsCreateVersionFromCodeOptionalParams) => Promise<AgentVersion>

Özellik Değeri

Aracıyı siler. Ev sahibi ajanlar için, herhangi bir sürümde aktif oturumlar varsa, talep HTTP 409 ile reddedilir, ancak force true olarak ayarlanmadıkça reddedilir. Güç doğru olduğunda, ilgili tüm oturumlar ajan ve versiyonlarıyla birlikte zincirleme silinir.

delete: (agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

Özellik Değeri

Bir oturumu senkronize olarak siler. Oturum silindiğinde veya mevcut olmadığında 204 İçerik Yok döner.

deleteSession: (agentName: string, sessionId: string, options?: AgentsDeleteSessionOptionalParams) => Promise<void>

Özellik Değeri

Belirtilen dosyayı veya dizini oturum kum kutusundan siler. Yanlış olduğunda recursive , boş olmayan bir dizini silmek 409 Çatışma döndürür.

deleteSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDeleteSessionFileOptionalParams) => Promise<void>

Özellik Değeri

Bir aracının belirli bir sürümünü siler. Barındırılan ajanlar için, eğer sürümde aktif oturumlar varsa, HTTP 409 ile talep reddedilir, ancak force gerçek olarak ayarlanmadıkça geçerlidir. Güç doğru olduğunda, bu sürümle ilişkili tüm oturumlar zincirleme silinir.

deleteVersion: (agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

Özellik Değeri

Belirtilen ajanı devre dışı bırakır, yeni oturumları kabul etmesini veya istekleri işlemesini engeller. Mevcut aktif oturumların zarifçe boşalmasına izin veriliyor ancak yeni oturumlar oluşturulamıyor. Bu işlem idempotent — zaten devre dışı bırakılmış bir ajanı etkisiz hale getirmek yan etkisi olmadan başarı sağlar.

disable: (agentName: string, options?: AgentsDisableOptionalParams) => Promise<void>

Özellik Değeri

Kod tabanlı barındırılan bir ajanın zip kodunu indiriyor. Daha önce yüklenen zip dosyasını geri döndürüyor (application/zip).

Eğer agent_version verilirse, o sürümün kod zip'ini döndürür; aksi takdirde en son sürümün kod zip'ini döndürür.

Geri dönen baytların SHA-256 özeti, çözülen versiyonun content_hash'daki özetiyle eşleşiyorcode_configuration.

downloadAgentCode: (agentName: string, options?: AgentsDownloadAgentCodeOptionalParams) => Promise<AgentsDownloadAgentCodeResponse>

Özellik Değeri

Dosyayı belirtilen kum havuzu yolundan ikili bir akış olarak indirir. Yol, oturum ana dizinine göre çözülür.

downloadSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDownloadSessionFileOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Özellik Değeri

Belirtilen ajanı etkinleştirir, böylece yeni oturumları kabul eder ve istekleri işlem yapar. Bu işlem idempotenttir — zaten etkinleştirilmiş bir ajanın yan etki olmadan başarılı bir geri dönüşünü sağlar.

enable: (agentName: string, options?: AgentsEnableOptionalParams) => Promise<void>

Özellik Değeri

Aracıyı alır.

get: (agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

Özellik Değeri

Ajanın adı ve oturum tanımlayıcısı ile barındırılan bir ajan oturumunun detaylarını alır.

getSession: (agentName: string, sessionId: string, options?: AgentsGetSessionOptionalParams) => Promise<AgentSessionResource>

Özellik Değeri

Belirli bir hosted agent oturumu için konsol loglarını (stdout / stderr) Server-Sent Events (SSE) akışı olarak yayınlar.

Her SSE çerçevesi şunları içerir:

• event: her zaman "log"
• data: düz metin log satırı (şu anda JSON formatında, ancak şema sözleşmeli değildir ve ek anahtarlar içerebilir veya zamanla format değişebilir — müşteriler bunu opak bir dizi olarak kabul etmelidir)

Örnek SSE kareleri:

event: log
data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting FoundryCBAgent server on port 8088"}

event: log
data: {"timestamp":"2026-03-10T09:33:17.130Z","stream":"stderr","message":"INFO: Application startup complete."}

event: log
data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}

event: log
data: {"timestamp":"2026-03-10T09:35:52.714Z","stream":"status","message":"No logs since last 60 seconds"}

Akış, istemci bağlantıyı koparana veya sunucu bağlantıyı sonlandırana kadar açık kalır. Müşteriler gerektiğinde yeniden bağlantı kurmaları gerekir.

getSessionLogStream: (agentName: string, agentVersion: string, sessionId: string, options?: AgentsGetSessionLogStreamOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Özellik Değeri

Bir aracının belirli bir sürümünü alır.

getVersion: (agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

Özellik Değeri

Tüm müşteri temsilcilerinin listesini döndürür.

list: (options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

Özellik Değeri

Oturum sandbox'ta belirtilen yolda dosyaları ve dizinleri döndürür. Yanıt yalnızca hedef dizinin doğrudan çocuklarını içerir ve yol sağlanmadığında varsayılan olarak oturum ana dizinine geçer.

listSessionFiles: (agentName: string, sessionId: string, options?: AgentsListSessionFilesOptionalParams) => PagedAsyncIterableIterator<SessionDirectoryEntry, SessionDirectoryEntry[], PageSettings>

Özellik Değeri

Belirtilen ajan uç noktasına bağlı sayfalanmış bir oturum koleksiyonunu döndürür.

listSessions: (agentName: string, options?: AgentsListSessionsOptionalParams) => PagedAsyncIterableIterator<AgentSessionResource, AgentSessionResource[], PageSettings>

Özellik Değeri

Bir aracının sürümlerinin listesini döndürür.

listVersions: (agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

Özellik Değeri

Belirtilen barındırılan ajan oturumunu sonlandırır ve istek başarılı olduğunda 204 No Content döndürür.

stopSession: (agentName: string, sessionId: string, options?: AgentsStopSessionOptionalParams) => Promise<void>

Özellik Değeri

Belirlenen ajan uç noktası yapılandırmasına birleştirme yaması güncellemesi uygular.

updateAgent: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

Özellik Değeri

Oturum kum kutusunda belirtilen yola ikili dosya içeriğini yükler. Hizmet, dosyayı oturum ana dizinine göre saklar ve 50 MB'den büyük yükleri reddeder.

uploadSessionFile: (agentName: string, sessionId: string, path: string, content: Uint8Array, options?: AgentsUploadSessionFileOptionalParams) => Promise<SessionFileWriteResponse>

Özellik Değeri

Aracıyı oluşturur.

function create(name: string, definition: AgentDefinitionUnion, options?: AgentsCreateOptionalParams): Promise<Agent>

Parametreler

Döndürülenler

Bildirimden bir aracı oluşturur.

function create(name: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentFromManifestOptionalParams): Promise<Agent>

Parametreler

Döndürülenler

Yeni bir aracı sürümü oluşturun.

function createVersion(agentName: string, definition: AgentDefinitionUnion, options?: AgentsCreateVersionOptionalParams): Promise<AgentVersion>

Parametreler

Döndürülenler

Bildirimden yeni bir aracı sürümü oluşturun.

function createVersion(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentVersionFromManifestOptionalParams): Promise<AgentVersion>

Parametreler

Döndürülenler

Aracı tanımında herhangi bir değişiklik olması durumunda yeni bir sürüm ekleyerek aracıyı güncelleştirir. Değişiklik yoksa mevcut aracı sürümünü döndürür.

function update(agentName: string, definition: AgentDefinitionUnion, options?: AgentsUpdateOptionalParams): Promise<Agent>

Parametreler

Döndürülenler

Aracı tanımında herhangi bir değişiklik varsa yeni bir sürüm ekleyerek bir bildirimden aracıyı güncelleştirir. Değişiklik yoksa mevcut aracı sürümünü döndürür.

function update(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsUpdateAgentFromManifestOptionalParams): Promise<Agent>

Parametreler

Döndürülenler