Skip to content
DocsTry Aspire
DocsTry

AzureSearchSettings Properties

ClassProperties5 members
Provides the client configuration settings for connecting to Azure AI Search.
CredentialSection titled CredentialnullableTokenCredential?
Gets or sets the credential used to authenticate to the Azure AI Search resource.
public TokenCredential? Credential { get; set; }
DisableHealthChecksSection titled DisableHealthChecksbool
Gets or sets a boolean value that indicates whether the Azure AI Search health check is disabled or not.
public bool DisableHealthChecks { get; set; }
Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.
public bool DisableTracing { get; set; }
EndpointSection titled EndpointnullableUri?
Gets or sets a Uri referencing the Azure AI Search endpoint. This is likely to be similar to "https://{search_service}.search.windows.net".
public Uri? Endpoint { get; set; }
Must not contain shared access signature. Used along with AzureSearchSettings.Credential or AzureSearchSettings.Key to establish the connection.
KeySection titled Keynullablestring?
Gets or sets the key to use to authenticate to the Azure AI Search endpoint.
public string? Key { get; set; }
When defined it will use an AzureKeyCredential instance instead of AzureSearchSettings.Credential.