مشاركة عبر

ClientSecretCredential الفصل

  • ‏‏المرجع

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

توريث
azure.identity._internal.client_credential_base.ClientCredentialBase
ClientSecretCredential

الدالمنشئ

ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **kwargs: Any)

المعلمات

tenant_id
str
مطلوب

معرف مستأجر كيان الخدمة. يسمى أيضا معرف "الدليل" الخاص به.

client_id
str
مطلوب

معرف عميل كيان الخدمة

client_secret
str
مطلوب

أحد أسرار عميل كيان الخدمة

authority
str

سلطة نقطة نهاية Azure Active Directory، على سبيل المثال "login.microsoftonline.com"، وهي سلطة Azure Public Cloud (وهو الافتراضي). AzureAuthorityHosts يحدد السلطات للسحب الأخرى.

cache_persistence_options
TokenCachePersistenceOptions

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

disable_instance_discovery
bool

تحديد ما إذا كان يتم تنفيذ اكتشاف المثيل أم لا عند محاولة المصادقة. سيؤدي تعيين هذا إلى true إلى تعطيل كل من اكتشاف المثيل والتحقق من صحة المرجع تماما. هذه الوظيفة مخصصة للاستخدام في السيناريوهات التي لا يمكن فيها الوصول إلى نقطة نهاية بيانات التعريف، كما هو الحال في السحب الخاصة أو Azure Stack. تتطلب عملية اكتشاف المثيل استرداد بيانات تعريف المرجع من https://login.microsoft.com/ للتحقق من صحة السلطة. من خلال تعيين هذا إلى True، يتم تعطيل التحقق من صحة المرجع. ونتيجة لذلك، من الضروري التأكد من أن مضيف المرجع المكون صالح وجدير بالثقة.

additionally_allowed_tenants
List[str]

يحدد المستأجرين بالإضافة إلى "tenant_id" المحدد الذي قد تحصل بيانات الاعتماد على رموز مميزة له. أضف قيمة حرف البدل "*" للسماح لبيانات الاعتماد بالحصول على رموز مميزة لأي مستأجر يمكن للتطبيق الوصول إليه.

أمثلة

إنشاء ClientSecretCredential.


   from azure.identity import ClientSecretCredential

   credential = ClientSecretCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       client_secret="<client_secret>",
   )

الأساليب

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.

المرتجعات

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

نوع الإرجاع

AccessToken

استثناءات

CredentialUnavailableError

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

ClientAuthenticationError

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