# HelmChartOptions Methods

- Package: [Aspire.Hosting.Kubernetes](/reference/api/csharp/aspire.hosting.kubernetes.md)
- Type: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Kind: `Methods`
- Members: `10`

Provides options for configuring Helm chart deployment settings on a [KubernetesEnvironmentResource](/reference/api/csharp/aspire.hosting.kubernetes/kubernetesenvironmentresource.md).

## WithChartDescription(string)

- Name: `WithChartDescription(string)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the Helm chart description written to the generated `Chart.yaml`.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithChartDescription(
        string description)
    {
        // ...
    }
}
```

## Parameters

- `description` (`string`)
  The chart description.

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.

## WithChartDescription(IResourceBuilder<ParameterResource>)

- Name: `WithChartDescription(IResourceBuilder<ParameterResource>)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the Helm chart description written to the generated `Chart.yaml` using a parameter that will be prompted at deploy time.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithChartDescription(
        IResourceBuilder<ParameterResource> description)
    {
        // ...
    }
}
```

## Parameters

- `description` (`IResourceBuilder<ParameterResource>`)
  A parameter resource builder for the chart description value.

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.

## WithChartName(string)

- Name: `WithChartName(string)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the Helm chart name written to the generated `Chart.yaml`.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithChartName(
        string name)
    {
        // ...
    }
}
```

## Parameters

- `name` (`string`)
  The chart name. Must match Helm's chart-name format (alphanumeric, `-`, `_`, or `.`).

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.

## WithChartName(IResourceBuilder<ParameterResource>)

- Name: `WithChartName(IResourceBuilder<ParameterResource>)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the Helm chart name written to the generated `Chart.yaml` using a parameter that will be prompted at deploy time.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithChartName(
        IResourceBuilder<ParameterResource> name)
    {
        // ...
    }
}
```

## Parameters

- `name` (`IResourceBuilder<ParameterResource>`)
  A parameter resource builder for the chart name value.

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.

## WithChartVersion(string)

- Name: `WithChartVersion(string)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the Helm chart version for deployment.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithChartVersion(
        string version)
    {
        // ...
    }
}
```

## Parameters

- `version` (`string`)
  The chart version. Helm accepts strict SemVer 2.0 strings (e.g. `"1.2.3"`, `"1.2.3-beta.1+ef365"`) as well as partial versions ( `"1"`, `"1.2"`) and versions with a leading `v` ( `"v1.2.3"`), which are coerced to a full semantic version. Leading zeros are not allowed.

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.

## WithChartVersion(IResourceBuilder<ParameterResource>)

- Name: `WithChartVersion(IResourceBuilder<ParameterResource>)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the Helm chart version for deployment using a parameter that will be prompted at deploy time.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithChartVersion(
        IResourceBuilder<ParameterResource> version)
    {
        // ...
    }
}
```

## Parameters

- `version` (`IResourceBuilder<ParameterResource>`)
  A parameter resource builder for the chart version value.

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.

## WithNamespace(string)

- Name: `WithNamespace(string)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the target Kubernetes namespace for deployment.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithNamespace(
        string @namespace)
    {
        // ...
    }
}
```

## Parameters

- `namespace` (`string`)
  The namespace name.

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.

## WithNamespace(IResourceBuilder<ParameterResource>)

- Name: `WithNamespace(IResourceBuilder<ParameterResource>)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the target Kubernetes namespace for deployment using a parameter that will be prompted at deploy time.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithNamespace(
        IResourceBuilder<ParameterResource> @namespace)
    {
        // ...
    }
}
```

## Parameters

- `namespace` (`IResourceBuilder<ParameterResource>`)
  A parameter resource builder for the namespace value.

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.

## WithReleaseName(string)

- Name: `WithReleaseName(string)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the Helm release name for deployment.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithReleaseName(
        string releaseName)
    {
        // ...
    }
}
```

## Parameters

- `releaseName` (`string`)
  The release name.

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.

## WithReleaseName(IResourceBuilder<ParameterResource>)

- Name: `WithReleaseName(IResourceBuilder<ParameterResource>)`
- Returns: [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md)
- Source: [GitHub](https://github.com/microsoft/aspire/blob/becb48e2d61099e35ae336d527d3875e928d6594/src/Aspire.Hosting.Kubernetes/HelmChartOptions.cs)

Sets the Helm release name for deployment using a parameter that will be prompted at deploy time.

```csharp
public sealed class HelmChartOptions
{
    public HelmChartOptions WithReleaseName(
        IResourceBuilder<ParameterResource> releaseName)
    {
        // ...
    }
}
```

## Parameters

- `releaseName` (`IResourceBuilder<ParameterResource>`)
  A parameter resource builder for the release name value.

## Returns

[HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) -- This [HelmChartOptions](/reference/api/csharp/aspire.hosting.kubernetes/helmchartoptions.md) for chaining.

## ATS metadata

### Ignored by ATS

- Excluded from automatic Polyglot export.