AzureCliCredentials class

Pacote:

@azure/ms-rest-nodeauth

Descreve as credenciais recuperando o token por meio da CLI do Azure.

Construtores

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

Propriedades

resource	Pontos de extremidade de recursos do Azure. Usa como padrão o Azure Resource Manager do ambiente: AzureCloud. "https://management.azure.com" Para o Azure KeyVault: "https://vault.azure.net" Para o Lote do Azure: "https://batch.core.windows.net" Para o Azure Active Directory Graph: "https://graph.windows.net" Para obter o recurso para outras nuvens: az cloud list
subscriptionInfo	Fornece informações sobre a assinatura padrão/atual da CLI do Azure.
tokenInfo	Fornece informações sobre o token de acesso para a assinatura correspondente da CLI do Azure.

Métodos

create(AccessTokenOptions)	Fornece credenciais que podem ser usadas pelo SDK do JS para interagir com o Azure por meio da CLI do Azure. pré-requisito instalar o azure-cli . Para obter mais informações, consulte Instalar a CLI do Azure logon via az login
getAccessToken(AccessTokenOptions)	Obtém o token de acesso para a assinatura padrão ou especificada.
getSubscription(string)	Obtém a assinatura da CLI do Azure.
getToken()	Tenta obter o novo token da CLI do Azure, se o token tiver expirado ou a assinatura tiver sido alterada, use o accessToken armazenado em cache.
listAllSubscriptions(ListAllSubscriptionOptions)	Retorna uma lista de todas as assinaturas da CLI do Azure.
setDefaultSubscription(string)	Define a assinatura especificada como a assinatura padrão da CLI do Azure.
signRequest(WebResource)	Assina uma solicitação com o cabeçalho autenticação.

Detalhes do construtor

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

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

Parâmetros

subscriptionInfo

LinkedSubscription

tokenInfo

CliAccessToken

resource

string

Detalhes da propriedade

resource

Pontos de extremidade de recursos do Azure.

• Usa como padrão o Azure Resource Manager do ambiente: AzureCloud. "https://management.azure.com"
• Para o Azure KeyVault: "https://vault.azure.net"
• Para o Lote do Azure: "https://batch.core.windows.net"
• Para o Azure Active Directory Graph: "https://graph.windows.net"

Para obter o recurso para outras nuvens:

• az cloud list

resource: string

Valor da propriedade

string

subscriptionInfo

Fornece informações sobre a assinatura padrão/atual da CLI do Azure.

subscriptionInfo: LinkedSubscription

Valor da propriedade

LinkedSubscription

tokenInfo

Fornece informações sobre o token de acesso para a assinatura correspondente da CLI do Azure.

tokenInfo: CliAccessToken

Valor da propriedade

CliAccessToken

Detalhes do método

create(AccessTokenOptions)

Fornece credenciais que podem ser usadas pelo SDK do JS para interagir com o Azure por meio da CLI do Azure. pré-requisito

• instalar o azure-cli . Para obter mais informações, consulte Instalar a CLI do Azure
• logon via az login

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

Parâmetros

options

AccessTokenOptions

Parâmetros opcionais que podem ser fornecidos durante a criação de AzureCliCredentials.

Retornos

Promise<AzureCliCredentials>

getAccessToken(AccessTokenOptions)

Obtém o token de acesso para a assinatura padrão ou especificada.

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

Parâmetros

options

AccessTokenOptions

Parâmetros opcionais que podem ser fornecidos para obter o token de acesso.

Retornos

Promise<CliAccessToken>

getSubscription(string)

Obtém a assinatura da CLI do Azure.

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

Parâmetros

subscriptionIdOrName

string

O nome ou a ID da assinatura para a qual as informações são necessárias.

Retornos

Promise<LinkedSubscription>

getToken()

Tenta obter o novo token da CLI do Azure, se o token tiver expirado ou a assinatura tiver sido alterada, use o accessToken armazenado em cache.

function getToken(): Promise<TokenResponse>

Retornos

Promise<TokenResponse>

O tokenResponse (tokenType e accessToken são as duas propriedades importantes).

listAllSubscriptions(ListAllSubscriptionOptions)

Retorna uma lista de todas as assinaturas da CLI do Azure.

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

Parâmetros

options

ListAllSubscriptionOptions

Parâmetros opcionais que podem ser fornecidos ao listar todas as subcrições.

Retornos

Promise<LinkedSubscription[]>

setDefaultSubscription(string)

Define a assinatura especificada como a assinatura padrão da CLI do Azure.

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

Parâmetros

subscriptionIdOrName

string

O nome ou a ID da subscipção que precisa ser definida como a assinatura padrão.

Retornos

Promise<void>

signRequest(WebResource)

Assina uma solicitação com o cabeçalho autenticação.

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

Parâmetros

webResource

WebResource

Retornos

Promise<WebResource>