مشاركة عبر

DeviceCodeCredentialOptions interface

الحزمة:
@azure/identity

يحدد خيارات فئة InteractiveBrowserCredential Node.js.

يمتد

InteractiveCredentialOptions,CredentialPersistenceOptions

الخصائص

clientId

معرف العميل لتطبيق Microsoft Entra الذي سيقوم المستخدمون بتسجيل الدخول إليه. من المستحسن أن يقوم المطورون بتسجيل تطبيقاتهم وتعيين الأدوار المناسبة. لمزيد من المعلومات، تفضل بزيارة https://aka.ms/identity/AppRegistrationAndRoleAssignment. إذا لم يتم تحديده، فسيصادق المستخدمون على تطبيق تطوير Azure، وهو أمر غير مستحسن لسيناريوهات الإنتاج.
tenantId

معرف مستأجر Microsoft Entra (الدليل).
userPromptCallback

دالة رد الاتصال التي سيتم استدعاؤها لإظهار DeviceCodeInfo للمستخدم. إذا ترك دون تعيين، فسنسجل تلقائيا معلومات التعليمات البرمجية للجهاز وإرشادات المصادقة في وحدة التحكم.

الخصائص الموروثة

additionallyAllowedTenants

بالنسبة للتطبيقات متعددة المستأجرين، يحدد المستأجرين الإضافيين الذين قد تحصل بيانات الاعتماد الخاصة بهم على رموز مميزة. أضف قيمة حرف البدل "*" للسماح لبيانات الاعتماد بالحصول على رموز مميزة لأي مستأجر تم تثبيت التطبيق عليه.
additionalPolicies

نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
agent

خيارات لتكوين مثيل العامل للطلبات الصادرة
allowInsecureConnection

تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS
authenticationRecord

نتيجة مصادقة سابقة يمكن استخدامها لاسترداد بيانات الاعتماد المخزنة مؤقتا لكل حساب فردي. هذا ضروري لتوفير في حالة رغبة التطبيق في العمل مع أكثر من حساب واحد لكل زوج معرف العميل ومعرف المستأجر.

يمكن استرداد هذا السجل عن طريق استدعاء أسلوب authenticate() لبيانات الاعتماد، كما يلي:

const authenticationRecord = await credential.authenticate();
authorityHost

مضيف المرجع لاستخدامه لطلبات المصادقة. تتوفر القيم المحتملة من خلال AzureAuthorityHosts. الافتراضي هو "https://login.microsoftonline.com".
disableAutomaticAuthentication

يجعل getToken يلقي إذا كانت المصادقة اليدوية ضرورية. سيحتاج المطورون إلى الاتصال authenticate() للتحكم في وقت المصادقة يدويا.
disableInstanceDiscovery

يحدد الحقل ما إذا كان يتم تنفيذ اكتشاف المثيل عند محاولة المصادقة. سيؤدي تعيين هذا إلى true إلى تعطيل كل من اكتشاف المثيل والتحقق من صحة المرجع تماما. ونتيجة لذلك، من الضروري التأكد من أن مضيف المرجع المكون صالح وجدير بالثقة. هذه الوظيفة مخصصة للاستخدام في السيناريوهات التي لا يمكن فيها الوصول إلى نقطة نهاية بيانات التعريف، كما هو الحال في السحب الخاصة أو Azure Stack. تتطلب عملية اكتشاف المثيل استرداد بيانات تعريف المرجع من https://login.microsoft.com/ للتحقق من صحة السلطة.
httpClient

HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.
loggingOptions

يسمح للمستخدمين بتكوين إعدادات خيارات نهج التسجيل، والسماح بمعلومات حساب التسجيل ومعلومات التعريف الشخصية لدعم العملاء.
proxyOptions

خيارات لتكوين وكيل للطلبات الصادرة.
redirectOptions

خيارات لكيفية معالجة استجابات إعادة التوجيه.
retryOptions

الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
telemetryOptions

خيارات لإعداد معلومات تتبع الاستخدام والتتبع الشائعة للطلبات الصادرة.
tlsOptions

خيارات لتكوين مصادقة TLS
tokenCachePersistenceOptions

خيارات لتوفيرها لطبقة الثبات (إذا كانت متوفرة) عند تخزين بيانات الاعتماد.

يجب عليك أولا تسجيل مكون إضافي لموفر الاستمرار. راجع حزمة @azure/identity-cache-persistence على NPM.

مثل:

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

useIdentityPlugin(cachePersistencePlugin);

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

خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

تفاصيل الخاصية

clientId

معرف العميل لتطبيق Microsoft Entra الذي سيقوم المستخدمون بتسجيل الدخول إليه. من المستحسن أن يقوم المطورون بتسجيل تطبيقاتهم وتعيين الأدوار المناسبة. لمزيد من المعلومات، تفضل بزيارة https://aka.ms/identity/AppRegistrationAndRoleAssignment. إذا لم يتم تحديده، فسيصادق المستخدمون على تطبيق تطوير Azure، وهو أمر غير مستحسن لسيناريوهات الإنتاج.

clientId?: string

قيمة الخاصية

string

tenantId

معرف مستأجر Microsoft Entra (الدليل).

tenantId?: string

قيمة الخاصية

string

userPromptCallback

دالة رد الاتصال التي سيتم استدعاؤها لإظهار DeviceCodeInfo للمستخدم. إذا ترك دون تعيين، فسنسجل تلقائيا معلومات التعليمات البرمجية للجهاز وإرشادات المصادقة في وحدة التحكم.

userPromptCallback?: DeviceCodePromptCallback

قيمة الخاصية

DeviceCodePromptCallback

تفاصيل الخاصية الموروثة

additionallyAllowedTenants

بالنسبة للتطبيقات متعددة المستأجرين، يحدد المستأجرين الإضافيين الذين قد تحصل بيانات الاعتماد الخاصة بهم على رموز مميزة. أضف قيمة حرف البدل "*" للسماح لبيانات الاعتماد بالحصول على رموز مميزة لأي مستأجر تم تثبيت التطبيق عليه.

additionallyAllowedTenants?: string[]

قيمة الخاصية

string[]

موروث منInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

قيمة الخاصية

AdditionalPolicyConfig[]

موروثة منInteractiveCredentialOptions.additionalPolicies

agent

خيارات لتكوين مثيل العامل للطلبات الصادرة

agent?: Agent

قيمة الخاصية

Agent

موروث منInteractiveCredentialOptions.agent

allowInsecureConnection

تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS

allowInsecureConnection?: boolean

قيمة الخاصية

boolean

موروث منInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

نتيجة مصادقة سابقة يمكن استخدامها لاسترداد بيانات الاعتماد المخزنة مؤقتا لكل حساب فردي. هذا ضروري لتوفير في حالة رغبة التطبيق في العمل مع أكثر من حساب واحد لكل زوج معرف العميل ومعرف المستأجر.

يمكن استرداد هذا السجل عن طريق استدعاء أسلوب authenticate() لبيانات الاعتماد، كما يلي:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

قيمة الخاصية

AuthenticationRecord

موروث منInteractiveCredentialOptions.authenticationRecord

authorityHost

مضيف المرجع لاستخدامه لطلبات المصادقة. تتوفر القيم المحتملة من خلال AzureAuthorityHosts. الافتراضي هو "https://login.microsoftonline.com".

authorityHost?: string

قيمة الخاصية

string

موروث منInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

يجعل getToken يلقي إذا كانت المصادقة اليدوية ضرورية. سيحتاج المطورون إلى الاتصال authenticate() للتحكم في وقت المصادقة يدويا.

disableAutomaticAuthentication?: boolean

قيمة الخاصية

boolean

موروث منInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

يحدد الحقل ما إذا كان يتم تنفيذ اكتشاف المثيل عند محاولة المصادقة. سيؤدي تعيين هذا إلى true إلى تعطيل كل من اكتشاف المثيل والتحقق من صحة المرجع تماما. ونتيجة لذلك، من الضروري التأكد من أن مضيف المرجع المكون صالح وجدير بالثقة. هذه الوظيفة مخصصة للاستخدام في السيناريوهات التي لا يمكن فيها الوصول إلى نقطة نهاية بيانات التعريف، كما هو الحال في السحب الخاصة أو Azure Stack. تتطلب عملية اكتشاف المثيل استرداد بيانات تعريف المرجع من https://login.microsoft.com/ للتحقق من صحة السلطة.

disableInstanceDiscovery?: boolean

قيمة الخاصية

boolean

موروث منInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.

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

خيارات لتوفيرها لطبقة الثبات (إذا كانت متوفرة) عند تخزين بيانات الاعتماد.

يجب عليك أولا تسجيل مكون إضافي لموفر الاستمرار. راجع حزمة @azure/identity-cache-persistence على NPM.

مثل:

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