PlatformHeaders Class

Definition

Namespace:: Azure.AI.AgentServer.Core

Assembly:: Azure.AI.AgentServer.Core.dll

Package:: Azure.AI.AgentServer.Core v1.0.0-beta.23

Source:: PlatformHeaders.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the HTTP header names used across the AgentServer platform. These headers form the wire contract between the Foundry platform, agent containers, and downstream storage services.

public static class PlatformHeaders

type PlatformHeaders = class

Public Class PlatformHeaders

Inheritance: Object
PlatformHeaders

Remarks

Response headers (set by the server on every response):

RequestId — request correlation ID.
ServerVersion — server SDK identity.
SessionId — resolved session ID (when applicable).

Request headers (set by the platform or client):

RequestId — client-provided correlation ID (echoed back on the response).
UserIsolationKey / ChatIsolationKey — platform isolation keys.
ClientHeaderPrefix — prefix for pass-through client headers.
TraceParent — W3C Trace Context propagation header.
ClientRequestId — Azure SDK client correlation header.

Fields

Name	Description
ChatIsolationKey	The `x-agent-chat-isolation-key` header — the platform-injected partition key for conversation-scoped state.
ClientHeaderPrefix	The prefix `x-client-` for pass-through client headers. All request headers starting with this prefix are extracted and forwarded to the handler via the invocation context.
ClientRequestId	The `x-ms-client-request-id` header — Azure SDK client correlation header. Logged for diagnostic correlation with upstream Azure SDK callers.
RequestId	The `x-request-id` header — carries the request correlation ID. On responses, the server always sets this header (OTEL trace ID → incoming header → GUID). On requests, clients may set it to provide their own correlation ID.
RequestIdItemKey	Key used to store the resolved request ID in Items. Downstream filters and middleware can read this value to correlate the request ID without re-resolving it.
ServerVersion	The `x-platform-server` header — identifies the server SDK stack (hosting version, protocol versions, language, and runtime). Set on every response by `ServerVersionMiddleware`.
SessionId	The `x-agent-session-id` header — the resolved session ID for the request. Set on responses by protocol-specific session resolution logic.
TraceParent	The `traceparent` header — W3C Trace Context propagation header. Used for distributed tracing correlation on outbound storage requests.
UserIsolationKey	The `x-agent-user-isolation-key` header — the platform-injected partition key for user-private state.

Applies to

Feedback

War diese Seite hilfreich?