DefaultAzureCredential class
يوفر تكوينا افتراضيا ChainedTokenCredential يعمل لمعظم التطبيقات التي تستخدم مكتبات عميل Azure SDK. لمزيد من المعلومات، راجع نظرة عامة على DefaultAzureCredential.
ستتم تجربة أنواع بيانات الاعتماد التالية بالترتيب:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- AzureDeveloperCliCredential
- BrokerCredential (تم تثبيت بيانات اعتماد ممكنة من قبل الوسيط تتطلب @azure/identity-broker ذلك)
راجع وثائق أنواع بيانات الاعتماد هذه للحصول على مزيد من المعلومات حول كيفية محاولة المصادقة.
يوضح المثال التالي كيفية استخدام الخيار 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",
],
});
المنشئون
| Default |
إنشاء مثيل لفئة DefaultAzureCredential مع DefaultAzureCredentialClientIdOptions. |
| Default |
إنشاء مثيل لفئة DefaultAzureCredential مع DefaultAzureCredentialOptions. |
| Default |
إنشاء مثيل للفئة DefaultAzureCredential مع DefaultAzureCredentialResourceIdOptions. |
الأساليب المتوارثة
| get |
إرجاع أول رمز مميز للوصول تم إرجاعه بواسطة أحد تطبيقات يتم استدعاء هذا الأسلوب تلقائيا بواسطة مكتبات عميل Azure SDK. يمكنك استدعاء هذا الأسلوب مباشرة، ولكن يجب عليك أيضا معالجة التخزين المؤقت للرمز المميز وتحديث الرمز المميز. |
تفاصيل المنشئ
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
إنشاء مثيل لفئة DefaultAzureCredential مع DefaultAzureCredentialClientIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)المعلمات
المعلمات الاختيارية. راجع DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)
إنشاء مثيل لفئة DefaultAzureCredential مع DefaultAzureCredentialOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)المعلمات
- options
- DefaultAzureCredentialOptions
المعلمات الاختيارية. راجع DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
إنشاء مثيل للفئة DefaultAzureCredential مع DefaultAzureCredentialResourceIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)المعلمات
المعلمات الاختيارية. راجع DefaultAzureCredentialResourceIdOptions.
تفاصيل الأساليب المتوارثة
getToken(string | string[], GetTokenOptions)
إرجاع أول رمز مميز للوصول تم إرجاعه بواسطة أحد تطبيقات TokenCredential المتسلسلة. يطرح AggregateAuthenticationError عندما يطرح واحد أو أكثر من بيانات الاعتماد AuthenticationError ولم يتم إرجاع أي بيانات اعتماد رمز مميز للوصول.
يتم استدعاء هذا الأسلوب تلقائيا بواسطة مكتبات عميل Azure SDK. يمكنك استدعاء هذا الأسلوب مباشرة، ولكن يجب عليك أيضا معالجة التخزين المؤقت للرمز المميز وتحديث الرمز المميز.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>المعلمات
- scopes
-
string | string[]
قائمة النطاقات التي سيكون للرمز المميز حق الوصول إليها.
- options
- GetTokenOptions
الخيارات المستخدمة لتكوين أي طلبات قد يقدمها هذا التطبيق TokenCredential.
المرتجعات
Promise<AccessToken>
موروث منChainedTokenCredential.getToken