Поделиться через

  • Статья

Состояние сборки

Клиентская библиотека пакета проверки подлинности Azure Смешанная реальность для Python — версия 1.0.0b1

Смешанная реальность службы, такие как Пространственные привязки Azure, Azure Удаленная отрисовка и другие, используют службу маркеров безопасности Смешанная реальность (STS) для проверки подлинности. Этот пакет поддерживает обмен учетными данными Смешанная реальность учетной записи на маркер доступа из службы маркеров безопасности, который можно использовать для доступа к Смешанная реальность службам.

Схема проверки подлинности службы Смешанная реальность

Начало работы

Поддерживаемые в настоящее время среды

Этот пакет протестирован с python 2.7, 3.5, 3.6, 3.7, 3.8 и 3.9.

Предварительные требования

Установка пакета

Установите пакет SDK проверки подлинности Azure Смешанная реальность.

pip install --pre azure-mixedreality-authentication

Создание и проверка подлинности MixedRealityStsClient

Чтобы создать клиентский объект для запроса маркера доступа для службы Смешанная реальность, потребуются account identifier и ресурса account domain службы Смешанная реальность и credential.

службы Смешанная реальность поддерживают несколько различных форм проверки подлинности:

  • Проверка подлинности с помощью ключа учетной записи
    • Ключи учетной записи позволяют быстро приступить к работе с Смешанная реальность службами. Но перед развертыванием приложения в рабочей среде рекомендуется обновить приложение и включить в нем использование проверки подлинности Azure AD.
  • Проверка подлинности на основе маркера Azure Active Directory (AD)
    • Если вы создаете корпоративное приложение и в вашей компании в качестве системы идентификации используется Azure AD, вы можете применить в своем приложении проверку подлинности Azure AD на основе пользователей. Затем вы предоставляете доступ к учетным записям Смешанная реальность с помощью существующих Azure AD групп безопасности. Вы также можете предоставлять доступ пользователям в вашей организации напрямую.
    • В противном случае рекомендуется получать маркеры Azure AD из веб-службы, поддерживающей ваше приложение. Мы рекомендуем использовать этот метод для рабочих приложений, так как он позволяет избежать внедрения учетных данных для доступа к службе Смешанная реальность в клиентском приложении.

Подробные инструкции и сведения см. здесь .

Использование проверки подлинности с помощью ключа учетной записи

На портале Azure перейдите к ресурсу службы Смешанная реальность и получите account key.

Получив ключ учетной записи, вы можете использовать AzureKeyCredential класс для проверки подлинности клиента следующим образом:

from azure.core.credentials import AzureKeyCredential
from azure.mixedreality.authentication import MixedRealityStsClient

account_id = "<ACCOUNTD ID>"
account_domain = "<ACCOUNT_DOMAIN>"
account_key = "<ACCOUNT_KEY>"
key_credential = AzureKeyCredential(account_key)

client = MixedRealityStsClient(account_id, account_domain, key_credential)

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

Использование учетных данных Azure Active Directory

Проверка подлинности с помощью ключа учетной записи используется в большинстве примеров, но вы также можете пройти проверку подлинности в Azure Active Directory с помощью библиотеки удостоверений Azure. Это рекомендуемый метод для рабочих приложений. Чтобы использовать поставщика DefaultAzureCredential, показанного ниже, или других поставщиков учетных данных, предоставляемых пакетом SDK для Azure, установите @azure/identity пакет :

Вам также потребуется зарегистрировать новое приложение AAD и предоставить доступ к ресурсу Смешанная реальность, назначив субъекту-службе Смешанная реальность соответствующую роль.

from azure.identity import DefaultAzureCredential
from azure.mixedreality.authentication import MixedRealityStsClient

account_id = "<ACCOUNTD ID>"
account_domain = "<ACCOUNT_DOMAIN>"
default_credential = DefaultAzureCredential()

client = MixedRealityStsClient(account_id, account_domain, default_credential)

Основные понятия

MixedRealityStsClient

— MixedRealityStsClient это клиентская библиотека, используемая для доступа к Смешанная реальность STS для получения маркера доступа. Маркер доступа можно получить, вызвав get_token() для экземпляра MixedRealityStsClient .

Срок действия маркеров, полученных из Смешанная реальность STS, составляет 24 часа.

Значение результата токена

Возвращаемое значение для успешного вызова get_token — .azure.core.credentials.AccessToken

Более сложные сценарии проверки подлинности см. в приведенных выше примерах проверки подлинности или в удостоверении Azure .

Синхронное получение маркера доступа

from azure.core.credentials import AzureKeyCredential
from azure.mixedreality.authentication import MixedRealityStsClient

account_id = "<ACCOUNTD ID>"
account_domain = "<ACCOUNT_DOMAIN>"
account_key = "<ACCOUNT_KEY>"
key_credential = AzureKeyCredential(account_key)

client = MixedRealityStsClient(account_id, account_domain, key_credential)

token = client.get_token()

Асинхронное получение маркера доступа

from azure.core.credentials import AzureKeyCredential
from azure.mixedreality.authentication.aio import MixedRealityStsClient

account_id = "<ACCOUNTD ID>"
account_domain = "<ACCOUNT_DOMAIN>"
account_key = "<ACCOUNT_KEY>"
key_credential = AzureKeyCredential(account_key)

client = MixedRealityStsClient(account_id, account_domain, key_credential)

token = await client.get_token()

Примеры

Ниже приведены примеры кода, в которых показаны распространенные операции сценария с клиентской библиотекой проверки подлинности azure Смешанная реальность. В асинхронных версиях примеров (файлы примеров Python, добавленные с _asyncпомощью ) отображаются асинхронные операции и требуется Python 3.5 или более поздней версии. Перед выполнением примера кода ознакомьтесь с предварительными условиями.

чтобы создать ресурс, а затем задать некоторые переменные среды

set MIXEDREALITY_ACCOUNT_DOMAIN="<the Mixed Reality account domain>"
set MIXEDREALITY_ACCOUNT_ID="<the Mixed Reality account identifier>"
set MIXEDREALITY_ACCOUNT_KEY="<the Mixed Reality account primary or secondary key>"

pip install azure-mixedreality-authentication

python samples\client_sample.py
python samples\client_sample_async.py

Устранение неполадок

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

Дальнейшие действия

Смешанная реальность клиентские библиотеки

  • Скоро выйдет

Участие

На этом проекте приветствуются публикации и предложения. Для участия в большинстве процессов по разработке документации необходимо принять лицензионное соглашение участника (CLA), в котором указывается, что вы предоставляете нам права на использование ваших публикаций. Для получения подробных сведений посетите веб-страницу https://cla.microsoft.com.

При отправке запроса на включение внесенных изменений CLA-бот автоматически определит необходимость предоставления соглашения CLA и соответствующего оформления запроса на включение внесенных изменений (например, добавление метки, комментария). Просто следуйте инструкциям бота. Будет достаточно выполнить их один раз для всех репозиториев, поддерживающих соглашение CLA.

В рамках этого проекта действуют правила поведения в отношении продуктов с открытым исходным кодом Майкрософт. Дополнительные сведения см. в разделе часто задаваемых вопросов о правилах поведения или обратитесь к opencode@microsoft.com с любыми дополнительными вопросами или комментариями.

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

Просмотры