ClientSecretCredential Sınıf

  • Başvuru

İstemci gizli dizisi kullanarak hizmet sorumlusu olarak kimlik doğrulaması yapar.

Devralma
azure.identity._internal.client_credential_base.ClientCredentialBase
ClientSecretCredential

Oluşturucu

ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **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

client_secret
str
Gerekli

Hizmet sorumlusunun istemci gizli dizilerinden biri

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.

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

ClientSecretCredential oluşturun.


   from azure.identity import ClientSecretCredential

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

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

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.