RoutingEndpointConventionBuilderExtensions.RequireHost<TBuilder> Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Builder

Assembly:: Microsoft.AspNetCore.Routing.dll

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Requires that endpoints match one of the specified hosts during routing.

public:
generic <typename TBuilder>
 where TBuilder : Microsoft::AspNetCore::Builder::IEndpointConventionBuilder[System::Runtime::CompilerServices::Extension]
 static TBuilder RequireHost(TBuilder builder, ... cli::array <System::String ^> ^ hosts);

public static TBuilder RequireHost<TBuilder> (this TBuilder builder, params string[] hosts) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;

static member RequireHost : 'Builder * string[] -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)

<Extension()>
Public Function RequireHost(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, ParamArray hosts As String()) As TBuilder

Type Parameters

TBuilder

Parameters

builder: TBuilder

The IEndpointConventionBuilder to add the metadata to.

hosts: String[]

The hosts used during routing. Hosts should be Unicode rather than punycode, and may have a port. An empty collection means any host will be accepted.

Returns

TBuilder

A reference to this instance after the operation has completed.

Applies to