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

AzureCliCredentials class

包:: @azure/ms-rest-nodeauth

通过 Azure CLI 检索令牌来描述凭据。

构造函数

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

属性

resource

Azure 资源终结点。

默认为环境中的 Azure 资源管理器：AzureCloud。 “https://management.azure.com"
对于 Azure KeyVault：“https://vault.azure.net"
对于 Azure Batch：“https://batch.core.windows.net"
对于 Azure Active Directory Graph：“https://graph.windows.net"

若要获取其他云的资源，请执行以下作：

az cloud list

subscriptionInfo

提供有关 Azure CLI 的默认/当前订阅的信息。

tokenInfo

提供有关 Azure CLI 相应订阅的访问令牌的信息。

方法

create(AccessTokenOptions)	提供 JS SDK 可用于通过 Azure cli 与 Azure 交互的凭据。先决条件安装 azure-cli。有关详细信息，请参阅安装 Azure CLI 通过 `az login` 登录
getAccessToken(AccessTokenOptions)	获取默认订阅或指定订阅的访问令牌。
getSubscription(string)	从 Azure CLI 获取订阅。
getToken()	如果令牌已过期或订阅已更改，则尝试从 Azure CLI 获取新令牌，否则会使用缓存的 accessToken。
listAllSubscriptions(ListAllSubscriptionOptions)	返回 Azure CLI 中所有订阅的列表。
setDefaultSubscription(string)	将指定的订阅设置为 Azure CLI 的默认订阅。
signRequest(WebResource)	使用身份验证标头对请求进行签名。

构造函数详细信息

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

new AzureCliCredentials(subscriptionInfo: LinkedSubscription, tokenInfo: CliAccessToken, resource?: string)

参数

subscriptionInfo: LinkedSubscription

tokenInfo: CliAccessToken

resource: string

属性详细信息

resource

Azure 资源终结点。

默认为环境中的 Azure 资源管理器：AzureCloud。 “https://management.azure.com"
对于 Azure KeyVault：“https://vault.azure.net"
对于 Azure Batch：“https://batch.core.windows.net"
对于 Azure Active Directory Graph：“https://graph.windows.net"

若要获取其他云的资源，请执行以下作：

az cloud list

resource: string

属性值

string

subscriptionInfo

提供有关 Azure CLI 的默认/当前订阅的信息。

subscriptionInfo: LinkedSubscription

属性值

LinkedSubscription

tokenInfo

提供有关 Azure CLI 相应订阅的访问令牌的信息。

tokenInfo: CliAccessToken

属性值

CliAccessToken

方法详细信息

create(AccessTokenOptions)

提供 JS SDK 可用于通过 Azure cli 与 Azure 交互的凭据。 先决条件

安装 azure-cli。有关详细信息，请参阅安装 Azure CLI
通过 az login 登录

static function create(options?: AccessTokenOptions): Promise<AzureCliCredentials>

参数

options: AccessTokenOptions

创建 AzureCliCredentials 时可以提供的可选参数。

Promise<AzureCliCredentials>

getAccessToken(AccessTokenOptions)

获取默认订阅或指定订阅的访问令牌。

static function getAccessToken(options?: AccessTokenOptions): Promise<CliAccessToken>

参数

options: AccessTokenOptions

提供用于获取访问令牌的可选参数。

Promise<CliAccessToken>

getSubscription(string)

从 Azure CLI 获取订阅。

static function getSubscription(subscriptionIdOrName?: string): Promise<LinkedSubscription>

参数

subscriptionIdOrName: string

需要其信息的订阅的名称或 ID。

Promise<LinkedSubscription>

getToken()

如果令牌已过期或订阅已更改，则尝试从 Azure CLI 获取新令牌，否则会使用缓存的 accessToken。

function getToken(): Promise<TokenResponse>

Promise<TokenResponse>

tokenResponse （tokenType 和 accessToken 是两个重要属性）。

listAllSubscriptions(ListAllSubscriptionOptions)

返回 Azure CLI 中所有订阅的列表。

static function listAllSubscriptions(options?: ListAllSubscriptionOptions): Promise<LinkedSubscription[]>

参数

options: ListAllSubscriptionOptions

列出所有子项时可以提供的可选参数。

Promise<LinkedSubscription[]>

setDefaultSubscription(string)

将指定的订阅设置为 Azure CLI 的默认订阅。

static function setDefaultSubscription(subscriptionIdOrName: string): Promise<void>

参数

subscriptionIdOrName: string

需要设置为默认订阅的子密码的名称或 ID。

Promise<void>

signRequest(WebResource)

使用身份验证标头对请求进行签名。

function signRequest(webResource: WebResource): Promise<WebResource>

参数

webResource: WebResource

Promise<WebResource>