AzureCliCredentials class

Balíček:

@azure/ms-rest-nodeauth

Popisuje přihlašovací údaje načtením tokenu prostřednictvím Azure CLI.

Konstruktory

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

Vlastnosti

resource	Koncové body prostředků Azure Výchozí nastavení Azure Resource Manageru z prostředí: AzureCloud. "https://management.azure.com" Pro Azure KeyVault: "https://vault.azure.net" Pro Azure Batch: "https://batch.core.windows.net" Pro Azure Active Directory Graph: "https://graph.windows.net" Získání prostředku pro ostatní cloudy: az cloud list
subscriptionInfo	Poskytuje informace o výchozím nebo aktuálním předplatném azure CLI.
tokenInfo	Poskytuje informace o přístupovém tokenu pro odpovídající předplatné azure CLI.

Metody

create(AccessTokenOptions)	Poskytuje přihlašovací údaje, které může sada JS SDK použít k interakci s Azure prostřednictvím azure cli. požadované nainstalovat azure-cli . Další informace najdete v tématu Instalace azure CLI přihlášení přes az login
getAccessToken(AccessTokenOptions)	Získá přístupový token pro výchozí nebo zadané předplatné.
getSubscription(string)	Získá předplatné z Azure CLI.
getToken()	Pokusí se získat nový token z Azure CLI, pokud vypršela platnost tokenu nebo se předplatné změnilo jinak používá přístupovýtoken uložený v mezipaměti.
listAllSubscriptions(ListAllSubscriptionOptions)	Vrátí seznam všech předplatných z Azure CLI.
setDefaultSubscription(string)	Nastaví zadané předplatné jako výchozí předplatné pro Azure CLI.
signRequest(WebResource)	Podepíše požadavek hlavičkou Ověřování.

Podrobnosti konstruktoru

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

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

Parametry

subscriptionInfo

LinkedSubscription

tokenInfo

CliAccessToken

resource

string

Podrobnosti vlastnosti

resource

Koncové body prostředků Azure

• Výchozí nastavení Azure Resource Manageru z prostředí: AzureCloud. "https://management.azure.com"
• Pro Azure KeyVault: "https://vault.azure.net"
• Pro Azure Batch: "https://batch.core.windows.net"
• Pro Azure Active Directory Graph: "https://graph.windows.net"

Získání prostředku pro ostatní cloudy:

• az cloud list

resource: string

Hodnota vlastnosti

string

subscriptionInfo

Poskytuje informace o výchozím nebo aktuálním předplatném azure CLI.

subscriptionInfo: LinkedSubscription

Hodnota vlastnosti

LinkedSubscription

tokenInfo

Poskytuje informace o přístupovém tokenu pro odpovídající předplatné azure CLI.

tokenInfo: CliAccessToken

Hodnota vlastnosti

CliAccessToken

Podrobnosti metody

create(AccessTokenOptions)

Poskytuje přihlašovací údaje, které může sada JS SDK použít k interakci s Azure prostřednictvím azure cli. požadované

• nainstalovat azure-cli . Další informace najdete v tématu Instalace azure CLI
• přihlášení přes az login

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

Parametry

options

AccessTokenOptions

Volitelné parametry, které lze zadat při vytváření AzureCliCredentials.

Návraty

Promise<AzureCliCredentials>

getAccessToken(AccessTokenOptions)

Získá přístupový token pro výchozí nebo zadané předplatné.

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

Parametry

options

AccessTokenOptions

Volitelné parametry, které lze poskytnout pro získání přístupového tokenu.

Návraty

Promise<CliAccessToken>

getSubscription(string)

Získá předplatné z Azure CLI.

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

Parametry

subscriptionIdOrName

string

Název nebo ID předplatného, pro které jsou informace požadovány.

Návraty

Promise<LinkedSubscription>

getToken()

Pokusí se získat nový token z Azure CLI, pokud vypršela platnost tokenu nebo se předplatné změnilo jinak používá přístupovýtoken uložený v mezipaměti.

function getToken(): Promise<TokenResponse>

Návraty

Promise<TokenResponse>

TokenResponse (tokenType a accessToken jsou dvě důležité vlastnosti).

listAllSubscriptions(ListAllSubscriptionOptions)

Vrátí seznam všech předplatných z Azure CLI.

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

Parametry

options

ListAllSubscriptionOptions

Volitelné parametry, které lze zadat při výpisu všech dílčích odběrů.

Návraty

Promise<LinkedSubscription[]>

setDefaultSubscription(string)

Nastaví zadané předplatné jako výchozí předplatné pro Azure CLI.

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

Parametry

subscriptionIdOrName

string

Název nebo ID dílčího odběru, které je potřeba nastavit jako výchozí předplatné.

Návraty

Promise<void>

signRequest(WebResource)

Podepíše požadavek hlavičkou Ověřování.

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

Parametry

webResource

WebResource

Návraty

Promise<WebResource>