HttpRequestMessageAuthenticationExtensions.WithAuthenticationOptions 方法
定義
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
多載
| 名稱 | Description |
|---|---|
| WithAuthenticationOptions(HttpRequestMessage, MicrosoftIdentityMessageHandlerOptions) |
為 HTTP 請求設定認證選項。 |
| WithAuthenticationOptions(HttpRequestMessage, Action<MicrosoftIdentityMessageHandlerOptions>) |
透過代理為 HTTP 請求配置認證選項。 |
WithAuthenticationOptions(HttpRequestMessage, MicrosoftIdentityMessageHandlerOptions)
為 HTTP 請求設定認證選項。
public static System.Net.Http.HttpRequestMessage WithAuthenticationOptions(this System.Net.Http.HttpRequestMessage request, Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions options);static member WithAuthenticationOptions : System.Net.Http.HttpRequestMessage * Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions -> System.Net.Http.HttpRequestMessage<Extension()>
Public Function WithAuthenticationOptions (request As HttpRequestMessage, options As MicrosoftIdentityMessageHandlerOptions) As HttpRequestMessage參數
- request
- HttpRequestMessage
HTTP 請求訊息來設定。
驗證選項可套用於此請求。
傳回
方法鏈結的請求訊息相同。
例外狀況
何時或requestoptions正在丟null棄。
範例
var options = new MicrosoftIdentityMessageHandlerOptions
{
Scopes = { "https://graph.microsoft.com/.default" }
};
options.WithAgentIdentity("my-agent-guid");
var request = new HttpRequestMessage(HttpMethod.Get, "/me")
.WithAuthenticationOptions(options);
備註
此方法會覆蓋請求中已設定的所有認證選項。 選項物件可透過其他 Microsoft Identity Web 套件的擴充方法進一步配置。
適用於
WithAuthenticationOptions(HttpRequestMessage, Action<MicrosoftIdentityMessageHandlerOptions>)
透過代理為 HTTP 請求配置認證選項。
public static System.Net.Http.HttpRequestMessage WithAuthenticationOptions(this System.Net.Http.HttpRequestMessage request, Action<Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions> configure);static member WithAuthenticationOptions : System.Net.Http.HttpRequestMessage * Action<Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions> -> System.Net.Http.HttpRequestMessage<Extension()>
Public Function WithAuthenticationOptions (request As HttpRequestMessage, configure As Action(Of MicrosoftIdentityMessageHandlerOptions)) As HttpRequestMessage參數
- request
- HttpRequestMessage
HTTP 請求訊息來設定。
- configure
- Action<MicrosoftIdentityMessageHandlerOptions>
一個負責設定認證選項的代表。
傳回
方法鏈結的請求訊息相同。
例外狀況
何時或requestconfigure正在丟null棄。
範例
var request = new HttpRequestMessage(HttpMethod.Get, "/api/users")
.WithAuthenticationOptions(options =>
{
options.Scopes.Add("https://myapi.domain.com/user.read");
options.WithAgentIdentity("agent-application-id");
options.RequestAppToken = true;
});
備註
如果請求已經設定了認證選項，代理將收到可修改的現有選項物件。 否則，將建立一個新的 MicrosoftIdentityMessageHandlerOptions 實例並交給代表。
當你需要套用其他 Microsoft Identity Web 套件的擴充方法時，這個方法特別有用，例如代理身份方法。