DefaultAzureCredential Класс

  • Ссылка

Учетные данные по умолчанию, способные обрабатывать большинство сценариев проверки подлинности пакета Azure SDK.

Используемое удостоверение зависит от среды. Когда требуется маркер доступа, он запрашивает один из них, используя эти удостоверения, в свою очередь, и останавливается, когда он предоставляет маркер:

  1. Субъект-служба, настроенный с помощью переменных среды. Дополнительные сведения см. в статье EnvironmentCredential.

  2. WorkloadIdentityCredential, если конфигурация переменной среды задается веб-перехватчиком удостоверения рабочей нагрузки Azure.

  3. Управляемое удостоверение Azure. Дополнительные сведения см. в статье ManagedIdentityCredential.

  4. Только в Windows: пользователь, выполнивший вход с помощью приложения Майкрософт, например Visual Studio. Если в кэше несколько удостоверений, то для выбора используемого удостоверения используется значение переменной AZURE_USERNAME среды. Дополнительные сведения см. в статье SharedTokenCacheCredential.

  5. Удостоверение, вошедшего в Azure CLI.

  6. Удостоверение, вошедшего в Azure PowerShell.

  7. Удостоверение, вошедшего в Azure Developer CLI.

Это поведение по умолчанию можно настроить с помощью ключевое слово аргументов.

Наследование
azure.identity._credentials.chained.ChainedTokenCredential
DefaultAzureCredential

Конструктор

DefaultAzureCredential(**kwargs: Any)

Параметры

authority
str

Центр конечной точки Azure Active Directory, например "login.microsoftonline.com", центр для общедоступного облака Azure (по умолчанию). AzureAuthorityHosts определяет полномочия для других облаков. Управляемые удостоверения игнорируют это, так как они находятся в одном облаке.

exclude_workload_identity_credential
bool

Следует ли исключить удостоверение рабочей нагрузки из учетных данных. Значение по умолчанию — False.

exclude_developer_cli_credential
bool

Следует ли исключить Azure Developer CLI из учетных данных. Значение по умолчанию — False.

exclude_cli_credential
bool

Следует ли исключить Azure CLI из учетных данных. Значение по умолчанию — False.

exclude_environment_credential
bool

Следует ли исключить субъект-службу, настроенный переменными среды, из учетных данных. Значение по умолчанию — False.

exclude_managed_identity_credential
bool

Следует ли исключать управляемое удостоверение из учетных данных. Значение по умолчанию — False.

exclude_powershell_credential
bool

Следует ли исключать Azure PowerShell. Значение по умолчанию — False.

exclude_visual_studio_code_credential
bool

Следует ли исключать сохраненные учетные данные из VS Code. По умолчанию имеет значение True.

exclude_shared_token_cache_credential
bool

Следует ли исключить общий кэш маркеров. Значение по умолчанию — False.

exclude_interactive_browser_credential
bool

Следует ли исключить интерактивную проверку подлинности браузера (см. ).InteractiveBrowserCredential По умолчанию имеет значение True.

interactive_browser_tenant_id
str

Идентификатор клиента, используемый при проверке подлинности пользователя с помощью InteractiveBrowserCredential. По умолчанию используется значение переменной среды AZURE_TENANT_ID, если таковой имеется. Если это не указано, пользователи будут проходить проверку подлинности в своих домашних клиентах.

managed_identity_client_id
str

Идентификатор клиента для управляемого удостоверения, назначаемого пользователем. По умолчанию используется значение переменной среды AZURE_CLIENT_ID, если таковой имеется. Если значение не указано, будет использоваться удостоверение, назначаемое системой.

workload_identity_client_id
str

Идентификатор клиента удостоверения, назначенного модулем pod. По умолчанию используется значение переменной среды AZURE_CLIENT_ID, если таковой имеется. Если значение не указано, будет использоваться удостоверение pod по умолчанию.

workload_identity_tenant_id
str

Предпочтительный клиент для WorkloadIdentityCredential. По умолчанию используется значение переменной среды AZURE_TENANT_ID, если таковой имеется.

interactive_browser_client_id
str

Идентификатор клиента, используемый в учетных данных интерактивного браузера. Если значение не указано, пользователи будут проходить проверку подлинности в приложении разработки Azure.

shared_cache_username
str

Предпочтительное имя пользователя для SharedTokenCacheCredential. По умолчанию используется значение переменной среды AZURE_USERNAME, если таковой имеется.

shared_cache_tenant_id
str

Предпочтительный клиент для SharedTokenCacheCredential. По умолчанию используется значение переменной среды AZURE_TENANT_ID, если таковой имеется.

visual_studio_code_tenant_id
str

Идентификатор клиента, используемый при проверке подлинности с VisualStudioCodeCredentialпомощью . По умолчанию используется параметр "Azure: клиент" в параметрах пользователя VS Code или, если этот параметр не имеет значения, клиент "организации", который поддерживает только рабочие или учебные учетные записи Azure Active Directory.

process_timeout
int

Время ожидания в секундах для использования учетных данных разработчика, выполняющих подпроцессы (например, AzureCliCredential, AzurePowerShellCredential). Значение по умолчанию — 10 секунд.

Примеры

Создайте DefaultAzureCredential.


   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

Методы

close

Закройте сеанс транспорта для всех учетных данных в цепочке.
get_token

Запрос маркера доступа для областей.

Этот метод вызывается автоматически клиентами пакета SDK Azure.

close

Закройте сеанс транспорта для всех учетных данных в цепочке.

close() -> None

get_token

Запрос маркера доступа для областей.

Этот метод вызывается автоматически клиентами пакета SDK Azure.

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Параметры

scopes
str
Обязательно

требуемые области для маркера доступа. Для этого метода требуется по крайней мере одна область. Дополнительные сведения об областях см. в разделе https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

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

tenant_id
str

необязательный клиент для включения в запрос маркера.

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

Маркер доступа с нужными областями.

Возвращаемый тип

AccessToken

Исключения

ClientAuthenticationError

сбой проверки подлинности. Исключение содержит атрибут сообщения со списком каждой попытки проверки подлинности и сообщение об ошибке.