DefaultAzureCredential Klas

Een standaardreferentie die de meeste Azure SDK-verificatiescenario's kan verwerken.

De identiteit die wordt gebruikt, is afhankelijk van de omgeving. Wanneer een toegangstoken nodig is, wordt er een aangevraagd met deze identiteiten en wordt gestopt wanneer er een token wordt verstrekt:

1. Een service-principal die is geconfigureerd door omgevingsvariabelen. Zie EnvironmentCredential voor meer informatie.

2. WorkloadIdentityCredential als de configuratie van de omgevingsvariabele is ingesteld door de webhook azure-workloadidentiteit.

3. Een door Azure beheerde identiteit. Zie ManagedIdentityCredential voor meer informatie.

4. Alleen in Windows: een gebruiker die zich heeft aangemeld met een Microsoft-toepassing, zoals Visual Studio. Als er meerdere identiteiten in de cache zijn, wordt de waarde van de omgevingsvariabele AZURE_USERNAME gebruikt om te selecteren welke identiteit moet worden gebruikt. Zie SharedTokenCacheCredential voor meer informatie.

5. De identiteit die momenteel is aangemeld bij de Azure CLI.

6. De identiteit die momenteel is aangemeld bij Azure PowerShell.

7. De identiteit die momenteel is aangemeld bij de Azure Developer CLI.

Dit standaardgedrag kan worden geconfigureerd met trefwoordargumenten.

Overname

azure.identity._credentials.chained.ChainedTokenCredential

DefaultAzureCredential

Constructor

DefaultAzureCredential(**kwargs: Any)

Parameters

authority

str

Instantie van een Azure Active Directory-eindpunt, bijvoorbeeld 'login.microsoftonline.com', de instantie voor de openbare Azure-cloud (dit is de standaardinstelling). AzureAuthorityHosts definieert instanties voor andere clouds. Beheerde identiteiten negeren dit omdat ze zich in één cloud bevinden.

exclude_workload_identity_credential

bool

Of de workloadidentiteit moet worden uitgesloten van de referentie. De standaardinstelling is False.

exclude_developer_cli_credential

bool

Of u de Azure Developer CLI wilt uitsluiten van de referentie. De standaardinstelling is False.

exclude_cli_credential

bool

Of u de Azure CLI wilt uitsluiten van de referentie. De standaardinstelling is False.

exclude_environment_credential

bool

Hiermee wordt aangegeven of een service-principal die is geconfigureerd door omgevingsvariabelen moet worden uitgesloten van de referentie. De standaardinstelling is False.

exclude_managed_identity_credential

bool

Of de beheerde identiteit moet worden uitgesloten van de referentie. De standaardinstelling is False.

exclude_powershell_credential

bool

Of u Azure PowerShell wilt uitsluiten. De standaardinstelling is False.

exclude_visual_studio_code_credential

bool

Of opgeslagen referenties moeten worden uitgesloten van VS Code. De standaardwaarde is True.

exclude_shared_token_cache_credential

bool

Of de gedeelde tokencache moet worden uitgesloten. De standaardinstelling is False.

exclude_interactive_browser_credential

bool

Of interactieve browserverificatie moet worden uitgesloten (zie InteractiveBrowserCredential). De standaardwaarde is True.

interactive_browser_tenant_id

str

Tenant-id die moet worden gebruikt bij het verifiëren van een gebruiker via InteractiveBrowserCredential. Standaard ingesteld op de waarde van omgevingsvariabele AZURE_TENANT_ID, indien van toepassing. Als dit niet wordt opgegeven, verifiëren gebruikers zich in hun thuistenant.

managed_identity_client_id

str

De client-id van een door de gebruiker toegewezen beheerde identiteit. Standaard ingesteld op de waarde van de omgevingsvariabele AZURE_CLIENT_ID, indien van toepassing. Als dit niet is opgegeven, wordt een door het systeem toegewezen identiteit gebruikt.

workload_identity_client_id

str

De client-id van een identiteit die is toegewezen aan de pod. Standaard ingesteld op de waarde van de omgevingsvariabele AZURE_CLIENT_ID, indien van toepassing. Als u dit niet opgeeft, wordt de standaardidentiteit van de pod gebruikt.

workload_identity_tenant_id

str

Voorkeurstenant voor WorkloadIdentityCredential. Standaard ingesteld op de waarde van omgevingsvariabele AZURE_TENANT_ID, indien van toepassing.

interactive_browser_client_id

str

De client-id die moet worden gebruikt in interactieve browserreferenties. Als dit niet is opgegeven, verifiëren gebruikers zich bij een Azure-ontwikkelingstoepassing.

shared_cache_username

str

Voorkeursgebruikersnaam voor SharedTokenCacheCredential. Standaard ingesteld op de waarde van omgevingsvariabele AZURE_USERNAME, indien van toepassing.

shared_cache_tenant_id

str

Voorkeurstenant voor SharedTokenCacheCredential. Standaard ingesteld op de waarde van omgevingsvariabele AZURE_TENANT_ID, indien van toepassing.

visual_studio_code_tenant_id

str

Tenant-id die moet worden gebruikt bij het verifiëren met VisualStudioCodeCredential. De standaardinstelling 'Azure: Tenant' in de gebruikersinstellingen van VS Code of, wanneer die instelling geen waarde heeft, de tenant 'organisaties', die alleen werk- of schoolaccounts van Azure Active Directory ondersteunt.

process_timeout

int

De time-out in seconden die moet worden gebruikt voor ontwikkelaarsreferenties die subprocessen uitvoeren (bijvoorbeeld AzureCliCredential, AzurePowerShellCredential). De standaardwaarde is 10 seconden.

Voorbeelden

Maak een DefaultAzureCredential.

   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

Methoden

close	Sluit de transportsessie van elke referentie in de keten.
get_token	Een toegangstoken aanvragen voor bereiken. Deze methode wordt automatisch aangeroepen door Azure SDK-clients.

close

Sluit de transportsessie van elke referentie in de keten.

close() -> None

get_token

Een toegangstoken aanvragen voor bereiken.

Deze methode wordt automatisch aangeroepen door Azure SDK-clients.

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

Parameters

scopes

str

Vereist

gewenste bereiken voor het toegangstoken. Voor deze methode is ten minste één bereik vereist. Zie voor meer informatie over bereiken https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

aanvullende claims die zijn vereist in het token, zoals de claims die worden geretourneerd in de claimvraag van een resourceprovider na een autorisatiefout.

tenant_id

str

optionele tenant die moet worden opgenomen in de tokenaanvraag.

Retouren

Een toegangstoken met de gewenste bereiken.

Retourtype

AccessToken

Uitzonderingen

ClientAuthenticationError

verificatie is mislukt. De uitzondering heeft een berichtkenmerk met elke verificatiepoging en het bijbehorende foutbericht.