KubernetesServiceExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Hosting.Kubernetes / KubernetesServiceExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting.Kubernetes KubernetesServiceExtensions Methods

Class Methods 1 member

Provides extension methods for customizing Kubernetes service resources.

PublishAsKubernetesService(IResourceBuilder<T>, Action<KubernetesResource>) extension IResourceBuilder<T>

Publishes the specified resource as a Kubernetes service.

public static class KubernetesServiceExtensions
{
    public static IResourceBuilder<T> PublishAsKubernetesService<T>(
        this IResourceBuilder<T> builder,
        Action<KubernetesResource> configure)
    {
        // ...
    }
}

KubernetesServiceExtensions.cs#L36-L46

Parameters

builder IResourceBuilder<T> The resource builder.

configure Action<KubernetesResource> The configuration action for the Kubernetes service.

Returns

IResourceBuilder<T> The updated resource builder.

Remarks

This method checks if the application is in publish mode. If it is, it adds a customization annotation that will be applied by the infrastructure when generating the Kubernetes service.

builder.AddContainer(
    "redis",
    "redis:alpine").PublishAsKubernetesService((service) =>
{
    service.Name = "redis";
});