VisualStudioCodeCredential Class

Authenticates as the Azure user signed in to Visual Studio Code via the 'Azure Account' extension.

It's a known issue that this credential doesn't work with Azure Account extension versions newer than 0.9.11. A long-term fix to this problem is in progress. In the meantime, consider authenticating with AzureCliCredential.

Inheritance

azure.identity._credentials.vscode._VSCodeCredentialBase

VisualStudioCodeCredential

azure.identity._internal.get_token_mixin.GetTokenMixin

VisualStudioCodeCredential

Constructor

VisualStudioCodeCredential(**kwargs: Any)

Keyword-Only Parameters

Name	Description
authority	str Authority of a Microsoft Entra endpoint, for example "login.microsoftonline.com". This argument is required for a custom cloud and usually unnecessary otherwise. Defaults to the authority matching the "Azure: Cloud" setting in VS Code's user settings or, when that setting has no value, the authority for Azure Public Cloud.
tenant_id	str ID of the tenant the credential should authenticate in. Defaults to the "Azure: Tenant" setting in VS Code's user settings or, when that setting has no value, the "organizations" tenant, which supports only Microsoft Entra work or school accounts.
additionally_allowed_tenants	List[str] Specifies tenants in addition to the specified "tenant_id" for which the credential may acquire tokens. Add the wildcard value "*" to allow the credential to acquire tokens for any tenant the application can access.

Methods

close	Close the credential's transport session.
get_token	Request an access token for scopes as the user currently signed in to Visual Studio Code. This method is called automatically by Azure SDK clients.

close

Close the credential's transport session.

close() -> None

get_token

Request an access token for scopes as the user currently signed in to Visual Studio Code.

This method is called automatically by Azure SDK clients.

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

Parameters

Name	Description
scopes Required	str desired scopes for the access token. This method requires at least one scope. For more information about scopes, see https://learn.microsoft.com/entra/identity-platform/scopes-oidc.

Keyword-Only Parameters

Name	Description
claims	str additional claims required in the token, such as those returned in a resource provider's claims challenge following an authorization failure.
tenant_id	str optional tenant to include in the token request.

Returns

Type	Description
AccessToken	An access token with the desired scopes.

Exceptions

Type	Description
CredentialUnavailableError	the credential cannot retrieve user details from Visual Studio Code