مشاركة عبر

DefaultAzureCredential الفصل

  • ‏‏المرجع

بيانات اعتماد افتراضية قادرة على التعامل مع معظم سيناريوهات مصادقة Azure SDK.

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

  1. كيان خدمة تم تكوينه بواسطة متغيرات البيئة. انظرEnvironmentCredential لمزيد من التفاصيل.

  2. WorkloadIdentityCredential إذا تم تعيين تكوين متغير البيئة بواسطة خطاف الويب لهوية حمل عمل Azure.

  3. هوية مدارة من Azure. انظرManagedIdentityCredential لمزيد من التفاصيل.

  4. على Windows فقط: مستخدم قام بتسجيل الدخول باستخدام تطبيق Microsoft، مثل Visual Studio. إذا كانت هناك هويات متعددة في ذاكرة التخزين المؤقت، فسيتم استخدام قيمة متغير AZURE_USERNAME البيئة لتحديد الهوية التي يجب استخدامها. انظرSharedTokenCacheCredential لمزيد من التفاصيل.

  5. الهوية المسجلة حاليا في Azure CLI.

  6. الهوية التي تم تسجيل دخولها حاليا إلى Azure PowerShell.

  7. الهوية المسجلة حاليا في Azure Developer CLI.

هذا السلوك الافتراضي قابل للتكوين باستخدام وسيطات الكلمة الأساسية.

توريث
azure.identity._credentials.chained.ChainedTokenCredential
DefaultAzureCredential

الدالمنشئ

DefaultAzureCredential(**kwargs: Any)

المعلمات

authority
str

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

exclude_workload_identity_credential
bool

ما إذا كان سيتم استبعاد هوية حمل العمل من بيانات الاعتماد. الإعدادات الافتراضية إلى False.

exclude_developer_cli_credential
bool

ما إذا كان سيتم استبعاد Azure Developer CLI من بيانات الاعتماد. الإعدادات الافتراضية إلى False.

exclude_cli_credential
bool

ما إذا كان سيتم استبعاد Azure CLI من بيانات الاعتماد. الإعدادات الافتراضية إلى False.

exclude_environment_credential
bool

ما إذا كان سيتم استبعاد كيان خدمة تم تكوينه بواسطة متغيرات البيئة من بيانات الاعتماد. الإعدادات الافتراضية إلى False.

exclude_managed_identity_credential
bool

ما إذا كان سيتم استبعاد الهوية المدارة من بيانات الاعتماد. الإعدادات الافتراضية إلى False.

exclude_powershell_credential
bool

ما إذا كان سيتم استبعاد Azure PowerShell. الإعدادات الافتراضية إلى False.

exclude_visual_studio_code_credential
bool

ما إذا كان سيتم استبعاد بيانات الاعتماد المخزنة من VS Code. الإعدادات الافتراضية إلى True.

exclude_shared_token_cache_credential
bool

ما إذا كان سيتم استبعاد ذاكرة التخزين المؤقت للرمز المميز المشترك. الإعدادات الافتراضية إلى False.

exclude_interactive_browser_credential
bool

ما إذا كان سيتم استبعاد مصادقة المستعرض التفاعلية (راجع InteractiveBrowserCredential). الإعدادات الافتراضية إلى True.

interactive_browser_tenant_id
str

معرف المستأجر لاستخدامه عند مصادقة مستخدم من خلال InteractiveBrowserCredential. الإعدادات الافتراضية لقيمة متغير البيئة AZURE_TENANT_ID، إن وجدت. إذا لم يتم تحديده، فسيصادق المستخدمون في المستأجرين المنزليين.

managed_identity_client_id
str

معرّف العميل الخاص بهوية مُدارة يُعينها المستخدم. الإعدادات الافتراضية لقيمة متغير البيئة AZURE_CLIENT_ID، إن وجدت. إذا لم يتم تحديدها، فسيتم استخدام هوية معينة من قبل النظام.

workload_identity_client_id
str

معرف العميل لهوية معينة إلى pod. الإعدادات الافتراضية لقيمة متغير البيئة AZURE_CLIENT_ID، إن وجدت. إذا لم يتم تحديده، فسيتم استخدام الهوية الافتراضية للحجيرة.

workload_identity_tenant_id
str

المستأجر المفضل ل WorkloadIdentityCredential. الإعدادات الافتراضية لقيمة متغير البيئة AZURE_TENANT_ID، إن وجدت.

interactive_browser_client_id
str

معرف العميل الذي سيتم استخدامه في بيانات اعتماد المستعرض التفاعلية. إذا لم يتم تحديده، فسيصادق المستخدمون على تطبيق تطوير Azure.

shared_cache_username
str

اسم المستخدم المفضل ل SharedTokenCacheCredential. الإعدادات الافتراضية لقيمة متغير البيئة AZURE_USERNAME، إن وجدت.

shared_cache_tenant_id
str

المستأجر المفضل ل SharedTokenCacheCredential. الإعدادات الافتراضية لقيمة متغير البيئة AZURE_TENANT_ID، إن وجدت.

visual_studio_code_tenant_id
str

معرف المستأجر لاستخدامه عند المصادقة مع VisualStudioCodeCredential. الإعدادات الافتراضية لإعداد "Azure: Tenant" في إعدادات مستخدم VS Code أو، عندما لا يكون لهذا الإعداد قيمة، مستأجر "المؤسسات"، الذي يدعم حسابات العمل أو المؤسسة التعليمية في Azure Active Directory فقط.

process_timeout
int

المهلة بالثوان لاستخدامها لبيانات اعتماد المطور التي تقوم بتشغيل العمليات الفرعية (على سبيل المثال، AzureCliCredential، AzurePowerShellCredential). الإعدادات الافتراضية إلى 10 ثوان.

أمثلة

إنشاء DefaultAzureCredential.


   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

الأساليب

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

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

المرتجعات

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

نوع الإرجاع

AccessToken

استثناءات

ClientAuthenticationError

فشلت المصادقة. يحتوي الاستثناء على سمة رسالة تسرد كل محاولة مصادقة ورسالة الخطأ الخاصة به.