@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 gerenciado em um ambiente do Serviço de Aplicativo.
MSITokenCredentials	Fornece informações sobre credenciais de token de identidade de serviço gerenciado. Esse objeto só pode ser usado para adquirir token em uma máquina virtual provisionada no Azure com identidade de serviço gerenciado.
MSIVmTokenCredentials	Fornece informações sobre credenciais de token de identidade de serviço gerenciado 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 que foi encontrada durante o processo de autenticação. A estrutura desse tipo é diferente do objeto de assinatura que se obtém fazendo uma solicitação à API do ResourceManager.
LinkedUser	Fornece informações sobre um usuário da perspetiva da 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 login withAuthFile.
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 for 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, pode ser "user" 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 lá. Se for bem-sucedido, o usuário obterá um objeto DeviceTokenCredentials e a lista de assinaturas associadas a esse userId em todos os locatários aplicáveis. Ao usar contas pessoais, a propriedade domain no parâmetro options deve 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 lá. Se for bem-sucedido, o usuário obterá um objeto DeviceTokenCredentials e a lista de assinaturas associadas a esse userId em todos os locatários aplicáveis. Ao usar contas pessoais, a propriedade domain no parâmetro options deve 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-se usando o MSI do Serviço de Aplicativo.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	Antes de usar 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 você quiser criar o sp para uma nuvem/ambiente diferente, execute: Lista de nuvens AZ az conjunto de nuvens –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 // criar sp com certificado Se a entidade de serviço já estiver criada, faça login 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á o subscriptionId do arquivo de autenticação para a variável de ambiente fornecida pelo usuário no parâmetro options ou no padrão "AZURE_SUBSCRIPTION_ID".
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	Antes de usar 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 você quiser criar o sp para uma nuvem/ambiente diferente, execute: Lista de nuvens AZ az conjunto de nuvens –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 // criar sp com certificado Se a entidade de serviço já estiver criada, faça login 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á o subscriptionId do arquivo de autenticação para a variável de ambiente fornecida pelo usuário no parâmetro options ou no 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 parâmetro domain deve ser definido como o 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 parâmetro domain deve ser definido como o 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 parâmetro domain deve ser definido como o 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 parâmetro domain deve ser definido como o 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 esse userId em todos os locatários aplicáveis. Este método é aplicável apenas para ids organizacionais que não estão habilitadas para 2FA, caso contrário, use o login interativo. Ao usar contas pessoais, a propriedade domain no parâmetro options deve 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 esse userId em todos os locatários aplicáveis. Este método é aplicável apenas para ids organizacionais que não estão habilitadas para 2FA, caso contrário, use o login interativo. Ao usar contas pessoais, a propriedade domain no parâmetro options deve 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 este método, instale az cli a partir de https://github.com/Azure/azure-cli/releases. Se você tiver uma máquina virtual do Azure provisionada com az cli e tiver o MSI habilitado, poderá usar esse método para obter tokens de autenticação da VM. Para criar uma nova VM, habilite 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 habilita um ponto de extremidade de serviço no host, com uma porta padrão 50342 Para habilitar o 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 este 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 ao serviço de autenticação hospedado na VM e recebe de volta 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 padrão 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 uma url e um código que precisam ser copiados e colados em um navegador e autenticados lá. Se for bem-sucedido, o usuário obterá um objeto DeviceTokenCredentials e a lista de assinaturas associadas a esse userId em todos os locatários aplicáveis.

Ao usar contas pessoais, a propriedade domain no parâmetro options deve 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>

Devoluções

Promise<DeviceTokenCredentials>

Se um retorno de chamada foi passado como o último parâmetro, então ele retorna void else retorna um 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

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 uma url e um código que precisam ser copiados e colados em um navegador e autenticados lá. Se for bem-sucedido, o usuário obterá um objeto DeviceTokenCredentials e a lista de assinaturas associadas a esse userId em todos os locatários aplicáveis.

Ao usar contas pessoais, a propriedade domain no parâmetro options deve 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.

Devoluções

Promise<AuthResponse<DeviceTokenCredentials>>

Uma promessa que resolve para AuthResponse, que contém "credenciais" e matriz opcional de "assinaturas" e rejeita com um erro.

loginWithAppServiceMSI()

Autentique-se usando o MSI do Serviço de Aplicativo.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Devoluções

Promise<MSIAppServiceTokenCredentials>

Se um retorno de chamada foi passado como o último parâmetro, então ele retorna void else retorna um Promise. O retorno de chamada é chamado 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 usar 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 você quiser criar o sp para uma nuvem/ambiente diferente, execute:

1. Lista de nuvens AZ
2. az conjunto de nuvens –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 // criar sp com certificado Se a entidade de serviço já estiver criada, faça login 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á o subscriptionId do arquivo de autenticação para a variável de ambiente fornecida pelo usuário no parâmetro options ou no padrão "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Devoluções

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Se um retorno de chamada foi passado como o último parâmetro, então ele retorna void else retorna um 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

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 usar 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 você quiser criar o sp para uma nuvem/ambiente diferente, execute:

1. Lista de nuvens AZ
2. az conjunto de nuvens –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 // criar sp com certificado Se a entidade de serviço já estiver criada, faça login 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á o subscriptionId do arquivo de autenticação para a variável de ambiente fornecida pelo usuário no parâmetro options ou no padrão "AZURE_SUBSCRIPTION_ID".

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 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 parâmetro domain deve ser definido como o 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

O ID do cliente de aplicativo do Ative Directory também conhecido como SPN (ServicePrincipal Name). Consulte Ative Directory Quickstart for .Net para obter um exemplo.

certificateStringOrFilePath

string

Um certificado codificado PEM e 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

O domínio ou ID do locatário que contém este aplicativo.

Devoluções

Promise<ApplicationTokenCertificateCredentials>

Se um retorno de chamada foi passado como o último parâmetro, então ele retorna void else retorna um 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

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 assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis.

Ao usar contas pessoais, o parâmetro domain deve ser definido como o 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

O ID do cliente de aplicativo do Ative Directory também conhecido como SPN (ServicePrincipal Name). Consulte Ative Directory Quickstart for .Net para obter um exemplo.

certificateStringOrFilePath

string

Um certificado codificado PEM e 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

O domínio ou ID do locatário que contém este aplicativo.

options

AzureTokenCredentialsOptions

Objeto que representa parâmetros opcionais.

Devoluções

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Uma promessa que resolve 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 parâmetro domain deve ser definido como o 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

O ID do cliente de aplicativo do Ative Directory também conhecido como SPN (ServicePrincipal Name). Consulte Ative Directory Quickstart for .Net para obter um exemplo.

secret

string

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

domain

string

O domínio ou ID do locatário que contém este aplicativo.

Devoluções

Promise<ApplicationTokenCredentials>

Se um retorno de chamada foi passado como o último parâmetro, então ele retorna void else retorna um 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

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 assinaturas associadas a esse servicePrincipalId/clientId em todos os locatários aplicáveis.

Ao usar contas pessoais, o parâmetro domain deve ser definido como o 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

O ID do cliente de aplicativo do Ative Directory também conhecido como SPN (ServicePrincipal Name). Consulte Ative Directory Quickstart for .Net para obter um exemplo.

secret

string

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

domain

string

O domínio ou ID do locatário que contém este aplicativo.

options

AzureTokenCredentialsOptions

Objeto que representa parâmetros opcionais.

Devoluções

Promise<AuthResponse<ApplicationTokenCredentials>>

Uma promessa que resolve 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 esse userId em todos os locatários aplicáveis.

Este método é aplicável apenas para ids organizacionais que não estão habilitadas para 2FA, caso contrário, use o login interativo.

Ao usar contas pessoais, a propriedade domain no parâmetro options deve 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.

Devoluções

Promise<UserTokenCredentials>

Se um retorno de chamada foi passado como o último parâmetro, então ele retorna void else retorna um 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

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 assinaturas associadas a esse userId em todos os locatários aplicáveis. Este método é aplicável apenas para ids organizacionais que não estão habilitadas para 2FA, caso contrário, use o login interativo.

Ao usar contas pessoais, a propriedade domain no parâmetro options deve 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.

Devoluções

Promise<AuthResponse<UserTokenCredentials>>

Um Promise que resolve para AuthResponse, que contém credentials e uma matriz subscriptions opcional, e rejeita com um Error.

loginWithVmMSI()

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

Para criar uma nova VM, habilite 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 habilita um ponto de extremidade de serviço no host, com uma porta padrão 50342

Para habilitar o 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 este 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 ao serviço de autenticação hospedado na VM e recebe de volta um token de acesso.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Devoluções

Promise<MSIVmTokenCredentials>

Se um retorno de chamada foi passado como o último parâmetro, então ele retorna void else retorna um Promise. O retorno de chamada é chamado 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>