Sdílet prostřednictvím

DeviceCodeCredentialOptions interface

  • Reference
Balíček:
@azure/identity

Definuje možnosti pro InteractiveBrowserCredential třídy pro Node.js.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Vlastnosti

clientId

ID klienta aplikace Microsoft Entra, ke které se budou uživatelé přihlašovat. Doporučuje se, aby vývojáři zaregistrovali své aplikace a přiřadili příslušné role. Další informace naleznete v https://aka.ms/identity/AppRegistrationAndRoleAssignment. Pokud není zadáno, uživatelé se budou ověřovat ve vývojové aplikaci Azure, která se nedoporučuje pro produkční scénáře.
tenantId

ID tenanta Microsoft Entra (adresáře).
userPromptCallback

Funkce zpětného volání, která se vyvolá k zobrazení DeviceCodeInfo uživateli. Pokud zůstane nepřiřazeno, automaticky zapíšeme informace o kódu zařízení a pokyny k ověření v konzole.

Zděděné vlastnosti

additionallyAllowedTenants

U aplikací s více tenanty určuje další tenanty, pro které mohou přihlašovací údaje získat tokeny. Přidejte hodnotu se zástupným znakem *, aby přihlašovací údaje mohly získat tokeny pro libovolného tenanta, na který je aplikace nainstalovaná.
additionalPolicies

Další zásady, které se mají zahrnout do kanálu HTTP.
allowInsecureConnection

Nastavte hodnotu true, pokud se požadavek odesílá přes protokol HTTP místo HTTPS.
authenticationRecord

Výsledek předchozího ověření, které lze použít k načtení přihlašovacích údajů uložených v mezipaměti jednotlivých účtů. To je nezbytné pro případ, že aplikace chce pracovat s více než jedním účtem na ID klienta a dvojici ID tenanta.

Tento záznam lze načíst voláním metody authenticate() přihlašovacích údajů následujícím způsobem:

const authenticationRecord = await credential.authenticate();
authorityHost

Hostitel autority, který se má použít pro žádosti o ověření. Možné hodnoty jsou k dispozici prostřednictvím AzureAuthorityHosts. Výchozí hodnota jehttps://login.microsoftonline.com".
disableAutomaticAuthentication

Vyvolá getToken, pokud je potřeba ruční ověřování. Vývojáři budou muset volat authenticate() k řízení, kdy se má provést ruční ověření.
disableInstanceDiscovery

Pole určuje, jestli se při pokusu o ověření provede zjišťování instancí. Nastavení na true úplně zakáže zjišťování instancí i ověření autority. V důsledku toho je důležité zajistit, aby nakonfigurovaný hostitel autority byl platný a důvěryhodný. Tato funkce je určená pro použití ve scénářích, kdy není možné dosáhnout koncového bodu metadat, například v privátních cloudech nebo ve službě Azure Stack. Proces zjišťování instancí zahrnuje načtení metadat autority z https://login.microsoft.com/ k ověření autority.
httpClient

HttpClient, který se použije k odesílání požadavků HTTP.
loggingOptions

Umožňuje uživatelům konfigurovat nastavení pro možnosti zásad protokolování, povolit protokolování informací o účtu a identifikovatelné osobní údaje pro zákaznickou podporu.
proxyOptions

Možnosti konfigurace proxy serveru pro odchozí požadavky
redirectOptions

Možnosti zpracování odpovědí na přesměrování
retryOptions

Možnosti, které řídí, jak opakovat neúspěšné požadavky.
telemetryOptions

Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky
tlsOptions

Možnosti konfigurace ověřování TLS
tokenCachePersistenceOptions

Možnosti poskytnutí vrstvy trvalosti (pokud je k dispozici) při ukládání přihlašovacích údajů

Nejprve musíte zaregistrovat modul plug-in poskytovatele trvalosti. Podívejte se na balíček @azure/identity-cache-persistence v NPM.

Příklad:

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});
userAgentOptions

Možnosti přidání podrobností o uživatelském agentu do odchozích požadavků

Podrobnosti vlastnosti

clientId

ID klienta aplikace Microsoft Entra, ke které se budou uživatelé přihlašovat. Doporučuje se, aby vývojáři zaregistrovali své aplikace a přiřadili příslušné role. Další informace naleznete v https://aka.ms/identity/AppRegistrationAndRoleAssignment. Pokud není zadáno, uživatelé se budou ověřovat ve vývojové aplikaci Azure, která se nedoporučuje pro produkční scénáře.

clientId?: string

Hodnota vlastnosti

string

tenantId

ID tenanta Microsoft Entra (adresáře).

tenantId?: string

Hodnota vlastnosti

string

userPromptCallback

Funkce zpětného volání, která se vyvolá k zobrazení DeviceCodeInfo uživateli. Pokud zůstane nepřiřazeno, automaticky zapíšeme informace o kódu zařízení a pokyny k ověření v konzole.

userPromptCallback?: DeviceCodePromptCallback

Hodnota vlastnosti

DeviceCodePromptCallback

Podrobnosti zděděných vlastností

additionallyAllowedTenants

U aplikací s více tenanty určuje další tenanty, pro které mohou přihlašovací údaje získat tokeny. Přidejte hodnotu se zástupným znakem *, aby přihlašovací údaje mohly získat tokeny pro libovolného tenanta, na který je aplikace nainstalovaná.

additionallyAllowedTenants?: string[]

Hodnota vlastnosti

string[]

zděděno zInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Další zásady, které se mají zahrnout do kanálu HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Hodnota vlastnosti

AdditionalPolicyConfig[]

zděděno zInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Nastavte hodnotu true, pokud se požadavek odesílá přes protokol HTTP místo HTTPS.

allowInsecureConnection?: boolean

Hodnota vlastnosti

boolean

zděděno zInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Výsledek předchozího ověření, které lze použít k načtení přihlašovacích údajů uložených v mezipaměti jednotlivých účtů. To je nezbytné pro případ, že aplikace chce pracovat s více než jedním účtem na ID klienta a dvojici ID tenanta.

Tento záznam lze načíst voláním metody authenticate() přihlašovacích údajů následujícím způsobem:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Hodnota vlastnosti

AuthenticationRecord

zděděno zInteractiveCredentialOptions.authenticationZáznam

authorityHost

Hostitel autority, který se má použít pro žádosti o ověření. Možné hodnoty jsou k dispozici prostřednictvím AzureAuthorityHosts. Výchozí hodnota jehttps://login.microsoftonline.com".

authorityHost?: string

Hodnota vlastnosti

string

zděděno zInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Vyvolá getToken, pokud je potřeba ruční ověřování. Vývojáři budou muset volat authenticate() k řízení, kdy se má provést ruční ověření.

disableAutomaticAuthentication?: boolean

Hodnota vlastnosti

boolean

zděděno zInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Pole určuje, jestli se při pokusu o ověření provede zjišťování instancí. Nastavení na true úplně zakáže zjišťování instancí i ověření autority. V důsledku toho je důležité zajistit, aby nakonfigurovaný hostitel autority byl platný a důvěryhodný. Tato funkce je určená pro použití ve scénářích, kdy není možné dosáhnout koncového bodu metadat, například v privátních cloudech nebo ve službě Azure Stack. Proces zjišťování instancí zahrnuje načtení metadat autority z https://login.microsoft.com/ k ověření autority.

disableInstanceDiscovery?: boolean

Hodnota vlastnosti

boolean

zděděné zInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient, který se použije k odesílání požadavků HTTP.

httpClient?: HttpClient

Hodnota vlastnosti

HttpClient

zděděné zInteractiveCredentialOptions.httpClient

loggingOptions

Umožňuje uživatelům konfigurovat nastavení pro možnosti zásad protokolování, povolit protokolování informací o účtu a identifikovatelné osobní údaje pro zákaznickou podporu.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Hodnota vlastnosti

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

zděděno zInteractiveCredentialOptions.loggingOptions

proxyOptions

Možnosti konfigurace proxy serveru pro odchozí požadavky

proxyOptions?: ProxySettings

Hodnota vlastnosti

ProxySettings

zděděno zInteractiveCredentialOptions.proxyOptions

redirectOptions

Možnosti zpracování odpovědí na přesměrování

redirectOptions?: RedirectPolicyOptions

Hodnota vlastnosti

RedirectPolicyOptions

zděděno zInteractiveCredentialOptions.redirectOptions

retryOptions

Možnosti, které řídí, jak opakovat neúspěšné požadavky.

retryOptions?: PipelineRetryOptions

Hodnota vlastnosti

PipelineRetryOptions

zděděné zInteractiveCredentialOptions.retryOptions

telemetryOptions

Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky

telemetryOptions?: TelemetryOptions

Hodnota vlastnosti

TelemetryOptions

zděděné zInteractiveCredentialOptions.telemetryOptions

tlsOptions

Možnosti konfigurace ověřování TLS

tlsOptions?: TlsSettings

Hodnota vlastnosti

TlsSettings

zděděno zInteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Možnosti poskytnutí vrstvy trvalosti (pokud je k dispozici) při ukládání přihlašovacích údajů

Nejprve musíte zaregistrovat modul plug-in poskytovatele trvalosti. Podívejte se na balíček @azure/identity-cache-persistence v NPM.

Příklad:

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Hodnota vlastnosti

TokenCachePersistenceOptions

zděděné zcredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Možnosti přidání podrobností o uživatelském agentu do odchozích požadavků

userAgentOptions?: UserAgentPolicyOptions

Hodnota vlastnosti

UserAgentPolicyOptions

zděděné zInteractiveCredentialOptions.userAgentOptions