@azure/identity package

  • Ссылка

Классы

AggregateAuthenticationError

Предоставляет массив, errors содержащий экземпляр AuthenticationError для сбоев проверки подлинности из учетных данных в ChainedTokenCredential.
AuthenticationError

Сведения о сбое проверки подлинности в Azure Active Directory. Поле errorResponse содержит дополнительные сведения о конкретном сбое.
AuthenticationRequiredError

Ошибка, используемая для принудительной проверки подлинности после попытки получить маркер автоматически.
AuthorizationCodeCredential

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

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
AzureCliCredential

Эти учетные данные будут использовать данные для входа пользователя, выполнившего вход в систему, с помощью программы командной строки Azure CLI (az). Для этого он считывает маркер доступа пользователя и истечет срок действия с помощью команды Azure CLI "az account get-access-token".
AzureDeveloperCliCredential

Azure Developer CLI — это средство интерфейса командной строки, которое позволяет разработчикам создавать, администрировать и развертывать ресурсы в Azure. Он основан на Azure CLI и предоставляет дополнительные функции, характерные для разработчиков Azure. Это позволяет пользователям проходить проверку подлинности в качестве пользователя и (или) субъекта-службы в Microsoft Entra ID. AzureDeveloperCliCredential выполняет проверку подлинности в среде разработки и получает маркер от имени вошедшего пользователя или субъекта-службы в Azure Developer CLI. Он выступает в качестве Azure Developer CLI, вошедшего в систему пользователя или субъекта-службы, и выполняет команду Azure CLI в разделе для проверки подлинности приложения на Microsoft Entra ID.

Настройка AzureDeveloperCliCredential

Чтобы использовать эти учетные данные, разработчику необходимо выполнить локальную проверку подлинности в Azure Developer CLI с помощью одной из приведенных ниже команд:

  1. Выполните команду azd auth login в Azure Developer CLI для интерактивной проверки подлинности от имени пользователя.
  2. Выполните команду azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID, чтобы пройти проверку подлинности в качестве субъекта-службы.

Возможно, этот процесс придется повторить по истечении некоторого периода времени в зависимости от срока действия маркеров обновления в организации. Как правило, период действия маркера обновления составляет от нескольких недель до нескольких месяцев. AzureDeveloperCliCredential предложит выполнить вход еще раз.
AzurePowerShellCredential

Эти учетные данные будут использовать данные вошедшего в систему пользователя из модуля Azure PowerShell. Для этого он считывает маркер доступа пользователя и истечет срок действия с помощью команды Azure PowerShell.Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Позволяет использовать несколько TokenCredential реализаций по порядку, пока один из методов getToken не вернет маркер доступа.
ClientAssertionCredential

Выполняет проверку подлинности субъекта-службы с помощью утверждения JWT.
ClientCertificateCredential

Разрешает проверку подлинности для Microsoft Entra ID с помощью сертификата в кодировке PEM, назначенного регистрации приложения. Дополнительные сведения о настройке проверки подлинности на основе сертификата можно найти здесь:

https://learn.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad
ClientSecretCredential

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

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
CredentialUnavailableError

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

Предоставляет конфигурацию по умолчанию ChainedTokenCredential , которая должна работать для большинства приложений, использующих пакет AZURE SDK.
DeviceCodeCredential

Включает проверку подлинности для Microsoft Entra ID с помощью кода устройства, который пользователь может ввести в https://microsoft.com/devicelogin.
EnvironmentCredential

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

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

Пытается выполнить проверку подлинности с помощью управляемого удостоверения, доступного в среде развертывания. Этот тип проверки подлинности работает на виртуальных машинах Azure, экземплярах Служба приложений, Функции Azure приложениях, службах Azure Kubernetes, экземплярах Azure Service Fabric и в Cloud Shell Azure.

Дополнительные сведения о настройке управляемых удостоверений можно найти здесь: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Включает проверку подлинности для Microsoft Entra ID с помощью потока On Behalf Of.
UsernamePasswordCredential

Включает проверку подлинности для Microsoft Entra ID с именем пользователя и паролем. Эти учетные данные требуют высокой степени доверия, поэтому их следует использовать только в том случае, если не удается использовать другие, более безопасные типы учетных данных.
VisualStudioCodeCredential

Подключается к Azure с помощью учетных данных, предоставленных расширением VSCode "Учетная запись Azure". После входа пользователя с помощью расширения эти учетные данные могут совместно использовать тот же маркер обновления, который кэшируется расширением.

Известно , что эти учетные данные не работают с более поздними версиями расширения учетной записи Azure , чем 0.9.11. В настоящее время выполняется долгосрочное решение этой проблемы. В то же время рассмотрите возможность проверки подлинности с помощью AzureCliCredential.
WorkloadIdentityCredential

Проверка подлинности удостоверений рабочей нагрузки — это функция в Azure, которая позволяет приложениям, работающим на виртуальных машинах, получать доступ к другим ресурсам Azure без необходимости в субъекте-службе или управляемом удостоверении. При использовании проверки подлинности удостоверений рабочей нагрузки приложения проходят проверку подлинности с помощью собственного удостоверения, а не с помощью общего субъекта-службы или управляемого удостоверения. В рамках проверки подлинности удостоверений рабочей нагрузки используется концепция учетных данных учетной записи службы (SAC), которые автоматически создаются Azure и безопасно хранятся на виртуальной машине. С помощью проверки подлинности удостоверений рабочей нагрузки можно избежать необходимости управления субъектами-службами или управляемыми удостоверениями для каждого приложения на каждой виртуальной машине. Кроме того, так как sac создаются автоматически и управляются Azure, вам не нужно беспокоиться о хранении и защите конфиденциальных учетных данных. WorkloadIdentityCredential поддерживает проверку подлинности Идентификация рабочей нагрузки Microsoft Entra в Azure Kubernetes и получает маркер с помощью saC, доступных в среде Azure Kubernetes. Дополнительные сведения см. в Идентификация рабочей нагрузки Microsoft Entra.

Интерфейсы

AccessToken

Представляет маркер доступа со временем окончания срока действия.
AuthenticationRecord

Запись, используемая для поиска кэшированных маркеров в кэше.
AuthenticationRequiredErrorOptions

Необязательные параметры для AuthenticationRequiredError
AuthorityValidationOptions

Предоставляет параметры для настройки того, как библиотека удостоверений выполняет проверку центра во время запросов проверки подлинности к Microsoft Entra ID.
AuthorizationCodeCredentialOptions

Параметры для AuthorizationCodeCredential
AzureCliCredentialOptions

Параметры для AzureCliCredential
AzureDeveloperCliCredentialOptions

Параметры для AzureDeveloperCliCredential
AzurePowerShellCredentialOptions

Параметры для AzurePowerShellCredential
BrokerAuthOptions

Параметры конфигурации для InteractiveBrowserCredential для поддержки проверки подлинности брокера WAM.
BrokerDisabledOptions

Параметры, когда проверка подлинности брокера WAM отключена.
BrokerEnabledOptions

Параметры, когда включена проверка подлинности брокера WAM.
BrowserCustomizationOptions

Параметры общей конфигурации для настройки браузера
ClientAssertionCredentialOptions

Параметры для ClientAssertionCredential
ClientCertificateCredentialOptions

Необязательные параметры для класса ClientCertificateCredential .
ClientCertificatePEMCertificate

Обязательные параметры конфигурации для ClientCertificateCredential со строковым содержимым сертификата PEM
ClientCertificatePEMCertificatePath

Обязательные параметры конфигурации для ClientCertificateCredential с путем к сертификату PEM.
ClientSecretCredentialOptions

Необязательные параметры для класса ClientSecretCredential .
CredentialPersistenceOptions

Параметры общей конфигурации для учетных данных, поддерживающих постоянное кэширование маркеров.
DefaultAzureCredentialClientIdOptions

Предоставляет параметры для настройки класса DefaultAzureCredential . Этот вариант поддерживает managedIdentityClientId и не managedIdentityResourceIdподдерживает , так как поддерживается только один из обоих вариантов.
DefaultAzureCredentialOptions

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

Предоставляет параметры для настройки класса DefaultAzureCredential . Этот вариант поддерживает managedIdentityResourceId и не managedIdentityClientIdподдерживает , так как поддерживается только один из обоих вариантов.
DeviceCodeCredentialOptions

Определяет параметры класса InteractiveBrowserCredential для Node.js.
DeviceCodeInfo

Предоставляет код пользователя и URI проверки, в который необходимо ввести код. Также предоставляет пользователю сообщение, содержащее инструкцию с этими сведениями.
EnvironmentCredentialOptions

Включает проверку подлинности для Microsoft Entra ID в зависимости от доступных переменных среды. Определяет параметры для класса EnvironmentCredential.
ErrorResponse

Дополнительные сведения см. в официальной документации:

https://learn.microsoft.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

Примечание. Эта документация относится к поддержке OAuth версии 1, но те же сведения об ошибке по-прежнему относятся к версии 2.
GetTokenOptions

Определяет параметры для TokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

Определяет общие параметры для класса InteractiveBrowserCredential.
InteractiveBrowserCredentialNodeOptions

Определяет общие параметры для класса InteractiveBrowserCredential.
InteractiveCredentialOptions

Общие параметры конструктора для учетных данных удостоверений, требующих взаимодействия с пользователем.
ManagedIdentityCredentialClientIdOptions

Параметры для отправки в конструкторе ManagedIdentityCredential . Этот вариант поддерживает clientId и не resourceIdподдерживает , так как поддерживается только один из обоих вариантов.
ManagedIdentityCredentialResourceIdOptions

Параметры для отправки в конструкторе ManagedIdentityCredential . Этот вариант поддерживает resourceId и не clientIdподдерживает , так как поддерживается только один из обоих вариантов.
MultiTenantTokenCredentialOptions

Варианты для мультитенантных приложений, которые позволяют использовать дополнительно разрешенные клиенты.
OnBehalfOfCredentialCertificateOptions

Определяет параметры для проверки подлинности OnBehalfOfCredential с помощью сертификата.
OnBehalfOfCredentialSecretOptions

Определяет параметры для проверки подлинности OnBehalfOfCredential с помощью секрета.
TokenCachePersistenceOptions

Параметры, обеспечивающие сохраняемость кэша маркеров в учетных данных удостоверения.
TokenCredential

Представляет учетные данные, способные предоставить маркер проверки подлинности.
TokenCredentialOptions

Предоставляет параметры для настройки того, как библиотека удостоверений выполняет запросы проверки подлинности для Microsoft Entra ID.
UsernamePasswordCredentialOptions

Определяет параметры для класса UsernamePasswordCredential .
VisualStudioCodeCredentialOptions

Предоставляет параметры для настройки учетных данных Visual Studio Code.
WorkloadIdentityCredentialOptions

Параметры для WorkloadIdentityCredential

Псевдонимы типа

BrokerOptions

Параметры, обеспечивающие проверку подлинности брокера WAM в InteractiveBrowserCredential.
BrowserLoginStyle

(функция только для браузера) "Стиль входа", используемый в потоке проверки подлинности:

  • "redirect" перенаправляет пользователя на страницу проверки подлинности, а затем перенаправляет его обратно на страницу после завершения проверки подлинности.
  • Всплывающее окно открывает новое окно браузера с инициированным потоком перенаправления. Существующее окно браузера пользователя не покидает текущую страницу
ClientCertificateCredentialPEMConfiguration

Обязательные параметры конфигурации для ClientCertificateCredential с строковым содержимым сертификата PEM или путем к сертификату PEM.
DeviceCodePromptCallback

Определяет сигнатуру обратного вызова, который будет передан в DeviceCodeCredential с целью отображения сведений о проверке подлинности для пользователя.
IdentityPlugin

Тип подключаемого модуля удостоверений Azure, функция, принимаюющая контекст подключаемого модуля.
OnBehalfOfCredentialOptions

Необязательные параметры для класса OnBehalfOfCredential .

Перечисления

AzureAuthorityHosts

Список известных узлов центра Azure

Функции

deserializeAuthenticationRecord(string)

Десериализует ранее сериализованную запись проверки подлинности из строки в объект .

Входная строка должна содержать следующие свойства:

  • "authority"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "имя пользователя"
  • "version"

Если получаемая версия не поддерживается, будет выдана ошибка.

На данный момент доступна только версия 1.0, которая всегда устанавливается при сериализации записи проверки подлинности.
getDefaultAzureCredential()

Возвращает новый экземпляр Объекта DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

Сериализует в AuthenticationRecord строку.

Выходные данные сериализованной записи проверки подлинности будут содержать следующие свойства:

  • "authority"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "имя пользователя"
  • "version"

Чтобы позже преобразовать эту строку в сериализованную AuthenticationRecord, используйте экспортированную функцию deserializeAuthenticationRecord().
useIdentityPlugin(IdentityPlugin)

Расширение удостоверений Azure с помощью дополнительных функциональных возможностей. Передайте подключаемый модуль из пакета подключаемого модуля, например:

  • @azure/identity-cache-persistence: обеспечивает постоянное кэширование маркеров.
  • @azure/identity-vscode: предоставляет зависимости VisualStudioCodeCredential и включает его.

Пример

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

Сведения о функции

deserializeAuthenticationRecord(string)

Десериализует ранее сериализованную запись проверки подлинности из строки в объект .

Входная строка должна содержать следующие свойства:

  • "authority"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "имя пользователя"
  • "version"

Если получаемая версия не поддерживается, будет выдана ошибка.

На данный момент доступна только версия 1.0, которая всегда устанавливается при сериализации записи проверки подлинности.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Параметры

serializedRecord

string

Запись проверки подлинности, ранее сериализованная в строку.

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

AuthenticationRecord

AuthenticationRecord.

getDefaultAzureCredential()

Возвращает новый экземпляр Объекта DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

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

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Сериализует в AuthenticationRecord строку.

Выходные данные сериализованной записи проверки подлинности будут содержать следующие свойства:

  • "authority"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "имя пользователя"
  • "version"

Чтобы позже преобразовать эту строку в сериализованную AuthenticationRecord, используйте экспортированную функцию deserializeAuthenticationRecord().

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Параметры

record
AuthenticationRecord

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

string

useIdentityPlugin(IdentityPlugin)

Расширение удостоверений Azure с помощью дополнительных функциональных возможностей. Передайте подключаемый модуль из пакета подключаемого модуля, например:

  • @azure/identity-cache-persistence: обеспечивает постоянное кэширование маркеров.
  • @azure/identity-vscode: предоставляет зависимости VisualStudioCodeCredential и включает его.

Пример

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

function useIdentityPlugin(plugin: IdentityPlugin)

Параметры

plugin
IdentityPlugin

подключаемый модуль для регистрации