DeviceCodeCredentialOptions interface
Definieert opties voor de klasse InteractiveBrowserCredential voor Node.js.
- Uitbreiding
Eigenschappen
client |
Client-id van de Microsoft Entra-toepassing waarmee gebruikers zich aanmelden. Het wordt aanbevolen dat ontwikkelaars hun toepassingen registreren en de juiste rollen toewijzen. Ga naar https://aka.ms/identity/AppRegistrationAndRoleAssignmentvoor meer informatie. Als dit niet is opgegeven, verifiëren gebruikers zich bij een Azure-ontwikkeltoepassing. Dit wordt niet aanbevolen voor productiescenario's. |
tenant |
De id van de Microsoft Entra-tenant (directory). |
user |
Een callback-functie die wordt aangeroepen om DeviceCodeInfo- aan de gebruiker weer te geven. Als de toewijzing niet is toegewezen, registreren we automatisch de apparaatcodegegevens en de verificatie-instructies in de console. |
Overgenomen eigenschappen
additionally |
Voor toepassingen met meerdere tenants geeft u extra tenants op waarvoor de referentie tokens kan verkrijgen. Voeg de jokertekenwaarde *toe om de referentie toe te staan tokens te verkrijgen voor elke tenant die de toepassing heeft geïnstalleerd. |
additional |
Aanvullende beleidsregels die moeten worden opgenomen in de HTTP-pijplijn. |
allow |
Ingesteld op waar als de aanvraag via HTTP wordt verzonden in plaats van HTTPS |
authentication |
Resultaat van een eerdere verificatie die kan worden gebruikt om de referenties in de cache van elk afzonderlijk account op te halen. Dit is nodig om op te geven voor het geval de toepassing met meer dan één account per client-id en tenant-id-paar wil werken. Deze record kan als volgt worden opgehaald door de
|
authority |
De instantiehost die moet worden gebruikt voor verificatieaanvragen. Mogelijke waarden zijn beschikbaar via AzureAuthorityHosts. De standaardwaarde ishttps://login.microsoftonline.com". |
disable |
Hiermee wordt getToken gegenereerd als handmatige verificatie nodig is.
Ontwikkelaars moeten |
disable |
Het veld bepaalt of exemplaardetectie wordt uitgevoerd bij het verifiëren.
Als u dit instelt op |
http |
De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen. |
logging |
Hiermee kunnen gebruikers instellingen configureren voor opties voor logboekregistratiebeleid, accountgegevens voor logboekregistratie en persoonsgegevens toestaan voor klantondersteuning. |
proxy |
Opties voor het configureren van een proxy voor uitgaande aanvragen. |
redirect |
Opties voor de manier waarop omleidingsreacties worden verwerkt. |
retry |
Opties voor het opnieuw proberen van mislukte aanvragen. |
telemetry |
Opties voor het instellen van algemene telemetrie en traceringsgegevens voor uitgaande aanvragen. |
tls |
Opties voor het configureren van TLS-verificatie |
token |
Opties voor de persistentielaag (indien beschikbaar) bij het opslaan van referenties. U moet eerst een invoegtoepassing voor de persistentieprovider registreren. Zie het Voorbeeld:
|
user |
Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen. |
Eigenschapdetails
clientId
Client-id van de Microsoft Entra-toepassing waarmee gebruikers zich aanmelden. Het wordt aanbevolen dat ontwikkelaars hun toepassingen registreren en de juiste rollen toewijzen. Ga naar https://aka.ms/identity/AppRegistrationAndRoleAssignmentvoor meer informatie. Als dit niet is opgegeven, verifiëren gebruikers zich bij een Azure-ontwikkeltoepassing. Dit wordt niet aanbevolen voor productiescenario's.
clientId?: string
Waarde van eigenschap
string
tenantId
De id van de Microsoft Entra-tenant (directory).
tenantId?: string
Waarde van eigenschap
string
userPromptCallback
Een callback-functie die wordt aangeroepen om DeviceCodeInfo- aan de gebruiker weer te geven. Als de toewijzing niet is toegewezen, registreren we automatisch de apparaatcodegegevens en de verificatie-instructies in de console.
userPromptCallback?: DeviceCodePromptCallback
Waarde van eigenschap
Details van overgenomen eigenschap
additionallyAllowedTenants
Voor toepassingen met meerdere tenants geeft u extra tenants op waarvoor de referentie tokens kan verkrijgen. Voeg de jokertekenwaarde *toe om de referentie toe te staan tokens te verkrijgen voor elke tenant die de toepassing heeft geïnstalleerd.
additionallyAllowedTenants?: string[]
Waarde van eigenschap
string[]
overgenomen vanInteractiveCredentialOptions.additionallyAllowedTenants
additionalPolicies
Aanvullende beleidsregels die moeten worden opgenomen in de HTTP-pijplijn.
additionalPolicies?: AdditionalPolicyConfig[]
Waarde van eigenschap
overgenomen vanInteractiveCredentialOptions.additionalPolicies
allowInsecureConnection
Ingesteld op waar als de aanvraag via HTTP wordt verzonden in plaats van HTTPS
allowInsecureConnection?: boolean
Waarde van eigenschap
boolean
overgenomen vanInteractiveCredentialOptions.allowInsecureConnection
authenticationRecord
Resultaat van een eerdere verificatie die kan worden gebruikt om de referenties in de cache van elk afzonderlijk account op te halen. Dit is nodig om op te geven voor het geval de toepassing met meer dan één account per client-id en tenant-id-paar wil werken.
Deze record kan als volgt worden opgehaald door de authenticate()
methode van de referentie aan te roepen:
const authenticationRecord = await credential.authenticate();
authenticationRecord?: AuthenticationRecord
Waarde van eigenschap
overgenomen vanInteractiveCredentialOptions.authenticationRecord
authorityHost
De instantiehost die moet worden gebruikt voor verificatieaanvragen. Mogelijke waarden zijn beschikbaar via AzureAuthorityHosts. De standaardwaarde ishttps://login.microsoftonline.com".
authorityHost?: string
Waarde van eigenschap
string
overgenomen vanInteractiveCredentialOptions.authorityHost-
disableAutomaticAuthentication
Hiermee wordt getToken gegenereerd als handmatige verificatie nodig is.
Ontwikkelaars moeten authenticate()
aanroepen om te bepalen wanneer ze handmatig moeten worden geverifieerd.
disableAutomaticAuthentication?: boolean
Waarde van eigenschap
boolean
overgenomen vanInteractiveCredentialOptions.disableAutomaticAuthentication
disableInstanceDiscovery
Het veld bepaalt of exemplaardetectie wordt uitgevoerd bij het verifiëren.
Als u dit instelt op true
, worden zowel de detectie van exemplaren als de validatie van de instantie volledig uitgeschakeld.
Als gevolg hiervan is het van cruciaal belang om ervoor te zorgen dat de geconfigureerde instantiehost geldig en betrouwbaar is.
Deze functionaliteit is bedoeld voor gebruik in scenario's waarin het eindpunt voor metagegevens niet kan worden bereikt, zoals in privéclouds of Azure Stack.
Het proces van exemplaardetectie omvat het ophalen van instantiemetagegevens van https://login.microsoft.com/ om de instantie te valideren.
disableInstanceDiscovery?: boolean
Waarde van eigenschap
boolean
overgenomen vanInteractiveCredentialOptions.disableInstanceDiscovery-
httpClient
De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.
httpClient?: HttpClient
Waarde van eigenschap
overgenomen vanInteractiveCredentialOptions.httpClient-
loggingOptions
Hiermee kunnen gebruikers instellingen configureren voor opties voor logboekregistratiebeleid, accountgegevens voor logboekregistratie en persoonsgegevens toestaan voor klantondersteuning.
loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
Waarde van eigenschap
LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
overgenomen vanInteractiveCredentialOptions.loggingOptions
proxyOptions
Opties voor het configureren van een proxy voor uitgaande aanvragen.
proxyOptions?: ProxySettings
Waarde van eigenschap
overgenomen vanInteractiveCredentialOptions.proxyOptions
redirectOptions
Opties voor de manier waarop omleidingsreacties worden verwerkt.
redirectOptions?: RedirectPolicyOptions
Waarde van eigenschap
overgenomen vanInteractiveCredentialOptions.redirectOptions
retryOptions
Opties voor het opnieuw proberen van mislukte aanvragen.
retryOptions?: PipelineRetryOptions
Waarde van eigenschap
overgenomen vanInteractiveCredentialOptions.retryOptions
telemetryOptions
Opties voor het instellen van algemene telemetrie en traceringsgegevens voor uitgaande aanvragen.
telemetryOptions?: TelemetryOptions
Waarde van eigenschap
overgenomen vanInteractiveCredentialOptions.telemetryOptions
tlsOptions
Opties voor het configureren van TLS-verificatie
tlsOptions?: TlsSettings
Waarde van eigenschap
overgenomen vanInteractiveCredentialOptions.tlsOptions
tokenCachePersistenceOptions
Opties voor de persistentielaag (indien beschikbaar) bij het opslaan van referenties.
U moet eerst een invoegtoepassing voor de persistentieprovider registreren. Zie het @azure/identity-cache-persistence
-pakket op NPM.
Voorbeeld:
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
tokenCachePersistenceOptions: {
enabled: true,
},
});
tokenCachePersistenceOptions?: TokenCachePersistenceOptions
Waarde van eigenschap
overgenomen vanCredentialPersistenceOptions.tokenCachePersistenceOptions-
userAgentOptions
Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen.
userAgentOptions?: UserAgentPolicyOptions
Waarde van eigenschap
overgenomen vanInteractiveCredentialOptions.userAgentOptions-