EnvironmentCredential class
클라이언트 암호 또는 인증서를 사용하거나 사용자 이름과 암호를 가진 사용자로 Microsoft Entra ID에 대한 인증을 사용하도록 설정합니다.
생성자
Environment |
EnvironmentCredential 클래스의 인스턴스를 만들고 사용 가능한 환경 변수에 따라 사용할 자격 증명을 결정합니다. 필수 환경 변수:
AZURE_TENANT_ID 설정하는 경우 추가로 허용된 테넌트도 설정할 수 있습니다.
클라이언트 자격 증명 인증에 사용되는 환경 변수:
또는 사용자가 사용자 이름 및 암호 인증을 위한 환경 변수를 제공할 수 있습니다.
인증을 수행하는 데 필요한 환경 변수가 누락된 경우 CredentialUnavailableError throw됩니다. 인증에 실패하거나 알 수 없는 오류가 발생하면 AuthenticationError throw됩니다. |
메서드
get |
Microsoft Entra ID를 사용하여 인증하고 성공하면 액세스 토큰을 반환합니다. |
생성자 세부 정보
EnvironmentCredential(EnvironmentCredentialOptions)
EnvironmentCredential 클래스의 인스턴스를 만들고 사용 가능한 환경 변수에 따라 사용할 자격 증명을 결정합니다.
필수 환경 변수:
-
AZURE_TENANT_ID
: Microsoft Entra 테넌트(디렉터리) ID입니다. -
AZURE_CLIENT_ID
: 테넌트에서 앱 등록의 클라이언트(애플리케이션) ID입니다.
AZURE_TENANT_ID 설정하는 경우 추가로 허용된 테넌트도 설정할 수 있습니다.
-
AZURE_ADDITIONALLY_ALLOWED_TENANTS
: 다중 테넌트 애플리케이션의 경우 자격 증명이 단일 세미콜론으로 구분된 문자열로 토큰을 획득할 수 있는 추가 테넌트를 지정합니다. *를 사용하여 모든 테넌트 허용
클라이언트 자격 증명 인증에 사용되는 환경 변수:
-
AZURE_CLIENT_SECRET
: 앱 등록에 대해 생성된 클라이언트 암호입니다. -
AZURE_CLIENT_CERTIFICATE_PATH
: 클라이언트 암호 대신 인증 중에 사용할 PEM 인증서의 경로입니다. -
AZURE_CLIENT_CERTIFICATE_PASSWORD
: (선택 사항) 인증서 파일의 암호입니다. -
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN
: (선택 사항) 주체 이름/발급자 기반 인증을 지원하도록 인증서 체인을 x5c 헤더로 설정해야 임을 나타냅니다.
또는 사용자가 사용자 이름 및 암호 인증을 위한 환경 변수를 제공할 수 있습니다.
-
AZURE_USERNAME
: 인증할 사용자 이름입니다. -
AZURE_PASSWORD
: 인증할 암호입니다.
인증을 수행하는 데 필요한 환경 변수가 누락된 경우 CredentialUnavailableError throw됩니다. 인증에 실패하거나 알 수 없는 오류가 발생하면 AuthenticationError throw됩니다.
new EnvironmentCredential(options?: EnvironmentCredentialOptions)
매개 변수
- options
- EnvironmentCredentialOptions
인증 요청을 만드는 클라이언트를 구성하는 옵션입니다.
메서드 세부 정보
getToken(string | string[], GetTokenOptions)
Microsoft Entra ID를 사용하여 인증하고 성공하면 액세스 토큰을 반환합니다.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
매개 변수
- scopes
-
string | string[]
토큰에 액세스할 수 있는 범위 목록입니다.
- options
- GetTokenOptions
선택적 매개 변수입니다. GetTokenOptions
반환
Promise<AccessToken>