ClientSecretCredential Klasa

Uwierzytelnia się jako jednostka usługi przy użyciu klucza tajnego klienta.

Dziedziczenie

azure.identity._internal.client_credential_base.ClientCredentialBase

ClientSecretCredential

Konstruktor

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

Parametry

tenant_id

str

Wymagane

Identyfikator dzierżawy jednostki usługi. Nazwany również identyfikatorem "katalogu".

client_id

str

Wymagane

Identyfikator klienta jednostki usługi

client_secret

str

Wymagane

Jeden z wpisów tajnych klienta jednostki usługi

authority

str

Urząd punktu końcowego usługi Azure Active Directory, na przykład "login.microsoftonline.com", urząd dla chmury publicznej platformy Azure (który jest domyślny). AzureAuthorityHosts definiuje władze dla innych chmur.

cache_persistence_options

TokenCachePersistenceOptions

Konfiguracja trwałego buforowania tokenów. Jeśli nie zostanie określona, poświadczenie będzie buforowane tokeny w pamięci.

disable_instance_discovery

bool

Określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie wartości true spowoduje całkowite wyłączenie weryfikacji odnajdywania wystąpień i urzędu. Ta funkcja jest przeznaczona do użycia w scenariuszach, w których nie można uzyskać dostępu do punktu końcowego metadanych, na przykład w chmurach prywatnych lub usłudze Azure Stack. Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ programu w celu zweryfikowania urzędu. Ustawiając wartość True, walidacja urzędu jest wyłączona. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania.

additionally_allowed_tenants

List[str]

Określa dzierżawy oprócz określonego "tenant_id", dla którego poświadczenia mogą uzyskać tokeny. Dodaj wartość symbolu wieloznakowego "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy, do których aplikacja może uzyskiwać dostęp.

Przykłady

Utwórz element ClientSecretCredential.

   from azure.identity import ClientSecretCredential

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

Metody

close
get_token	Żądanie tokenu dostępu dla zakresów. Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK.

close

close() -> None

get_token

Żądanie tokenu dostępu dla zakresów.

Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK.

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

Parametry

scopes

str

Wymagane

żądane zakresy tokenu dostępu. Ta metoda wymaga co najmniej jednego zakresu. Aby uzyskać więcej informacji na temat zakresów, zobacz https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

dodatkowe oświadczenia wymagane w tokenie, takie jak te zwrócone w żądaniu dostawcy zasobów wyzwanie po niepowodzeniu autoryzacji.

tenant_id

str

opcjonalna dzierżawa do uwzględnienia w żądaniu tokenu.

enable_cae

bool

wskazuje, czy włączyć ciągłą ocenę dostępu (CAE) dla żądanego tokenu. Wartość domyślna to False.

Zwraca

Token dostępu z żądanymi zakresami.

Typ zwracany

AccessToken

Wyjątki

CredentialUnavailableError

poświadczenie nie może podjąć próby uwierzytelnienia, ponieważ brakuje wymaganych danych, stanu lub obsługi platformy

ClientAuthenticationError

uwierzytelnianie nie powiodło się. Atrybut błędu message podaje przyczynę.