@azure/ms-rest-nodeauth package

Compila una matriz de tenantIds.

function buildTenantList(credentials: TokenCredentialsBase, apiVersion?: string): Promise<string[]>

Parámetros

Devoluciones

Promesa que se resuelve en una matriz de tenantIds y rechaza con un error.

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parámetros

Devoluciones

Proporciona una dirección URL y un código que debe copiarse y pegarse en un explorador y autenticarse allí. Si se ejecuta correctamente, el usuario obtendrá un objeto DeviceTokenCredentials y la lista de suscripciones asociadas a ese userId en todos los inquilinos aplicables.

Al usar cuentas personales, es necesario establecer la propiedad domain en el parámetro options en el identificador de un inquilino para esa cuenta. De lo contrario, la credencial resultante no podrá acceder a los recursos de la cuenta.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Devoluciones

Si se ha pasado una devolución de llamada como último parámetro, devuelve void else devuelve una promesa. Se llama a la devolución de llamada con el objeto DeviceTokenCredentials resultante y una lista de suscripciones asociadas en todos los inquilinos aplicables.

function interactiveLogin(options: InteractiveLoginOptions): Promise<DeviceTokenCredentials>

Parámetros

Devoluciones

function interactiveLogin(options: InteractiveLoginOptions, callback: (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Parámetros

function interactiveLogin(callback: any)

Parámetros

Proporciona una dirección URL y un código que debe copiarse y pegarse en un explorador y autenticarse allí. Si se ejecuta correctamente, el usuario obtendrá un objeto DeviceTokenCredentials y la lista de suscripciones asociadas a ese userId en todos los inquilinos aplicables.

Al usar cuentas personales, es necesario establecer la propiedad domain en el parámetro options en el identificador de un inquilino para esa cuenta. De lo contrario, la credencial resultante no podrá acceder a los recursos de la cuenta.

function interactiveLoginWithAuthResponse(options?: InteractiveLoginOptions): Promise<AuthResponse<DeviceTokenCredentials>>

Parámetros

Devoluciones

Promesa que se resuelve en AuthResponse, que contiene "credenciales" y la matriz opcional "suscripciones" y rechaza con un error.

Autentíquese mediante la MSI de App Service.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Devoluciones

Si se ha pasado una devolución de llamada como último parámetro, devuelve void else devuelve una promesa. Se llama a la devolución de llamada con el objeto MSIAppServiceTokenCredentials resultante.

function loginWithAppServiceMSI(options: MSIAppServiceOptions): Promise<MSIAppServiceTokenCredentials>

Parámetros

Devoluciones

function loginWithAppServiceMSI(options: MSIAppServiceOptions, callback: Callback<MSIAppServiceTokenCredentials>)

Parámetros

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Parámetros

Antes de usar este método, instale az cli desde https://github.com/Azure/azure-cli/releases. A continuación, ejecute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Si desea crear el sp para una nube o entorno diferente, ejecute lo siguiente:

1. az cloud list
2. az cloud set –n <nombre del entorno>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp con secret O
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp con certificado Si la entidad de servicio ya está creada, inicie sesión con la información de la entidad de servicio:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. Cuenta az mostrar ---sdk-auth > auth.json

Se autentica mediante la información de la entidad de servicio proporcionada en el archivo de autenticación. Este método establecerá el subscriptionId del archivo de autenticación en la variable de entorno proporcionada por el usuario en el parámetro options o el valor predeterminado "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Devoluciones

Si se ha pasado una devolución de llamada como último parámetro, devuelve void else devuelve una promesa. Se llama a la devolución de llamada con el objeto ApplicationTokenCredentials o ApplicationTokenCertificateCredentials resultante y una lista de suscripciones asociadas en todos los inquilinos aplicables.

function loginWithAuthFile(options: LoginWithAuthFileOptions): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Parámetros

Devoluciones

function loginWithAuthFile(options: LoginWithAuthFileOptions, callback: (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

Parámetros

function loginWithAuthFile(callback: any)

Parámetros

Antes de usar este método, instale az cli desde https://github.com/Azure/azure-cli/releases. A continuación, ejecute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Si desea crear el sp para una nube o entorno diferente, ejecute lo siguiente:

1. az cloud list
2. az cloud set –n <nombre del entorno>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp con secret O
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp con certificado Si la entidad de servicio ya está creada, inicie sesión con la información de la entidad de servicio:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. Cuenta az mostrar ---sdk-auth > auth.json

Se autentica mediante la información de la entidad de servicio proporcionada en el archivo de autenticación. Este método establecerá el subscriptionId del archivo de autenticación en la variable de entorno proporcionada por el usuario en el parámetro options o el valor predeterminado "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFileWithAuthResponse(options?: LoginWithAuthFileOptions): Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Parámetros

Devoluciones

Promesa que se resuelve en AuthResponse, que contiene "credenciales" y la matriz opcional "suscripciones" y rechaza con un error.

Proporciona un objeto ApplicationTokenCertificateCredentials y la lista de suscripciones asociadas a ese servicePrincipalId/clientId en todos los inquilinos aplicables.

Al usar cuentas personales, es necesario establecer el parámetro domain en el identificador de un inquilino para esa cuenta. De lo contrario, la credencial resultante no podrá acceder a los recursos de la cuenta.

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string): Promise<ApplicationTokenCertificateCredentials>

Parámetros

Devoluciones

Si se ha pasado una devolución de llamada como último parámetro, devuelve void else devuelve una promesa. Se llama a la devolución de llamada con el objeto ApplicationTokenCertificateCredentials resultante y una lista de suscripciones asociadas en todos los inquilinos aplicables.

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCertificateCredentials>

Parámetros

Devoluciones

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions, callback: (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

Parámetros

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, callback: any)

Parámetros

Proporciona un objeto ApplicationTokenCertificateCredentials y la lista de suscripciones asociadas a ese servicePrincipalId/clientId en todos los inquilinos aplicables.

Al usar cuentas personales, es necesario establecer el parámetro domain en el identificador de un inquilino para esa cuenta. De lo contrario, la credencial resultante no podrá acceder a los recursos de la cuenta.

function loginWithServicePrincipalCertificateWithAuthResponse(clientId: string, certificateStringOrFilePath: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Parámetros

Devoluciones

Promesa que se resuelve en AuthResponse, que contiene "credenciales" y la matriz opcional "suscripciones" y rechaza con un error.

Proporciona un objeto ApplicationTokenCredentials y la lista de suscripciones asociadas a ese servicePrincipalId/clientId en todos los inquilinos aplicables.

Al usar cuentas personales, es necesario establecer el parámetro domain en el identificador de un inquilino para esa cuenta. De lo contrario, la credencial resultante no podrá acceder a los recursos de la cuenta.

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string): Promise<ApplicationTokenCredentials>

Parámetros

Devoluciones

Si se ha pasado una devolución de llamada como último parámetro, devuelve void else devuelve una promesa. Se llama a la devolución de llamada con el objeto ApplicationTokenCredentials resultante y una lista de suscripciones asociadas en todos los inquilinos aplicables.

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCredentials>

Parámetros

Devoluciones

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions, callback: (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Parámetros

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, callback: any)

Parámetros

Proporciona un objeto ApplicationTokenCredentials y la lista de suscripciones asociadas a ese servicePrincipalId/clientId en todos los inquilinos aplicables.

Al usar cuentas personales, es necesario establecer el parámetro domain en el identificador de un inquilino para esa cuenta. De lo contrario, la credencial resultante no podrá acceder a los recursos de la cuenta.

function loginWithServicePrincipalSecretWithAuthResponse(clientId: string, secret: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse<ApplicationTokenCredentials>>

Parámetros

Devoluciones

Promesa que se resuelve en AuthResponse, que contiene "credenciales" y la matriz opcional "suscripciones" y rechaza con un error.

Proporciona un objeto UserTokenCredentials y la lista de suscripciones asociadas a ese userId en todos los inquilinos aplicables.

Este método solo es aplicable a los identificadores de la organización que no están habilitados para 2FA; de lo contrario, use el inicio de sesión interactivo.

Al usar cuentas personales, es necesario establecer la propiedad domain en el parámetro options en el identificador de un inquilino para esa cuenta. De lo contrario, la credencial resultante no podrá acceder a los recursos de la cuenta.

function loginWithUsernamePassword(username: string, password: string): Promise<UserTokenCredentials>

Parámetros

Devoluciones

Si se ha pasado una devolución de llamada como último parámetro, devuelve void else devuelve una promesa. Se llama a la devolución de llamada con el objeto UserTokenCredentials resultante y una lista de suscripciones asociadas en todos los inquilinos aplicables.

function loginWithUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions): Promise<UserTokenCredentials>

Parámetros

Devoluciones

function loginWithUsernamePassword(username: string, password: string, callback: any)

Parámetros

function loginWithUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions, callback: (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Parámetros

Proporciona un objeto UserTokenCredentials y la lista de suscripciones asociadas a ese userId en todos los inquilinos aplicables. Este método solo es aplicable a los identificadores de la organización que no están habilitados para 2FA; de lo contrario, use el inicio de sesión interactivo.

Al usar cuentas personales, es necesario establecer la propiedad domain en el parámetro options en el identificador de un inquilino para esa cuenta. De lo contrario, la credencial resultante no podrá acceder a los recursos de la cuenta.

function loginWithUsernamePasswordWithAuthResponse(username: string, password: string, options?: LoginWithUsernamePasswordOptions): Promise<AuthResponse<UserTokenCredentials>>

Parámetros

Devoluciones

Promesa que se resuelve en AuthResponse, que contiene credentials y una matriz de subscriptions opcional, y rechaza con un error.

Antes de usar este método, instale az cli desde https://github.com/Azure/azure-cli/releases. Si tiene una máquina virtual de Azure aprovisionada con az cli y tiene MSI habilitado, puede usar este método para obtener tokens de autenticación de la máquina virtual.

Para crear una máquina virtual, habilite MSI; ejecute este comando: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Nota: el comando anterior habilita un punto de conexión de servicio en el host, con un puerto predeterminado 50342.

Para habilitar MSI en una máquina virtual ya aprovisionada, ejecute el siguiente comando: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Para obtener más información sobre este comando, ejecute: az vm --assign-identity -h

Se autentica mediante el servicio de identidad que se ejecuta en una máquina virtual de Azure. Este método realiza una solicitud al servicio de autenticación hospedado en la máquina virtual y obtiene un token de acceso.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Devoluciones

Si se ha pasado una devolución de llamada como último parámetro, devuelve void else devuelve una promesa. Se llama a la devolución de llamada con el objeto MSIVmTokenCredentials resultante.

function loginWithVmMSI(options: MSIVmOptions): Promise<MSIVmTokenCredentials>

Parámetros

Devoluciones

function loginWithVmMSI(options: MSIVmOptions, callback: Callback<MSIVmTokenCredentials>)

Parámetros

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Parámetros

AuthConstants: { AAD_COMMON_TENANT: string, AZURE_AUTH_LOCATION: string, DEFAULT_ADAL_CLIENT_ID: string, DEFAULT_LANGUAGE: string, RESOURCE_MANAGER_ENDPOINT: string, SDK_INTERNAL_ERROR: string }

Tipo