DeviceTokenCredentials class

Пакет:: @azure/ms-rest-nodeauth

Extends: TokenCredentialsBase

Конструкторы

DeviceTokenCredentials(string, string, string, TokenAudience, Environment, TokenCache)

Создает новый объект DeviceTokenCredentials, который получает новый маркер доступа с помощью userCodeInfo (содержит user_code, device_code) для проверки подлинности пользователя на устройстве.

При использовании этих учетных данных скрипт предоставит URL-адрес и код. Пользователь должен скопировать URL-адрес и код, вставить его в браузер и пройти проверку подлинности. В случае успешного выполнения скрипт получит маркер доступа.

Свойства

username

Унаследованные свойства

authContext
clientId
domain
environment
tokenAudience
tokenCache

Методы

getToken()

Сначала пытается получить маркер из кэша. Если это не удалось, он пытается получить маркер из ADAL.

Наследуемые методы

setDomain(string)
signRequest(WebResource)	Подписывает запрос с помощью заголовка проверки подлинности.

Сведения о конструкторе

DeviceTokenCredentials(string, string, string, TokenAudience, Environment, TokenCache)

new DeviceTokenCredentials(clientId?: string, domain?: string, username?: string, tokenAudience?: TokenAudience, environment?: Environment, tokenCache?: TokenCache)

Параметры

clientId: string

Идентификатор клиента приложения Active Directory.

domain: string

Идентификатор домена или клиента, содержащего это приложение. Значение по умолчанию — "common"

username: string

Имя пользователя для учетной записи в форме: "user@example.com".

tokenAudience: TokenAudience

Аудитория, для которой запрашивается маркер. Допустимые значения: graph, batch или любой другой ресурс, например "https://vault.azure.net/". Если tokenAudience имеет значение Graph, домен также должен быть предоставлен, а его значение не должно быть клиентом по умолчанию common. Она должна быть строкой (предпочтительно в формате GUID). Пример см. кратком руководстве по Active Directory для .Net.

environment: Environment

Среда Azure для проверки подлинности с помощью. Среда по умолчанию — Azure, известная как "Общедоступное облако Azure".

tokenCache: TokenCache

Кэш маркеров. Значением по умолчанию является объект MemoryCache из adal.

Сведения о свойстве

username

username: string

Значение свойства

string

Сведения об унаследованном свойстве

authContext

authContext: AuthenticationContext

Значение свойства

AuthenticationContext

унаследован отTokenCredentialsBase.authContext

clientId

clientId: string

Значение свойства

string

наследуется отTokenCredentialsBase.clientId

domain

domain: string

Значение свойства

string

наследуется отTokenCredentialsBase.domain

environment

environment: Environment

Значение свойства

Environment

наследуется отTokenCredentialsBase.environment

tokenAudience

tokenAudience?: string

Значение свойства

string

унаследован отTokenCredentialsBase.tokenAudience

tokenCache

tokenCache: TokenCache

Значение свойства

TokenCache

унаследовано отTokenCredentialsBase.tokenCache

Сведения о методе

getToken()

Сначала пытается получить маркер из кэша. Если это не удалось, он пытается получить маркер из ADAL.

function getToken(): Promise<TokenResponse>

Возвращаемое значение

Promise<TokenResponse>

TokenResponse (tokenType и accessToken являются двумя важными свойствами).

Сведения о наследуемом методе

setDomain(string)

function setDomain(domain: string)

Параметры

domain: string

унаследован отTokenCredentialsBase.setDomain

signRequest(WebResource)

Подписывает запрос с помощью заголовка проверки подлинности.

function signRequest(webResource: WebResource): Promise<WebResource>

Параметры

webResource: WebResource

Подписанный webResource.

Возвращаемое значение

Promise<WebResource>

Наследуется отTokenCredentialsBase.signRequest