@azure/ms-rest-nodeauth package

Klasy

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials	Opisuje poświadczenia przez pobieranie tokenu za pośrednictwem interfejsu wiersza polecenia platformy Azure.
DeviceTokenCredentials
MSIAppServiceTokenCredentials	Zawiera informacje o poświadczeniach tokenu tożsamości usługi zarządzanej w środowisku App Service.
MSITokenCredentials	Zawiera informacje o poświadczeniach tokenu tożsamości usługi zarządzanej. Ten obiekt może służyć tylko do uzyskiwania tokenu na maszynie wirtualnej aprowizowanej na platformie Azure przy użyciu tożsamości usługi zarządzanej.
MSIVmTokenCredentials	Zawiera informacje o poświadczeniach tokenu tożsamości usługi zarządzanej na maszynie wirtualnej aprowizowanej na platformie Azure.
TokenCredentialsBase
UserTokenCredentials

Interfejsy

AuthResponse	Opisuje odpowiedź uwierzytelniania.
AzureTokenCredentialsOptions	Opisuje opcjonalne parametry uwierzytelniania servicePrincipal/secret.
CliAccessToken	Opisuje token dostępu pobrany z interfejsu wiersza polecenia platformy Azure.
InteractiveLoginOptions	Opisuje opcjonalne parametry uwierzytelniania interakcyjnego.
LinkedSubscription	Zawiera informacje o subskrypcji, która została znaleziona podczas procesu uwierzytelniania. Struktura tego typu różni się od obiektu subskrypcji, który otrzymuje, wysyłając żądanie do interfejsu API ResourceManager.
LinkedUser	Zawiera informacje o użytkowniku z perspektywy uwierzytelniania.
ListAllSubscriptionOptions	Opisuje opcje, które można podać podczas wyświetlania listy wszystkich subskrypcji/kont za pośrednictwem interfejsu wiersza polecenia platformy Azure.
LoginWithAuthFileOptions	Opisuje opcjonalne parametry logowania za pomocą elementuAuthFile.
LoginWithUsernamePasswordOptions	Opisuje opcjonalne parametry uwierzytelniania nazwy użytkownika/hasła.
MSIAppServiceOptions	Definiuje opcjonalne parametry uwierzytelniania za pomocą tożsamości usługi Zarządzanej dla usługi AppService.
MSIOptions	Definiuje opcjonalne parametry uwierzytelniania za pomocą tożsamości usługi zarządzanej.
MSITokenResponse	Opisuje element MSITokenResponse.
MSIVmOptions	Definiuje opcjonalne parametry uwierzytelniania za pomocą tożsamości usługi zarządzanej dla maszyny wirtualnej.

Aliasy typu

TokenAudience
UserType	Zawiera informacje o typie użytkownika. Obecnie może to być "użytkownik" lub "servicePrincipal".

Funkcje

buildTenantList(TokenCredentialsBase, string)	Tworzy tablicę identyfikatorów dzierżawy.
createAuthenticator(MSITokenCredentials)
interactiveLogin()	Udostępnia adres URL i kod, który należy skopiować i wkleić w przeglądarce oraz uwierzytelnić się tam. W przypadku powodzenia użytkownik otrzyma obiekt DeviceTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem userId we wszystkich odpowiednich dzierżawach. W przypadku korzystania z kont osobistych domain właściwość w parametrze options jest wymagana do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.
interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)	Udostępnia adres URL i kod, który należy skopiować i wkleić w przeglądarce oraz uwierzytelnić się tam. W przypadku powodzenia użytkownik otrzyma obiekt DeviceTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem userId we wszystkich odpowiednich dzierżawach. W przypadku korzystania z kont osobistych domain właściwość w parametrze options jest wymagana do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.
loginWithAppServiceMSI()	Uwierzytelnianie przy użyciu App Service msi.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	Przed użyciem tej metody zainstaluj polecenie az cli z https://github.com/Azure/azure-cli/releasesprogramu . Następnie wykonaj polecenie az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Jeśli chcesz utworzyć dostawcę dla innej chmury/środowiska, wykonaj następujące polecenie: 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 z certyfikatem Jeśli jednostka usługi została już utworzona, zaloguj się przy użyciu informacji o jednostce usługi: az login --service-principal -u -p -t az account show --sdk-auth auth.json > Uwierzytelnia się przy użyciu informacji o jednostce usługi podanych w pliku uwierzytelniania. Ta metoda ustawi identyfikator subscriptionId z pliku uwierzytelniania na zmienną środowiskową podaną przez użytkownika w parametrze options lub domyślnym "AZURE_SUBSCRIPTION_ID".
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	Przed użyciem tej metody zainstaluj polecenie az cli z https://github.com/Azure/azure-cli/releasesprogramu . Następnie wykonaj polecenie az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Jeśli chcesz utworzyć dostawcę dla innej chmury/środowiska, wykonaj następujące polecenie: 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 z certyfikatem Jeśli jednostka usługi została już utworzona, zaloguj się przy użyciu informacji o jednostce usługi: az login --service-principal -u -p -t az account show --sdk-auth auth.json > Uwierzytelnia się przy użyciu informacji o jednostce usługi podanych w pliku uwierzytelniania. Ta metoda ustawi identyfikator subscriptionId z pliku uwierzytelniania na zmienną środowiskową podaną przez użytkownika w parametrze options lub domyślnym "AZURE_SUBSCRIPTION_ID".
loginWithServicePrincipalCertificate(string, string, string)	Udostępnia obiekt ApplicationTokenCertificateCredentials oraz listę subskrypcji skojarzonych z tym identyfikatorem servicePrincipalId/clientId we wszystkich odpowiednich dzierżawach. W przypadku korzystania z kont osobistych domain parametr jest wymagany do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.
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)	Udostępnia obiekt ApplicationTokenCertificateCredentials oraz listę subskrypcji skojarzonych z tym identyfikatorem servicePrincipalId/clientId we wszystkich odpowiednich dzierżawach. W przypadku korzystania z kont osobistych domain parametr jest wymagany do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.
loginWithServicePrincipalSecret(string, string, string)	Udostępnia obiekt ApplicationTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem servicePrincipalId/clientId we wszystkich odpowiednich dzierżawach. W przypadku korzystania z kont osobistych domain parametr jest wymagany do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.
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)	Udostępnia obiekt ApplicationTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem servicePrincipalId/clientId we wszystkich odpowiednich dzierżawach. W przypadku korzystania z kont osobistych domain parametr jest wymagany do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.
loginWithUsernamePassword(string, string)	Udostępnia obiekt UserTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem userId we wszystkich odpowiednich dzierżawach. Ta metoda ma zastosowanie tylko w przypadku identyfikatorów organizacyjnych, które nie są włączone 2FA, w przeciwnym razie użyj logowania interakcyjnego. W przypadku korzystania z kont osobistych domain właściwość w parametrze options jest wymagana do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)
loginWithUsernamePassword(string, string, any)
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)	Udostępnia obiekt UserTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem userId we wszystkich odpowiednich dzierżawach. Ta metoda ma zastosowanie tylko w przypadku identyfikatorów organizacyjnych, które nie są włączone 2FA, w przeciwnym razie użyj logowania interakcyjnego. W przypadku korzystania z kont osobistych domain właściwość w parametrze options jest wymagana do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.
loginWithVmMSI()	Przed użyciem tej metody zainstaluj polecenie az cli z https://github.com/Azure/azure-cli/releasesprogramu . Jeśli masz maszynę wirtualną platformy Azure aprowizowaną za pomocą polecenia az cli i włączono usługę MSI, możesz użyć tej metody, aby uzyskać tokeny uwierzytelniania z maszyny wirtualnej. Aby utworzyć nową maszynę wirtualną, włącz usługę MSI, wykonaj następujące polecenie: az vm create -g <-resource_group_name -n <vm_name> --assign-identity --image <os_image_name>> Uwaga: powyższe polecenie włącza punkt końcowy usługi na hoście z domyślnym portem 50342 Aby włączyć tożsamość msi na już aprowizowanej maszynie wirtualnej, wykonaj następujące polecenie: az vm --assign-identity -g <resource_group_name -n <vm_name> --port <custom_port_number>> Aby dowiedzieć się więcej o tym poleceniu, wykonaj polecenie az vm --assign-identity -h Uwierzytelnia się przy użyciu usługi tożsamości uruchomionej na maszynie wirtualnej platformy Azure. Ta metoda wysyła żądanie do usługi uwierzytelniania hostowanej na maszynie wirtualnej i pobiera token dostępu.
loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Szczegóły funkcji

buildTenantList(TokenCredentialsBase, string)

Tworzy tablicę identyfikatorów dzierżawy.

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

Parametry

credentials

TokenCredentialsBase

Poświadczenia.

apiVersion

string

wartość domyślna 2016-06-01

Zwraca

Promise<string[]>

Obietnica, która rozwiązuje tablicę identyfikatorów dzierżaw i odrzuca błąd.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parametry

credentials

MSITokenCredentials

Zwraca

Authenticator

interactiveLogin()

Udostępnia adres URL i kod, który należy skopiować i wkleić w przeglądarce oraz uwierzytelnić się tam. W przypadku powodzenia użytkownik otrzyma obiekt DeviceTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem userId we wszystkich odpowiednich dzierżawach.

W przypadku korzystania z kont osobistych domain właściwość w parametrze options jest wymagana do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Zwraca

Promise<DeviceTokenCredentials>

Jeśli wywołanie zwrotne zostało przekazane jako ostatni parametr, zwraca wartość void else zwraca obietnicę. Wywołanie zwrotne jest wywoływane z wynikowym obiektem DeviceTokenCredentials i listą skojarzonych subskrypcji we wszystkich odpowiednich dzierżawach.

interactiveLogin(InteractiveLoginOptions)

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

Parametry

options

InteractiveLoginOptions

Zwraca

Promise<DeviceTokenCredentials>

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

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

Parametry

options

InteractiveLoginOptions

callback

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

interactiveLogin(any)

function interactiveLogin(callback: any)

Parametry

callback

any

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

Udostępnia adres URL i kod, który należy skopiować i wkleić w przeglądarce oraz uwierzytelnić się tam. W przypadku powodzenia użytkownik otrzyma obiekt DeviceTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem userId we wszystkich odpowiednich dzierżawach.

W przypadku korzystania z kont osobistych domain właściwość w parametrze options jest wymagana do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.

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

Parametry

options

InteractiveLoginOptions

Obiekt reprezentujący parametry opcjonalne.

Zwraca

Promise<AuthResponse<DeviceTokenCredentials>>

Obietnica rozpoznawana jako AuthResponse, która zawiera tablicę "credentials" i opcjonalną tablicę "subscriptions" i odrzuca błąd.

loginWithAppServiceMSI()

Uwierzytelnianie przy użyciu App Service msi.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Zwraca

Promise<MSIAppServiceTokenCredentials>

Jeśli wywołanie zwrotne zostało przekazane jako ostatni parametr, zwraca wartość void else zwraca obietnicę. Wywołanie zwrotne jest wywoływane z wynikowym obiektem MSIAppServiceTokenCredentials.

loginWithAppServiceMSI(MSIAppServiceOptions)

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

Parametry

options

MSIAppServiceOptions

Zwraca

Promise<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

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

Parametry

options

MSIAppServiceOptions

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Parametry

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAuthFile()

Przed użyciem tej metody zainstaluj polecenie az cli z https://github.com/Azure/azure-cli/releasesprogramu . Następnie wykonaj polecenie az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Jeśli chcesz utworzyć dostawcę dla innej chmury/środowiska, wykonaj następujące polecenie:

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 z certyfikatem Jeśli jednostka usługi została już utworzona, zaloguj się przy użyciu informacji o jednostce usługi:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth auth.json >

Uwierzytelnia się przy użyciu informacji o jednostce usługi podanych w pliku uwierzytelniania. Ta metoda ustawi identyfikator subscriptionId z pliku uwierzytelniania na zmienną środowiskową podaną przez użytkownika w parametrze options lub domyślnym "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Zwraca

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Jeśli wywołanie zwrotne zostało przekazane jako ostatni parametr, zwraca wartość void else zwraca obietnicę. Wywołanie zwrotne jest wywoływane z wynikowym obiektem ApplicationTokenCredentials lub ApplicationTokenCertificateCredentials oraz listą skojarzonych subskrypcji we wszystkich odpowiednich dzierżawach.

loginWithAuthFile(LoginWithAuthFileOptions)

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

Parametry

options

LoginWithAuthFileOptions

Zwraca

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)

Parametry

options

LoginWithAuthFileOptions

callback

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

loginWithAuthFile(any)

function loginWithAuthFile(callback: any)

Parametry

callback

any

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

Przed użyciem tej metody zainstaluj polecenie az cli z https://github.com/Azure/azure-cli/releasesprogramu . Następnie wykonaj polecenie az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Jeśli chcesz utworzyć dostawcę dla innej chmury/środowiska, wykonaj następujące polecenie:

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 z certyfikatem Jeśli jednostka usługi została już utworzona, zaloguj się przy użyciu informacji o jednostce usługi:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth auth.json >

Uwierzytelnia się przy użyciu informacji o jednostce usługi podanych w pliku uwierzytelniania. Ta metoda ustawi identyfikator subscriptionId z pliku uwierzytelniania na zmienną środowiskową podaną przez użytkownika w parametrze options lub domyślnym "AZURE_SUBSCRIPTION_ID".

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

Parametry

options

LoginWithAuthFileOptions

Parametry opcjonalne

Zwraca

Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Obietnica rozpoznawana jako AuthResponse, która zawiera tablicę "credentials" i opcjonalną tablicę "subscriptions" i odrzuca błąd.

loginWithServicePrincipalCertificate(string, string, string)

Udostępnia obiekt ApplicationTokenCertificateCredentials oraz listę subskrypcji skojarzonych z tym identyfikatorem servicePrincipalId/clientId we wszystkich odpowiednich dzierżawach.

W przypadku korzystania z kont osobistych domain parametr jest wymagany do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.

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

Parametry

clientId

string

Identyfikator klienta aplikacji usługi Active Directory znany również jako nazwa SPN (servicePrincipal Name). Zobacz przewodnik Szybki start dotyczący usługi Active Directory dla platformy .Net , aby zapoznać się z przykładem.

certificateStringOrFilePath

string

Certyfikat kodowany PEM i klucz prywatny LUB bezwzględna ścieżka pliku do pliku pem zawierającego te informacje. Przykład:

• CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
• CertificateFilePath: bezwzględna ścieżka pliku pem.

domain

string

Identyfikator domeny lub dzierżawy zawierający tę aplikację.

Zwraca

Promise<ApplicationTokenCertificateCredentials>

Jeśli wywołanie zwrotne zostało przekazane jako ostatni parametr, zwraca wartość void else zwraca obietnicę. Wywołanie zwrotne jest wywoływane z wynikowym obiektem ApplicationTokenCertificateCredentials i listą skojarzonych subskrypcji we wszystkich odpowiednich dzierżawach.

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

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

Parametry

clientId

string

certificateStringOrFilePath

string

domain

string

options

AzureTokenCredentialsOptions

Zwraca

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)

Parametry

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)

Parametry

clientId

string

certificateStringOrFilePath

string

domain

string

callback

any

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Udostępnia obiekt ApplicationTokenCertificateCredentials oraz listę subskrypcji skojarzonych z tym identyfikatorem servicePrincipalId/clientId we wszystkich odpowiednich dzierżawach.

W przypadku korzystania z kont osobistych domain parametr jest wymagany do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.

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

Parametry

clientId

string

Identyfikator klienta aplikacji usługi Active Directory znany również jako nazwa SPN (servicePrincipal Name). Zobacz przewodnik Szybki start dotyczący usługi Active Directory dla platformy .Net , aby zapoznać się z przykładem.

certificateStringOrFilePath

string

Certyfikat kodowany PEM i klucz prywatny LUB bezwzględna ścieżka pliku do pliku pem zawierającego te informacje. Przykład:

• CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
• CertificateFilePath: bezwzględna ścieżka pliku pem.

domain

string

Identyfikator domeny lub dzierżawy zawierający tę aplikację.

options

AzureTokenCredentialsOptions

Obiekt reprezentujący parametry opcjonalne.

Zwraca

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Obietnica rozpoznawana jako AuthResponse, która zawiera tablicę "credentials" i opcjonalną tablicę "subscriptions" i odrzuca błąd.

loginWithServicePrincipalSecret(string, string, string)

Udostępnia obiekt ApplicationTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem servicePrincipalId/clientId we wszystkich odpowiednich dzierżawach.

W przypadku korzystania z kont osobistych domain parametr jest wymagany do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.

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

Parametry

clientId

string

Identyfikator klienta aplikacji usługi Active Directory znany również jako nazwa SPN (servicePrincipal Name). Zobacz przewodnik Szybki start dotyczący usługi Active Directory dla platformy .Net , aby zapoznać się z przykładem.

secret

string

Wpis tajny aplikacji dla jednostki usługi.

domain

string

Identyfikator domeny lub dzierżawy zawierający tę aplikację.

Zwraca

Promise<ApplicationTokenCredentials>

Jeśli wywołanie zwrotne zostało przekazane jako ostatni parametr, zwraca wartość void else zwraca obietnicę. Wywołanie zwrotne jest wywoływane z wynikowym obiektem ApplicationTokenCredentials i listą skojarzonych subskrypcji we wszystkich odpowiednich dzierżawach.

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

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

Parametry

clientId

string

secret

string

domain

string

options

AzureTokenCredentialsOptions

Zwraca

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)

Parametry

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)

Parametry

clientId

string

secret

string

domain

string

callback

any

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Udostępnia obiekt ApplicationTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem servicePrincipalId/clientId we wszystkich odpowiednich dzierżawach.

W przypadku korzystania z kont osobistych domain parametr jest wymagany do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.

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

Parametry

clientId

string

Identyfikator klienta aplikacji usługi Active Directory znany również jako nazwa SPN (servicePrincipal Name). Zobacz przewodnik Szybki start dotyczący usługi Active Directory dla platformy .Net , aby zapoznać się z przykładem.

secret

string

Wpis tajny aplikacji dla jednostki usługi.

domain

string

Identyfikator domeny lub dzierżawy zawierający tę aplikację.

options

AzureTokenCredentialsOptions

Obiekt reprezentujący parametry opcjonalne.

Zwraca

Promise<AuthResponse<ApplicationTokenCredentials>>

Obietnica rozpoznawana jako AuthResponse, która zawiera tablicę "credentials" i opcjonalną tablicę "subscriptions" i odrzuca błąd.

loginWithUsernamePassword(string, string)

Udostępnia obiekt UserTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem userId we wszystkich odpowiednich dzierżawach.

Ta metoda ma zastosowanie tylko w przypadku identyfikatorów organizacyjnych, które nie są włączone 2FA, w przeciwnym razie użyj logowania interakcyjnego.

W przypadku korzystania z kont osobistych domain właściwość w parametrze options jest wymagana do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.

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

Parametry

username

string

Nazwa użytkownika konta identyfikatora organizacji.

password

string

Hasło konta identyfikatora organizacji.

Zwraca

Promise<UserTokenCredentials>

Jeśli wywołanie zwrotne zostało przekazane jako ostatni parametr, zwraca wartość void else zwraca obietnicę. Wywołanie zwrotne jest wywoływane z wynikowym obiektem UserTokenCredentials i listą skojarzonych subskrypcji we wszystkich odpowiednich dzierżawach.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

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

Parametry

username

string

password

string

options

LoginWithUsernamePasswordOptions

Zwraca

Promise<UserTokenCredentials>

loginWithUsernamePassword(string, string, any)

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

Parametry

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)

Parametry

username

string

password

string

options

LoginWithUsernamePasswordOptions

callback

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

loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)

Udostępnia obiekt UserTokenCredentials i listę subskrypcji skojarzonych z tym identyfikatorem userId we wszystkich odpowiednich dzierżawach. Ta metoda ma zastosowanie tylko w przypadku identyfikatorów organizacyjnych, które nie są włączone 2FA, w przeciwnym razie użyj logowania interakcyjnego.

W przypadku korzystania z kont osobistych domain właściwość w parametrze options jest wymagana do ustawienia identyfikatora dzierżawy dla tego konta. W przeciwnym razie wynikowe poświadczenie nie będzie mogło uzyskać dostępu do zasobów konta.

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

Parametry

username

string

Nazwa użytkownika konta identyfikatora organizacji.

password

string

Hasło konta identyfikatora organizacji.

options

LoginWithUsernamePasswordOptions

Obiekt reprezentujący parametry opcjonalne.

Zwraca

Promise<AuthResponse<UserTokenCredentials>>

Obietnica rozpoznawana jako AuthResponse, która zawiera credentials i opcjonalną subscriptions tablicę oraz odrzuca błąd.

loginWithVmMSI()

Przed użyciem tej metody zainstaluj polecenie az cli z https://github.com/Azure/azure-cli/releasesprogramu . Jeśli masz maszynę wirtualną platformy Azure aprowizowaną za pomocą polecenia az cli i włączono usługę MSI, możesz użyć tej metody, aby uzyskać tokeny uwierzytelniania z maszyny wirtualnej.

Aby utworzyć nową maszynę wirtualną, włącz usługę MSI, wykonaj następujące polecenie: az vm create -g <-resource_group_name -n <vm_name> --assign-identity --image <os_image_name>> Uwaga: powyższe polecenie włącza punkt końcowy usługi na hoście z domyślnym portem 50342

Aby włączyć tożsamość msi na już aprowizowanej maszynie wirtualnej, wykonaj następujące polecenie: az vm --assign-identity -g <resource_group_name -n <vm_name> --port <custom_port_number>>

Aby dowiedzieć się więcej o tym poleceniu, wykonaj polecenie az vm --assign-identity -h

Uwierzytelnia się przy użyciu usługi tożsamości uruchomionej na maszynie wirtualnej platformy Azure. Ta metoda wysyła żądanie do usługi uwierzytelniania hostowanej na maszynie wirtualnej i pobiera token dostępu.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Zwraca

Promise<MSIVmTokenCredentials>

Jeśli wywołanie zwrotne zostało przekazane jako ostatni parametr, zwraca wartość void else zwraca obietnicę. Wywołanie zwrotne jest wywoływane z wynikowym obiektem MSIVmTokenCredentials.

loginWithVmMSI(MSIVmOptions)

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

Parametry

options

MSIVmOptions

Zwraca

Promise<MSIVmTokenCredentials>

loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)

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

Parametry

options

MSIVmOptions

callback

Callback<MSIVmTokenCredentials>

loginWithVmMSI(Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Parametry

callback

Callback<MSIVmTokenCredentials>