DefaultAzureCredential Sınıf

  • Başvuru

Azure SDK kimlik doğrulama senaryolarının çoğunu işleyebilen varsayılan kimlik bilgileri.

Kullandığı kimlik ortama bağlıdır. Erişim belirteci gerektiğinde, bu kimlikleri kullanarak bir belirteç sağlandığında durdurularak bir belirteç isteğinde bulunulması gerekir:

  1. Ortam değişkenleri tarafından yapılandırılmış bir hizmet sorumlusu. Diğer ayrıntılar için bkz EnvironmentCredential .

  2. Ortam değişkeni yapılandırması Azure iş yükü kimliği web kancası tarafından ayarlandıysa WorkloadIdentityCredential.

  3. Azure yönetilen kimliği. Diğer ayrıntılar için bkz ManagedIdentityCredential .

  4. Yalnızca Windows'ta: Visual Studio gibi bir Microsoft uygulamasıyla oturum açmış bir kullanıcı. Önbellekte birden çok kimlik varsa, hangi kimliğin kullanılacağını seçmek için ortam değişkeninin AZURE_USERNAME değeri kullanılır. Diğer ayrıntılar için bkz SharedTokenCacheCredential .

  5. Şu anda Azure CLI'da oturum açmış olan kimlik.

  6. Şu anda Azure PowerShell oturum açmış olan kimlik.

  7. Şu anda Azure Developer CLI oturum açmış olan kimlik.

Bu varsayılan davranış anahtar sözcük bağımsız değişkenleriyle yapılandırılabilir.

Devralma
azure.identity._credentials.chained.ChainedTokenCredential
DefaultAzureCredential

Oluşturucu

DefaultAzureCredential(**kwargs: Any)

Parametreler

authority
str

Azure Active Directory uç noktasının yetkilisi, örneğin 'login.microsoftonline.com', Azure Genel Bulut yetkilisi (varsayılandır). AzureAuthorityHosts diğer bulutlar için yetkilileri tanımlar. Yönetilen kimlikler tek bir bulutta bulunduğundan bunu yoksayar.

exclude_workload_identity_credential
bool

İş yükü kimliğinin kimlik bilgilerinin dışında tutulup tutulmayacağı. Varsayılan değer False'tur.

exclude_developer_cli_credential
bool

Azure Developer CLI kimlik bilgilerinin dışında tutulup tutulmayacağı. Varsayılan değer False'tur.

exclude_cli_credential
bool

Azure CLI'nın kimlik bilgilerinin dışında tutulup tutulmayacağı. Varsayılan değer False'tur.

exclude_environment_credential
bool

Ortam değişkenleri tarafından yapılandırılan bir hizmet sorumlusunun kimlik bilgilerinin dışında tutulup tutulmayacağı. Varsayılan değer False'tur.

exclude_managed_identity_credential
bool

Yönetilen kimliğin kimlik bilgilerinin dışında tutulup tutulmayacağı. Varsayılan değer False'tur.

exclude_powershell_credential
bool

Azure PowerShell dışlanıp dışlanmayacağını. Varsayılan değer False'tur.

exclude_visual_studio_code_credential
bool

Depolanan kimlik bilgilerinin VS Code'dan dışlanıp dışlanmayacağı. Varsayılan değer True'dır.

exclude_shared_token_cache_credential
bool

Paylaşılan belirteç önbelleğinin dışlanıp dışlanmayacağı. Varsayılan değer False'tur.

exclude_interactive_browser_credential
bool

Etkileşimli tarayıcı kimlik doğrulamasını dışlayıp dışlamayacağınız (bkz InteractiveBrowserCredential. ). Varsayılan değer True'dır.

interactive_browser_tenant_id
str

aracılığıyla InteractiveBrowserCredentialkullanıcının kimliğini doğrularken kullanılacak kiracı kimliği. Varsa, ortam değişkeninin değerini varsayılan olarak AZURE_TENANT_ID. Belirtilmezse, kullanıcılar kendi ev kiracılarında kimlik doğrulaması yapar.

managed_identity_client_id
str

Kullanıcı tarafından atanan yönetilen kimliğin istemci kimliği. Varsa, AZURE_CLIENT_ID ortam değişkeninin değerini varsayılan olarak kullanır. Belirtilmezse, sistem tarafından atanan bir kimlik kullanılır.

workload_identity_client_id
str

Pod'a atanan kimliğin istemci kimliği. Varsa, AZURE_CLIENT_ID ortam değişkeninin değerini varsayılan olarak kullanır. Belirtilmezse pod'un varsayılan kimliği kullanılır.

workload_identity_tenant_id
str

için WorkloadIdentityCredentialtercih edilen kiracı. Varsa, ortam değişkeninin değerini varsayılan olarak AZURE_TENANT_ID.

interactive_browser_client_id
str

Etkileşimli tarayıcı kimlik bilgileri içinde kullanılacak istemci kimliği. Belirtilmezse, kullanıcılar bir Azure geliştirme uygulamasında kimlik doğrulaması yapar.

shared_cache_username
str

için SharedTokenCacheCredentialtercih edilen kullanıcı adı. Varsa, AZURE_USERNAME ortam değişkeninin değerini varsayılan olarak kullanır.

shared_cache_tenant_id
str

için SharedTokenCacheCredentialtercih edilen kiracı. Varsa, ortam değişkeninin değerini varsayılan olarak AZURE_TENANT_ID.

visual_studio_code_tenant_id
str

ile VisualStudioCodeCredentialkimlik doğrulaması yaparken kullanılacak kiracı kimliği. Varsayılan olarak VS Code'un kullanıcı ayarlarında "Azure: Kiracı" ayarı kullanılır veya bu ayarın değeri olmadığında yalnızca Azure Active Directory iş veya okul hesaplarını destekleyen "kuruluşlar" kiracısı kullanılır.

process_timeout
int

Alt işlemleri (örneğin AzureCliCredential, AzurePowerShellCredential) çalıştıran geliştirici kimlik bilgileri için kullanılacak saniye olarak zaman aşımı. Varsayılan değer 10 saniyedir.

Örnekler

DefaultAzureCredential oluşturun.


   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

Yöntemler

close

Zincirdeki her kimlik bilgilerinin aktarım oturumunu kapatın.
get_token

Kapsamlar için erişim belirteci isteyin.

Bu yöntem Azure SDK istemcileri tarafından otomatik olarak çağrılır.

close

Zincirdeki her kimlik bilgilerinin aktarım oturumunu kapatın.

close() -> None

get_token

Kapsamlar için erişim belirteci isteyin.

Bu yöntem Azure SDK istemcileri tarafından otomatik olarak çağrılır.

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

Parametreler

scopes
str
Gerekli

erişim belirteci için istenen kapsamlar. Bu yöntem en az bir kapsam gerektirir. Kapsamlar hakkında daha fazla bilgi için bkz https://video2.skills-academy.com/azure/active-directory/develop/scopes-oidc. .

claims
str

bir yetkilendirme hatasından sonra bir kaynak sağlayıcısının talep sınamasında döndürülenler gibi belirteçte gerekli olan ek talepler.

tenant_id
str

belirteci isteğine dahil etmek için isteğe bağlı kiracı.

Döndürülenler

İstenen kapsamlara sahip bir erişim belirteci.

Dönüş türü

AccessToken

Özel durumlar

ClientAuthenticationError

kimlik doğrulaması başarısız oldu. Özel durum, her kimlik doğrulama girişimini ve hata iletisini listeleyen bir ileti özniteliğine sahiptir.