# AzureSearchSettings Properties

- Package: [Aspire.Azure.Search.Documents](/reference/api/csharp/aspire.azure.search.documents.md)
- Type: [AzureSearchSettings](/reference/api/csharp/aspire.azure.search.documents/azuresearchsettings.md)
- Kind: `Properties`
- Members: `5`

Provides the client configuration settings for connecting to Azure AI Search.

## Credential

- Name: `Credential`
- Modifiers: `nullable` `get; set`
- Returns: `TokenCredential?`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Search.Documents/AzureSearchSettings.cs)

Gets or sets the credential used to authenticate to the Azure AI Search resource.

```csharp
public TokenCredential? Credential { get; set; }
```

## DisableHealthChecks

- Name: `DisableHealthChecks`
- Modifiers: `get; set`
- Returns: `bool`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Search.Documents/AzureSearchSettings.cs)

Gets or sets a boolean value that indicates whether the Azure AI Search health check is disabled or not.

```csharp
public bool DisableHealthChecks { get; set; }
```

## DisableTracing

- Name: `DisableTracing`
- Modifiers: `get; set`
- Returns: `bool`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Search.Documents/AzureSearchSettings.cs)

Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.

```csharp
public bool DisableTracing { get; set; }
```

## Endpoint

- Name: `Endpoint`
- Modifiers: `nullable` `get; set`
- Returns: `Uri?`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Search.Documents/AzureSearchSettings.cs)

Gets or sets a `Uri` referencing the Azure AI Search endpoint. This is likely to be similar to "https://{search_service}.search.windows.net".

```csharp
public Uri? Endpoint { get; set; }
```

## Remarks

Must not contain shared access signature. Used along with [AzureSearchSettings.Credential](/reference/api/csharp/aspire.azure.search.documents/azuresearchsettings/properties.md#credential) or [AzureSearchSettings.Key](/reference/api/csharp/aspire.azure.search.documents/azuresearchsettings/properties.md#key) to establish the connection.

## Key

- Name: `Key`
- Modifiers: `nullable` `get; set`
- Returns: `string?`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Search.Documents/AzureSearchSettings.cs)

Gets or sets the key to use to authenticate to the Azure AI Search endpoint.

```csharp
public string? Key { get; set; }
```

## Remarks

When defined it will use an `AzureKeyCredential` instance instead of [AzureSearchSettings.Credential](/reference/api/csharp/aspire.azure.search.documents/azuresearchsettings/properties.md#credential).