Aracılığıyla paylaş

CertificateCredential Sınıf

  • Başvuru

Sertifika kullanarak hizmet sorumlusu olarak kimlik doğrulaması yapar.

Bu kimlik bilgisi RS256 kullanarak onaylamaları imzalar çünkü sertifikanın bir RSA özel anahtarı olmalıdır. Sertifika kimlik doğrulamasını yapılandırma hakkında daha fazla bilgi için bkz. Azure Active Directory belgeleri .

Devralma
azure.identity._internal.client_credential_base.ClientCredentialBase
CertificateCredential

Oluşturucu

CertificateCredential(tenant_id: str, client_id: str, certificate_path: str | None = None, **kwargs: Any)

Parametreler

tenant_id
str
Gerekli

Hizmet sorumlusunun kiracısının kimliği. "Dizin" kimliği olarak da adlandırılır.

client_id
str
Gerekli

Hizmet sorumlusunun istemci kimliği

certificate_path
str
varsayılan değer: None

Özel anahtar da dahil olmak üzere PEM veya PKCS12 biçimindeki bir sertifika dosyasının isteğe bağlı yolu. Sağlanmadıysa certificate_data gereklidir.

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.

certificate_data
bytes

Özel anahtar da dahil olmak üzere PEM veya PKCS12 biçimindeki bir sertifikanın baytları

password
str veya bytes

Sertifikanın parolası. Unicode dizesi ise UTF-8 olarak kodlanır. Sertifika farklı bir kodlama gerektiriyorsa, bunun yerine uygun şekilde kodlanmış baytları geçirin.

send_certificate_chain
bool

True ise, kimlik bilgisi her belirteç isteğinin JWT'sinin x5c üst bilgisinde genel sertifika zincirini gönderir. Bu, Konu Adı/Veren (SNI) kimlik doğrulaması için gereklidir. Varsayılan değer False'tur.

cache_persistence_options
TokenCachePersistenceOptions

Kalıcı belirteç önbelleğe alma yapılandırması. Belirtilmezse, kimlik bilgisi belirteçleri bellekte önbelleğe alır.

disable_instance_discovery
bool

Kimlik doğrulaması denenirken örnek bulma işleminin gerçekleştirilip gerçekleştirilmeyeceğini belirler. Bunu true olarak ayarlamak hem örnek bulma hem de yetkili doğrulamayı tamamen devre dışı bırakır. Bu işlevsellik, meta veri uç noktasına erişilemeyen özel bulutlar veya Azure Stack gibi senaryolarda kullanılmak üzere tasarlanmıştır. Örnek bulma işlemi, yetkiliyi doğrulamak için yetkili meta verilerinin 'den https://login.microsoft.com/ alınmasını gerektirir. Bunu True olarak ayarladığınızda, yetkilinin doğrulaması devre dışı bırakılır. Sonuç olarak, yapılandırılan yetkili konağın geçerli ve güvenilir olduğundan emin olmak çok önemlidir.

additionally_allowed_tenants
List[str]

Kimlik bilgilerinin belirteçleri edinebileceği belirtilen "tenant_id" ek olarak kiracıları belirtir. Kimlik bilgilerinin uygulamanın erişebileceği herhangi bir kiracı için belirteç almasına izin vermek için "*" joker karakter değerini ekleyin.

Örnekler

CertificateCredential oluşturun.


   from azure.identity import CertificateCredential

   credential = CertificateCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       certificate_path="<path to PEM/PKCS12 certificate>",
       password="<certificate password if necessary>",
   )

   # Certificate/private key byte data can also be passed directly
   credential = CertificateCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       certificate_data=b"<cert data>",
   )

Yöntemler

close
get_token

Kapsamlar için erişim belirteci isteyin.

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

close 

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://learn.microsoft.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ı.

enable_cae
bool

, istenen belirteç için Sürekli Erişim Değerlendirmesi'nin (CAE) etkinleştirilip etkinleştirilmeydiğini gösterir. Varsayılan değer False'tur.

Döndürülenler

İstenen kapsamlara sahip bir erişim belirteci.

Dönüş türü

AccessToken

Özel durumlar

CredentialUnavailableError

gerekli veri, durum veya platform desteği olmadığından kimlik doğrulaması denenemiyor

ClientAuthenticationError

kimlik doğrulaması başarısız oldu. Hatanın message özniteliği bir neden verir.