Aracılığıyla paylaş

DeviceCodeCredentialOptions interface

  • Başvuru
Paket:
@azure/identity

Node.js için InteractiveBrowserCredential sınıfının seçeneklerini tanımlar.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Özellikler

clientId

Kiracıdaki bir Uygulama Kaydının istemci (uygulama) kimliği.
tenantId

Microsoft Entra kiracı (dizin) kimliği.
userPromptCallback

DeviceCodeInfo'nun kullanıcıya gösterilmesi için çağrılacak bir geri çağırma işlevi. Atanmamış olarak bırakılırsa, cihaz kodu bilgilerini ve kimlik doğrulama yönergelerini konsolda otomatik olarak günlüğe kaydederiz.

Devralınan Özellikler

additionallyAllowedTenants

Çok kiracılı uygulamalar için, kimlik bilgilerinin belirteçleri edinebileceği ek kiracıları belirtir. Kimlik bilgilerinin uygulamanın yüklü olduğu herhangi bir kiracı için belirteç almasına izin vermek için "*" joker karakter değerini ekleyin.
additionalPolicies

HTTP işlem hattına eklenecek ek ilkeler.
allowInsecureConnection

İstek HTTPS yerine HTTP üzerinden gönderilirse true olarak ayarlayın
authenticationRecord

Her bir hesabın önbelleğe alınmış kimlik bilgilerini almak için kullanılabilecek önceki kimlik doğrulamasının sonucu. Bu, uygulamanın İstemci Kimliği ve Kiracı Kimliği çifti başına birden fazla hesapla çalışmak istemesi durumunda sağlamak için gereklidir.

Bu kayıt, kimlik bilgilerinin authenticate() yöntemine aşağıdaki gibi çağrılarak alınabilir:

const authenticationRecord = await credential.authenticate();
authorityHost

Kimlik doğrulama istekleri için kullanılacak yetkili ana bilgisayar. Olası değerler AzureAuthorityHosts aracılığıyla kullanılabilir. Varsayılan değer "https://login.microsoftonline.com".
disableAutomaticAuthentication

El ile kimlik doğrulaması gerekiyorsa getToken oluşturma işlemi yapar. Geliştiricilerin el ile kimlik doğrulamasının ne zaman olacağını denetlemek için çağrısında authenticate() olması gerekir.
disableInstanceDiscovery

alanı, kimlik doğrulaması denenirken örnek bulma işleminin gerçekleştirilip gerçekleştirilmeyeceğini belirler. Bunu olarak true ayarlamak hem örnek bulma hem de yetkili doğrulamayı tamamen devre dışı bırakır. Sonuç olarak, yapılandırılan yetkili konağın geçerli ve güvenilir olduğundan emin olmak çok önemlidir. Bu işlevsellik, meta veri uç noktasına erişilemeyen özel bulutlar veya Azure Stack gibi senaryolarda kullanılmak üzere tasarlanmıştır. Örnek bulma işlemi, yetkiliyi doğrulamak için yetkili meta verilerinin 'den https://login.microsoft.com/ alınmasını gerektirir.
httpClient

HTTP istekleri göndermek için kullanılacak HttpClient.
loggingOptions

Kullanıcıların ilke seçeneklerini günlüğe kaydetme ayarlarını yapılandırmasına, günlük hesabı bilgilerine ve müşteri desteği için kişisel bilgilere izin vermesine olanak tanır.
proxyOptions

Giden istekler için ara sunucu yapılandırma seçenekleri.
redirectOptions

Yeniden yönlendirme yanıtlarının nasıl işlendiğini gösteren seçenekler.
retryOptions

Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.
telemetryOptions

Genel telemetriyi ayarlama ve bilgileri giden isteklere izleme seçenekleri.
tlsOptions

TLS kimlik doğrulamasını yapılandırma seçenekleri
tokenCachePersistenceOptions

Kimlik bilgilerini depolarken kalıcılık katmanına (varsa) sağlama seçenekleri.

Önce bir kalıcılık sağlayıcısı eklentisi kaydetmeniz gerekir. NPM'de @azure/identity-cache-persistence pakete bakın.

Örnek:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});
userAgentOptions

Giden isteklere kullanıcı aracısı ayrıntılarını ekleme seçenekleri.

Özellik Ayrıntıları

clientId

Kiracıdaki bir Uygulama Kaydının istemci (uygulama) kimliği.

clientId?: string

Özellik Değeri

string

tenantId

Microsoft Entra kiracı (dizin) kimliği.

tenantId?: string

Özellik Değeri

string

userPromptCallback

DeviceCodeInfo'nun kullanıcıya gösterilmesi için çağrılacak bir geri çağırma işlevi. Atanmamış olarak bırakılırsa, cihaz kodu bilgilerini ve kimlik doğrulama yönergelerini konsolda otomatik olarak günlüğe kaydederiz.

userPromptCallback?: DeviceCodePromptCallback

Özellik Değeri

DeviceCodePromptCallback

Devralınan Özellik Detayları

additionallyAllowedTenants

Çok kiracılı uygulamalar için, kimlik bilgilerinin belirteçleri edinebileceği ek kiracıları belirtir. Kimlik bilgilerinin uygulamanın yüklü olduğu herhangi bir kiracı için belirteç almasına izin vermek için "*" joker karakter değerini ekleyin.

additionallyAllowedTenants?: string[]

Özellik Değeri

string[]

InteractiveCredentialOptions.additionallyAllowedTenants'danDevralındı

additionalPolicies

HTTP işlem hattına eklenecek ek ilkeler.

additionalPolicies?: AdditionalPolicyConfig[]

Özellik Değeri

AdditionalPolicyConfig[]

InteractiveCredentialOptions.additionalPolicies'tenDevralındı

allowInsecureConnection

İstek HTTPS yerine HTTP üzerinden gönderilirse true olarak ayarlayın

allowInsecureConnection?: boolean

Özellik Değeri

boolean

InteractiveCredentialOptions.allowInsecureConnection'danDevralındı

authenticationRecord

Her bir hesabın önbelleğe alınmış kimlik bilgilerini almak için kullanılabilecek önceki kimlik doğrulamasının sonucu. Bu, uygulamanın İstemci Kimliği ve Kiracı Kimliği çifti başına birden fazla hesapla çalışmak istemesi durumunda sağlamak için gereklidir.

Bu kayıt, kimlik bilgilerinin authenticate() yöntemine aşağıdaki gibi çağrılarak alınabilir:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Özellik Değeri

AuthenticationRecord

InteractiveCredentialOptions.authenticationRecord'danDevralındı

authorityHost

Kimlik doğrulama istekleri için kullanılacak yetkili ana bilgisayar. Olası değerler AzureAuthorityHosts aracılığıyla kullanılabilir. Varsayılan değer "https://login.microsoftonline.com".

authorityHost?: string

Özellik Değeri

string

InteractiveCredentialOptions.authorityHost'tanDevralındı

disableAutomaticAuthentication

El ile kimlik doğrulaması gerekiyorsa getToken oluşturma işlemi yapar. Geliştiricilerin el ile kimlik doğrulamasının ne zaman olacağını denetlemek için çağrısında authenticate() olması gerekir.

disableAutomaticAuthentication?: boolean

Özellik Değeri

boolean

InteractiveCredentialOptions.disableAutomaticAuthentication'danDevralındı

disableInstanceDiscovery

alanı, kimlik doğrulaması denenirken örnek bulma işleminin gerçekleştirilip gerçekleştirilmeyeceğini belirler. Bunu olarak true ayarlamak hem örnek bulma hem de yetkili doğrulamayı tamamen devre dışı bırakır. Sonuç olarak, yapılandırılan yetkili konağın geçerli ve güvenilir olduğundan emin olmak çok önemlidir. Bu işlevsellik, meta veri uç noktasına erişilemeyen özel bulutlar veya Azure Stack gibi senaryolarda kullanılmak üzere tasarlanmıştır. Örnek bulma işlemi, yetkiliyi doğrulamak için yetkili meta verilerinin 'den https://login.microsoft.com/ alınmasını gerektirir.

disableInstanceDiscovery?: boolean

Özellik Değeri

boolean

InteractiveCredentialOptions.disableInstanceDiscovery'denDevralındı

httpClient

HTTP istekleri göndermek için kullanılacak HttpClient.

httpClient?: HttpClient

Özellik Değeri

HttpClient

InteractiveCredentialOptions.httpClient'danDevralındı

loggingOptions

Kullanıcıların ilke seçeneklerini günlüğe kaydetme ayarlarını yapılandırmasına, günlük hesabı bilgilerine ve müşteri desteği için kişisel bilgilere izin vermesine olanak tanır.

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

Özellik Değeri

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

InteractiveCredentialOptions.loggingOptions'danDevralındı

proxyOptions

Giden istekler için ara sunucu yapılandırma seçenekleri.

proxyOptions?: ProxySettings

Özellik Değeri

ProxySettings

InteractiveCredentialOptions.proxyOptions'danDevralındı

redirectOptions

Yeniden yönlendirme yanıtlarının nasıl işlendiğini gösteren seçenekler.

redirectOptions?: RedirectPolicyOptions

Özellik Değeri

RedirectPolicyOptions

InteractiveCredentialOptions.redirectOptions'danDevralındı

retryOptions

Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.

retryOptions?: PipelineRetryOptions

Özellik Değeri

PipelineRetryOptions

InteractiveCredentialOptions.retryOptions'danDevralındı

telemetryOptions

Genel telemetriyi ayarlama ve bilgileri giden isteklere izleme seçenekleri.

telemetryOptions?: TelemetryOptions

Özellik Değeri

TelemetryOptions

InteractiveCredentialOptions.telemetryOptions'danDevralındı

tlsOptions

TLS kimlik doğrulamasını yapılandırma seçenekleri

tlsOptions?: TlsSettings

Özellik Değeri

TlsSettings

InteractiveCredentialOptions.tlsOptions'danDevralındı

tokenCachePersistenceOptions

Kimlik bilgilerini depolarken kalıcılık katmanına (varsa) sağlama seçenekleri.

Önce bir kalıcılık sağlayıcısı eklentisi kaydetmeniz gerekir. NPM'de @azure/identity-cache-persistence pakete bakın.

Örnek:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Özellik Değeri

TokenCachePersistenceOptions

CredentialPersistenceOptions.tokenCachePersistenceOptions'danDevralındı

userAgentOptions

Giden isteklere kullanıcı aracısı ayrıntılarını ekleme seçenekleri.

userAgentOptions?: UserAgentPolicyOptions

Özellik Değeri

UserAgentPolicyOptions

InteractiveCredentialOptions.userAgentOptions'danDevralındı