AzureDeveloperCliCredential Klass

Autentiserar genom att begära en token från Azure Developer CLI.

Azure Developer CLI är ett kommandoradsgränssnittsverktyg som gör att utvecklare kan skapa, hantera och distribuera resurser i Azure. Den bygger på Azure CLI och ger ytterligare funktioner som är specifika för Azure-utvecklare. Det gör att användare kan autentisera sig som en användare och/eller ett tjänsthuvudnamn mot Azure Active Directory (Azure AD). AzureDeveloperCliCredential autentiseras i en utvecklingsmiljö och hämtar en token för den inloggade användaren eller tjänstens huvudnamn i Azure Developer CLI. Den fungerar som den Azure Developer CLI inloggade användaren eller tjänstens huvudnamn och kör ett Azure CLI-kommando under för att autentisera programmet mot Azure Active Directory.

Om du vill använda den här autentiseringsuppgiften måste utvecklaren autentisera lokalt i Azure Developer CLI med något av kommandona nedan:

• Kör "azd auth login" i Azure Developer CLI för att autentisera interaktivt som användare.

• Kör "azd auth login –client-id 'client_id' –client-secret 'client_secret' -tenant-id 'tenant_id'" för att autentisera som tjänstens huvudnamn.

Du kan behöva upprepa den här processen efter en viss tidsperiod, beroende på giltigheten för uppdateringstoken i din organisation. I allmänhet är giltighetsperioden för uppdateringstoken några veckor till några månader. AzureDeveloperCliCredential uppmanar dig att logga in igen.

Arv

builtins.object

AzureDeveloperCliCredential

Konstruktor

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

Parametrar

tenant_id

str

Valfri klientorganisation som ska ingå i tokenbegäran.

additionally_allowed_tenants

List[str]

Anger klientorganisationer utöver den angivna "tenant_id" som autentiseringsuppgifterna kan hämta token för. Lägg till jokertecknet "*" så att autentiseringsuppgifterna kan hämta token för alla klienter som programmet kan komma åt.

process_timeout

int

Sekunder att vänta på att Azure Developer CLI processen ska svara. Standardvärdet är 10 sekunder.

Exempel

Skapa en AzureDeveloperCliCredential.

   from azure.identity import AzureDeveloperCliCredential

   credential = AzureDeveloperCliCredential()

Metoder

close	Det är inte nödvändigt att anropa den här metoden.
get_token	Begär en åtkomsttoken för omfång. Den här metoden anropas automatiskt av Azure SDK-klienter. Program som anropar den här metoden direkt måste också hantera tokencachelagring eftersom den här autentiseringsuppgiften inte cachelagrar de token som hämtas.

close

Det är inte nödvändigt att anropa den här metoden.

close() -> None

get_token

Begär en åtkomsttoken för omfång.

Den här metoden anropas automatiskt av Azure SDK-klienter. Program som anropar den här metoden direkt måste också hantera tokencachelagring eftersom den här autentiseringsuppgiften inte cachelagrar de token som hämtas.

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

Parametrar

scopes

str

Obligatorisk

önskat omfång för åtkomsttoken. Den här autentiseringsuppgiften tillåter endast ett omfång per begäran. Mer information om omfång finns i https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

används inte av denna autentiseringsuppgift; alla angivna värden ignoreras.

tenant_id

str

valfri klientorganisation som ska ingå i tokenbegäran.

Returer

En åtkomsttoken med önskade omfång.

Returtyp

AccessToken

Undantag

CredentialUnavailableError

autentiseringsuppgiften kunde inte anropa Azure Developer CLI.

ClientAuthenticationError

autentiseringsuppgiften anropade Azure Developer CLI men tog inte emot en åtkomsttoken.