مشاركة عبر

@azure/identity package

  • ‏‏المرجع

الفصول

AggregateAuthenticationError

يوفر صفيفا errors يحتوي على مثيل AuthenticationError لحالات فشل المصادقة من بيانات الاعتماد في ChainedTokenCredential.
AuthenticationError

يوفر تفاصيل حول فشل المصادقة باستخدام Azure Active Directory. errorResponse يحتوي الحقل على مزيد من التفاصيل حول الفشل المحدد.
AuthenticationRequiredError

خطأ يستخدم لفرض المصادقة بعد محاولة استرداد رمز مميز بصمت.
AuthorizationCodeCredential

تمكين المصادقة من Microsoft Entra ID باستخدام رمز تخويل تم الحصول عليه من خلال تدفق رمز التخويل، الموضح بمزيد من التفصيل في وثائق Microsoft Entra ID:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
AzureCliCredential

ستستخدم بيانات الاعتماد هذه معلومات تسجيل دخول المستخدم المسجلة حاليا عبر أداة سطر الأوامر Azure CLI ('az'). للقيام بذلك، سيقرأ الرمز المميز لوصول المستخدم ووقت انتهاء الصلاحية باستخدام أمر Azure CLI "az account get-access-token".
AzureDeveloperCliCredential

Azure Developer CLI هي أداة واجهة سطر الأوامر التي تسمح للمطورين بإنشاء الموارد وإدارتها وتوزيعها في Azure. تم إنشاؤه أعلى Azure CLI ويوفر وظائف إضافية خاصة بمطوري Azure. يسمح للمستخدمين بالمصادقة كمستخدم و/أو كيان خدمة مقابل Microsoft Entra ID. يصادق AzureDeveloperCliCredential في بيئة تطوير ويكتسب رمزا مميزا نيابة عن المستخدم أو كيان الخدمة المسجل في Azure Developer CLI. يعمل ك Azure Developer CLI الذي قام بتسجيل الدخول إلى المستخدم أو كيان الخدمة وينفذ أمر Azure CLI أسفل لمصادقة التطبيق مقابل Microsoft Entra ID.

تكوين AzureDeveloperCliCredential

لاستخدام بيانات الاعتماد هذه، يحتاج المطور إلى المصادقة محليا في Azure Developer CLI باستخدام أحد الأوامر أدناه:

  1. قم بتشغيل "تسجيل الدخول إلى azd auth" في Azure Developer CLI للمصادقة بشكل تفاعلي كمستخدم.
  2. قم بتشغيل "تسجيل الدخول إلى azd auth --client-id clientID --client-secret clientSecret --tenant-id tenantID" للمصادقة ككيان خدمة.

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

ستستخدم بيانات الاعتماد هذه معلومات المستخدم المسجلة حاليا من الوحدة النمطية Azure PowerShell. للقيام بذلك، سيقرأ الرمز المميز لوصول المستخدم ووقت انتهاء الصلاحية باستخدام أمر Azure PowerShell Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

تمكين تنفيذات متعددة TokenCredential ليتم تجربتها بالترتيب حتى تقوم إحدى أساليب getToken بإرجاع رمز مميز للوصول.
ClientAssertionCredential

مصادقة كيان خدمة بتأكيد JWT.
ClientCertificateCredential

تمكين المصادقة من Microsoft Entra ID باستخدام شهادة مشفرة من PEM تم تعيينها إلى تسجيل التطبيق. يمكن العثور على مزيد من المعلومات حول كيفية تكوين مصادقة الشهادة هنا:

https://learn.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad
ClientSecretCredential

تمكين المصادقة من Microsoft Entra ID باستخدام سر عميل تم إنشاؤه لتسجيل التطبيق. يمكن العثور على مزيد من المعلومات حول كيفية تكوين سر العميل هنا:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
CredentialUnavailableError

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

يوفر تكوين ChainedTokenCredential افتراضيا يجب أن يعمل لمعظم التطبيقات التي تستخدم Azure SDK.
DeviceCodeCredential

تمكين المصادقة من Microsoft Entra ID باستخدام رمز جهاز يمكن للمستخدم إدخاله في https://microsoft.com/devicelogin.
EnvironmentCredential

تمكين المصادقة من Microsoft Entra ID باستخدام سر العميل أو الشهادة، أو كمستخدم باسم مستخدم وكلمة مرور.
InteractiveBrowserCredential

تمكين المصادقة من Microsoft Entra ID داخل مستعرض الويب باستخدام تدفق تسجيل الدخول التفاعلي.
ManagedIdentityCredential

يحاول المصادقة باستخدام هوية مدارة متوفرة في بيئة التوزيع. يعمل نوع المصادقة هذا في أجهزة Azure الظاهرية ومثيلات App Service وتطبيقات Azure Functions وخدمات Azure Kubernetes ومثيلات Azure Service Fabric وداخل Azure Cloud Shell.

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

تمكين المصادقة من Microsoft Entra ID باستخدام تدفق نيابة عن.
UsernamePasswordCredential

تمكين المصادقة من Microsoft Entra ID باستخدام اسم المستخدم وكلمة المرور للمستخدم. تتطلب بيانات الاعتماد هذه درجة عالية من الثقة لذلك يجب عليك استخدامها فقط عندما لا يمكن استخدام أنواع بيانات اعتماد أخرى أكثر أمانا.
VisualStudioCodeCredential

يتصل ب Azure باستخدام بيانات الاعتماد التي يوفرها ملحق VSCode "حساب Azure". بمجرد تسجيل دخول المستخدم عبر الملحق، يمكن لبيانات الاعتماد هذه مشاركة نفس رمز التحديث الذي تم تخزينه مؤقتا بواسطة الملحق.

إنها مشكلة معروفة أن بيانات الاعتماد هذه لا تعمل مع إصدارات ملحق حساب Azure الأحدث من 0.9.11. هناك إصلاح طويل الأجل لهذه المشكلة قيد التقدم. في هذه الأثناء، ضع في اعتبارك المصادقة باستخدام AzureCliCredential.
WorkloadIdentityCredential

مصادقة هوية حمل العمل هي ميزة في Azure تسمح للتطبيقات التي تعمل على الأجهزة الظاهرية (VMs) بالوصول إلى موارد Azure الأخرى دون الحاجة إلى كيان خدمة أو هوية مدارة. باستخدام مصادقة هوية حمل العمل، تصادق التطبيقات نفسها باستخدام هويتها الخاصة، بدلا من استخدام كيان خدمة مشترك أو هوية مدارة. تحت الغطاء، تستخدم مصادقة هوية حمل العمل مفهوم بيانات اعتماد حساب الخدمة (SACs)، والتي يتم إنشاؤها تلقائيا بواسطة Azure وتخزينها بأمان في الجهاز الظاهري. باستخدام مصادقة هوية حمل العمل، يمكنك تجنب الحاجة إلى إدارة وتدوير كيانات الخدمة أو الهويات المدارة لكل تطبيق على كل جهاز ظاهري. بالإضافة إلى ذلك، نظرا لأن SACs يتم إنشاؤها تلقائيا وإدارتها بواسطة Azure، فلا داعي للقلق بشأن تخزين وتأمين بيانات الاعتماد الحساسة نفسها. يدعم WorkloadIdentityCredential المصادقة هوية حمل عمل Microsoft Entra على Azure Kubernetes ويكتسب رمزا مميزا باستخدام SACs المتوفرة في بيئة Azure Kubernetes. راجع هوية حمل عمل Microsoft Entra لمزيد من المعلومات.

الواجهات

AccessToken

يمثل رمزا مميزا للوصول مع وقت انتهاء الصلاحية.
AuthenticationRecord

السجل الذي يجب استخدامه للعثور على الرموز المميزة المخزنة مؤقتا في ذاكرة التخزين المؤقت.
AuthenticationRequiredErrorOptions

معلمات اختيارية إلى AuthenticationRequiredError
AuthorityValidationOptions

يوفر خيارات لتكوين كيفية التحقق من صحة المرجع في مكتبة الهوية أثناء طلبات المصادقة إلى Microsoft Entra ID.
AuthorizationCodeCredentialOptions

خيارات AuthorizationCodeCredential
AzureCliCredentialOptions

خيارات AzureCliCredential
AzureDeveloperCliCredentialOptions

خيارات AzureDeveloperCliCredential
AzurePowerShellCredentialOptions

خيارات AzurePowerShellCredential
BrokerAuthOptions

خيارات التكوين ل InteractiveBrowserCredential لدعم مصادقة وسيط WAM.
BrokerDisabledOptions

المعلمات عند تعطيل مصادقة وسيط WAM.
BrokerEnabledOptions

المعلمات عند تمكين مصادقة وسيط WAM.
BrowserCustomizationOptions

خيارات التكوين المشتركة لتخصيص المستعرض
ClientAssertionCredentialOptions

خيارات ClientAssertionCredential
ClientCertificateCredentialOptions

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

خيارات التكوين المطلوبة ل ClientCertificateCredential، مع محتويات سلسلة شهادة PEM
ClientCertificatePEMCertificatePath

خيارات التكوين المطلوبة ل ClientCertificateCredential، مع المسار إلى شهادة PEM.
ClientSecretCredentialOptions

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

خيارات التكوين المشتركة لبيانات الاعتماد التي تدعم التخزين المؤقت للرمز المميز المستمر.
DefaultAzureCredentialClientIdOptions

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

يوفر خيارات لتكوين فئة DefaultAzureCredential .
DefaultAzureCredentialResourceIdOptions

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

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

يوفر رمز المستخدم وURI للتحقق حيث يجب إدخال التعليمات البرمجية. يوفر أيضا رسالة لعرضها على المستخدم تحتوي على تعليمات بهذه التفاصيل.
EnvironmentCredentialOptions

تمكين المصادقة من Microsoft Entra ID اعتمادا على متغيرات البيئة المتوفرة. يحدد خيارات فئة EnvironmentCredential.
ErrorResponse

راجع الوثائق الرسمية لمزيد من التفاصيل:

https://learn.microsoft.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

ملاحظة: هذه الوثائق مخصصة لدعم v1 OAuth ولكن نفس تفاصيل استجابة الخطأ لا تزال تنطبق على الإصدار 2.
GetBearerTokenProviderOptions

خيارات تكوين موفر الرمز المميز.
GetTokenOptions

يحدد خيارات TokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

يحدد الخيارات الشائعة لفئة InteractiveBrowserCredential.
InteractiveBrowserCredentialNodeOptions

يحدد الخيارات الشائعة لفئة InteractiveBrowserCredential.
InteractiveCredentialOptions

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

خيارات لإرسالها على الدالة الإنشائية ManagedIdentityCredential . يدعم clientId هذا التباين وليس resourceId، حيث يتم دعم واحد فقط من كليهما.
ManagedIdentityCredentialResourceIdOptions

خيارات لإرسالها على الدالة الإنشائية ManagedIdentityCredential . يدعم resourceId هذا التباين وليس clientId، حيث يتم دعم واحد فقط من كليهما.
MultiTenantTokenCredentialOptions

خيارات للتطبيقات متعددة المستأجرين التي تسمح للمستأجرين المسموح لهم بالإضافة إلى ذلك.
OnBehalfOfCredentialCertificateOptions

يحدد المعلمات لمصادقة OnBehalfOfCredential بشهادة.
OnBehalfOfCredentialSecretOptions

يحدد المعلمات لمصادقة OnBehalfOfCredential مع سر.
TokenCachePersistenceOptions

المعلمات التي تمكن استمرار ذاكرة التخزين المؤقت للرمز المميز في بيانات اعتماد الهوية.
TokenCredential

يمثل بيانات اعتماد قادرة على توفير رمز مميز للمصادقة.
TokenCredentialOptions

يوفر خيارات لتكوين كيفية تقديم مكتبة الهوية لطلبات المصادقة Microsoft Entra ID.
UsernamePasswordCredentialOptions

يحدد خيارات فئة UsernamePasswordCredential .
VisualStudioCodeCredentialOptions

يوفر خيارات لتكوين بيانات اعتماد Visual Studio Code.
WorkloadIdentityCredentialOptions

خيارات WorkloadIdentityCredential

النوع أسماء مستعارة

BrokerOptions

المعلمات التي تمكن مصادقة وسيط WAM في InteractiveBrowserCredential.
BrowserLoginStyle

(ميزة المستعرض فقط) "نمط تسجيل الدخول" لاستخدامه في تدفق المصادقة:

  • يعيد "إعادة التوجيه" توجيه المستخدم إلى صفحة المصادقة ثم يعيد توجيهه مرة أخرى إلى الصفحة بمجرد اكتمال المصادقة.
  • تفتح "النافذة المنبثقة" نافذة مستعرض جديدة من خلالها مع بدء تدفق إعادة التوجيه. لا تترك نافذة المستعرض الموجودة للمستخدم الصفحة الحالية
ClientCertificateCredentialPEMConfiguration

خيارات التكوين المطلوبة ل ClientCertificateCredential، إما مع محتويات سلسلة شهادة PEM، أو المسار إلى شهادة PEM.
DeviceCodePromptCallback

يحدد توقيع رد الاتصال الذي سيتم تمريره إلى DeviceCodeCredential لغرض عرض تفاصيل المصادقة للمستخدم.
IdentityPlugin

نوع المكون الإضافي ل Azure Identity، وهي وظيفة تقبل سياق المكون الإضافي.
OnBehalfOfCredentialOptions

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

التعدادات

AzureAuthorityHosts

قائمة بمضيفي سلطة Azure المعروفين

الوظائف

deserializeAuthenticationRecord(string)

إلغاء تسلسل سجل مصادقة تم تسلسله مسبقا من سلسلة إلى كائن.

يجب أن تحتوي سلسلة الإدخال على الخصائص التالية:

  • "السلطة"
  • "homeAccountId"
  • "معرف العميل"
  • "tenantId"
  • "اسم المستخدم"
  • "الإصدار"

إذا كان الإصدار الذي نتلقاه غير مدعوم، فسيتم طرح خطأ.

في الوقت الحالي، الإصدار الوحيد المتاح هو: "1.0"، والذي يتم تعيينه دائما عند تسلسل سجل المصادقة.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

إرجاع رد اتصال يوفر رمزا مميزا للحامل. على سبيل المثال، يمكن استخدام الرمز المميز للحامل لمصادقة طلب على النحو التالي:

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();

// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);
getDefaultAzureCredential()

إرجاع مثيل جديد من DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

تسلسل في AuthenticationRecord سلسلة.

سيحتوي إخراج سجل مصادقة متسلسل على الخصائص التالية:

  • "السلطة"
  • "homeAccountId"
  • "معرف العميل"
  • "tenantId"
  • "اسم المستخدم"
  • "الإصدار"

لتحويل هذه السلسلة لاحقا إلى تسلسل AuthenticationRecord، يرجى استخدام الدالة deserializeAuthenticationRecord()المصدرة .
useIdentityPlugin(IdentityPlugin)

توسيع هوية Azure بوظائف إضافية. قم بتمرير مكون إضافي من حزمة مكون إضافي، مثل:

  • @azure/identity-cache-persistence: يوفر التخزين المؤقت للرمز المميز المستمر
  • @azure/identity-vscode: يوفر تبعيات VisualStudioCodeCredential وتمكينه

مثال:

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

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

تفاصيل الوظيفة

deserializeAuthenticationRecord(string)

إلغاء تسلسل سجل مصادقة تم تسلسله مسبقا من سلسلة إلى كائن.

يجب أن تحتوي سلسلة الإدخال على الخصائص التالية:

  • "السلطة"
  • "homeAccountId"
  • "معرف العميل"
  • "tenantId"
  • "اسم المستخدم"
  • "الإصدار"

إذا كان الإصدار الذي نتلقاه غير مدعوم، فسيتم طرح خطأ.

في الوقت الحالي، الإصدار الوحيد المتاح هو: "1.0"، والذي يتم تعيينه دائما عند تسلسل سجل المصادقة.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

المعلمات

serializedRecord

string

سجل المصادقة الذي تم تسلسله مسبقا في سلسلة.

المرتجعات

AuthenticationRecord

AuthenticationRecord.

getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

إرجاع رد اتصال يوفر رمزا مميزا للحامل. على سبيل المثال، يمكن استخدام الرمز المميز للحامل لمصادقة طلب على النحو التالي:

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();

// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);

function getBearerTokenProvider(credential: TokenCredential, scopes: string | string[], options?: GetBearerTokenProviderOptions): () => Promise<string>

المعلمات

credential
TokenCredential

بيانات الاعتماد المستخدمة لمصادقة الطلب.

scopes

string | string[]

النطاقات المطلوبة للرمز المميز للحامل.

options
GetBearerTokenProviderOptions

خيارات لتكوين موفر الرمز المميز.

المرتجعات

() => Promise<string>

رد اتصال يوفر رمزا مميزا للحامل.

getDefaultAzureCredential()

إرجاع مثيل جديد من DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

المرتجعات

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

تسلسل في AuthenticationRecord سلسلة.

سيحتوي إخراج سجل مصادقة متسلسل على الخصائص التالية:

  • "السلطة"
  • "homeAccountId"
  • "معرف العميل"
  • "tenantId"
  • "اسم المستخدم"
  • "الإصدار"

لتحويل هذه السلسلة لاحقا إلى تسلسل AuthenticationRecord، يرجى استخدام الدالة deserializeAuthenticationRecord()المصدرة .

function serializeAuthenticationRecord(record: AuthenticationRecord): string

المعلمات

record
AuthenticationRecord

المرتجعات

string

useIdentityPlugin(IdentityPlugin)

توسيع هوية Azure بوظائف إضافية. قم بتمرير مكون إضافي من حزمة مكون إضافي، مثل:

  • @azure/identity-cache-persistence: يوفر التخزين المؤقت للرمز المميز المستمر
  • @azure/identity-vscode: يوفر تبعيات VisualStudioCodeCredential وتمكينه

مثال:

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

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

function useIdentityPlugin(plugin: IdentityPlugin)

المعلمات

plugin
IdentityPlugin

المكون الإضافي للتسجيل