AzureCliCredentials class

Paket:

@azure/ms-rest-nodeauth

Beschreibt die Anmeldeinformationen durch Abrufen des Tokens über Azure CLI.

Konstruktoren

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

Eigenschaften

resource	Azure-Ressourcenendpunkte. Der Standardwert ist Azure Resource Manager aus der Umgebung: AzureCloud. „https://management.azure.com" Für Azure KeyVault: "https://vault.azure.net" Für Azure Batch: "https://batch.core.windows.net" Für Azure Active Directory Graph: "https://graph.windows.net" So rufen Sie die Ressource für andere Clouds ab: az cloud list
subscriptionInfo	Stellt Informationen zum Standard-/aktuellen Abonnement für Azure CLI bereit.
tokenInfo	Stellt Informationen zum Zugriffstoken für das entsprechende Abonnement für Azure CLI bereit.

Methoden

create(AccessTokenOptions)	Stellt Anmeldeinformationen bereit, die vom JS SDK für die Interaktion mit Azure über azure cli verwendet werden können. Voraussetzung azure-cli installieren. Weitere Informationen finden Sie unter Installieren von Azure CLI anmeldung über az login
getAccessToken(AccessTokenOptions)	Ruft das Zugriffstoken für das Standardabonnement oder das angegebene Abonnement ab.
getSubscription(string)	Ruft das Abonnement von Azure CLI ab.
getToken()	Versucht, das neue Token von Azure CLI abzurufen, wenn das Token abgelaufen ist oder das Abonnement geändert wurde, das zwischengespeicherte AccessToken verwendet.
listAllSubscriptions(ListAllSubscriptionOptions)	Gibt eine Liste aller Abonnements von Azure CLI zurück.
setDefaultSubscription(string)	Legt das angegebene Abonnement als Standardabonnement für Azure CLI fest.
signRequest(WebResource)	Signiert eine Anforderung mit dem Authentifizierungsheader.

Details zum Konstruktor

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

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

Parameter

subscriptionInfo

LinkedSubscription

tokenInfo

CliAccessToken

resource

string

Details zur Eigenschaft

resource

Azure-Ressourcenendpunkte.

• Der Standardwert ist Azure Resource Manager aus der Umgebung: AzureCloud. „https://management.azure.com"
• Für Azure KeyVault: "https://vault.azure.net"
• Für Azure Batch: "https://batch.core.windows.net"
• Für Azure Active Directory Graph: "https://graph.windows.net"

So rufen Sie die Ressource für andere Clouds ab:

• az cloud list

resource: string

Eigenschaftswert

string

subscriptionInfo

Stellt Informationen zum Standard-/aktuellen Abonnement für Azure CLI bereit.

subscriptionInfo: LinkedSubscription

Eigenschaftswert

LinkedSubscription

tokenInfo

Stellt Informationen zum Zugriffstoken für das entsprechende Abonnement für Azure CLI bereit.

tokenInfo: CliAccessToken

Eigenschaftswert

CliAccessToken

Details zur Methode

create(AccessTokenOptions)

Stellt Anmeldeinformationen bereit, die vom JS SDK für die Interaktion mit Azure über azure cli verwendet werden können. Voraussetzung

• azure-cli installieren. Weitere Informationen finden Sie unter Installieren von Azure CLI
• anmeldung über az login

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

Parameter

options

AccessTokenOptions

Optionale Parameter, die beim Erstellen von AzureCliCredentials bereitgestellt werden können.

Gibt zurück

Promise<AzureCliCredentials>

getAccessToken(AccessTokenOptions)

Ruft das Zugriffstoken für das Standardabonnement oder das angegebene Abonnement ab.

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

Parameter

options

AccessTokenOptions

Optionale Parameter, die bereitgestellt werden können, um das Zugriffstoken abzurufen.

Gibt zurück

Promise<CliAccessToken>

getSubscription(string)

Ruft das Abonnement von Azure CLI ab.

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

Parameter

subscriptionIdOrName

string

Der Name oder die ID des Abonnements, für das die Informationen erforderlich sind.

Gibt zurück

Promise<LinkedSubscription>

getToken()

Versucht, das neue Token von Azure CLI abzurufen, wenn das Token abgelaufen ist oder das Abonnement geändert wurde, das zwischengespeicherte AccessToken verwendet.

function getToken(): Promise<TokenResponse>

Gibt zurück

Promise<TokenResponse>

TokenResponse (tokenType und accessToken sind die beiden wichtigen Eigenschaften).

listAllSubscriptions(ListAllSubscriptionOptions)

Gibt eine Liste aller Abonnements von Azure CLI zurück.

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

Parameter

options

ListAllSubscriptionOptions

Optionale Parameter, die beim Auflisten aller Unterschreibungen bereitgestellt werden können.

Gibt zurück

Promise<LinkedSubscription[]>

setDefaultSubscription(string)

Legt das angegebene Abonnement als Standardabonnement für Azure CLI fest.

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

Parameter

subscriptionIdOrName

string

Der Name oder die ID der Untervorlage, die als Standardabonnement festgelegt werden muss.

Gibt zurück

Promise<void>

signRequest(WebResource)

Signiert eine Anforderung mit dem Authentifizierungsheader.

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

Parameter

webResource

WebResource

Gibt zurück

Promise<WebResource>