ClientSecretCredential Класс

  • Ссылка

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

Наследование
azure.identity.aio._internal.AsyncContextManager
ClientSecretCredential
azure.identity.aio._internal.get_token_mixin.GetTokenMixin
ClientSecretCredential

Конструктор

ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **kwargs: Any)

Параметры

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

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

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

Идентификатор клиента субъекта-службы

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

Один из секретов клиента субъекта-службы

authority
str

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

cache_persistence_options
TokenCachePersistenceOptions

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

additionally_allowed_tenants
List[str]

Указывает клиентов в дополнение к указанному "tenant_id", для которого учетные данные могут получать маркеры. Добавьте значение подстановочного знака "*", чтобы разрешить учетным данным получать маркеры для любого клиента, к который может получить доступ приложение.

Примеры

Создайте ClientSecretCredential.


   from azure.identity.aio import ClientSecretCredential

   credential = ClientSecretCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       client_secret="<client_secret>",
   )

Методы

close

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

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

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

close

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

async close() -> None

get_token

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

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

async 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

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

enable_cae
bool

указывает, следует ли включить непрерывную оценку доступа (CAE) для запрошенного маркера. Значение по умолчанию — False.

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

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

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

AccessToken

Исключения

CredentialUnavailableError

учетные данные не могут попытаться выполнить проверку подлинности из-за отсутствия необходимых данных, состояния или поддержки платформы

ClientAuthenticationError

сбой проверки подлинности. Атрибут ошибки message указывает причину.