AzureCliCredentials class

Pacote:

@azure/ms-rest-nodeauth

Descreve as credenciais ao obter o token através da CLI do Azure.

Construtores

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

Propriedades

resource	Pontos finais de recursos do Azure. A predefinição é a Resource Manager do Azure a partir do ambiente: AzureCloud. "https://management.azure.com" Para o Azure KeyVault: "https://vault.azure.net" Para Azure Batch: "https://batch.core.windows.net" Para o Azure Active Directory Graph: "https://graph.windows.net" Para obter o recurso para outras clouds: az cloud list
subscriptionInfo	Fornece informações sobre a subscrição predefinida/atual da CLI do Azure.
tokenInfo	Fornece informações sobre o token de acesso para a subscrição correspondente para a CLI do Azure.

Métodos

create(AccessTokenOptions)	Fornece credenciais que podem ser utilizadas pelo SDK JS para interagir com o Azure através da CLI do Azure. Pré-requisito instalar azure-cli . Para obter mais informações, veja Instalar a CLI do Azure iniciar sessão via az login
getAccessToken(AccessTokenOptions)	Obtém o token de acesso para a subscrição predefinida ou especificada.
getSubscription(string)	Obtém a subscrição da CLI do Azure.
getToken()	Tenta obter o novo token da CLI do Azure se o token tiver expirado ou se a subscrição tiver sido alterada. Caso contrário, utiliza o accessToken em cache.
listAllSubscriptions(ListAllSubscriptionOptions)	Devolve uma lista de todas as subscrições da CLI do Azure.
setDefaultSubscription(string)	Define a subscrição especificada como a subscrição predefinida da CLI do Azure.
signRequest(WebResource)	Assina um pedido 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 de Propriedade

resource

Pontos finais de recursos do Azure.

• A predefinição é a Resource Manager do Azure a partir do ambiente: AzureCloud. "https://management.azure.com"
• Para o Azure KeyVault: "https://vault.azure.net"
• Para Azure Batch: "https://batch.core.windows.net"
• Para o Azure Active Directory Graph: "https://graph.windows.net"

Para obter o recurso para outras clouds:

• az cloud list

resource: string

Valor de Propriedade

string

subscriptionInfo

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

subscriptionInfo: LinkedSubscription

Valor de Propriedade

LinkedSubscription

tokenInfo

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

tokenInfo: CliAccessToken

Valor de Propriedade

CliAccessToken

Detalhes de Método

create(AccessTokenOptions)

Fornece credenciais que podem ser utilizadas pelo SDK JS para interagir com o Azure através da CLI do Azure. Pré-requisito

• instalar azure-cli . Para obter mais informações, veja Instalar a CLI do Azure
• iniciar sessão 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 do AzureCliCredentials.

Devoluções

Promise<AzureCliCredentials>

getAccessToken(AccessTokenOptions)

Obtém o token de acesso para a subscrição predefinida 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.

Devoluções

Promise<CliAccessToken>

getSubscription(string)

Obtém a subscrição da CLI do Azure.

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

Parâmetros

subscriptionIdOrName

string

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

Devoluções

Promise<LinkedSubscription>

getToken()

Tenta obter o novo token da CLI do Azure se o token tiver expirado ou se a subscrição tiver sido alterada. Caso contrário, utiliza o accessToken em cache.

function getToken(): Promise<TokenResponse>

Devoluções

Promise<TokenResponse>

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

listAllSubscriptions(ListAllSubscriptionOptions)

Devolve uma lista de todas as subscrições 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 subcriptações.

Devoluções

Promise<LinkedSubscription[]>

setDefaultSubscription(string)

Define a subscrição especificada como a subscrição predefinida da CLI do Azure.

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

Parâmetros

subscriptionIdOrName

string

O nome ou id da subscipção que tem de ser definido como a subscrição predefinida.

Devoluções

Promise<void>

signRequest(WebResource)

Assina um pedido com o cabeçalho Autenticação.

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

Parâmetros

webResource

WebResource

Devoluções

Promise<WebResource>