ManagedIdentityCredential class

يحاول المصادقة باستخدام هوية مدارة متوفرة في بيئة النشر. This authentication type works in Azure VMs, App Service instances, دالات Azure applications, Azure Kubernetes Services, Azure Service Fabric instances ובתוך Azure Cloud Shell.

يمكن العثور على مزيد من المعلومات حول تكوين الهويات المدارة هنا: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview

المنشئون

ManagedIdentityCredential(ManagedIdentityCredentialClientIdOptions)

إنشاء مثيل ManagedIdentityCredential مع معرف العميل

ManagedIdentityCredential(ManagedIdentityCredentialObjectIdOptions)

إنشاء مثيل ManagedIdentityCredential مع معرف كائن

ManagedIdentityCredential(ManagedIdentityCredentialResourceIdOptions)

إنشاء مثيل ManagedIdentityCredential مع معرف مورد

ManagedIdentityCredential(string, TokenCredentialOptions)

إنشاء مثيل ManagedIdentityCredential مع معرف العميل للهوية المعينة من قبل المستخدم، أو تسجيل التطبيق (عند العمل مع AKS pod-identity).

الأساليب

getToken(string | string[], GetTokenOptions)

يتم التحقق من المصادقة باستخدام معرف Microsoft Entra ID ويعيد رمز الوصول إذا نجحت. إذا فشلت المصادقة، طرح CredentialUnavailableError مع تفاصيل الفشل. في حالة حدوث خطأ غير متوقع، سيتم طرح AuthenticationError مع تفاصيل الفشل.

تفاصيل المنشئ

ManagedIdentityCredential(ManagedIdentityCredentialClientIdOptions)

إنشاء مثيل ManagedIdentityCredential مع معرف العميل

new ManagedIdentityCredential(options?: ManagedIdentityCredentialClientIdOptions)

المعلمات

options
ManagedIdentityCredentialClientIdOptions

خيارات لتكوين العميل الذي يقوم بطلب الرمز المميز للوصول.

ManagedIdentityCredential(ManagedIdentityCredentialObjectIdOptions)

إنشاء مثيل ManagedIdentityCredential مع معرف كائن

new ManagedIdentityCredential(options?: ManagedIdentityCredentialObjectIdOptions)

المعلمات

options
ManagedIdentityCredentialObjectIdOptions

خيارات لتكوين المورد الذي يجعل طلب الرمز المميز للوصول.

ManagedIdentityCredential(ManagedIdentityCredentialResourceIdOptions)

إنشاء مثيل ManagedIdentityCredential مع معرف مورد

new ManagedIdentityCredential(options?: ManagedIdentityCredentialResourceIdOptions)

المعلمات

options
ManagedIdentityCredentialResourceIdOptions

خيارات لتكوين المورد الذي يجعل طلب الرمز المميز للوصول.

ManagedIdentityCredential(string, TokenCredentialOptions)

إنشاء مثيل ManagedIdentityCredential مع معرف العميل للهوية المعينة من قبل المستخدم، أو تسجيل التطبيق (عند العمل مع AKS pod-identity).

new ManagedIdentityCredential(clientId: string, options?: TokenCredentialOptions)

المعلمات

clientId

string

معرف العميل للهوية المعينة من قبل المستخدم، أو تسجيل التطبيق (عند العمل مع AKS pod-identity).

options
TokenCredentialOptions

خيارات لتكوين العميل الذي يقوم بطلب الرمز المميز للوصول.

تفاصيل الأسلوب

getToken(string | string[], GetTokenOptions)

يتم التحقق من المصادقة باستخدام معرف Microsoft Entra ID ويعيد رمز الوصول إذا نجحت. إذا فشلت المصادقة، طرح CredentialUnavailableError مع تفاصيل الفشل. في حالة حدوث خطأ غير متوقع، سيتم طرح AuthenticationError مع تفاصيل الفشل.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

المعلمات

scopes

string | string[]

قائمة النطاقات التي سيكون للرمز المميز حق الوصول إليها.

options
GetTokenOptions

الخيارات المستخدمة لتكوين أي طلبات قد يقدمها تطبيق TokenCredential هذا.

المرتجعات

Promise<AccessToken>