@azure/identity package

الفصول

AggregateAuthenticationError

يوفر صفيف يحتوي على مثيل 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. يقوم Azure DeveloperCliCredential بالتحقق في بيئة تطوير ويحصل على رمز نيابة عن المستخدم أو المزود المسجل للخدمة في واجهة Azure Developer CLI. يعمل كواجهة مستخدم أو خدمة مسجل الدخول إلى Azure Developer وينفذ أمر Azure CLI تحته للمصادقة على التطبيق مقابل Microsoft Entra ID.

تكوين AzureDeveloperCliCredential

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

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

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

تم تصميم هذه الشهادة للاستخدام في Azure Pipelines مع اتصالات الخدمة كإعداد لاتحاد هوية عبء العمل.
AzurePowerShellCredential

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

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

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

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

https://learn.microsoft.com/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 العملاء. لمزيد من المعلومات، راجع نظرة عامة على DefaultAzureCredential.

ستتم تجربة أنواع بيانات الاعتماد التالية بالترتيب:

راجع وثائق أنواع بيانات الاعتماد هذه للحصول على مزيد من المعلومات حول كيفية محاولة المصادقة.

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

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

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});
DeviceCodeCredential

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

يتيح المصادقة إلى Microsoft Entra ID باستخدام سر العميل أو الشهادة.
InteractiveBrowserCredential

يتيح المصادقة إلى Microsoft Entra ID داخل متصفح الويب باستخدام تدفق تسجيل الدخول التفاعلي.
ManagedIdentityCredential

يحاول المصادقة باستخدام هوية مدارة متوفرة في بيئة النشر. 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
OnBehalfOfCredential

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

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

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

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

الواجهات

AccessToken

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

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

معلمات اختيارية المصادقة RequiredError
AuthorityValidationOptions

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

خيارات AuthorizationCodeCredential

AzureCliCredentialOptions

خيارات AzureCliCredential
AzureDeveloperCliCredentialOptions

خيارات AzureDeveloperCliCredential

AzurePipelinesCredentialOptions

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

خيارات AzurePowerShellCredential
BrokerAuthOptions

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

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

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

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

خيارات ClientAssertionCredential
ClientCertificateCredentialOptions

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

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

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

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

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

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

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

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

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

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

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

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

https://learn.microsoft.com/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، حيث يتم دعم واحد فقط من كليهما.
ManagedIdentityCredentialObjectIdOptions

خيارات الإرسال على ManagedIdentityCredential الإنشائية. يدعم هذا التباين objectId كوسيطة منشئ.
ManagedIdentityCredentialResourceIdOptions

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

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

تعريف المعلمات لمصادقة OnBehalfOfCredential مع تأكيد.
OnBehalfOfCredentialCertificateOptions

تعريف المعلمات لمصادقة OnBehalfOfCredential مع شهادة.
OnBehalfOfCredentialSecretOptions

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

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

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

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

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

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

خيارات workloadIdentityCredential

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

BrokerOptions

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

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

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

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

متغيرات البيئة المدعومة بشكل شائع للفئة DefaultAzureCredential .
DeviceCodePromptCallback

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

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

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

التعدادات

AzureAuthorityHosts

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

الوظائف

deserializeAuthenticationRecord(string)

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

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

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

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

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

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

import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";

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"
  • "معرف العميل"
  • "معرف المستأجر"
  • "اسم المستخدم"
  • "إصدار"

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

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

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

مثل:

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

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

المتغيرات

AggregateAuthenticationErrorName

القيمة Error.name ل AggregateAuthenticationError
AuthenticationErrorName

القيمة Error.name لخطأ التحقق
CredentialUnavailableErrorName

القيمة Error.name لشهادة غير متاحة
logger

يستخدم AzureLogger لجميع العملاء ضمن حزمة الهوية

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

deserializeAuthenticationRecord(string)

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

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

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

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

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

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

المعلمات

serializedRecord

string

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

المرتجعات

AuthenticationRecord

سجل المصادقة.

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

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

import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";

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"
  • "معرف العميل"
  • "معرف المستأجر"
  • "اسم المستخدم"
  • "إصدار"

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

function serializeAuthenticationRecord(record: AuthenticationRecord): string

المعلمات

record
AuthenticationRecord

المرتجعات

string

useIdentityPlugin(IdentityPlugin)

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

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

مثل:

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

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

function useIdentityPlugin(plugin: IdentityPlugin)

المعلمات

plugin
IdentityPlugin

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

تفاصيل المُتغيّر

AggregateAuthenticationErrorName

القيمة Error.name ل AggregateAuthenticationError

AggregateAuthenticationErrorName: "AggregateAuthenticationError"

النوع

"AggregateAuthenticationError"

AuthenticationErrorName

القيمة Error.name لخطأ التحقق

AuthenticationErrorName: "AuthenticationError"

النوع

"AuthenticationError"

CredentialUnavailableErrorName

القيمة Error.name لشهادة غير متاحة

CredentialUnavailableErrorName: "CredentialUnavailableError"

النوع

"CredentialUnavailableError"

logger

يستخدم AzureLogger لجميع العملاء ضمن حزمة الهوية

logger: AzureLogger

النوع

AzureLogger