ClientSecretCredentialOptions interface

الحزمة:

@azure/identity

معلمات اختيارية لفئة ClientSecretCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

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

additionallyAllowedTenants	بالنسبة للتطبيقات متعددة المستأجرين، يحدد المستأجرين الإضافيين الذين قد تحصل بيانات الاعتماد على رموز مميزة لها. أضف قيمة حرف البدل "*" للسماح لبيانات الاعتماد بالحصول على رموز مميزة لأي مستأجر تم تثبيت التطبيق عليه.
additionalPolicies	نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
allowInsecureConnection	تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS
authorityHost	مضيف المرجع المراد استخدامه لطلبات المصادقة. تتوفر القيم المحتملة من خلال AzureAuthorityHosts. الافتراضي هو "https://login.microsoftonline.com".
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 { 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	خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

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

additionallyAllowedTenants

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

additionallyAllowedTenants?: string[]

قيمة الخاصية

string[]

موروث منMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

قيمة الخاصية

AdditionalPolicyConfig[]

موروث منMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

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

allowInsecureConnection?: boolean

قيمة الخاصية

boolean

موروث منMultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

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

authorityHost?: string

قيمة الخاصية

string

موروث منMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

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

disableInstanceDiscovery?: boolean

قيمة الخاصية

boolean

موروث منAuthorityValidationOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

قيمة الخاصية

HttpClient

موروث منMultiTenantTokenCredentialOptions.httpClient

loggingOptions

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

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

قيمة الخاصية

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

موروث منMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

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

proxyOptions?: ProxySettings

قيمة الخاصية

ProxySettings

موروث منMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

قيمة الخاصية

RedirectPolicyOptions

موروث منMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

قيمة الخاصية

PipelineRetryOptions

موروث منMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

قيمة الخاصية

TelemetryOptions

موروث منMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

قيمة الخاصية

TlsSettings

موروث منMultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

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

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

مثال:

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

قيمة الخاصية

TokenCachePersistenceOptions

موروث منCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

قيمة الخاصية

UserAgentPolicyOptions

موروث منMultiTenantTokenCredentialOptions.userAgentOptions