EnvironmentCredential class

  • Ссылка
Пакет:
@azure/identity

Позволяет выполнять проверку подлинности для Microsoft Entra ID с помощью секрета клиента или сертификата либо в качестве пользователя с именем пользователя и паролем.

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

EnvironmentCredential(EnvironmentCredentialOptions)

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

Обязательные переменные среды:

  • AZURE_TENANT_ID: идентификатор клиента (каталога) Microsoft Entra.
  • AZURE_CLIENT_ID: идентификатор клиента (приложения) регистрации приложения в клиенте.

Если задать AZURE_TENANT_ID, можно также задать дополнительно разрешенные клиенты.

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: для мультитенантных приложений указывает дополнительные клиенты, для которых учетные данные могут получать маркеры с одной строкой с разделителями с запятой. Используйте * для разрешения всех клиентов.

Переменные среды, используемые для проверки подлинности учетных данных клиента:

  • AZURE_CLIENT_SECRET: секрет клиента, созданный для регистрации приложения.
  • AZURE_CLIENT_CERTIFICATE_PATH: путь к сертификату PEM для использования во время проверки подлинности вместо секрета клиента.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (необязательно) пароль для файла сертификата.

Кроме того, пользователи могут указать переменные среды для проверки подлинности имени пользователя и пароля:

  • AZURE_USERNAME: имя пользователя для проверки подлинности.
  • AZURE_PASSWORD: пароль для проверки подлинности.

Если переменные среды, необходимые для проверки подлинности, отсутствуют, возникает ошибка CredentialUnavailableError . Если проверка подлинности завершается сбоем или возникает неизвестная ошибка, возникает ошибка AuthenticationError .

Методы

getToken(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения.

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

EnvironmentCredential(EnvironmentCredentialOptions)

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

Обязательные переменные среды:

  • AZURE_TENANT_ID: идентификатор клиента (каталога) Microsoft Entra.
  • AZURE_CLIENT_ID: идентификатор клиента (приложения) регистрации приложения в клиенте.

Если задать AZURE_TENANT_ID, можно также задать дополнительно разрешенные клиенты.

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: для мультитенантных приложений указывает дополнительные клиенты, для которых учетные данные могут получать маркеры с одной строкой с разделителями с запятой. Используйте * для разрешения всех клиентов.

Переменные среды, используемые для проверки подлинности учетных данных клиента:

  • AZURE_CLIENT_SECRET: секрет клиента, созданный для регистрации приложения.
  • AZURE_CLIENT_CERTIFICATE_PATH: путь к сертификату PEM для использования во время проверки подлинности вместо секрета клиента.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (необязательно) пароль для файла сертификата.

Кроме того, пользователи могут указать переменные среды для проверки подлинности имени пользователя и пароля:

  • AZURE_USERNAME: имя пользователя для проверки подлинности.
  • AZURE_PASSWORD: пароль для проверки подлинности.

Если переменные среды, необходимые для проверки подлинности, отсутствуют, возникает ошибка CredentialUnavailableError . Если проверка подлинности завершается сбоем или возникает неизвестная ошибка, возникает ошибка AuthenticationError .

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Параметры

options
EnvironmentCredentialOptions

Параметры настройки клиента, который выполняет запрос проверки подлинности.

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

getToken(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Параметры

scopes

string | string[]

Список областей, доступ к которым будет иметь маркер.

options
GetTokenOptions

Дополнительные параметры. См . раздел GetTokenOptions.

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

Promise<AccessToken>