ExternalServiceBuilderExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Hosting / ExternalServiceBuilderExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting ExternalServiceBuilderExtensions Methods

Class Methods 4 members

Provides extension methods for adding external services to an application.

AddExternalService(IDistributedApplicationBuilder, string, string) extension IResourceBuilder<ExternalServiceResource>

Adds an external service resource to the distributed application with the specified URL.

public static class ExternalServiceBuilderExtensions
{
    public static IResourceBuilder<ExternalServiceResource> AddExternalService(
        this IDistributedApplicationBuilder builder,
        string name,
        string url)
    {
        // ...
    }
}

ExternalServiceBuilderExtensions.cs#L29-L38

Parameters

builder IDistributedApplicationBuilder The distributed application builder.

name string The name of the resource.

url string The URL of the external service.

Returns

IResourceBuilder<ExternalServiceResource> An ApplicationModel.IResourceBuilder`1 instance.

AddExternalService(IDistributedApplicationBuilder, string, Uri) extension IResourceBuilder<ExternalServiceResource>

Adds an external service resource to the distributed application with the specified URI.

public static class ExternalServiceBuilderExtensions
{
    public static IResourceBuilder<ExternalServiceResource> AddExternalService(
        this IDistributedApplicationBuilder builder,
        string name,
        Uri uri)
    {
        // ...
    }
}

ExternalServiceBuilderExtensions.cs#L50-L54

Parameters

builder IDistributedApplicationBuilder The distributed application builder.

name string The name of the resource.

uri Uri The URI of the external service.

Returns

IResourceBuilder<ExternalServiceResource> An ApplicationModel.IResourceBuilder`1 instance.

AddExternalService(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>) extension IResourceBuilder<ExternalServiceResource>

Adds an external service resource to the distributed application with the URL coming from the specified parameter.

public static class ExternalServiceBuilderExtensions
{
    public static IResourceBuilder<ExternalServiceResource> AddExternalService(
        this IDistributedApplicationBuilder builder,
        string name,
        IResourceBuilder<ParameterResource> urlParameter)
    {
        // ...
    }
}

ExternalServiceBuilderExtensions.cs#L66-L70

Parameters

builder IDistributedApplicationBuilder The distributed application builder.

name string The name of the resource.

urlParameter IResourceBuilder<ParameterResource> The parameter containing the URL of the external service.

Returns

IResourceBuilder<ExternalServiceResource> An ApplicationModel.IResourceBuilder`1 instance.

WithHttpHealthCheck(IResourceBuilder<ExternalServiceResource>, string?, int?) extension IResourceBuilder<ExternalServiceResource>

Adds a health check to the external service resource.

public static class ExternalServiceBuilderExtensions
{
    public static IResourceBuilder<ExternalServiceResource> WithHttpHealthCheck(
        this IResourceBuilder<ExternalServiceResource> builder,
        string? path = null,
        int? statusCode = null)
    {
        // ...
    }
}

ExternalServiceBuilderExtensions.cs#L187-L246

Parameters

builder IResourceBuilder<ExternalServiceResource>

path string? optional The relative path to use for the HTTP health check.

statusCode int? optional

Remarks

This method adds a health check to the health check service which polls the specified external service on a periodic basis. The address is based on the URL of the external service. A path for the health check request can be specified. The expected status code is set to 200 by default but a different one can be specified.