@azure/ms-rest-nodeauth package

Třídy

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials	Popisuje přihlašovací údaje načtením tokenu prostřednictvím Azure CLI.
DeviceTokenCredentials
MSIAppServiceTokenCredentials	Poskytuje informace o přihlašovacích údajích tokenu identity spravované služby v prostředí App Service.
MSITokenCredentials	Poskytuje informace o přihlašovacích údaji tokenu identity spravované služby. Tento objekt lze použít pouze k získání tokenu na virtuálním počítači zřízeném v Azure s identitou spravované služby.
MSIVmTokenCredentials	Poskytuje informace o přihlašovacích údajích tokenu identity spravované služby na virtuálním počítači zřízeném v Azure.
TokenCredentialsBase
UserTokenCredentials

Rozhraní

AuthResponse	Popisuje odpověď na ověření.
AzureTokenCredentialsOptions	Popisuje volitelné parametry pro ověřování servicePrincipal/secret.
CliAccessToken	Popisuje přístupový token načtený z Azure CLI.
InteractiveLoginOptions	Popisuje volitelné parametry pro interaktivní ověřování.
LinkedSubscription	Poskytuje informace o předplatném, které bylo nalezeno během procesu ověřování. Struktura tohoto typu se liší od objektu předplatného, který získá, provedením požadavku na rozhraní API ResourceManager.
LinkedUser	Poskytuje informace o uživateli z hlediska ověřování.
ListAllSubscriptionOptions	Popisuje možnosti, které je možné poskytnout při výpisu všech předplatných nebo účtů prostřednictvím Azure CLI.
LoginWithAuthFileOptions	Popisuje volitelné parametry pro přihlášení pomocíAuthFile.
LoginWithUsernamePasswordOptions	Popisuje volitelné parametry pro ověřování pomocí uživatelského jména a hesla.
MSIAppServiceOptions	Definuje volitelné parametry pro ověřování pomocí MSI pro AppService.
MSIOptions	Definuje volitelné parametry pro ověřování pomocí MSI.
MSITokenResponse	Popisuje MSITokenResponse.
MSIVmOptions	Definuje volitelné parametry pro ověřování pomocí MSI pro virtuální počítač.

Aliasy typu

TokenAudience
UserType	Poskytuje informace o typu uživatele. V současné době může být "user" nebo "servicePrincipal".

Funkce

buildTenantList(TokenCredentialsBase, string)	Vytvoří pole id tenanta.
createAuthenticator(MSITokenCredentials)
interactiveLogin()	Poskytuje adresu URL a kód, který je potřeba zkopírovat a vložit do prohlížeče a ověřit ho tam. V případě úspěchu získá uživatel objekt DeviceTokenCredentials a seznam předplatných přidružených k ho userId ve všech příslušných tenantech. Při použití osobních účtů je nutné nastavit vlastnost domain v parametru options na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.
interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)	Poskytuje adresu URL a kód, který je potřeba zkopírovat a vložit do prohlížeče a ověřit ho tam. V případě úspěchu získá uživatel objekt DeviceTokenCredentials a seznam předplatných přidružených k ho userId ve všech příslušných tenantech. Při použití osobních účtů je nutné nastavit vlastnost domain v parametru options na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.
loginWithAppServiceMSI()	Ověřte se pomocí MSI služby App Service.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	Před použitím této metody nainstalujte az cli z https://github.com/Azure/azure-cli/releases. Pak spusťte az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Pokud chcete vytvořit sp pro jiný cloud nebo prostředí, spusťte následující příkaz: az cloud list az cloud set –n az ad sp create-for-rbac --sdk-auth > auth.json // create sp s tajnými NEBO az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp s certifikátem Pokud je instanční objekt již vytvořený, přihlaste se pomocí informací instančního objektu: az login --service-principal -u -p -t az account show --sdk-auth > auth.json Ověřuje se pomocí informací instančního objektu, které jsou k dispozici v souboru ověřování. Tato metoda nastaví id předplatného ze souboru ověřování na proměnnou prostředí poskytnuté uživatelem v parametru možností nebo výchozí "AZURE_SUBSCRIPTION_ID".
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	Před použitím této metody nainstalujte az cli z https://github.com/Azure/azure-cli/releases. Pak spusťte az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Pokud chcete vytvořit sp pro jiný cloud nebo prostředí, spusťte následující příkaz: az cloud list az cloud set –n az ad sp create-for-rbac --sdk-auth > auth.json // create sp s tajnými NEBO az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp s certifikátem Pokud je instanční objekt již vytvořený, přihlaste se pomocí informací instančního objektu: az login --service-principal -u -p -t az account show --sdk-auth > auth.json Ověřuje se pomocí informací instančního objektu, které jsou k dispozici v souboru ověřování. Tato metoda nastaví id předplatného ze souboru ověřování na proměnnou prostředí poskytnuté uživatelem v parametru možností nebo výchozí "AZURE_SUBSCRIPTION_ID".
loginWithServicePrincipalCertificate(string, string, string)	Poskytuje Objekt ApplicationTokenCertificateCredentials a seznam předplatných přidružených k této hodnotě servicePrincipalId/clientId ve všech příslušných tenantech. Při použití osobních účtů je nutné nastavit parametr domain na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.
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)	Poskytuje Objekt ApplicationTokenCertificateCredentials a seznam předplatných přidružených k této hodnotě servicePrincipalId/clientId ve všech příslušných tenantech. Při použití osobních účtů je nutné nastavit parametr domain na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.
loginWithServicePrincipalSecret(string, string, string)	Poskytuje objekt ApplicationTokenCredentials a seznam předplatných přidružených k této servicePrincipalId/clientId ve všech příslušných tenantech. Při použití osobních účtů je nutné nastavit parametr domain na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.
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)	Poskytuje objekt ApplicationTokenCredentials a seznam předplatných přidružených k této servicePrincipalId/clientId ve všech příslušných tenantech. Při použití osobních účtů je nutné nastavit parametr domain na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.
loginWithUsernamePassword(string, string)	Poskytuje objekt UserTokenCredentials a seznam předplatných přidružených k danému ID uživatele ve všech příslušných tenantech. Tato metoda se vztahuje pouze na ID organizace, které nejsou povoleny 2FA, jinak použijte interaktivní přihlášení. Při použití osobních účtů je nutné nastavit vlastnost domain v parametru options na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)
loginWithUsernamePassword(string, string, any)
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)	Poskytuje objekt UserTokenCredentials a seznam předplatných přidružených k danému ID uživatele ve všech příslušných tenantech. Tato metoda se vztahuje pouze na ID organizace, které nejsou povoleny 2FA, jinak použijte interaktivní přihlášení. Při použití osobních účtů je nutné nastavit vlastnost domain v parametru options na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.
loginWithVmMSI()	Před použitím této metody nainstalujte az cli z https://github.com/Azure/azure-cli/releases. Pokud máte virtuální počítač Azure zřízený pomocí az cli a má povolenou MSI, můžete pomocí této metody získat z virtuálního počítače ověřovací tokeny. Pokud chcete vytvořit nový virtuální počítač, povolte MSI, spusťte tento příkaz: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Poznámka: Výše uvedený příkaz povolí koncový bod služby na hostiteli s výchozím portem 50342. Pokud chcete povolit MSI na již zřízeném virtuálním počítači, spusťte následující příkaz: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number> Pokud chcete získat další informace o tomto příkazu, spusťte příkaz: az vm --assign-identity -h Ověřuje se pomocí služby identit spuštěné na virtuálním počítači Azure. Tato metoda vytvoří požadavek na ověřovací službu hostované na virtuálním počítači a vrátí přístupový token.
loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Podrobnosti funkce

buildTenantList(TokenCredentialsBase, string)

Vytvoří pole id tenanta.

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

Parametry

credentials

TokenCredentialsBase

Přihlašovací údaje.

apiVersion

string

výchozí hodnota 2016-06-01

Návraty

Promise<string[]>

Příslib, který se přeloží na pole ID tenanta a odmítne s chybou.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parametry

credentials

MSITokenCredentials

Návraty

Authenticator

interactiveLogin()

Poskytuje adresu URL a kód, který je potřeba zkopírovat a vložit do prohlížeče a ověřit ho tam. V případě úspěchu získá uživatel objekt DeviceTokenCredentials a seznam předplatných přidružených k ho userId ve všech příslušných tenantech.

Při použití osobních účtů je nutné nastavit vlastnost domain v parametru options na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Návraty

Promise<DeviceTokenCredentials>

Pokud se zpětné volání předalo jako poslední parametr, vrátí hodnotu void else. Zpětné volání se volá s výsledným objektem DeviceTokenCredentials a seznamem přidružených předplatných ve všech příslušných tenantech.

interactiveLogin(InteractiveLoginOptions)

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

Parametry

options

InteractiveLoginOptions

Návraty

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)

Poskytuje adresu URL a kód, který je potřeba zkopírovat a vložit do prohlížeče a ověřit ho tam. V případě úspěchu získá uživatel objekt DeviceTokenCredentials a seznam předplatných přidružených k ho userId ve všech příslušných tenantech.

Při použití osobních účtů je nutné nastavit vlastnost domain v parametru options na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.

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

Parametry

options

InteractiveLoginOptions

Objekt představující volitelné parametry

Návraty

Promise<AuthResponse<DeviceTokenCredentials>>

Příslib, který se přeloží na AuthResponse, který obsahuje "přihlašovací údaje" a volitelné pole "předplatná" a odmítne s chybou.

loginWithAppServiceMSI()

Ověřte se pomocí MSI služby App Service.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Návraty

Promise<MSIAppServiceTokenCredentials>

Pokud se zpětné volání předalo jako poslední parametr, vrátí hodnotu void else. Zpětné volání se volá s výsledným objektem MSIAppServiceTokenCredentials.

loginWithAppServiceMSI(MSIAppServiceOptions)

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

Parametry

options

MSIAppServiceOptions

Návraty

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()

Před použitím této metody nainstalujte az cli z https://github.com/Azure/azure-cli/releases. Pak spusťte az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Pokud chcete vytvořit sp pro jiný cloud nebo prostředí, spusťte následující příkaz:

1. az cloud list
2. az cloud set –n
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp s tajnými NEBO
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp s certifikátem Pokud je instanční objekt již vytvořený, přihlaste se pomocí informací instančního objektu:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth > auth.json

Ověřuje se pomocí informací instančního objektu, které jsou k dispozici v souboru ověřování. Tato metoda nastaví id předplatného ze souboru ověřování na proměnnou prostředí poskytnuté uživatelem v parametru možností nebo výchozí "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Návraty

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Pokud se zpětné volání předalo jako poslední parametr, vrátí hodnotu void else. Zpětné volání se volá s výsledným objektem ApplicationTokenCredentials nebo ApplicationTokenCertificateCredentials a seznamem přidružených předplatných ve všech příslušných tenantech.

loginWithAuthFile(LoginWithAuthFileOptions)

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

Parametry

options

LoginWithAuthFileOptions

Návraty

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)

Před použitím této metody nainstalujte az cli z https://github.com/Azure/azure-cli/releases. Pak spusťte az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Pokud chcete vytvořit sp pro jiný cloud nebo prostředí, spusťte následující příkaz:

1. az cloud list
2. az cloud set –n
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp s tajnými NEBO
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp s certifikátem Pokud je instanční objekt již vytvořený, přihlaste se pomocí informací instančního objektu:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth > auth.json

Ověřuje se pomocí informací instančního objektu, které jsou k dispozici v souboru ověřování. Tato metoda nastaví id předplatného ze souboru ověřování na proměnnou prostředí poskytnuté uživatelem v parametru možností nebo výchozí "AZURE_SUBSCRIPTION_ID".

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

Parametry

options

LoginWithAuthFileOptions

Volitelné parametry

Návraty

Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Příslib, který se přeloží na AuthResponse, který obsahuje "přihlašovací údaje" a volitelné pole "předplatná" a odmítne s chybou.

loginWithServicePrincipalCertificate(string, string, string)

Poskytuje Objekt ApplicationTokenCertificateCredentials a seznam předplatných přidružených k této hodnotě servicePrincipalId/clientId ve všech příslušných tenantech.

Při použití osobních účtů je nutné nastavit parametr domain na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.

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

Parametry

clientId

string

ID klienta aplikace služby Active Directory označované také jako hlavní název služby (ServicePrincipal Name). Příklad najdete v rychlém startu služby Active Directory pro .Net.

certificateStringOrFilePath

string

Certifikát s kódováním PEM a privátní klíč NEBO absolutní cesta k souboru .pem obsahujícího tyto informace. Například:

• CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
• CertificateFilePath: Absolutní cesta k souboru souboru .pem.

domain

string

Doména nebo ID tenanta obsahující tuto aplikaci.

Návraty

Promise<ApplicationTokenCertificateCredentials>

Pokud se zpětné volání předalo jako poslední parametr, vrátí hodnotu void else. Zpětné volání se volá s výsledným objektem ApplicationTokenCertificateCredentials a seznamem přidružených předplatných ve všech příslušných tenantech.

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

Návraty

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)

Poskytuje Objekt ApplicationTokenCertificateCredentials a seznam předplatných přidružených k této hodnotě servicePrincipalId/clientId ve všech příslušných tenantech.

Při použití osobních účtů je nutné nastavit parametr domain na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.

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

Parametry

clientId

string

ID klienta aplikace služby Active Directory označované také jako hlavní název služby (ServicePrincipal Name). Příklad najdete v rychlém startu služby Active Directory pro .Net.

certificateStringOrFilePath

string

Certifikát s kódováním PEM a privátní klíč NEBO absolutní cesta k souboru .pem obsahujícího tyto informace. Například:

• CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
• CertificateFilePath: Absolutní cesta k souboru souboru .pem.

domain

string

Doména nebo ID tenanta obsahující tuto aplikaci.

options

AzureTokenCredentialsOptions

Objekt představující volitelné parametry

Návraty

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Příslib, který se přeloží na AuthResponse, který obsahuje "přihlašovací údaje" a volitelné pole "předplatná" a odmítne s chybou.

loginWithServicePrincipalSecret(string, string, string)

Poskytuje objekt ApplicationTokenCredentials a seznam předplatných přidružených k této servicePrincipalId/clientId ve všech příslušných tenantech.

Při použití osobních účtů je nutné nastavit parametr domain na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.

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

Parametry

clientId

string

ID klienta aplikace služby Active Directory označované také jako hlavní název služby (ServicePrincipal Name). Příklad najdete v rychlém startu služby Active Directory pro .Net.

secret

string

Tajný kód aplikace pro instanční objekt.

domain

string

Doména nebo ID tenanta obsahující tuto aplikaci.

Návraty

Promise<ApplicationTokenCredentials>

Pokud se zpětné volání předalo jako poslední parametr, vrátí hodnotu void else. Zpětné volání se volá s výsledným objektem ApplicationTokenCredentials a seznamem přidružených předplatných ve všech příslušných tenantech.

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

Návraty

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)

Poskytuje objekt ApplicationTokenCredentials a seznam předplatných přidružených k této servicePrincipalId/clientId ve všech příslušných tenantech.

Při použití osobních účtů je nutné nastavit parametr domain na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.

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

Parametry

clientId

string

ID klienta aplikace služby Active Directory označované také jako hlavní název služby (ServicePrincipal Name). Příklad najdete v rychlém startu služby Active Directory pro .Net.

secret

string

Tajný kód aplikace pro instanční objekt.

domain

string

Doména nebo ID tenanta obsahující tuto aplikaci.

options

AzureTokenCredentialsOptions

Objekt představující volitelné parametry

Návraty

Promise<AuthResponse<ApplicationTokenCredentials>>

Příslib, který se přeloží na AuthResponse, který obsahuje "přihlašovací údaje" a volitelné pole "předplatná" a odmítne s chybou.

loginWithUsernamePassword(string, string)

Poskytuje objekt UserTokenCredentials a seznam předplatných přidružených k danému ID uživatele ve všech příslušných tenantech.

Tato metoda se vztahuje pouze na ID organizace, které nejsou povoleny 2FA, jinak použijte interaktivní přihlášení.

Při použití osobních účtů je nutné nastavit vlastnost domain v parametru options na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.

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

Parametry

username

string

Uživatelské jméno pro účet ID organizace.

password

string

Heslo pro účet ID organizace.

Návraty

Promise<UserTokenCredentials>

Pokud se zpětné volání předalo jako poslední parametr, vrátí hodnotu void else. Zpětné volání se volá s výsledným objektem UserTokenCredentials a seznamem přidružených předplatných ve všech příslušných tenantech.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

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

Parametry

username

string

password

string

options

LoginWithUsernamePasswordOptions

Návraty

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)

Poskytuje objekt UserTokenCredentials a seznam předplatných přidružených k danému ID uživatele ve všech příslušných tenantech. Tato metoda se vztahuje pouze na ID organizace, které nejsou povoleny 2FA, jinak použijte interaktivní přihlášení.

Při použití osobních účtů je nutné nastavit vlastnost domain v parametru options na ID tenanta pro tento účet. Jinak výsledné přihlašovací údaje nebudou mít přístup k prostředkům účtu.

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

Parametry

username

string

Uživatelské jméno pro účet ID organizace.

password

string

Heslo pro účet ID organizace.

options

LoginWithUsernamePasswordOptions

Objekt představující volitelné parametry

Návraty

Promise<AuthResponse<UserTokenCredentials>>

Příslib, který se přeloží na AuthResponse, který obsahuje credentials a volitelné pole subscriptions a odmítne chybu.

loginWithVmMSI()

Před použitím této metody nainstalujte az cli z https://github.com/Azure/azure-cli/releases. Pokud máte virtuální počítač Azure zřízený pomocí az cli a má povolenou MSI, můžete pomocí této metody získat z virtuálního počítače ověřovací tokeny.

Pokud chcete vytvořit nový virtuální počítač, povolte MSI, spusťte tento příkaz: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Poznámka: Výše uvedený příkaz povolí koncový bod služby na hostiteli s výchozím portem 50342.

Pokud chcete povolit MSI na již zřízeném virtuálním počítači, spusťte následující příkaz: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Pokud chcete získat další informace o tomto příkazu, spusťte příkaz: az vm --assign-identity -h

Ověřuje se pomocí služby identit spuštěné na virtuálním počítači Azure. Tato metoda vytvoří požadavek na ověřovací službu hostované na virtuálním počítači a vrátí přístupový token.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Návraty

Promise<MSIVmTokenCredentials>

Pokud se zpětné volání předalo jako poslední parametr, vrátí hodnotu void else. Zpětné volání se volá s výsledným objektem MSIVmTokenCredentials.

loginWithVmMSI(MSIVmOptions)

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

Parametry

options

MSIVmOptions

Návraty

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>