Sdílet prostřednictvím

  • Článek

Stav sestavení

Klientská knihovna balíčku ověřování Azure Mixed Reality pro Python – verze 1.0.0b1

Mixed Reality služby, jako jsou Azure Spatial Anchors, Azure Remote Rendering a další, používají k ověřování službu tokenů zabezpečení (STS) Mixed Reality. Tento balíček podporuje výměnu přihlašovacích údajů Mixed Reality účtu pro přístupový token ze služby STS, které lze použít pro přístup ke službám Mixed Reality.

diagram ověřování služby Mixed Reality

Začínáme

Aktuálně podporovaná prostředí

Tento balíček byl testován s Pythony 2.7, 3.5, 3.6, 3.7, 3.8 a 3.9.

Požadavky

Instalace balíčku

Nainstalujte sadu Azure Mixed Reality Authentication SDK.

pip install --pre azure-mixedreality-authentication

Vytvoření a ověření MixedRealityStsClient

Pokud chcete vytvořit objekt klienta pro vyžádání přístupového tokenu pro službu Mixed Reality, budete potřebovat account identifier a account domain prostředku služby Mixed Reality a credential.

Mixed Reality služby podporují několik různých forem ověřování:

  • Ověřování pomocí klíče účtu
    • Klíče účtu umožňují rychle začít používat Mixed Reality služby. Než ale nasadíte aplikaci do produkčního prostředí, doporučujeme aplikaci aktualizovat tak, aby používala ověřování Azure AD.
  • Ověřování tokenem Azure Active Directory (AD)
    • Pokud vytváříte podnikovou aplikaci a vaše společnost používá jako systém identit Azure AD, můžete ve své aplikaci použít ověřování založené na Azure AD uživatele. Přístup k účtům Mixed Reality pak udělíte pomocí stávajících skupin zabezpečení Azure AD. Přístup můžete také udělit přímo uživatelům ve vaší organizaci.
    • V opačném případě doporučujeme získat tokeny Azure AD z webové služby, která podporuje vaši aplikaci. Tuto metodu doporučujeme pro produkční aplikace, protože umožňuje vyhnout se vkládání přihlašovacích údajů pro přístup ke službě Mixed Reality do klientské aplikace.

Podrobné pokyny a informace najdete tady .

Použití ověřování pomocí klíče účtu

Pomocí webu Azure Portal přejděte k prostředku služby Mixed Reality a načtěte account key.

Jakmile budete mít klíč účtu, můžete třídu použít AzureKeyCredential k ověření klienta následujícím způsobem:

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)

Poznámka: Ověřování pomocí klíče účtu se nedoporučuje pro produkční aplikace.

Použití přihlašovacích údajů Azure Active Directory

Ve většině příkladů se používá ověřování pomocí klíče účtu, ale můžete se také ověřit pomocí Azure Active Directory pomocí knihovny identit Azure. Toto je doporučená metoda pro produkční aplikace. Pokud chcete použít zprostředkovatele DefaultAzureCredential uvedeného níže nebo jiné poskytovatele přihlašovacích údajů poskytovaného se sadou Azure SDK, nainstalujte @azure/identity balíček:

Budete také muset zaregistrovat novou aplikaci AAD a udělit přístup k prostředku Mixed Reality přiřazením příslušné role pro službu Mixed Reality vašemu instančnímu objektu.

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)

Klíčové koncepty

MixedRealityStsClient

Jedná se MixedRealityStsClient o klientskou knihovnu, která se používá pro přístup k Mixed Reality STS za účelem získání přístupového tokenu. Přístupový token lze načíst voláním get_token()MixedRealityStsClient instance.

Tokeny získané z Mixed Reality sts mají životnost 24 hodin.

Hodnota výsledku tokenu

Návratová hodnota pro úspěšné volání get_token je .azure.core.credentials.AccessToken

Složitější scénáře ověřování najdete v předchozích příkladech ověřování nebo v Azure Identity .

Synchronní načtení přístupového tokenu

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

Asynchronní načtení přístupového tokenu

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

Příklady

Toto jsou ukázky kódu, které ukazují běžné operace scénářů s klientskou knihovnou Azure Mixed Reality Authentication. Asynchronní verze ukázek (ukázkové soubory Pythonu připojené k _async) zobrazují asynchronní operace a vyžadují Python 3.5 nebo novější. Před spuštěním ukázkového kódu si projděte požadavky.

vytvořte prostředek a pak nastavte některé proměnné prostředí.

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

Poradce při potížích

Při řešení potíží s ověřováním může být užitečná část pro řešení potíží s identitou Azure.

Další kroky

Mixed Reality klientských knihoven

  • Již brzy

Přispívání

Tento projekt vítá příspěvky a návrhy. Většina příspěvků vyžaduje souhlas s licenční smlouvou s přispěvatelem (CLA), která stanoví, že máte právo udělit nám práva k používání vašeho příspěvku a skutečně tak činíte. Podrobnosti najdete tady: https://cla.microsoft.com

Při odesílání žádosti o přijetí změn robot CLA automaticky určí, jestli je potřeba poskytnout smlouvu CLA, a příslušným způsobem žádost o přijetí změn upraví (např. přidáním jmenovky nebo komentáře). Stačí postupovat podle pokynů robota. Pro všechna úložiště používající naši smlouvu CLA to stačí udělat jenom jednou.

Tento projekt přijal pravidla chování pro Microsoft Open Source. Další informace najdete v nejčastějších dotazech k pravidlům chování nebo se obraťte na opencode@microsoft.com případné další dotazy nebo komentáře.

Pokud chcete přispívat do této knihovny, přečtěte si prosím průvodce přispívání , kde se dozvíte více o tom, jak sestavit a otestovat kód.

Imprese