DeviceCodeCredentialOptions クラス

定義

名前空間:

Azure.Identity

アセンブリ:

Azure.Identity.dll

パッケージ:

Azure.Identity v1.11.1

ソース:

DeviceCodeCredentialOptions.cs

を構成 DeviceCodeCredentialするためのオプション。

public class DeviceCodeCredentialOptions : Azure.Identity.TokenCredentialOptions

type DeviceCodeCredentialOptions = class
    inherit TokenCredentialOptions

Public Class DeviceCodeCredentialOptions
Inherits TokenCredentialOptions

継承

Object

ClientOptions

TokenCredentialOptions

DeviceCodeCredentialOptions

コンストラクター

DeviceCodeCredentialOptions()

を構成 DeviceCodeCredentialするためのオプション。

プロパティ

AdditionallyAllowedTenants	資格情報がトークンを取得できる指定された に加えて、テナントを指定 TenantId します。 ワイルドカード値 "*" を追加して、ログインしているアカウントがアクセスできるテナントのトークンを資格情報で取得できるようにします。 に TenantId値が指定されていない場合、このオプションは無効になり、資格情報は要求されたテナントのトークンを取得します。
AuthenticationRecord	以前の AuthenticationRecord 認証からキャプチャされた 。
AuthorityHost	Microsoft Entra機関のホスト。 既定値は、https://login.microsoftonline.com/ です。 Azure クラウド インスタンスの既知の機関ホストについては、「」を参照してください AzureAuthorityHosts。 (継承元 TokenCredentialOptions)
ClientId	ユーザーの認証に使用されるアプリケーションのクライアント ID。 指定しない場合、ユーザーは Azure 開発アプリケーションで認証されます。
DeviceCodeCallback	ユーザーにデバイス コード ログインの詳細を表示するために実行されるコールバック。 指定されていない場合、デバイス コードとログイン手順がコンソールに出力されます。
Diagnostics	資格情報の診断オプションを取得します。 (継承元 TokenCredentialOptions)
DisableAutomaticAuthentication	を使用してユーザーに DeviceCodeCredential 自動的にメッセージを表示できないようにします。 自動認証が無効になっている場合、AuthenticationRequiredException は、ユーザーの操作が必要な場合と GetTokenAsync(TokenRequestContext, CancellationToken) からGetToken(TokenRequestContext, CancellationToken)スローされます。 アプリケーションは、この例外を処理し、 または AuthenticateAsync(CancellationToken) を呼び出Authenticate(CancellationToken)してユーザーを対話形式で認証する役割を担います。
DisableInstanceDiscovery	認証時にインスタンス検出を実行するかどうかを決定する設定を取得または設定します。 これを true に設定すると、インスタンスの検出と機関の検証の両方が完全に無効になります。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオでの使用を目的としています。 インスタンス検出のプロセスでは、 から https://login.microsoft.com/ 機関メタデータを取得して機関を検証する必要があります。 これを に true設定すると、機関の検証は無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。
IsUnsafeSupportLoggingEnabled	機密性の高いコンテンツを含む ETW ログ記録をログに記録するかどうかを示す値を取得または設定します。 このプロパティを true に設定すると、Content の Request 編集は無効になりません。 機密性の高い Content ログを有効にするには、 プロパティを IsLoggingContentEnabled に設定する true必要があります。 このプロパティを に設定すると true 、enablePiiLogging パラメーターの 'true' を MSAL クライアント ビルダーの 'WithLogging' メソッドに渡すことと同じになります。 (継承元 TokenCredentialOptions)
Retry	クライアントの再試行オプションを取得します。 (継承元 ClientOptions)
RetryPolicy	再試行に使用するポリシーを取得または設定します。 ポリシーが指定されている場合は、 プロパティの代わりにポリシーが Retry 使用されます。 型を RetryPolicy から派生して、再試行ロジックを完全に実装しなくても、既定の動作を変更できます。 がオーバーライドされた場合、またはカスタムHttpPipelinePolicyが指定されている場合Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>)は、実装者が値を更新するProcessingContext必要があります。 (継承元 ClientOptions)
TenantId	ユーザーが認証されるテナント ID。 指定しない場合、ユーザーはホーム テナントに対して認証されます。
TokenCachePersistenceOptions	資格情報で TokenCachePersistenceOptions 使用する を指定します。 オプションを指定しない場合、トークン キャッシュはディスクに保持されません。
Transport	HttpPipelineTransportこのクライアントに使用する 。 既定値は の HttpClientTransportインスタンスです。 (継承元 ClientOptions)

メソッド

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

ポリシーを HttpPipeline クライアント パイプラインに追加します。 パイプライン内のポリシーの位置は、 パラメーターによって position 制御されます。 クライアント要求ごとにポリシーを 1 回実行する場合は、 を使用PerCallPerRetryして再試行ごとにポリシーを実行します。 の同じインスタンス policy は、この ClientOptions オブジェクトを使用して構築されたクライアントのすべてのパイプラインに追加されることに注意してください。 (継承元 ClientOptions)