Libreria client del pacchetto di autenticazione di Azure Realtà mista per Python - versione 1.0.0b1

Realtà mista servizi, ad esempio Ancoraggi nello spazio di Azure, Azure Rendering remoto e altri, usare il servizio token di sicurezza Realtà mista per l'autenticazione. Questo pacchetto supporta lo scambio di credenziali dell'account Realtà mista per un token di accesso dal servizio token di sicurezza che può essere usato per accedere ai servizi di Realtà mista.

Introduzione

Ambienti attualmente supportati

Questo pacchetto è stato testato con Python 2.7, 3.5, 3.6, 3.7, 3.8 e 3.9.

Prerequisiti

• Una sottoscrizione di Azure.
• È necessario avere un account con un servizio azure Realtà mista:
  • Rendering remoto di Azure
  • Ancoraggi nello spazio di Azure
• Familiarità con i concetti relativi all'autenticazione e alle credenziali della libreria di identità di Azure.
• Python 2.7 o 3.5 o versione successiva è necessario per usare questo pacchetto.

Installare il pacchetto

Installare Azure Realtà mista Authentication SDK.

pip install --pre azure-mixedreality-authentication

Creare e autenticare un oggetto MixedRealityStsClient

Per creare un oggetto client per richiedere un token di accesso per un servizio di Realtà mista, sono necessari e account identifieraccount domain della risorsa del servizio di Realtà mista e di .credential

Realtà mista servizi supportano alcune diverse forme di autenticazione:

• Autenticazione della chiave dell'account
  • Le chiavi dell'account consentono di iniziare rapidamente a usare i servizi di Realtà mista. Tuttavia, prima di distribuire l'applicazione nell'ambiente di produzione, è consigliabile aggiornare l'app per usare l'autenticazione di Azure AD.
• Autenticazione del token di Azure Active Directory (AD)
  • Se si sta creando un'applicazione aziendale e l'azienda usa Azure AD come sistema di identità, è possibile usare l'autenticazione di Azure AD basata sull'utente nell'app. Si concede quindi l'accesso agli account Realtà mista usando i gruppi di sicurezza di Azure AD esistenti. È anche possibile concedere l'accesso direttamente agli utenti dell'organizzazione.
  • In caso contrario, è consigliabile ottenere i token di Azure AD da un servizio Web che supporta l'app. È consigliabile usare questo metodo per le applicazioni di produzione perché consente di evitare di incorporare le credenziali per l'accesso a un servizio Realtà mista nell'applicazione client.

Per istruzioni dettagliate e informazioni, vedere qui .

Uso dell'autenticazione della chiave dell'account

Usare il portale di Azure per passare alla risorsa del servizio Realtà mista e recuperare un oggetto account key.

Dopo aver ottenuto una chiave dell'account, è possibile usare la AzureKeyCredential classe per autenticare il client come indicato di seguito:

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)

Nota: l'autenticazione della chiave dell'account non è consigliata per le applicazioni di produzione.

Uso di credenziali di Azure Active Directory

L'autenticazione della chiave dell'account viene usata nella maggior parte degli esempi, ma è anche possibile eseguire l'autenticazione con Azure Active Directory usando la libreria di identità di Azure. Questo è il metodo consigliato per le applicazioni di produzione. Per usare il provider DefaultAzureCredential illustrato di seguito o altri provider di credenziali forniti con Azure SDK, installare il @azure/identity pacchetto:

Sarà anche necessario registrare una nuova applicazione AAD e concedere l'accesso alla risorsa Realtà mista assegnando il ruolo appropriato per il servizio Realtà mista all'entità servizio.

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)

Concetti chiave

MixedRealityStsClient

MixedRealityStsClient è la libreria client usata per accedere al servizio token di sicurezza di Realtà mista per ottenere un token di accesso. È possibile recuperare un token di accesso chiamando get_token() su un'istanza MixedRealityStsClient di .

I token ottenuti dal servizio token di sicurezza di Realtà mista hanno una durata di 24 ore.

Valore del risultato del token

Il valore restituito per una chiamata riuscita a get_token è un oggetto azure.core.credentials.AccessToken.

Per scenari di autenticazione più complessi, vedere gli esempi di autenticazione precedenti o Azure Identity .

Recuperare un token di accesso in modo sincrono

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

Recuperare un token di accesso in modo asincrono

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

Esempio

Si tratta di esempi di codice che illustrano operazioni di scenario comuni con la libreria client di autenticazione di Azure Realtà mista. Le versioni asincrone degli esempi (i file di esempio Python aggiunti con _async) mostrano operazioni asincrone e richiedono Python 3.5 o versione successiva. Prima di eseguire il codice di esempio, vedere Prerequisiti

per creare una risorsa, quindi impostare alcune variabili di ambiente

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

Risoluzione dei problemi

La sezione relativa alla risoluzione dei problemi per Identità di Azure può essere utile per la risoluzione dei problemi di autenticazione.

Passaggi successivi

librerie client Realtà mista

• Presto disponibile

Contributo

In questo progetto sono benvenuti i contributi e i suggerimenti. Per la maggior parte dei contenuti è necessario sottoscrivere un contratto di licenza di collaborazione (CLA, Contributor License Agreement) che stabilisce che l'utente ha il diritto di concedere, e di fatto concede a Microsoft i diritti d'uso del suo contributo. Per informazioni dettagliate, vedere https://cla.microsoft.com.

Quando si invia una richiesta pull, un bot CLA determina automaticamente se è necessario specificare un contratto CLA e completare la richiesta pull in modo appropriato (ad esempio con un'etichetta e un commento). Seguire le istruzioni specificate dal bot. È sufficiente eseguire questa operazione una sola volta per tutti i repository che usano il contratto CLA Microsoft.

Questo progetto ha adottato il Codice di comportamento di Microsoft per l'open source. Per altre informazioni, vedere Code of Conduct FAQ (Domande frequenti sul Codice di comportamento Open Source di Microsoft) oppure contattare opencode@microsoft.com per eventuali altre domande o commenti.

Per contribuire a questa libreria, leggere la guida ai contributi per altre informazioni su come compilare e testare il codice.