다음을 통해 공유

DeviceCodeCredentialOptions interface

  • 참조
패키지:
@azure/identity

Node.jsInteractiveBrowserCredential 클래스에 대한 옵션을 정의합니다.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

속성

clientId

사용자가 로그인할 Microsoft Entra 애플리케이션의 클라이언트 ID입니다. 개발자는 애플리케이션을 등록하고 적절한 역할을 할당하는 것이 좋습니다. 자세한 내용은 https://aka.ms/identity/AppRegistrationAndRoleAssignment방문하세요. 지정하지 않으면 사용자는 프로덕션 시나리오에 권장되지 않는 Azure 개발 애플리케이션에 인증합니다.
tenantId

Microsoft Entra 테넌트(디렉터리) ID입니다.
userPromptCallback

DeviceCodeInfo 사용자에게 표시하기 위해 호출되는 콜백 함수입니다. 할당되지 않은 상태로 두면 콘솔에서 디바이스 코드 정보 및 인증 지침이 자동으로 기록됩니다.

상속된 속성

additionallyAllowedTenants

다중 테넌트 애플리케이션의 경우 자격 증명이 토큰을 획득할 수 있는 추가 테넌트입니다. 자격 증명이 애플리케이션이 설치된 테넌트에 대한 토큰을 획득할 수 있도록 와일드카드 값 "*"을 추가합니다.
additionalPolicies

HTTP 파이프라인에 포함할 추가 정책입니다.
allowInsecureConnection

요청이 HTTPS 대신 HTTP를 통해 전송되는 경우 true로 설정
authenticationRecord

각 개별 계정의 캐시된 자격 증명을 검색하는 데 사용할 수 있는 이전 인증의 결과입니다. 이는 애플리케이션이 클라이언트 ID 및 테넌트 ID 쌍당 둘 이상의 계정으로 작업하려는 경우에 제공해야 합니다.

다음과 같이 자격 증명의 authenticate() 메서드를 호출하여 이 레코드를 검색할 수 있습니다.

const authenticationRecord = await credential.authenticate();
authorityHost

인증 요청에 사용할 기관 호스트입니다. 가능한 값은 AzureAuthorityHosts통해 사용할 수 있습니다. 기본값은 "https://login.microsoftonline.com"입니다.
disableAutomaticAuthentication

수동 인증이 필요한 경우 getToken을 throw합니다. 개발자는 authenticate() 호출하여 수동으로 인증해야 하는 시기를 제어해야 합니다.
disableInstanceDiscovery

필드는 인증을 시도할 때 인스턴스 검색이 수행되는지 여부를 결정합니다. 이를 true 설정하면 인스턴스 검색 및 기관 유효성 검사가 완전히 비활성화됩니다. 따라서 구성된 기관 호스트가 유효하고 신뢰할 수 있는지 확인하는 것이 중요합니다. 이 기능은 프라이빗 클라우드 또는 Azure Stack과 같이 메타데이터 엔드포인트에 연결할 수 없는 시나리오에서 사용하기 위한 것입니다. 인스턴스 검색 프로세스에는 https://login.microsoft.com/ 기관 메타데이터를 검색하여 권한의 유효성을 검사해야 합니다.
httpClient

HTTP 요청을 보내는 데 사용할 HttpClient입니다.
loggingOptions

사용자가 로깅 정책 옵션에 대한 설정을 구성하고, 고객 지원을 위해 계정 정보 로깅 및 개인 식별 정보를 허용할 수 있습니다.
proxyOptions

나가는 요청에 대한 프록시를 구성하는 옵션입니다.
redirectOptions

리디렉션 응답을 처리하는 방법에 대한 옵션입니다.
retryOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.
telemetryOptions

일반적인 원격 분석 및 추적 정보를 나가는 요청으로 설정하는 옵션입니다.
tlsOptions

TLS 인증을 구성하는 옵션
tokenCachePersistenceOptions

자격 증명을 저장할 때 지속성 계층(사용 가능한 경우)에 제공하는 옵션입니다.

먼저 지속성 공급자 플러그 인을 등록해야 합니다. NPM에서 @azure/identity-cache-persistence 패키지를 참조하세요.

본보기:

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

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

나가는 요청에 사용자 에이전트 세부 정보를 추가하는 옵션입니다.

속성 세부 정보

clientId

사용자가 로그인할 Microsoft Entra 애플리케이션의 클라이언트 ID입니다. 개발자는 애플리케이션을 등록하고 적절한 역할을 할당하는 것이 좋습니다. 자세한 내용은 https://aka.ms/identity/AppRegistrationAndRoleAssignment방문하세요. 지정하지 않으면 사용자는 프로덕션 시나리오에 권장되지 않는 Azure 개발 애플리케이션에 인증합니다.

clientId?: string

속성 값

string

tenantId

Microsoft Entra 테넌트(디렉터리) ID입니다.

tenantId?: string

속성 값

string

userPromptCallback

DeviceCodeInfo 사용자에게 표시하기 위해 호출되는 콜백 함수입니다. 할당되지 않은 상태로 두면 콘솔에서 디바이스 코드 정보 및 인증 지침이 자동으로 기록됩니다.

userPromptCallback?: DeviceCodePromptCallback

속성 값

DeviceCodePromptCallback

상속된 속성 세부 정보

additionallyAllowedTenants

다중 테넌트 애플리케이션의 경우 자격 증명이 토큰을 획득할 수 있는 추가 테넌트입니다. 자격 증명이 애플리케이션이 설치된 테넌트에 대한 토큰을 획득할 수 있도록 와일드카드 값 "*"을 추가합니다.

additionallyAllowedTenants?: string[]

속성 값

string[]

InteractiveCredentialOptions.additionallyAllowedTenants 상속된

additionalPolicies

HTTP 파이프라인에 포함할 추가 정책입니다.

additionalPolicies?: AdditionalPolicyConfig[]

속성 값

AdditionalPolicyConfig[]

InteractiveCredentialOptions.additionalPolicies 상속된

allowInsecureConnection

요청이 HTTPS 대신 HTTP를 통해 전송되는 경우 true로 설정

allowInsecureConnection?: boolean

속성 값

boolean

InteractiveCredentialOptions.allowInsecureConnection 상속된

authenticationRecord

각 개별 계정의 캐시된 자격 증명을 검색하는 데 사용할 수 있는 이전 인증의 결과입니다. 이는 애플리케이션이 클라이언트 ID 및 테넌트 ID 쌍당 둘 이상의 계정으로 작업하려는 경우에 제공해야 합니다.

다음과 같이 자격 증명의 authenticate() 메서드를 호출하여 이 레코드를 검색할 수 있습니다.

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

속성 값

AuthenticationRecord

InteractiveCredentialOptions.authenticationRecord 상속된

authorityHost

인증 요청에 사용할 기관 호스트입니다. 가능한 값은 AzureAuthorityHosts통해 사용할 수 있습니다. 기본값은 "https://login.microsoftonline.com"입니다.

authorityHost?: string

속성 값

string

InteractiveCredentialOptions.authorityHost 상속된

disableAutomaticAuthentication

수동 인증이 필요한 경우 getToken을 throw합니다. 개발자는 authenticate() 호출하여 수동으로 인증해야 하는 시기를 제어해야 합니다.

disableAutomaticAuthentication?: boolean

속성 값

boolean

InteractiveCredentialOptions.disableAutomaticAuthentication 상속된

disableInstanceDiscovery

필드는 인증을 시도할 때 인스턴스 검색이 수행되는지 여부를 결정합니다. 이를 true 설정하면 인스턴스 검색 및 기관 유효성 검사가 완전히 비활성화됩니다. 따라서 구성된 기관 호스트가 유효하고 신뢰할 수 있는지 확인하는 것이 중요합니다. 이 기능은 프라이빗 클라우드 또는 Azure Stack과 같이 메타데이터 엔드포인트에 연결할 수 없는 시나리오에서 사용하기 위한 것입니다. 인스턴스 검색 프로세스에는 https://login.microsoft.com/ 기관 메타데이터를 검색하여 권한의 유효성을 검사해야 합니다.

disableInstanceDiscovery?: boolean

속성 값

boolean

InteractiveCredentialOptions.disableInstanceDiscovery 상속된

httpClient

HTTP 요청을 보내는 데 사용할 HttpClient입니다.

httpClient?: HttpClient

속성 값

HttpClient

InteractiveCredentialOptions.httpClient 상속된

loggingOptions

사용자가 로깅 정책 옵션에 대한 설정을 구성하고, 고객 지원을 위해 계정 정보 로깅 및 개인 식별 정보를 허용할 수 있습니다.

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

속성 값

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

InteractiveCredentialOptions.loggingOptions 상속된

proxyOptions

나가는 요청에 대한 프록시를 구성하는 옵션입니다.

proxyOptions?: ProxySettings

속성 값

ProxySettings

InteractiveCredentialOptions.proxyOptions 상속됨

redirectOptions

리디렉션 응답을 처리하는 방법에 대한 옵션입니다.

redirectOptions?: RedirectPolicyOptions

속성 값

RedirectPolicyOptions

InteractiveCredentialOptions.redirectOptions 상속된

retryOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.

retryOptions?: PipelineRetryOptions

속성 값

PipelineRetryOptions

InteractiveCredentialOptions.retryOptions 상속된

telemetryOptions

일반적인 원격 분석 및 추적 정보를 나가는 요청으로 설정하는 옵션입니다.

telemetryOptions?: TelemetryOptions

속성 값

TelemetryOptions

InteractiveCredentialOptions.telemetryOptions 상속된

tlsOptions

TLS 인증을 구성하는 옵션

tlsOptions?: TlsSettings

속성 값

TlsSettings

InteractiveCredentialOptions.tlsOptions 상속됨

tokenCachePersistenceOptions

자격 증명을 저장할 때 지속성 계층(사용 가능한 경우)에 제공하는 옵션입니다.

먼저 지속성 공급자 플러그 인을 등록해야 합니다. NPM에서 @azure/identity-cache-persistence 패키지를 참조하세요.

본보기:

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

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

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

속성 값

TokenCachePersistenceOptions

CredentialPersistenceOptions.tokenCachePersistenceOptions 상속된

userAgentOptions

나가는 요청에 사용자 에이전트 세부 정보를 추가하는 옵션입니다.

userAgentOptions?: UserAgentPolicyOptions

속성 값

UserAgentPolicyOptions

InteractiveCredentialOptions.userAgentOptions 상속된