DeviceCodeCredentialOptions Klasse

Definition

Optionen zum Konfigurieren von DeviceCodeCredential.

public class DeviceCodeCredentialOptions : Azure.Identity.TokenCredentialOptions
type DeviceCodeCredentialOptions = class
    inherit TokenCredentialOptions
Public Class DeviceCodeCredentialOptions
Inherits TokenCredentialOptions
Vererbung
DeviceCodeCredentialOptions

Konstruktoren

DeviceCodeCredentialOptions()

Optionen zum Konfigurieren von DeviceCodeCredential.

Eigenschaften

AdditionallyAllowedTenants

Gibt zusätzlich zu den angegebenen TenantId Mandanten an, für die die Anmeldeinformationen Token abrufen können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, auf den das angemeldete Konto zugreifen kann. Wenn kein Wert für TenantIdangegeben ist, hat diese Option keine Auswirkung, und die Anmeldeinformationen erhalten Token für jeden angeforderten Mandanten.

AuthenticationRecord

Der AuthenticationRecord aus einer vorherigen Authentifizierung erfasste.

AuthorityHost

Der Host der Microsoft Entra Autorität. Der Standardwert lautet https://login.microsoftonline.com/. Informationen zu bekannten Autoritätshosts für Azure-Cloudinstanzen finden Sie unter AzureAuthorityHosts.

(Geerbt von TokenCredentialOptions)
ClientId

Die Client-ID der Anwendung, die zum Authentifizieren des Benutzers verwendet wird. Wenn nicht angegeben, wird der Benutzer bei einer Azure-Entwicklungsanwendung authentifiziert.

DeviceCodeCallback

Der Rückruf, der ausgeführt wird, um dem Benutzer die Anmeldedetails des Gerätecodes anzuzeigen. In nicht angegeben werden der Gerätecode und die Anmeldeanweisungen in der Konsole ausgegeben.

Diagnostics

Ruft die Diagnoseoptionen für Anmeldeinformationen ab.

(Geerbt von TokenCredentialOptions)
DisableAutomaticAuthentication

Verhindert, dass der DeviceCodeCredential Benutzer automatisch aufgefordert wird. Wenn die automatische Authentifizierung deaktiviert ist, wird eine AuthenticationRequiredException von GetToken(TokenRequestContext, CancellationToken) und GetTokenAsync(TokenRequestContext, CancellationToken) für den Fall ausgelöst, dass eine Benutzerinteraktion erforderlich ist. Die Anwendung ist dafür verantwortlich, diese Ausnahme zu behandeln und den Benutzer interaktiv aufzurufen Authenticate(CancellationToken) oder AuthenticateAsync(CancellationToken) zu authentifizieren.

DisableInstanceDiscovery

Ruft die Einstellung ab, die bestimmt, ob instance Ermittlung ausgeführt wird, wenn versucht wird, sich zu authentifizieren, oder legt sie fest. Wenn Sie dies auf true festlegen, werden sowohl instance Ermittlung als auch die Validierung von Autoritäten vollständig deaktiviert. Diese Funktionalität ist für die Verwendung in Szenarien vorgesehen, in denen der Metadatenendpunkt nicht erreicht werden kann, z. B. in privaten Clouds oder Azure Stack. Der Prozess der instance Ermittlung umfasst das Abrufen von Autoritätsmetadaten aus, https://login.microsoft.com/ um die Autorität zu überprüfen. Wenn Sie dies auf truefestlegen, wird die Überprüfung der Autorität deaktiviert. Daher ist es wichtig sicherzustellen, dass der konfigurierte Autoritätshost gültig und vertrauenswürdig ist."

IsUnsafeSupportLoggingEnabled

Ruft einen Wert ab, der angibt, ob die ETW-Protokollierung protokolliert werden soll, die potenziell vertrauliche Inhalte enthält, oder legt diesen fest. Wenn Sie diese Eigenschaft auf true festlegen, wird die Bearbeitung von Request Content nicht deaktiviert. Um die Protokollierung vertraulicher Daten Content zu aktivieren, muss die IsLoggingContentEnabled -Eigenschaft auf truefestgelegt sein. Das Festlegen dieser Eigenschaft auf true entspricht der Übergabe von "true" für den enablePiiLogging-Parameter an die WithLogging-Methode im MSAL-Client-Generator.

(Geerbt von TokenCredentialOptions)
Retry

Ruft die Clientwiebele-Wiederholungsoptionen ab.

(Geerbt von ClientOptions)
RetryPolicy

Ruft die Richtlinie ab, die für Wiederholungsversuche verwendet werden soll, oder legt sie fest. Wenn eine Richtlinie angegeben wird, wird sie anstelle der Retry -Eigenschaft verwendet. Der RetryPolicy Typ kann von abgeleitet werden, um das Standardverhalten zu ändern, ohne die Wiederholungslogik vollständig implementieren zu müssen. Wenn Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) überschrieben wird oder ein benutzerdefinierter HttpPipelinePolicy Wert angegeben ist, ist es die Verantwortung des Implementierers, die ProcessingContext Werte zu aktualisieren.

(Geerbt von ClientOptions)
TenantId

Die Mandanten-ID, bei der der Benutzer authentifiziert wird. Wenn nicht angegeben, wird der Benutzer bei ihrem Basismandanten authentifiziert.

TokenCachePersistenceOptions

Gibt die an, die TokenCachePersistenceOptions von den Anmeldeinformationen verwendet werden soll. Wenn keine Optionen angegeben werden, wird der Tokencache nicht auf dem Datenträger beibehalten.

Transport

Die , die HttpPipelineTransport für diesen Client verwendet werden soll. Standardmäßig wird eine instance von verwendetHttpClientTransport.

(Geerbt von ClientOptions)

Methoden

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Fügt der Clientpipeline eine Richtlinie hinzu HttpPipeline . Die Position der Richtlinie in der Pipeline wird durch den position -Parameter gesteuert. Wenn die Richtlinie einmal pro Clientanforderung ausgeführt werden soll, verwenden PerRetry Sie PerCall andernfalls , um die Richtlinie für jeden Wiederholungsversuch auszuführen. Beachten Sie, dass derselbe instance von policy allen Pipelines des Clients hinzugefügt wird, die mit diesem ClientOptions Objekt erstellt wurden.

(Geerbt von ClientOptions)

Gilt für: