Partager via

AzureCliCredentials class

Paquet:
@azure/ms-rest-nodeauth

Décrit les informations d’identification en récupérant le jeton via Azure CLI.

Constructeurs

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

Propriétés

resource

Points de terminaison de ressources Azure.

  • Valeur par défaut d’Azure Resource Manager à partir de l’environnement : AzureCloud. "https://management.azure.com" ;
  • Pour Azure KeyVault : «https://vault.azure.net"
  • Pour Azure Batch : «https://batch.core.windows.net"
  • Pour Azure Active Directory Graph : «https://graph.windows.net"

Pour obtenir la ressource pour d’autres clouds :

  • az cloud list
subscriptionInfo

Fournit des informations sur l’abonnement par défaut/actuel pour Azure CLI.
tokenInfo

Fournit des informations sur le jeton d’accès pour l’abonnement correspondant pour Azure CLI.

Méthodes

create(AccessTokenOptions)

Fournit des informations d’identification qui peuvent être utilisées par le Kit de développement logiciel (SDK) JS pour interagir avec Azure via Azure cli. conditions préalables

  • installer azure-cli . Pour plus d’informations, consultez Installer Azure CLI
  • connexion via az login
getAccessToken(AccessTokenOptions)

Obtient le jeton d’accès pour l’abonnement par défaut ou spécifié.
getSubscription(string)

Obtient l’abonnement à partir d’Azure CLI.
getToken()

Tente d’obtenir le nouveau jeton à partir d’Azure CLI, si le jeton a expiré ou si l’abonnement a changé utilise l’accessToken mis en cache.
listAllSubscriptions(ListAllSubscriptionOptions)

Retourne une liste de tous les abonnements d’Azure CLI.
setDefaultSubscription(string)

Définit l’abonnement spécifié comme abonnement par défaut pour Azure CLI.
signRequest(WebResource)

Signe une demande avec l’en-tête d’authentification.

Détails du constructeur

AzureCliCredentials(LinkedSubscription, CliAccessToken, string) 

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

Paramètres

subscriptionInfo
LinkedSubscription
tokenInfo
CliAccessToken
resource

string

Détails de la propriété

resource

Points de terminaison de ressources Azure.

  • Valeur par défaut d’Azure Resource Manager à partir de l’environnement : AzureCloud. "https://management.azure.com" ;
  • Pour Azure KeyVault : «https://vault.azure.net"
  • Pour Azure Batch : «https://batch.core.windows.net"
  • Pour Azure Active Directory Graph : «https://graph.windows.net"

Pour obtenir la ressource pour d’autres clouds :

  • az cloud list
resource: string

Valeur de propriété

string

subscriptionInfo

Fournit des informations sur l’abonnement par défaut/actuel pour Azure CLI.

subscriptionInfo: LinkedSubscription

Valeur de propriété

LinkedSubscription

tokenInfo

Fournit des informations sur le jeton d’accès pour l’abonnement correspondant pour Azure CLI.

tokenInfo: CliAccessToken

Valeur de propriété

CliAccessToken

Détails de la méthode

create(AccessTokenOptions)

Fournit des informations d’identification qui peuvent être utilisées par le Kit de développement logiciel (SDK) JS pour interagir avec Azure via Azure cli. conditions préalables

  • installer azure-cli . Pour plus d’informations, consultez Installer Azure CLI
  • connexion via az login
static function create(options?: AccessTokenOptions): Promise<AzureCliCredentials>

Paramètres

options

AccessTokenOptions

Paramètres facultatifs qui peuvent être fournis lors de la création d’AzureCliCredentials.

Retours

Promise<AzureCliCredentials>

getAccessToken(AccessTokenOptions)

Obtient le jeton d’accès pour l’abonnement par défaut ou spécifié.

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

Paramètres

options

AccessTokenOptions

Paramètres facultatifs qui peuvent être fournis pour obtenir le jeton d’accès.

Retours

Promise<CliAccessToken>

getSubscription(string)

Obtient l’abonnement à partir d’Azure CLI.

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

Paramètres

subscriptionIdOrName

string

Nom ou ID de l’abonnement pour lequel les informations sont requises.

Retours

Promise<LinkedSubscription>

getToken()

Tente d’obtenir le nouveau jeton à partir d’Azure CLI, si le jeton a expiré ou si l’abonnement a changé utilise l’accessToken mis en cache.

function getToken(): Promise<TokenResponse>

Retours

Promise<TokenResponse>

TokenResponse (tokenType et accessToken sont les deux propriétés importantes).

listAllSubscriptions(ListAllSubscriptionOptions)

Retourne une liste de tous les abonnements d’Azure CLI.

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

Paramètres

options
ListAllSubscriptionOptions

Paramètres facultatifs qui peuvent être fournis lors de la liste de toutes les sous-inscriptions.

Retours

Promise<LinkedSubscription[]>

setDefaultSubscription(string)

Définit l’abonnement spécifié comme abonnement par défaut pour Azure CLI.

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

Paramètres

subscriptionIdOrName

string

Nom ou ID de la sous-instance qui doit être défini comme abonnement par défaut.

Retours

Promise<void>

signRequest(WebResource)

Signe une demande avec l’en-tête d’authentification.

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

Paramètres

webResource
WebResource

Retours

Promise<WebResource>