AzureDeveloperCliCredential Klasa

Uwierzytelnia się, żądając tokenu z Azure Developer CLI.

Azure Developer CLI to narzędzie interfejsu wiersza polecenia, które umożliwia deweloperom tworzenie i wdrażanie zasobów na platformie Azure oraz zarządzanie nimi. Jest ona oparta na interfejsie wiersza polecenia platformy Azure i udostępnia dodatkowe funkcje specyficzne dla deweloperów platformy Azure. Umożliwia ona użytkownikom uwierzytelnianie się jako użytkownik i/lub jednostka usługi w usłudze Azure Active Directory (Azure AD). Usługa AzureDeveloperCliCredential uwierzytelnia się w środowisku deweloperskim i uzyskuje token w imieniu zalogowanego użytkownika lub jednostki usługi w Azure Developer CLI. Działa on jako Azure Developer CLI zalogowany użytkownik lub jednostka usługi i wykonuje poniżej polecenie interfejsu wiersza polecenia platformy Azure w celu uwierzytelnienia aplikacji w usłudze Azure Active Directory.

Aby użyć tego poświadczenia, deweloper musi uwierzytelnić się lokalnie w Azure Developer CLI przy użyciu jednego z poniższych poleceń:

• Uruchom polecenie "azd auth login" w Azure Developer CLI, aby uwierzytelnić się interaktywnie jako użytkownik.

• Uruchom polecenie "azd auth login –client-id 'client_id' –client-secret 'client_secret' –tenant-id 'tenant_id'" w celu uwierzytelnienia się jako jednostka usługi.

Może być konieczne powtórzenie tego procesu po określonym czasie, w zależności od ważności tokenu odświeżania w organizacji. Zazwyczaj okres ważności tokenu odświeżania wynosi od kilku tygodni do kilku miesięcy. Polecenie AzureDeveloperCliCredential wyświetli monit o ponowne zalogowanie się.

Dziedziczenie

builtins.object

AzureDeveloperCliCredential

Konstruktor

AzureDeveloperCliCredential(*, 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 Azure Developer CLI. Wartość domyślna to 10 sekund.

Przykłady

Utwórz obiekt AzureDeveloperCliCredential.

   from azure.identity import AzureDeveloperCliCredential

   credential = AzureDeveloperCliCredential()

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ć Azure Developer CLI.

ClientAuthenticationError

poświadczenie wywołało Azure Developer CLI, ale nie otrzymało tokenu dostępu.