Biblioteka klienta pakietu uwierzytelniania usługi Azure Mixed Reality dla języka Python — wersja 1.0.0b1

usługi Mixed Reality, takie jak Azure Spatial Anchors, Azure Remote Rendering i inne, używają usługi Mixed Reality tokenu zabezpieczającego (STS) do uwierzytelniania. Ten pakiet obsługuje wymianę poświadczeń konta Mixed Reality dla tokenu dostępu z usługi STS, których można użyć do uzyskiwania dostępu do usług Mixed Reality.

Wprowadzenie

Obecnie obsługiwane środowiska

Ten pakiet został przetestowany przy użyciu języka Python 2.7, 3.5, 3.6, 3.7, 3.8 i 3.9.

Wymagania wstępne

• Subskrypcja platformy Azure.
• Musisz mieć konto z usługą Azure Mixed Reality:
  • Azure Remote Rendering
  • Azure Spatial Anchors
• Znajomość pojęć dotyczących uwierzytelniania i poświadczeń z biblioteki tożsamości platformy Azure.
• Do korzystania z tego pakietu wymagany jest język Python w wersji 2.7 lub 3.5 lub nowszej.

Instalowanie pakietu

Zainstaluj zestaw SDK uwierzytelniania usługi Azure Mixed Reality.

pip install --pre azure-mixedreality-authentication

Tworzenie i uwierzytelnianie MixedRealityStsClient

Aby utworzyć obiekt klienta w celu żądania tokenu dostępu dla usługi Mixed Reality, potrzebny account identifieraccount domain będzie zasób usługi Mixed Reality i .credential

usługi Mixed Reality obsługują kilka różnych form uwierzytelniania:

• Uwierzytelnianie klucza konta
  • Klucze kont umożliwiają szybkie rozpoczęcie pracy przy użyciu usług Mixed Reality. Jednak przed wdrożeniem aplikacji w środowisku produkcyjnym zalecamy zaktualizowanie aplikacji do korzystania z uwierzytelniania Azure AD.
• Uwierzytelnianie tokenu usługi Azure Active Directory (AD)
  • Jeśli tworzysz aplikację dla przedsiębiorstw, a firma używa Azure AD jako systemu tożsamości, możesz użyć uwierzytelniania Azure AD opartego na użytkownikach w aplikacji. Następnie udzielasz dostępu do kont Mixed Reality przy użyciu istniejących grup zabezpieczeń Azure AD. Możesz również udzielić dostępu bezpośrednio użytkownikom w organizacji.
  • W przeciwnym razie zalecamy uzyskanie Azure AD tokenów z usługi internetowej obsługującej aplikację. Zalecamy tę metodę dla aplikacji produkcyjnych, ponieważ pozwala uniknąć osadzania poświadczeń w celu uzyskania dostępu do usługi Mixed Reality w aplikacji klienckiej.

Zobacz tutaj , aby uzyskać szczegółowe instrukcje i informacje.

Korzystanie z uwierzytelniania klucza konta

Użyj witryny Azure Portal, aby przejść do zasobu usługi Mixed Reality i pobrać plik account key.

Po utworzeniu klucza konta możesz użyć AzureKeyCredential klasy do uwierzytelnienia klienta w następujący sposób:

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)

Uwaga: uwierzytelnianie klucza konta nie jest zalecane w przypadku aplikacji produkcyjnych.

Używanie poświadczeń usługi Azure Active Directory

Uwierzytelnianie klucza konta jest używane w większości przykładów, ale można również uwierzytelnić się w usłudze Azure Active Directory przy użyciu biblioteki tożsamości platformy Azure. Jest to zalecana metoda dla aplikacji produkcyjnych. Aby użyć poniższego dostawcy DefaultAzureCredential lub innych dostawców poświadczeń dostarczonych z zestawem Azure SDK, zainstaluj @azure/identity pakiet:

Musisz również zarejestrować nową aplikację usługi AAD i udzielić dostępu do zasobu Mixed Reality, przypisując odpowiednią rolę dla usługi Mixed Reality do jednostki usługi.

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)

Kluczowe pojęcia

MixedRealityStsClient

Jest MixedRealityStsClient to biblioteka klienta używana do uzyskiwania dostępu do Mixed Reality usług STS w celu uzyskania tokenu dostępu. Token dostępu można pobrać, wywołując get_token()MixedRealityStsClient wystąpienie.

Tokeny uzyskane z Mixed Reality STS mają okres istnienia 24 godzin.

Wartość wyniku tokenu

Wartość zwracana dla pomyślnego wywołania get_token to azure.core.credentials.AccessToken.

Zobacz przykłady uwierzytelniania powyżej lub usługę Azure Identity , aby uzyskać bardziej złożone scenariusze uwierzytelniania.

Synchronicznie pobieranie tokenu dostępu

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()

Pobieranie asynchronicznego tokenu dostępu

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()

Przykłady

Są to przykłady kodu, które pokazują typowe operacje scenariuszy w bibliotece klienta usługi Azure Mixed Reality Authentication. Asynchroniczne wersje przykładów (przykładowe pliki języka Python dołączone za pomocą _asyncpolecenia ) pokazują operacje asynchroniczne i wymagają języka Python 3.5 lub nowszego. Przed uruchomieniem przykładowego kodu zapoznaj się z tematem Wymagania wstępne

aby utworzyć zasób, a następnie ustawić niektóre zmienne środowiskowe

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

Rozwiązywanie problemów

Sekcja rozwiązywania problemów z tożsamością platformy Azure może być przydatna podczas rozwiązywania problemów z uwierzytelnianiem.

Następne kroki

biblioteki klienta Mixed Reality

• Już wkrótce

Współtworzenie

W tym projekcie zachęcamy do współtworzenia i zgłaszania sugestii. Współtworzenie w większości przypadków wymaga zgody na umowę licencyjną dotyczącą współautorów (CLA, Contributor License Agreement), zgodnie z którą współautor ma prawo udzielić i faktycznie udziela nam praw do używania wytworzonej przez siebie zawartości. Aby uzyskać szczegółowe informacje, odwiedź stronę https://cla.microsoft.com.

Po przesłaniu żądania ściągnięcia robot CLA automatycznie określi, czy musisz przekazać umowę CLA, i doda odpowiednie informacje do tego żądania (na przykład etykietę czy komentarz). Po prostu postępuj zgodnie z instrukcjami robota. Wystarczy zrobić to raz dla wszystkich repozytoriów, w przypadku których jest używana nasza umowa CLA.

W tym projekcie przyjęto Kodeks postępowania oprogramowania Open Source firmy Microsoft. Aby uzyskać więcej informacji, zobacz Często zadawane pytania dotyczące kodeksu postępowania lub skontaktuj się z opencode@microsoft.com dodatkowymi pytaniami lub komentarzami.

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik współtworzenia , aby dowiedzieć się więcej na temat sposobu kompilowania i testowania kodu.