你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

VisualStudioCodeCredential 类

通过“Azure 帐户”扩展登录到Visual Studio Code的 Azure 用户进行身份验证。

这是一个已知问题,即此凭据不适用于 0.9.11 以上的 Azure 帐户扩展版本。 正在对此问题进行长期修复。 同时,请考虑使用 AzureCliCredential进行身份验证。

继承
azure.identity._credentials.vscode._VSCodeCredentialBase
VisualStudioCodeCredential
azure.identity._internal.get_token_mixin.GetTokenMixin
VisualStudioCodeCredential

构造函数

VisualStudioCodeCredential(**kwargs: Any)

参数

authority
str

Azure Active Directory 终结点的颁发机构,例如“login.microsoftonline.com”。 自定义云需要此参数,否则通常不需要此参数。 默认为与 VS Code 用户设置中的“Azure:云”设置匹配的颁发机构,或者当该设置没有值时,则为 Azure 公有云的颁发机构。

tenant_id
str

凭据应在其中进行身份验证的租户的 ID。 默认情况下为 VS Code 的用户设置中的“Azure:租户”设置,或者,当该设置没有值时,则为仅支持 Azure Active Directory 工作或学校帐户的“组织”租户。

additionally_allowed_tenants
List[str]

除了指定凭据可能为其获取令牌的指定“tenant_id”之外,还指定租户。 添加通配符值“*”以允许凭据获取应用程序可以访问的任何租户的令牌。

方法

close

关闭凭据的传输会话。

get_token

当用户当前登录到 Visual Studio Code 时,请求范围的访问令牌。

Azure SDK 客户端会自动调用此方法。

close

关闭凭据的传输会话。

close() -> None

get_token

当用户当前登录到 Visual Studio Code 时,请求范围的访问令牌。

Azure SDK 客户端会自动调用此方法。

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

参数

scopes
str
必需

访问令牌的所需范围。 此方法至少需要一个范围。 有关范围的详细信息,请参阅 https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc

claims
str

令牌中所需的其他声明,例如授权失败后资源提供程序的声明质询中返回的声明。

tenant_id
str

要包含在令牌请求中的可选租户。

返回

具有所需范围的访问令牌。

返回类型

例外

凭据无法从Visual Studio Code检索用户详细信息