@azure/ms-rest-nodeauth package

Classes

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials	Descreve as credenciais ao obter o token através da CLI do Azure.
DeviceTokenCredentials
MSIAppServiceTokenCredentials	Fornece informações sobre credenciais de token de identidade de serviço gerida num ambiente Serviço de Aplicações.
MSITokenCredentials	Fornece informações sobre as credenciais do token de identidade de serviço gerida. Este objeto só pode ser utilizado para adquirir o token numa máquina virtual aprovisionada no Azure com a identidade de serviço gerida.
MSIVmTokenCredentials	Fornece informações sobre as credenciais do token de identidade de serviço gerida numa máquina virtual aprovisionada no Azure.
TokenCredentialsBase
UserTokenCredentials

Interfaces

AuthResponse	Descreve a resposta de autenticação.
AzureTokenCredentialsOptions	Descreve os parâmetros opcionais para a autenticação servicePrincipal/secret.
CliAccessToken	Descreve o token de acesso obtido da CLI do Azure.
InteractiveLoginOptions	Descreve os parâmetros opcionais para a autenticação interativa.
LinkedSubscription	Fornece informações sobre a subscrição que foi encontrada durante o processo de autenticação. A estrutura deste tipo é diferente do objeto de subscrição que se obtém ao fazer um pedido à API ResourceManager.
LinkedUser	Fornece informações sobre um utilizador na perspetiva de autenticação.
ListAllSubscriptionOptions	Descreve as opções que podem ser fornecidas ao listar todas as subscrições/contas através da CLI do Azure.
LoginWithAuthFileOptions	Descreve os parâmetros opcionais para o início de sessão comAuthFile.
LoginWithUsernamePasswordOptions	Descreve os parâmetros opcionais para a autenticação de nome de utilizador/palavra-passe.
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 utilizador. Atualmente, pode ser "utilizador" ou "servicePrincipal".

Funções

buildTenantList(TokenCredentialsBase, string)	Cria uma matriz de tenantIds.
createAuthenticator(MSITokenCredentials)
interactiveLogin()	Fornece um URL e código que têm de ser copiados e colados num browser e autenticados nesse local. Se for bem-sucedido, o utilizador obterá um objeto DeviceTokenCredentials e a lista de subscrições associadas a esse userId em todos os inquilinos aplicáveis. Ao utilizar contas pessoais, a domain propriedade no options parâmetro tem de ser definida para o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.
interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)	Fornece um URL e código que têm de ser copiados e colados num browser e autenticados nesse local. Se for bem-sucedido, o utilizador obterá um objeto DeviceTokenCredentials e a lista de subscrições associadas a esse userId em todos os inquilinos aplicáveis. Ao utilizar contas pessoais, a domain propriedade no options parâmetro tem de ser definida para o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.
loginWithAppServiceMSI()	Autenticar com o Serviço de Aplicações MSI.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	Antes de utilizar este método, instale az cli a partir de https://github.com/Azure/azure-cli/releases. Em seguida, execute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se quiser criar o sp para uma cloud/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 > auth.json // create sp with certificate Se o principal de serviço já estiver criado, inicie sessão com as informações do principal de serviço: az login --service-principal -u -p -t az account show --sdk-auth > auth.json Autentica com as informações do principal de serviço fornecidas no ficheiro de autenticação. Este método irá definir o subscriptionId do ficheiro de autenticação para a variável de ambiente fornecida pelo utilizador no parâmetro de opções ou o "AZURE_SUBSCRIPTION_ID" predefinido.
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	Antes de utilizar este método, instale az cli a partir de https://github.com/Azure/azure-cli/releases. Em seguida, execute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se quiser criar o sp para uma cloud/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 > auth.json // create sp with certificate Se o principal de serviço já estiver criado, inicie sessão com as informações do principal de serviço: az login --service-principal -u -p -t az account show --sdk-auth > auth.json Autentica com as informações do principal de serviço fornecidas no ficheiro de autenticação. Este método irá definir o subscriptionId do ficheiro de autenticação para a variável de ambiente fornecida pelo utilizador no parâmetro de opções ou o "AZURE_SUBSCRIPTION_ID" predefinido.
loginWithServicePrincipalCertificate(string, string, string)	Fornece um objeto ApplicationTokenCertificateCredentials e a lista de subscrições associadas a esse servicePrincipalId/clientId em todos os inquilinos aplicáveis. Ao utilizar contas pessoais, o domain parâmetro tem de ser definido como o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos 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 subscrições associadas a esse servicePrincipalId/clientId em todos os inquilinos aplicáveis. Ao utilizar contas pessoais, o domain parâmetro tem de ser definido como o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.
loginWithServicePrincipalSecret(string, string, string)	Fornece um objeto ApplicationTokenCredentials e a lista de subscrições associadas a esse servicePrincipalId/clientId em todos os inquilinos aplicáveis. Ao utilizar contas pessoais, o domain parâmetro tem de ser definido como o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos 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 subscrições associadas a esse servicePrincipalId/clientId em todos os inquilinos aplicáveis. Ao utilizar contas pessoais, o domain parâmetro tem de ser definido como o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.
loginWithUsernamePassword(string, string)	Fornece um objeto UserTokenCredentials e a lista de subscrições associadas a esse userId em todos os inquilinos aplicáveis. Este método é aplicável apenas a IDs organizacionais que não tenham a 2FA ativada. Caso contrário, utilize o início de sessão interativo. Ao utilizar contas pessoais, a domain propriedade no options parâmetro tem de ser definida para o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos 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 subscrições associadas a esse userId em todos os inquilinos aplicáveis. Este método é aplicável apenas a IDs organizacionais que não tenham a 2FA ativada. Caso contrário, utilize o início de sessão interativo. Ao utilizar contas pessoais, a domain propriedade no options parâmetro tem de ser definida para o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.
loginWithVmMSI()	Antes de utilizar este método, instale az cli a partir de https://github.com/Azure/azure-cli/releases. Se tiver uma máquina virtual do Azure aprovisionada com az cli e tiver o MSI ativado, pode utilizar este método para obter tokens de autenticação da VM. Para criar uma nova VM, ative o MSI, execute este comando: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Nota: o comando acima ativa um ponto final de serviço no anfitrião, com uma porta predefinida 50342 Para ativar o MSI numa VM já aprovisionada, execute o seguinte comando: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number> Para saber mais sobre este comando, execute: az vm --assign-identity -h Autentica com o serviço de identidade em execução numa máquina virtual do Azure. Este método faz um pedido ao serviço de autenticação alojado na VM e obtém um token de acesso.
loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Detalhes de 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 predefinido 2016-06-01

Devoluções

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

Devoluções

Authenticator

interactiveLogin()

Fornece um URL e código que têm de ser copiados e colados num browser e autenticados nesse local. Se for bem-sucedido, o utilizador obterá um objeto DeviceTokenCredentials e a lista de subscrições associadas a esse userId em todos os inquilinos aplicáveis.

Ao utilizar contas pessoais, a domain propriedade no options parâmetro tem de ser definida para o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Devoluções

Promise<DeviceTokenCredentials>

Se uma chamada de retorno tiver sido transmitida como o último parâmetro, devolve nulo senão devolve uma Promessa. A chamada de retorno é chamada com o objeto DeviceTokenCredentials resultante e uma lista de subscrições associadas em todos os inquilinos aplicáveis.

interactiveLogin(InteractiveLoginOptions)

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

Parâmetros

options

InteractiveLoginOptions

Devoluções

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 um URL e código que têm de ser copiados e colados num browser e autenticados nesse local. Se for bem-sucedido, o utilizador obterá um objeto DeviceTokenCredentials e a lista de subscrições associadas a esse userId em todos os inquilinos aplicáveis.

Ao utilizar contas pessoais, a domain propriedade no options parâmetro tem de ser definida para o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.

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

Parâmetros

options

InteractiveLoginOptions

Objeto que representa parâmetros opcionais.

Devoluções

Promise<AuthResponse<DeviceTokenCredentials>>

Uma Promessa que resolve para a AuthResponse, que contém "credenciais" e matriz opcional de "subscrições" e rejeita com um Erro.

loginWithAppServiceMSI()

Autenticar com o Serviço de Aplicações MSI.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Devoluções

Promise<MSIAppServiceTokenCredentials>

Se uma chamada de retorno tiver sido transmitida como o último parâmetro, devolve nulo senão devolve uma Promessa. A chamada de retorno é chamada com o objeto MSIAppServiceTokenCredentials resultante.

loginWithAppServiceMSI(MSIAppServiceOptions)

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

Parâmetros

options

MSIAppServiceOptions

Devoluções

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 utilizar este método, instale az cli a partir de https://github.com/Azure/azure-cli/releases. Em seguida, execute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se quiser criar o sp para uma cloud/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 > auth.json // create sp with certificate Se o principal de serviço já estiver criado, inicie sessão com as informações do principal de serviço:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth > auth.json

Autentica com as informações do principal de serviço fornecidas no ficheiro de autenticação. Este método irá definir o subscriptionId do ficheiro de autenticação para a variável de ambiente fornecida pelo utilizador no parâmetro de opções ou o "AZURE_SUBSCRIPTION_ID" predefinido.

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Devoluções

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Se uma chamada de retorno tiver sido transmitida como o último parâmetro, devolve nulo senão devolve uma Promessa. A chamada de retorno é chamada com o objeto ApplicationTokenCredentials ou ApplicationTokenCertificateCredentials resultante e uma lista de subscrições associadas em todos os inquilinos aplicáveis.

loginWithAuthFile(LoginWithAuthFileOptions)

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

Parâmetros

options

LoginWithAuthFileOptions

Devoluções

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 utilizar este método, instale az cli a partir de https://github.com/Azure/azure-cli/releases. Em seguida, execute az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se quiser criar o sp para uma cloud/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 > auth.json // create sp with certificate Se o principal de serviço já estiver criado, inicie sessão com as informações do principal de serviço:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth > auth.json

Autentica com as informações do principal de serviço fornecidas no ficheiro de autenticação. Este método irá definir o subscriptionId do ficheiro de autenticação para a variável de ambiente fornecida pelo utilizador no parâmetro de opções ou o "AZURE_SUBSCRIPTION_ID" predefinido.

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

Parâmetros

options

LoginWithAuthFileOptions

Parâmetros opcionais

Devoluções

Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Uma Promessa que resolve para a AuthResponse, que contém "credenciais" e matriz opcional de "subscrições" e rejeita com um Erro.

loginWithServicePrincipalCertificate(string, string, string)

Fornece um objeto ApplicationTokenCertificateCredentials e a lista de subscrições associadas a esse servicePrincipalId/clientId em todos os inquilinos aplicáveis.

Ao utilizar contas pessoais, o domain parâmetro tem de ser definido como o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.

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

Parâmetros

clientId

string

O ID de cliente da aplicação do Active Directory também conhecido como SPN (ServicePrincipal Name). Veja Início Rápido do Active Directory para .Net para obter um exemplo.

certificateStringOrFilePath

string

Um certificado codificado PEM e uma chave privada OU um caminho de ficheiro absoluto para o ficheiro .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 ficheiro absoluto do ficheiro .pem.

domain

string

O ID de domínio ou inquilino que contém esta aplicação.

Devoluções

Promise<ApplicationTokenCertificateCredentials>

Se uma chamada de retorno tiver sido transmitida como o último parâmetro, devolve nulo senão devolve uma Promessa. A chamada de retorno é chamada com o objeto ApplicationTokenCertificateCredentials resultante e uma lista de subscrições associadas em todos os inquilinos 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

Devoluções

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 subscrições associadas a esse servicePrincipalId/clientId em todos os inquilinos aplicáveis.

Ao utilizar contas pessoais, o domain parâmetro tem de ser definido como o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.

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

Parâmetros

clientId

string

O ID de cliente da aplicação do Active Directory também conhecido como SPN (ServicePrincipal Name). Veja Início Rápido do Active Directory para .Net para obter um exemplo.

certificateStringOrFilePath

string

Um certificado codificado PEM e uma chave privada OU um caminho de ficheiro absoluto para o ficheiro .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 ficheiro absoluto do ficheiro .pem.

domain

string

O ID de domínio ou inquilino que contém esta aplicação.

options

AzureTokenCredentialsOptions

Objeto que representa parâmetros opcionais.

Devoluções

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Uma Promessa que resolve para a AuthResponse, que contém "credenciais" e matriz opcional de "subscrições" e rejeita com um Erro.

loginWithServicePrincipalSecret(string, string, string)

Fornece um objeto ApplicationTokenCredentials e a lista de subscrições associadas a esse servicePrincipalId/clientId em todos os inquilinos aplicáveis.

Ao utilizar contas pessoais, o domain parâmetro tem de ser definido como o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.

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

Parâmetros

clientId

string

O ID de cliente da aplicação do Active Directory também conhecido como SPN (ServicePrincipal Name). Veja Início Rápido do Active Directory para .Net para obter um exemplo.

secret

string

O segredo da aplicação para o principal de serviço.

domain

string

O ID de domínio ou inquilino que contém esta aplicação.

Devoluções

Promise<ApplicationTokenCredentials>

Se uma chamada de retorno tiver sido transmitida como o último parâmetro, devolve nulo senão devolve uma Promessa. A chamada de retorno é chamada com o objeto ApplicationTokenCredentials resultante e uma lista de subscrições associadas em todos os inquilinos 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

Devoluções

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 subscrições associadas a esse servicePrincipalId/clientId em todos os inquilinos aplicáveis.

Ao utilizar contas pessoais, o domain parâmetro tem de ser definido como o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.

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

Parâmetros

clientId

string

O ID de cliente da aplicação do Active Directory também conhecido como SPN (ServicePrincipal Name). Veja Início Rápido do Active Directory para .Net para obter um exemplo.

secret

string

O segredo da aplicação para o principal de serviço.

domain

string

O ID de domínio ou inquilino que contém esta aplicação.

options

AzureTokenCredentialsOptions

Objeto que representa parâmetros opcionais.

Devoluções

Promise<AuthResponse<ApplicationTokenCredentials>>

Uma Promessa que resolve para a AuthResponse, que contém "credenciais" e matriz opcional de "subscrições" e rejeita com um Erro.

loginWithUsernamePassword(string, string)

Fornece um objeto UserTokenCredentials e a lista de subscrições associadas a esse userId em todos os inquilinos aplicáveis.

Este método é aplicável apenas a IDs organizacionais que não tenham a 2FA ativada. Caso contrário, utilize o início de sessão interativo.

Ao utilizar contas pessoais, a domain propriedade no options parâmetro tem de ser definida para o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.

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

Parâmetros

username

string

O nome de utilizador da conta de ID da Organização.

password

string

A palavra-passe da conta de ID da Organização.

Devoluções

Promise<UserTokenCredentials>

Se uma chamada de retorno tiver sido transmitida como o último parâmetro, devolve nulo senão devolve uma Promessa. A chamada de retorno é chamada com o objeto UserTokenCredentials resultante e uma lista de subscrições associadas em todos os inquilinos aplicáveis.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

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

Parâmetros

username

string

password

string

options

LoginWithUsernamePasswordOptions

Devoluções

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 subscrições associadas a esse userId em todos os inquilinos aplicáveis. Este método é aplicável apenas a IDs organizacionais que não tenham a 2FA ativada. Caso contrário, utilize o início de sessão interativo.

Ao utilizar contas pessoais, a domain propriedade no options parâmetro tem de ser definida para o ID de um inquilino para essa conta. Caso contrário, a credencial resultante não conseguirá aceder aos recursos da conta.

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

Parâmetros

username

string

O nome de utilizador da conta de ID da Organização.

password

string

A palavra-passe da conta de ID da Organização.

options

LoginWithUsernamePasswordOptions

Objeto que representa parâmetros opcionais.

Devoluções

Promise<AuthResponse<UserTokenCredentials>>

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

loginWithVmMSI()

Antes de utilizar este método, instale az cli a partir de https://github.com/Azure/azure-cli/releases. Se tiver uma máquina virtual do Azure aprovisionada com az cli e tiver o MSI ativado, pode utilizar este método para obter tokens de autenticação da VM.

Para criar uma nova VM, ative o MSI, execute este comando: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Nota: o comando acima ativa um ponto final de serviço no anfitrião, com uma porta predefinida 50342

Para ativar o MSI numa VM já aprovisionada, execute o seguinte comando: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

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

Autentica com o serviço de identidade em execução numa máquina virtual do Azure. Este método faz um pedido ao serviço de autenticação alojado na VM e obtém um token de acesso.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Devoluções

Promise<MSIVmTokenCredentials>

Se uma chamada de retorno tiver sido transmitida como o último parâmetro, devolve nulo senão devolve uma Promessa. A chamada de retorno é chamada com o objeto MSIVmTokenCredentials resultante.

loginWithVmMSI(MSIVmOptions)

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

Parâmetros

options

MSIVmOptions

Devoluções

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>