Microsoft.Identity.Abstractions 命名空間
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
類別
| 名稱 | Description |
|---|---|
| AcquiredTokenRegionDetails |
關於區域 ESTS 路由的資訊,用於代幣取得嘗試。 |
| AcquireTokenOptions |
選擇權主導代幣取得。 這些選項提供給 ITokenAcquirer 方法,或是 AuthorizationHeaderProviderOptions、 DownstreamApiOptions或 。 |
| AcquireTokenOptionsExtensions |
SDK 對 SDK 的輔助工具,用於將輸出HttpRequestMessage資料流向請求感知的授權標頭提供者。ExtraParameters |
| AcquireTokenResult |
這是象徵性收購的結果。 |
| AuthorizationHeaderError |
代表在建立或處理授權標頭時發生的錯誤。 |
| AuthorizationHeaderInformation |
代表授權標頭的完整資訊,包括標頭值與綁定憑證。 |
| AuthorizationHeaderProviderOptions |
透過傳入選項來呼叫下游的網頁 API。 若要呼叫 Microsoft Graph,請參考 |
| AuthorizationHeaderResult |
代表授權標頭建立操作的結果。 此結果可包含成功的授權標頭資訊或錯誤細節。 |
| CloudMetadataKeyNames |
透過 交換 ICloudMetadataProvider的雲端專屬元資料的知名金鑰。 |
| CredentialDescription |
資格說明。 憑證用於證明應用程式的身份(參見 ClientCredentials),或用於解密權杖(參見 TokenDecryptionCredentials)。 憑證可以是秘密(用戶端秘密)、憑證或簽署斷言。 它們可以用多種方式儲存或提供,本類別提供了描述它們的方式。 該描述隨後被 Microsoft 採用。用 Identity.Web 來取得憑證。 (參見 DefaultCredentialProvider 類別) |
| CredentialDescriptionJsonConverter |
自訂 JSON 轉換器用於憑證描述,以處理基於 SourceType 的憑證資訊的正確序列化/反序列化。 |
| CredentialSourceLoaderParameters |
這些參數是憑證載入器(如簽署斷言提供者)可以用來載入憑證的。 除非你在寫自訂憑證載入器,否則不會直接使用這個類別。 |
| DownstreamApiOptions |
透過傳入選項來呼叫下游的網頁 API。 |
| DownstreamApiOptionsReadOnlyHttpMethod |
專門化,指DownstreamApiOptionsHttpMethod的是除了建造階段外無法設定的部分。 |
| IdentityApplicationOptions |
在網頁應用程式、網頁 API 或守護程序應用程式中設定認證的選項。 此類別包含任何 OAuth 2.0 身份提供者的設定屬性。 關於 Azure AD 的特定選項,請參考衍生類別: MicrosoftIdentityApplicationOptions。 此類別及其衍生類別通常作為選項使用,並從設定檔反序列化,如 appsettings.json |
| InMemoryCloudMetadataProvider |
一個現成、可 ICloudMetadataProvider 變的呼叫者在啟動時自動填入,並有一個可選的備用提供者,適用於它自己不認識的主機。 |
| ManagedIdentityOptions |
資料物件,用以保存應用程式用於認證的管理身份定義。 若 UserAssignedClientId 為空,應用程式將使用系統指派的管理身份。 若 UserAssignedClientId 設定為 ,應用程式將嘗試使用與所提供客戶 ID 相關的使用者指派管理身份。 如需詳細資訊,請參閱 https://aka.ms/Entra/ManagedIdentityOverview。 |
| MicrosoftEntraApplicationOptions |
針對網頁應用程式、網頁 API 或守護程序應用程式,設定 Microsoft Entra(Azure AD)專用認證的選項。 |
| MicrosoftIdentityApplicationOptions |
使用 Azure Active Directory 設定網頁應用程式、網頁 API 或守護程序的認證選項。 它同時具備 AAD 與 B2C 配置屬性。 |
| OperationError |
代表操作過程中發生的錯誤。 |
| TokenAcquisitionFailureDetails |
關於失敗的憑證獲取嘗試的診斷細節,與底層憑證服務例外所暴露的欄位相呼應。 |
| TokenAcquisitionMetadata |
描述存取權杖如何取得的元資料:時序、快取狀態、區域路由,以及令牌端點回傳的任何額外回應參數。 |
結構
| 名稱 | Description |
|---|---|
| OperationResult<TResult,TError> |
代表一個操作的結果,該操作可能以有效結果成功,或因特定錯誤而失敗。 |
介面
| 名稱 | Description |
|---|---|
| IAuthenticationSchemeInformationProvider |
提供有效認證方案(選項名稱)的資訊。 如果傳遞 null 或字串。空則回傳預設的認證方案。 |
| IAuthorizationHeaderProvider |
建立授權標頭的值,讓呼叫者可用來呼叫受保護的網頁 API。 |
| IAuthorizationHeaderProvider<TResult> |
建立授權標頭的值,讓呼叫者可用來呼叫受保護的網頁 API。 |
| IAuthorizationHeaderProvider2 |
IAuthorizationHeaderProvider擴充了其三種標頭建立方法的元資料承載對應系統。 每個字串都會回傳完整的 AuthorizationHeaderInformation (標頭值、綁定憑證及憑證取得元資料),而 OperationResult<TResult,TError> 非裸標頭字串。 |
| IBoundAuthorizationHeaderProvider |
建立授權標頭值,供呼叫者存取受保護的網頁 API,該 API 支援無綁定或綁定於憑證(例如在 mTLS PoP 情境下)的憑證。 |
| ICloudMetadataProvider |
解析由權威主機(例如 |
| ICredentialsLoader |
憑證載入器的合約,由像 Microsoft 中的 DefaultCertificateLoader 或 DefaultCredentialLoader 這類類別實作。Identity.Web。 憑證載入器用於從 載 CredentialDescription入憑證,結果則會顯示在 CredentialDescription.CachedValue 屬性中。 憑證載入器構成一個擴充點。 他們會委託給憑證來源載入器,這些載入器在集合 CredentialSourceLoaders 中指定,選擇與 CredentialSource 憑證描述中憑證來源相符的載入器來載入。 |
| ICredentialSourceLoader |
合約來實作載入憑證,例如憑證。 |
| ICustomSignedAssertionProvider |
介面用以實作自訂簽署斷言提供者的載入。 |
| IDownstreamApi |
介面用於呼叫下游 API,例如從控制器呼叫。 |
| ITokenAcquirer |
憑證擷取服務介面(例如封裝 MSAL.NET)。 |
| ITokenAcquirerFactory |
代幣收單工廠。 |
列舉
| 名稱 | Description |
|---|---|
| AcquiredTokenCacheLevel |
是提供存取權杖的快取層。 |
| AcquiredTokenCacheRefreshReason |
為什麼嘗試取得憑證會刷新快取的存取憑證。 |
| AcquiredTokenRegionOutcome |
區域 ESTS 路由嘗試取得代幣的結果。 |
| AcquiredTokenSource |
取得存取權杖的來源。 |
| CredentialSource |
資格來源。 憑證用於證明應用程式的身份(參見 ClientCredentials),或用於解密權杖(參見 TokenDecryptionCredentials)。 憑證可以是秘密(用戶端秘密)、憑證或簽署斷言。 它們可以透過多種方式儲存或提供,而這個列舉描述了這些方式。 它在物業 SourceType 內使用。 |
| CredentialType |
認證類型。 這用來指定所載入的憑證類型。 此值依據憑證類型(依據 的價值CredentialType類型CredentialSource)在教區SourceType中提供。 |