VisualStudioCodeCredential Class
Authenticates as the Azure user signed in to Visual Studio Code via the 'Azure Resources' extension.
This currently only works in Windows/WSL environments and requires the 'azure-identity-broker' package to be installed.
Constructor
VisualStudioCodeCredential(**kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
tenant_id
|
A Microsoft Entra tenant ID. Defaults to the tenant specified in the authentication record file used by the Azure Resources extension. |
|
additionally_allowed_tenants
|
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. |
| get_token_info |
Request an access token for scopes as the user currently signed in to Visual Studio Code. This is an alternative to get_token to enable certain scenarios that require additional properties on the token. This method is called automatically by Azure SDK clients. |
close
Close the credential's transport session.
close() -> Noneget_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) -> AccessTokenParameters
| Name | Description |
|---|---|
|
scopes
Required
|
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
|
additional claims required in the token, such as those returned in a resource provider's claims challenge following an authorization failure. Default value: None
|
|
tenant_id
|
optional tenant to include in the token request. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An access token with the desired scopes. |
Exceptions
| Type | Description |
|---|---|
|
the credential cannot retrieve user details from Visual Studio Code |
get_token_info
Request an access token for scopes as the user currently signed in to Visual Studio Code.
This is an alternative to get_token to enable certain scenarios that require additional properties on the token. This method is called automatically by Azure SDK clients.
get_token_info(*scopes: str, options: TokenRequestOptions | None = None) -> AccessTokenInfoParameters
| Name | Description |
|---|---|
|
scopes
Required
|
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 |
|---|---|
|
options
|
A dictionary of options for the token request. Unknown options will be ignored. Optional. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An AccessTokenInfo instance containing information about the token. |
Exceptions
| Type | Description |
|---|---|
|
the credential cannot retrieve user details from Visual Studio Code. |
