WorkloadIdentityCredential الفصل

المصادقة باستخدام هوية حمل عمل Azure Active Directory.

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

يدعم WorkloadIdentityCredential مصادقة هوية حمل العمل Azure على Azure Kubernetes ويكتسب رمزا مميزا باستخدام بيانات اعتماد حساب الخدمة المتوفرة في بيئة Azure Kubernetes. راجع نظرة عامة على هوية حمل العمل هذه للحصول على مزيد من المعلومات.

توريث
azure.identity._credentials.client_assertion.ClientAssertionCredential
WorkloadIdentityCredential
azure.identity._credentials.workload_identity.TokenFileMixin
WorkloadIdentityCredential

الدالمنشئ

WorkloadIdentityCredential(*, tenant_id: str | None = None, client_id: str | None = None, token_file_path: str | None = None, **kwargs: Any)

المعلمات

tenant_id
str

معرف مستأجر Azure Active Directory للتطبيق. يسمى أيضا معرف "الدليل" الخاص به.

client_id
str

معرف العميل لتسجيل تطبيق Azure AD.

token_file_path
str

المسار إلى ملف يحتوي على رمز مميز لحساب خدمة Kubernetes الذي يصادق الهوية.

أمثلة

إنشاء WorkloadIdentityCredential.


   from azure.identity import WorkloadIdentityCredential

   credential = WorkloadIdentityCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       token_file_path="<token_file_path>",
   )

   # Parameters can be omitted if the following environment variables are set:
   #   - AZURE_TENANT_ID
   #   - AZURE_CLIENT_ID
   #   - AZURE_FEDERATED_TOKEN_FILE
   credential = WorkloadIdentityCredential()

الأساليب

close
get_token

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

يتم استدعاء هذا الأسلوب تلقائيا بواسطة عملاء Azure SDK.

close

close() -> None

get_token

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

يتم استدعاء هذا الأسلوب تلقائيا بواسطة عملاء Azure SDK.

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

المعلمات

scopes
str
مطلوب

النطاقات المطلوبة للرمز المميز للوصول. يتطلب هذا الأسلوب نطاقا واحدا على الأقل. لمزيد من المعلومات حول النطاقات، راجع https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

المطالبات الإضافية المطلوبة في الرمز المميز، مثل تلك التي تم إرجاعها في تحدي مطالبات موفر الموارد بعد فشل التخويل.

tenant_id
str

مستأجر اختياري لتضمينه في طلب الرمز المميز.

enable_cae
bool

يشير إلى ما إذا كان يجب تمكين تقييم الوصول المستمر (CAE) للرمز المميز المطلوب. الإعدادات الافتراضية معينة على False.

المرتجعات

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

نوع الإرجاع

استثناءات

بيانات الاعتماد غير قادرة على محاولة المصادقة لأنها تفتقر إلى البيانات المطلوبة أو الحالة أو دعم النظام الأساسي

فشلت المصادقة. تعطي سمة message الخطأ سببا.