OptionsAttribute.RequestName Property

Reference

Definition

Namespace:: Microsoft.Extensions.Http.AutoClient

Assembly:: Microsoft.Extensions.Http.AutoClient.dll

Package:: Microsoft.Extensions.Http.AutoClient v8.0.0-rc.2.23510.2

Source:: OptionsAttribute.cs

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.

Gets or sets the name to use for this request within telemetry.

public:
 property System::String ^ RequestName { System::String ^ get(); void set(System::String ^ value); };

public string? RequestName { get; set; }

member this.RequestName : string with get, set

Public Property RequestName As String

Property Value

String

Examples

[AutoClient("MyClient")]
interface IMyDependencyClient
{
    [Options("/api/users/{userId}", RequestName = "Users")]
    Task<UserOptions> UserOptionsAsync(string userId, CancellationToken cancellationToken);
}

Remarks

If this property is not provided, the request name is obtained from the method name. If the method name ends in 'Async', the request name will exclude that. For example, if the method is called UserOptionsAsync, the request name, by default, will be UserOptions.

Applies to

แชร์ผ่าน