Udostępnij za pośrednictwem

AzureCliCredential Klasa

  • Odwołanie

Uwierzytelnia się, żądając tokenu z interfejsu wiersza polecenia platformy Azure.

Wymaga to wcześniejszego zalogowania się na platformie Azure za pomocą polecenia "az login" i będzie używać aktualnie zalogowanego identyfikatora interfejsu wiersza polecenia.

Dziedziczenie
builtins.object
AzureCliCredential

Konstruktor

AzureCliCredential(*, tenant_id: str = '', additionally_allowed_tenants: List[str] | None = None, process_timeout: int = 10)

Parametry

tenant_id
str

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

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.

process_timeout
int

Sekundy oczekiwania na odpowiedź procesu interfejsu wiersza polecenia platformy Azure. Wartość domyślna to 10 sekund.

Przykłady

Utwórz obiekt AzureCliCredential.


   from azure.identity import AzureCliCredential

   credential = AzureCliCredential()

Metody

close

Wywoływanie tej metody jest niepotrzebne.
get_token

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

Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK. Aplikacje wywołujące tę metodę muszą również obsługiwać buforowanie tokenów, ponieważ to poświadczenie nie buforuje tokenów, które uzyskuje.

close

Wywoływanie tej metody jest niepotrzebne.

close() -> None

get_token

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

Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK. Aplikacje wywołujące tę metodę muszą również obsługiwać buforowanie tokenów, ponieważ to poświadczenie nie buforuje tokenów, które uzyskuje.

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

Parametry

scopes
str
Wymagane

żądany zakres tokenu dostępu. To poświadczenie zezwala tylko na jeden zakres na żądanie. Aby uzyskać więcej informacji na temat zakresów, zobacz https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

nieużytowane przez to poświadczenie; każda podana wartość zostanie zignorowana.

tenant_id
str

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

Zwraca

Token dostępu z żądanymi zakresami.

Typ zwracany

AccessToken

Wyjątki

CredentialUnavailableError

poświadczenie nie mogło wywołać interfejsu wiersza polecenia platformy Azure.

ClientAuthenticationError

poświadczenie wywołało interfejs wiersza polecenia platformy Azure, ale nie otrzymało tokenu dostępu.