AzureCliCredentials class

Paquete:

@azure/ms-rest-nodeauth

Describe las credenciales mediante la recuperación del token mediante la CLI de Azure.

Constructores

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

Propiedades

resource	Puntos de conexión de recursos de Azure. El valor predeterminado es Azure Resource Manager desde el entorno: AzureCloud. "https://management.azure.com" Para Azure KeyVault: "https://vault.azure.net" Para Azure Batch: "https://batch.core.windows.net" Para Azure Active Directory Graph: "https://graph.windows.net" Para obtener el recurso para otras nubes: az cloud list
subscriptionInfo	Proporciona información sobre la suscripción predeterminada o actual para la CLI de Azure.
tokenInfo	Proporciona información sobre el token de acceso de la suscripción correspondiente para la CLI de Azure.

Métodos

create(AccessTokenOptions)	Proporciona credenciales que el SDK de JS puede usar para interactuar con Azure mediante la cli de Azure. requisitos previos instale azure-cli . Para más información, consulte Instalación de la CLI de Azure inicio de sesión de a través de az login
getAccessToken(AccessTokenOptions)	Obtiene el token de acceso de la suscripción predeterminada o especificada.
getSubscription(string)	Obtiene la suscripción de la CLI de Azure.
getToken()	Intenta obtener el nuevo token de la CLI de Azure, si el token ha expirado o la suscripción ha cambiado, usa accessToken almacenado en caché.
listAllSubscriptions(ListAllSubscriptionOptions)	Devuelve una lista de todas las suscripciones de la CLI de Azure.
setDefaultSubscription(string)	Establece la suscripción especificada como la suscripción predeterminada para la CLI de Azure.
signRequest(WebResource)	Firma una solicitud con el encabezado Authentication.

Detalles del constructor

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

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

Parámetros

subscriptionInfo

LinkedSubscription

tokenInfo

CliAccessToken

resource

string

Detalles de las propiedades

resource

Puntos de conexión de recursos de Azure.

• El valor predeterminado es Azure Resource Manager desde el entorno: AzureCloud. "https://management.azure.com"
• Para Azure KeyVault: "https://vault.azure.net"
• Para Azure Batch: "https://batch.core.windows.net"
• Para Azure Active Directory Graph: "https://graph.windows.net"

Para obtener el recurso para otras nubes:

• az cloud list

resource: string

Valor de propiedad

string

subscriptionInfo

Proporciona información sobre la suscripción predeterminada o actual para la CLI de Azure.

subscriptionInfo: LinkedSubscription

Valor de propiedad

LinkedSubscription

tokenInfo

Proporciona información sobre el token de acceso de la suscripción correspondiente para la CLI de Azure.

tokenInfo: CliAccessToken

Valor de propiedad

CliAccessToken

Detalles del método

create(AccessTokenOptions)

Proporciona credenciales que el SDK de JS puede usar para interactuar con Azure mediante la cli de Azure. requisitos previos

• instale azure-cli . Para más información, consulte Instalación de la CLI de Azure
• inicio de sesión de a través de az login

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

Parámetros

options

AccessTokenOptions

Parámetros opcionales que se pueden proporcionar al crear AzureCliCredentials.

Devoluciones

Promise<AzureCliCredentials>

getAccessToken(AccessTokenOptions)

Obtiene el token de acceso de la suscripción predeterminada o especificada.

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

Parámetros

options

AccessTokenOptions

Parámetros opcionales que se pueden proporcionar para obtener el token de acceso.

Devoluciones

Promise<CliAccessToken>

getSubscription(string)

Obtiene la suscripción de la CLI de Azure.

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

Parámetros

subscriptionIdOrName

string

Nombre o identificador de la suscripción para la que se requiere la información.

Devoluciones

Promise<LinkedSubscription>

getToken()

Intenta obtener el nuevo token de la CLI de Azure, si el token ha expirado o la suscripción ha cambiado, usa accessToken almacenado en caché.

function getToken(): Promise<TokenResponse>

Devoluciones

Promise<TokenResponse>

TokenResponse (tokenType y accessToken son las dos propiedades importantes).

listAllSubscriptions(ListAllSubscriptionOptions)

Devuelve una lista de todas las suscripciones de la CLI de Azure.

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

Parámetros

options

ListAllSubscriptionOptions

Parámetros opcionales que se pueden proporcionar al enumerar todas las subcripciones.

Devoluciones

Promise<LinkedSubscription[]>

setDefaultSubscription(string)

Establece la suscripción especificada como la suscripción predeterminada para la CLI de Azure.

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

Parámetros

subscriptionIdOrName

string

Nombre o identificador de la suscripción que debe establecerse como la suscripción predeterminada.

Devoluciones

Promise<void>

signRequest(WebResource)

Firma una solicitud con el encabezado Authentication.

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

Parámetros

webResource

WebResource

Devoluciones

Promise<WebResource>