DefaultAzureCredentialClientIdOptions interface

الحزمة:

@azure/identity

يوفر خيارات لتكوين فئة الافتراضية AzureCredential. يدعم هذا التباين managedIdentityClientId وليس managedIdentityResourceId، حيث يتم دعم واحد فقط من كليهما.

يمتد

DefaultAzureCredentialOptions

الخصائص

managedIdentityClientId	قم بتمرير معرف عميل معين من قبل المستخدم اختياريا لاستخدامه بواسطة ManagedIdentityCredential. يمكن أيضا تمرير معرف العميل هذا إلى ManagedIdentityCredential من خلال متغير البيئة: AZURE_CLIENT_ID.
workloadIdentityClientId	قم بتمرير معرف عميل معين من قبل المستخدم اختياريا لاستخدامه بواسطة workloadIdentityCredential. يمكن أيضا تمرير معرف العميل هذا إلى workloadIdentityCredential من خلال متغير البيئة: AZURE_CLIENT_ID.

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

additionallyAllowedTenants	بالنسبة للتطبيقات متعددة المستأجرين، يحدد المستأجرين الإضافيين الذين قد تحصل بيانات الاعتماد الخاصة بهم على رموز مميزة. أضف قيمة حرف البدل "*" للسماح لبيانات الاعتماد بالحصول على رموز مميزة لأي مستأجر تم تثبيت التطبيق عليه.
additionalPolicies	نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
agent	خيارات لتكوين مثيل العامل للطلبات الصادرة
allowInsecureConnection	تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS
authorityHost	مضيف المرجع لاستخدامه لطلبات المصادقة. تتوفر القيم المحتملة من خلال AzureAuthorityHosts. الافتراضي هو "https://login.microsoftonline.com".
disableInstanceDiscovery	يحدد الحقل ما إذا كان يتم تنفيذ اكتشاف المثيل عند محاولة المصادقة. سيؤدي تعيين هذا إلى true إلى تعطيل كل من اكتشاف المثيل والتحقق من صحة المرجع تماما. ونتيجة لذلك، من الضروري التأكد من أن مضيف المرجع المكون صالح وجدير بالثقة. هذه الوظيفة مخصصة للاستخدام في السيناريوهات التي لا يمكن فيها الوصول إلى نقطة نهاية بيانات التعريف، كما هو الحال في السحب الخاصة أو Azure Stack. تتطلب عملية اكتشاف المثيل استرداد بيانات تعريف المرجع من https://login.microsoft.com/ للتحقق من صحة السلطة.
httpClient	HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.
loggingOptions	يسمح للمستخدمين بتكوين إعدادات خيارات نهج التسجيل، والسماح بمعلومات حساب التسجيل ومعلومات التعريف الشخصية لدعم العملاء.
processTimeoutInMs	المهلة القابلة للتكوين لتقديم طلبات الرمز المميز لبيانات اعتماد المطور، وهي <xref:AzurePowershellCredential>AzureDeveloperCliCredentialAzureCliCredential. يجب توفير مهلة العملية لبيانات الاعتماد بالمللي ثانية.
proxyOptions	خيارات لتكوين وكيل للطلبات الصادرة.
redirectOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
requiredEnvVars	قائمة بمتغيرات البيئة التي يجب تعريفها في وقت التشغيل. إذا كان أي متغير في هذه القائمة مفقودا أو تم تعيينه إلى قيمة فارغة، فسيقوم منشئ DefaultAzureCredential بطرح خطأ. استخدم هذا لفرض أن التطبيق الخاص بك يحتوي على تكوين البيئة الضروري قبل متابعة التنفيذ.
retryOptions	الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
telemetryOptions	خيارات لإعداد معلومات تتبع الاستخدام والتتبع الشائعة للطلبات الصادرة.
tenantId	قم بتمرير معرف المستأجر اختياريا لاستخدامه كجزء من بيانات الاعتماد. بشكل افتراضي، قد يستخدم معرف مستأجر عام اعتمادا على بيانات الاعتماد الأساسية.
tlsOptions	خيارات لتكوين مصادقة TLS
userAgentOptions	خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

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

managedIdentityClientId

قم بتمرير معرف عميل معين من قبل المستخدم اختياريا لاستخدامه بواسطة ManagedIdentityCredential. يمكن أيضا تمرير معرف العميل هذا إلى ManagedIdentityCredential من خلال متغير البيئة: AZURE_CLIENT_ID.

managedIdentityClientId?: string

قيمة الخاصية

string

workloadIdentityClientId

قم بتمرير معرف عميل معين من قبل المستخدم اختياريا لاستخدامه بواسطة workloadIdentityCredential. يمكن أيضا تمرير معرف العميل هذا إلى workloadIdentityCredential من خلال متغير البيئة: AZURE_CLIENT_ID.

workloadIdentityClientId?: string

قيمة الخاصية

string

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

additionallyAllowedTenants

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

additionallyAllowedTenants?: string[]

قيمة الخاصية

string[]

موروث منDefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

قيمة الخاصية

AdditionalPolicyConfig[]

موروث منDefaultAzureCredentialOptions.additionalPolicies

agent

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

agent?: Agent

قيمة الخاصية

Agent

موروث منDefaultAzureCredentialOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

قيمة الخاصية

boolean

موروث منDefaultAzureCredentialOptions.allowInsecureConnection

authorityHost

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

authorityHost?: string

قيمة الخاصية

string

موروث منDefaultAzureCredentialOptions.authorityHost

disableInstanceDiscovery

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

disableInstanceDiscovery?: boolean

قيمة الخاصية

boolean

موروث منDefaultAzureCredentialOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

قيمة الخاصية

HttpClient

موروث منDefaultAzureCredentialOptions.httpClient

loggingOptions

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

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

قيمة الخاصية

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

موروثة منDefaultAzureCredentialOptions.loggingOptions

processTimeoutInMs

المهلة القابلة للتكوين لتقديم طلبات الرمز المميز لبيانات اعتماد المطور، وهي <xref:AzurePowershellCredential>AzureDeveloperCliCredentialAzureCliCredential. يجب توفير مهلة العملية لبيانات الاعتماد بالمللي ثانية.

processTimeoutInMs?: number

قيمة الخاصية

number

موروث منDefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

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

proxyOptions?: ProxySettings

قيمة الخاصية

ProxySettings

موروثة منDefaultAzureCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

قيمة الخاصية

RedirectPolicyOptions

موروث منDefaultAzureCredentialOptions.redirectOptions

requiredEnvVars

قائمة بمتغيرات البيئة التي يجب تعريفها في وقت التشغيل. إذا كان أي متغير في هذه القائمة مفقودا أو تم تعيينه إلى قيمة فارغة، فسيقوم منشئ DefaultAzureCredential بطرح خطأ. استخدم هذا لفرض أن التطبيق الخاص بك يحتوي على تكوين البيئة الضروري قبل متابعة التنفيذ.

requiredEnvVars?: DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

قيمة الخاصية

DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

موروثة منDefaultAzureCredentialOptions.requiredEnvVars

retryOptions

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

retryOptions?: PipelineRetryOptions

قيمة الخاصية

PipelineRetryOptions

موروثة منDefaultAzureCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

قيمة الخاصية

TelemetryOptions

موروثة منDefaultAzureCredentialOptions.telemetryOptions

tenantId

قم بتمرير معرف المستأجر اختياريا لاستخدامه كجزء من بيانات الاعتماد. بشكل افتراضي، قد يستخدم معرف مستأجر عام اعتمادا على بيانات الاعتماد الأساسية.

tenantId?: string

قيمة الخاصية

string

موروث منDefaultAzureCredentialOptions.tenantId

tlsOptions

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

tlsOptions?: TlsSettings

قيمة الخاصية

TlsSettings

موروث منDefaultAzureCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

قيمة الخاصية

UserAgentPolicyOptions

موروث منDefaultAzureCredentialOptions.userAgentOptions