DefaultAzureCredential class
Предоставляет конфигурацию по умолчанию ChainedTokenCredential, которая работает для большинства приложений, использующих клиентские библиотеки пакета SDK Azure. Дополнительные сведения см. в обзоре DefaultAzureCredential.
Следующие типы учетных данных будут проверены в порядке:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- AzureDeveloperCliCredential
- BrokerCredential (учетные данные с поддержкой брокера, которые должны @azure/identity-broker быть установлены)
Дополнительные сведения о попытке проверки подлинности см. в документации по этим типам учетных данных.
В следующем примере показано, как использовать requiredEnvVars этот параметр, чтобы убедиться, что определенные переменные среды заданы перед созданием экземпляра параметра DefaultAzureCredential .
Если какая-либо из указанных переменных окружения отсутствует или пуста, будет выдана ошибка, которая не позволит приложению продолжить выполнение без необходимой конфигурации.
В нем также показано, как задать переменную AZURE_TOKEN_CREDENTIALS среды для управления учетными данными, включенными в цепочку.
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential({
requiredEnvVars: [
"AZURE_CLIENT_ID",
"AZURE_TENANT_ID",
"AZURE_CLIENT_SECRET",
"AZURE_TOKEN_CREDENTIALS",
],
});
- Extends
Конструкторы
| Default |
Создает экземпляр класса DefaultAzureCredential с DefaultAzureCredentialClientIdOptions. |
| Default |
Создает экземпляр класса DefaultAzureCredential с DefaultAzureCredentialOptions. |
| Default |
Создает экземпляр класса DefaultAzureCredential с DefaultAzureCredentialResourceIdOptions. |
Наследуемые методы
| get |
Возвращает первый маркер доступа, возвращаемый одной из цепочек Этот метод вызывается автоматически клиентскими библиотеками Azure SDK. Этот метод можно вызвать напрямую, но также необходимо обрабатывать кэширование маркеров и обновление маркеров. |
Сведения о конструкторе
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
Создает экземпляр класса DefaultAzureCredential с DefaultAzureCredentialClientIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)Параметры
Необязательные параметры. См. defaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)
Создает экземпляр класса DefaultAzureCredential с DefaultAzureCredentialOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)Параметры
- options
- DefaultAzureCredentialOptions
Необязательные параметры. См. defaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
Создает экземпляр класса DefaultAzureCredential с DefaultAzureCredentialResourceIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)Параметры
Необязательные параметры. См. defaultAzureCredentialResourceIdOptions.
Сведения о наследуемом методе
getToken(string | string[], GetTokenOptions)
Возвращает первый маркер доступа, возвращаемый одной из цепочек TokenCredential реализаций. Вызывает AggregateAuthenticationError, когда один или несколько учетных данных создает AuthenticationError, а учетные данные не возвращают маркер доступа.
Этот метод вызывается автоматически клиентскими библиотеками Azure SDK. Этот метод можно вызвать напрямую, но также необходимо обрабатывать кэширование маркеров и обновление маркеров.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>Параметры
- scopes
-
string | string[]
Список областей, для которых маркер будет иметь доступ.
- options
- GetTokenOptions
Параметры, используемые для настройки любых запросов, которые могут выполняться TokenCredential реализации.
Возвращаемое значение
Promise<AccessToken>
наследуется отChainedTokenCredential.getToken