LinkGenerator.GetUriByAddress Method

Definition

Namespace:

Microsoft.AspNetCore.Routing

Assembly:

Microsoft.AspNetCore.Routing.Abstractions.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

Overloads

GetUriByAddress<TAddress>(TAddress, RouteValueDictionary, String, HostString, PathString, FragmentString, LinkOptions)	Generates an absolute URI based on the provided values.
GetUriByAddress<TAddress>(HttpContext, TAddress, RouteValueDictionary, RouteValueDictionary, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions)	Generates an absolute URI based on the provided values and HttpContext.

GetUriByAddress<TAddress>(TAddress, RouteValueDictionary, String, HostString, PathString, FragmentString, LinkOptions)

Generates an absolute URI based on the provided values.

public abstract string? GetUriByAddress<TAddress> (TAddress address, Microsoft.AspNetCore.Routing.RouteValueDictionary values, string scheme, Microsoft.AspNetCore.Http.HostString host, Microsoft.AspNetCore.Http.PathString pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);

abstract member GetUriByAddress : 'Address * Microsoft.AspNetCore.Routing.RouteValueDictionary * string * Microsoft.AspNetCore.Http.HostString * Microsoft.AspNetCore.Http.PathString * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string

Public MustOverride Function GetUriByAddress(Of TAddress) (address As TAddress, values As RouteValueDictionary, scheme As String, host As HostString, Optional pathBase As PathString = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As String

Type Parameters

TAddress

The address type.

Parameters

address

TAddress

The address value. Used to resolve endpoints.

values

RouteValueDictionary

The route values. Used to expand parameters in the route template.

scheme

String

The URI scheme, applied to the resulting URI.

host

HostString

The URI host/authority, applied to the resulting URI. See the remarks section for details about the security implications of the host.

pathBase

PathString

An optional URI path base. Prepended to the path in the resulting URI.

fragment

FragmentString

An optional URI fragment. Appended to the resulting URI.

options

LinkOptions

An optional LinkOptions. Settings on provided object override the settings with matching names from RouteOptions.

Returns

String

An absolute URI, or null.

Remarks

The value of host should be a trusted value. Relying on the value of the current request can allow untrusted input to influence the resulting URI unless the Host header has been validated. See the deployment documentation for instructions on how to properly validate the Host header in your deployment environment.

GetUriByAddress<TAddress>(HttpContext, TAddress, RouteValueDictionary, RouteValueDictionary, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions)

Generates an absolute URI based on the provided values and HttpContext.

public abstract string? GetUriByAddress<TAddress> (Microsoft.AspNetCore.Http.HttpContext httpContext, TAddress address, Microsoft.AspNetCore.Routing.RouteValueDictionary values, Microsoft.AspNetCore.Routing.RouteValueDictionary? ambientValues = default, string? scheme = default, Microsoft.AspNetCore.Http.HostString? host = default, Microsoft.AspNetCore.Http.PathString? pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);

abstract member GetUriByAddress : Microsoft.AspNetCore.Http.HttpContext * 'Address * Microsoft.AspNetCore.Routing.RouteValueDictionary * Microsoft.AspNetCore.Routing.RouteValueDictionary * string * Nullable<Microsoft.AspNetCore.Http.HostString> * Nullable<Microsoft.AspNetCore.Http.PathString> * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string

Public MustOverride Function GetUriByAddress(Of TAddress) (httpContext As HttpContext, address As TAddress, values As RouteValueDictionary, Optional ambientValues As RouteValueDictionary = Nothing, Optional scheme As String = Nothing, Optional host As Nullable(Of HostString) = Nothing, Optional pathBase As Nullable(Of PathString) = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As String

Type Parameters

TAddress

The address type.

Parameters

httpContext

HttpContext

The HttpContext associated with the current request.

address

TAddress

The address value. Used to resolve endpoints.

values

RouteValueDictionary

The route values. Used to expand parameters in the route template.

ambientValues

RouteValueDictionary

The values associated with the current request. Optional.

scheme

String

The URI scheme, applied to the resulting URI. Optional. If not provided, the value of Scheme will be used.

host

Nullable<HostString>

The URI host/authority, applied to the resulting URI. Optional. If not provided, the value Host will be used. See the remarks section for details about the security implications of the host.

pathBase

Nullable<PathString>

An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of PathBase will be used.

fragment

FragmentString

An optional URI fragment. Appended to the resulting URI.

options

LinkOptions

An optional LinkOptions. Settings on provided object override the settings with matching names from RouteOptions.

Returns

String

A URI with an absolute path, or null.

Remarks

The value of host should be a trusted value. Relying on the value of the current request can allow untrusted input to influence the resulting URI unless the Host header has been validated. See the deployment documentation for instructions on how to properly validate the Host header in your deployment environment.