@azure/ms-rest-nodeauth package

Classes

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials	Descreve as credenciais recuperando o token por meio da CLI do Azure.
DeviceTokenCredentials
MSIAppServiceTokenCredentials	Fornece informações sobre credenciais de token de identidade de serviço gerenciada em um ambiente Serviço de Aplicativo.
MSITokenCredentials	Fornece informações sobre credenciais de token de identidade de serviço gerenciada. Esse objeto só pode ser usado para adquirir token em uma máquina virtual provisionada no Azure com identidade de serviço gerenciada.
MSIVmTokenCredentials	Fornece informações sobre credenciais de token de identidade de serviço gerenciada em uma máquina virtual provisionada no Azure.
TokenCredentialsBase
UserTokenCredentials

Interfaces

AuthResponse	Descreve a resposta de autenticação.
AzureTokenCredentialsOptions	Descreve parâmetros opcionais para autenticação servicePrincipal/secret.
CliAccessToken	Descreve o token de acesso recuperado da CLI do Azure.
InteractiveLoginOptions	Descreve parâmetros opcionais para autenticação interativa.
LinkedSubscription	Fornece informações sobre a assinatura encontrada durante o processo de autenticação. A estrutura desse tipo é diferente do objeto de assinatura que se obtém fazendo uma solicitação para a API ResourceManager.
LinkedUser	Fornece informações sobre um usuário da perspectiva de autenticação.
ListAllSubscriptionOptions	Descreve as opções que podem ser fornecidas ao listar todas as assinaturas/contas por meio da CLI do Azure.
LoginWithAuthFileOptions	Descreve parâmetros opcionais para logon comAuthFile.
LoginWithUsernamePasswordOptions	Descreve parâmetros opcionais para autenticação de nome de usuário/senha.
MSIAppServiceOptions	Define os parâmetros opcionais para autenticação com MSI para AppService.
MSIOptions	Define os parâmetros opcionais para autenticação com MSI.
MSITokenResponse	Descreve o MSITokenResponse.
MSIVmOptions	Define os parâmetros opcionais para autenticação com MSI para Máquina Virtual.

Aliases de tipo

TokenAudience
UserType	Fornece informações sobre o tipo de usuário. Atualmente, ele pode ser "usuário" ou "servicePrincipal".

Funções

buildTenantList(TokenCredentialsBase, string)	Cria uma matriz de tenantIds.
createAuthenticator(MSITokenCredentials)
interactiveLogin()	Fornece uma URL e um código que precisam ser copiados e colados em um navegador e autenticados ali. Se tiver êxito, o usuário obterá um objeto DeviceTokenCredentials e a lista de assinaturas associadas a essa userId em todos os locatários aplicáveis. Ao usar contas pessoais, a domain propriedade no options parâmetro é necessária para ser definida como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.
interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)	Fornece uma URL e um código que precisam ser copiados e colados em um navegador e autenticados ali. Se tiver êxito, o usuário obterá um objeto DeviceTokenCredentials e a lista de assinaturas associadas a essa userId em todos os locatários aplicáveis. Ao usar contas pessoais, a domain propriedade no options parâmetro é necessária para ser definida como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.
loginWithAppServiceMSI()	Autentique usando a MSI do Serviço de Aplicativo.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	Antes de usar esse método, instale az cli de https://github.com/Azure/azure-cli/releases. Em seguida, execute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se você quiser criar o sp para uma nuvem/ambiente diferente, execute: az cloud list az cloud set –n az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR az ad sp create-for-rbac --create-cert --sdk-auth.json > // create sp with certificate Se a entidade de serviço já tiver sido criada, faça logon com as informações da entidade de serviço: az login --service-principal -u -p -t az account show --sdk-auth > auth.json Autentica usando as informações da entidade de serviço fornecidas no arquivo de autenticação. Esse método definirá a subscriptionId do arquivo de autenticação para a variável de ambiente fornecida pelo usuário no parâmetro options ou o padrão "AZURE_SUBSCRIPTION_ID".
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	Antes de usar esse método, instale az cli de https://github.com/Azure/azure-cli/releases. Em seguida, execute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se você quiser criar o sp para uma nuvem/ambiente diferente, execute: az cloud list az cloud set –n az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR az ad sp create-for-rbac --create-cert --sdk-auth.json > // create sp with certificate Se a entidade de serviço já tiver sido criada, faça logon com as informações da entidade de serviço: az login --service-principal -u -p -t az account show --sdk-auth > auth.json Autentica usando as informações da entidade de serviço fornecidas no arquivo de autenticação. Esse método definirá a subscriptionId do arquivo de autenticação para a variável de ambiente fornecida pelo usuário no parâmetro options ou o padrão "AZURE_SUBSCRIPTION_ID".
loginWithServicePrincipalCertificate(string, string, string)	Fornece um objeto ApplicationTokenCertificateCredentials e a lista de assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis. Ao usar contas pessoais, o domain parâmetro deve ser definido como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.
loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)
loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithServicePrincipalCertificate(string, string, string, any)
loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)	Fornece um objeto ApplicationTokenCertificateCredentials e a lista de assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis. Ao usar contas pessoais, o domain parâmetro deve ser definido como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.
loginWithServicePrincipalSecret(string, string, string)	Fornece um objeto ApplicationTokenCredentials e a lista de assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis. Ao usar contas pessoais, o domain parâmetro deve ser definido como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.
loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)
loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithServicePrincipalSecret(string, string, string, any)
loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)	Fornece um objeto ApplicationTokenCredentials e a lista de assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis. Ao usar contas pessoais, o domain parâmetro deve ser definido como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.
loginWithUsernamePassword(string, string)	Fornece um objeto UserTokenCredentials e a lista de assinaturas associadas a essa userId em todos os locatários aplicáveis. Esse método é aplicável somente a IDs organizacionais que não estão habilitadas para 2FA, caso contrário, use o logon interativo. Ao usar contas pessoais, a domain propriedade no options parâmetro é necessária para ser definida como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)
loginWithUsernamePassword(string, string, any)
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)	Fornece um objeto UserTokenCredentials e a lista de assinaturas associadas a essa userId em todos os locatários aplicáveis. Esse método é aplicável somente a IDs organizacionais que não estão habilitadas para 2FA, caso contrário, use o logon interativo. Ao usar contas pessoais, a domain propriedade no options parâmetro é necessária para ser definida como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.
loginWithVmMSI()	Antes de usar esse método, instale az cli de https://github.com/Azure/azure-cli/releases. Se você tiver uma máquina virtual do Azure provisionada com az cli e tiver a MSI habilitada, poderá usar esse método para obter tokens de autenticação da VM. Para criar uma nova VM, habilite a MSI, execute este comando: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Observação: o comando acima habilita um ponto de extremidade de serviço no host, com uma porta padrão 50342 Para habilitar a MSI em uma VM já provisionada, execute o seguinte comando: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number> Para saber mais sobre esse comando, execute: az vm --assign-identity -h Autentica usando o serviço de identidade em execução em uma máquina virtual do Azure. Esse método faz uma solicitação para o serviço de autenticação hospedado na VM e obtém de volta um token de acesso.
loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Detalhes da função

buildTenantList(TokenCredentialsBase, string)

Cria uma matriz de tenantIds.

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

Parâmetros

credentials

TokenCredentialsBase

As credenciais.

apiVersion

string

valor padrão 2016-06-01

Retornos

Promise<string[]>

Uma promessa que resolve para uma matriz de tenantIds e rejeita com um erro.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parâmetros

credentials

MSITokenCredentials

Retornos

Authenticator

interactiveLogin()

Fornece uma URL e um código que precisam ser copiados e colados em um navegador e autenticados ali. Se tiver êxito, o usuário obterá um objeto DeviceTokenCredentials e a lista de assinaturas associadas a essa userId em todos os locatários aplicáveis.

Ao usar contas pessoais, a domain propriedade no options parâmetro é necessária para ser definida como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Retornos

Promise<DeviceTokenCredentials>

Se um retorno de chamada tiver sido passado como o último parâmetro, ele retornará void caso contrário, retornará promise. O retorno de chamada é chamado com o objeto DeviceTokenCredentials resultante e uma lista de assinaturas associadas em todos os locatários aplicáveis.

interactiveLogin(InteractiveLoginOptions)

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

Parâmetros

options

InteractiveLoginOptions

Retornos

Promise<DeviceTokenCredentials>

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

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

Parâmetros

options

InteractiveLoginOptions

callback

(err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void

interactiveLogin(any)

function interactiveLogin(callback: any)

Parâmetros

callback

any

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

Fornece uma URL e um código que precisam ser copiados e colados em um navegador e autenticados ali. Se tiver êxito, o usuário obterá um objeto DeviceTokenCredentials e a lista de assinaturas associadas a essa userId em todos os locatários aplicáveis.

Ao usar contas pessoais, a domain propriedade no options parâmetro é necessária para ser definida como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.

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

Parâmetros

options

InteractiveLoginOptions

Objeto que representa parâmetros opcionais.

Retornos

Promise<AuthResponse<DeviceTokenCredentials>>

Uma Promessa que é resolvida para AuthResponse, que contém "credenciais" e matriz opcional de "assinaturas" e rejeita com um Erro.

loginWithAppServiceMSI()

Autentique usando a MSI do Serviço de Aplicativo.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Retornos

Promise<MSIAppServiceTokenCredentials>

Se um retorno de chamada tiver sido passado como o último parâmetro, ele retornará void caso contrário, retornará promise. O retorno de chamada é chamado com o objeto MSIAppServiceTokenCredentials resultante.

loginWithAppServiceMSI(MSIAppServiceOptions)

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

Parâmetros

options

MSIAppServiceOptions

Retornos

Promise<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

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

Parâmetros

options

MSIAppServiceOptions

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Parâmetros

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAuthFile()

Antes de usar esse método, instale az cli de https://github.com/Azure/azure-cli/releases. Em seguida, execute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se você quiser criar o sp para uma nuvem/ambiente diferente, execute:

1. az cloud list
2. az cloud set –n
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR
4. az ad sp create-for-rbac --create-cert --sdk-auth.json > // create sp with certificate Se a entidade de serviço já tiver sido criada, faça logon com as informações da entidade de serviço:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth > auth.json

Autentica usando as informações da entidade de serviço fornecidas no arquivo de autenticação. Esse método definirá a subscriptionId do arquivo de autenticação para a variável de ambiente fornecida pelo usuário no parâmetro options ou o padrão "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Retornos

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Se um retorno de chamada tiver sido passado como o último parâmetro, ele retornará void caso contrário, retornará promise. O retorno de chamada é chamado com o objeto ApplicationTokenCredentials ou ApplicationTokenCertificateCredentials resultante e uma lista de assinaturas associadas em todos os locatários aplicáveis.

loginWithAuthFile(LoginWithAuthFileOptions)

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

Parâmetros

options

LoginWithAuthFileOptions

Retornos

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

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

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

Parâmetros

options

LoginWithAuthFileOptions

callback

(err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void

loginWithAuthFile(any)

function loginWithAuthFile(callback: any)

Parâmetros

callback

any

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

Antes de usar esse método, instale az cli de https://github.com/Azure/azure-cli/releases. Em seguida, execute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se você quiser criar o sp para uma nuvem/ambiente diferente, execute:

1. az cloud list
2. az cloud set –n
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR
4. az ad sp create-for-rbac --create-cert --sdk-auth.json > // create sp with certificate Se a entidade de serviço já tiver sido criada, faça logon com as informações da entidade de serviço:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth > auth.json

Autentica usando as informações da entidade de serviço fornecidas no arquivo de autenticação. Esse método definirá a subscriptionId do arquivo de autenticação para a variável de ambiente fornecida pelo usuário no parâmetro options ou o padrão "AZURE_SUBSCRIPTION_ID".

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

Parâmetros

options

LoginWithAuthFileOptions

Parâmetros opcionais

Retornos

Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Uma Promessa que é resolvida para AuthResponse, que contém "credenciais" e matriz opcional de "assinaturas" e rejeita com um Erro.

loginWithServicePrincipalCertificate(string, string, string)

Fornece um objeto ApplicationTokenCertificateCredentials e a lista de assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis.

Ao usar contas pessoais, o domain parâmetro deve ser definido como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.

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

Parâmetros

clientId

string

A ID do cliente do aplicativo active directory também conhecida como SPN (ServicePrincipal Name). Consulte Início Rápido do Active Directory para .Net para obter um exemplo.

certificateStringOrFilePath

string

Um certificado codificado em PEM e uma chave privada OU um caminho de arquivo absoluto para o arquivo .pem que contém essas informações. Por exemplo:

• CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
• CertificateFilePath: caminho de arquivo absoluto do arquivo .pem.

domain

string

A ID de domínio ou locatário que contém este aplicativo.

Retornos

Promise<ApplicationTokenCertificateCredentials>

Se um retorno de chamada tiver sido passado como o último parâmetro, ele retornará void caso contrário, retornará promise. O retorno de chamada é chamado com o objeto ApplicationTokenCertificateCredentials resultante e uma lista de assinaturas associadas em todos os locatários aplicáveis.

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

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

Parâmetros

clientId

string

certificateStringOrFilePath

string

domain

string

options

AzureTokenCredentialsOptions

Retornos

Promise<ApplicationTokenCertificateCredentials>

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

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

Parâmetros

clientId

string

certificateStringOrFilePath

string

domain

string

options

AzureTokenCredentialsOptions

callback

(err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void

loginWithServicePrincipalCertificate(string, string, string, any)

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

Parâmetros

clientId

string

certificateStringOrFilePath

string

domain

string

callback

any

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Fornece um objeto ApplicationTokenCertificateCredentials e a lista de assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis.

Ao usar contas pessoais, o domain parâmetro deve ser definido como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.

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

Parâmetros

clientId

string

A ID do cliente do aplicativo active directory também conhecida como SPN (ServicePrincipal Name). Consulte Início Rápido do Active Directory para .Net para obter um exemplo.

certificateStringOrFilePath

string

Um certificado codificado em PEM e uma chave privada OU um caminho de arquivo absoluto para o arquivo .pem que contém essas informações. Por exemplo:

• CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
• CertificateFilePath: caminho de arquivo absoluto do arquivo .pem.

domain

string

A ID de domínio ou locatário que contém esse aplicativo.

options

AzureTokenCredentialsOptions

Objeto que representa parâmetros opcionais.

Retornos

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Uma Promessa que é resolvida para AuthResponse, que contém "credenciais" e matriz opcional de "assinaturas" e rejeita com um Erro.

loginWithServicePrincipalSecret(string, string, string)

Fornece um objeto ApplicationTokenCredentials e a lista de assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis.

Ao usar contas pessoais, o domain parâmetro deve ser definido como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.

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

Parâmetros

clientId

string

A ID do cliente do aplicativo active directory também conhecida como SPN (Nome do ServicePrincipal). Consulte Início Rápido do Active Directory para .Net para obter um exemplo.

secret

string

O segredo do aplicativo para a entidade de serviço.

domain

string

A ID de domínio ou locatário que contém esse aplicativo.

Retornos

Promise<ApplicationTokenCredentials>

Se um retorno de chamada tiver sido passado como o último parâmetro, ele retornará void else retornará uma Promise. O retorno de chamada é chamado com o objeto ApplicationTokenCredentials resultante e uma lista de assinaturas associadas em todos os locatários aplicáveis.

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

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

Parâmetros

clientId

string

secret

string

domain

string

options

AzureTokenCredentialsOptions

Retornos

Promise<ApplicationTokenCredentials>

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)

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

Parâmetros

clientId

string

secret

string

domain

string

options

AzureTokenCredentialsOptions

callback

(err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void

loginWithServicePrincipalSecret(string, string, string, any)

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

Parâmetros

clientId

string

secret

string

domain

string

callback

any

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Fornece um objeto ApplicationTokenCredentials e a lista de assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis.

Ao usar contas pessoais, o domain parâmetro deve ser definido como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.

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

Parâmetros

clientId

string

A ID do cliente do aplicativo active directory também conhecida como SPN (Nome do ServicePrincipal). Consulte Início Rápido do Active Directory para .Net para obter um exemplo.

secret

string

O segredo do aplicativo para a entidade de serviço.

domain

string

A ID de domínio ou locatário que contém esse aplicativo.

options

AzureTokenCredentialsOptions

Objeto que representa parâmetros opcionais.

Retornos

Promise<AuthResponse<ApplicationTokenCredentials>>

Uma Promessa que é resolvida para AuthResponse, que contém "credenciais" e matriz opcional de "assinaturas" e rejeita com um Erro.

loginWithUsernamePassword(string, string)

Fornece um objeto UserTokenCredentials e a lista de assinaturas associadas a essa userId em todos os locatários aplicáveis.

Esse método é aplicável somente a IDs organizacionais que não estão habilitadas para 2FA, caso contrário, use o logon interativo.

Ao usar contas pessoais, a domain propriedade no options parâmetro é necessária para ser definida como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.

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

Parâmetros

username

string

O nome de usuário da conta de ID da Organização.

password

string

A senha da conta de ID da Organização.

Retornos

Promise<UserTokenCredentials>

Se um retorno de chamada tiver sido passado como o último parâmetro, ele retornará void else retornará uma Promise. O retorno de chamada é chamado com o objeto UserTokenCredentials resultante e uma lista de assinaturas associadas em todos os locatários aplicáveis.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

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

Parâmetros

username

string

password

string

options

LoginWithUsernamePasswordOptions

Retornos

Promise<UserTokenCredentials>

loginWithUsernamePassword(string, string, any)

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

Parâmetros

username

string

password

string

callback

any

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)

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

Parâmetros

username

string

password

string

options

LoginWithUsernamePasswordOptions

callback

(err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void

loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)

Fornece um objeto UserTokenCredentials e a lista de assinaturas associadas a essa userId em todos os locatários aplicáveis. Esse método é aplicável somente a IDs organizacionais que não estão habilitadas para 2FA, caso contrário, use o logon interativo.

Ao usar contas pessoais, a domain propriedade no options parâmetro é necessária para ser definida como a ID de um locatário para essa conta. Caso contrário, a credencial resultante não poderá acessar os recursos da conta.

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

Parâmetros

username

string

O nome de usuário da conta de ID da Organização.

password

string

A senha da conta de ID da Organização.

options

LoginWithUsernamePasswordOptions

Objeto que representa parâmetros opcionais.

Retornos

Promise<AuthResponse<UserTokenCredentials>>

Uma Promessa que é resolvida para AuthResponse, que contém credentials e uma matriz opcional subscriptions , e rejeita com um Erro.

loginWithVmMSI()

Antes de usar esse método, instale az cli de https://github.com/Azure/azure-cli/releases. Se você tiver uma máquina virtual do Azure provisionada com az cli e tiver a MSI habilitada, poderá usar esse método para obter tokens de autenticação da VM.

Para criar uma nova VM, habilite a MSI, execute este comando: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Observação: o comando acima habilita um ponto de extremidade de serviço no host, com uma porta padrão 50342

Para habilitar a MSI em uma VM já provisionada, execute o seguinte comando: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Para saber mais sobre esse comando, execute: az vm --assign-identity -h

Autentica usando o serviço de identidade em execução em uma máquina virtual do Azure. Esse método faz uma solicitação para o serviço de autenticação hospedado na VM e obtém de volta um token de acesso.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Retornos

Promise<MSIVmTokenCredentials>

Se um retorno de chamada tiver sido passado como o último parâmetro, ele retornará void else retornará uma Promise. O retorno de chamada é chamado com o objeto MSIVmTokenCredentials resultante.

loginWithVmMSI(MSIVmOptions)

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

Parâmetros

options

MSIVmOptions

Retornos

Promise<MSIVmTokenCredentials>

loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)

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

Parâmetros

options

MSIVmOptions

callback

Callback<MSIVmTokenCredentials>

loginWithVmMSI(Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Parâmetros

callback

Callback<MSIVmTokenCredentials>