HeaderTelemetryEndpointAuth interface

Package:

@azure/ai-projects

Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header.

Extends

TelemetryEndpointAuth

Properties

header_name	The name of the HTTP header to inject the secret value into.
secret_id	The identifier of the secret store or connection.
secret_key	The key within the secret to retrieve the authentication value.
type	The authentication type, always 'header' for header-based secret authentication.

Property Details

header_name

The name of the HTTP header to inject the secret value into.

header_name: string

Property Value

string

secret_id

The identifier of the secret store or connection.

secret_id: string

Property Value

string

secret_key

The key within the secret to retrieve the authentication value.

secret_key: string

Property Value

string

type

The authentication type, always 'header' for header-based secret authentication.

type: "header"

Property Value

"header"