EnvironmentCredential Класс

  • Ссылка

Учетные данные, настроенные переменными среды.

Эти учетные данные могут выполнять проверку подлинности в качестве субъекта-службы с помощью секрета клиента или сертификата либо как пользователя с именем пользователя и паролем. Попытка настройки выполняется в таком порядке с использованием следующих переменных среды:

Субъект-служба с секретом:

  • AZURE_TENANT_ID: идентификатор клиента субъекта-службы. Также называется идентификатором каталога.

  • AZURE_CLIENT_ID: идентификатор клиента субъекта-службы.

  • AZURE_CLIENT_SECRET: один из секретов клиента субъекта-службы.

  • AZURE_AUTHORITY_HOST: полномочия конечной точки Azure Active Directory, например "login.microsoftonline.com", центр для общедоступного облака Azure, который используется по умолчанию, если значение не задано.

Субъект-служба с сертификатом:

  • AZURE_TENANT_ID: идентификатор клиента субъекта-службы. Также называется идентификатором каталога.

  • AZURE_CLIENT_ID: идентификатор клиента субъекта-службы.

  • AZURE_CLIENT_CERTIFICATE_PATH: путь к файлу сертификата PEM или PKCS12, включая закрытый ключ.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (необязательно) пароль файла сертификата, если таковой есть.

  • AZURE_AUTHORITY_HOST: полномочия конечной точки Azure Active Directory, например "login.microsoftonline.com", центр для общедоступного облака Azure, который используется по умолчанию, если значение не задано.

Пользователь с именем пользователя и паролем:

  • AZURE_CLIENT_ID: идентификатор клиента приложения.

  • AZURE_USERNAME: имя пользователя (обычно это адрес электронной почты).

  • AZURE_PASSWORD: пароль пользователя

  • AZURE_TENANT_ID: (необязательно) идентификатор клиента субъекта-службы. Также называется идентификатором каталога. Если этот параметр не указан, по умолчанию используется клиент organizations, который поддерживает только рабочие или учебные учетные записи Azure Active Directory.

  • AZURE_AUTHORITY_HOST: полномочия конечной точки Azure Active Directory, например "login.microsoftonline.com", центр для общедоступного облака Azure, который используется по умолчанию, если значение не задано.

Наследование
builtins.object
EnvironmentCredential

Конструктор

EnvironmentCredential(**kwargs: Any)

Примеры

Создайте Объект EnvironmentCredential.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Методы

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

Исключения

CredentialUnavailableError

Конфигурация переменной среды не завершена