Pustaka klien Paket Autentikasi Azure Mixed Reality untuk Python - versi 1.0.0b1

Mixed Reality layanan, seperti Azure Spatial Anchors, Azure Remote Rendering, dan lainnya, gunakan layanan token keamanan (STS) Mixed Reality untuk autentikasi. Paket ini mendukung pertukaran kredensial akun Mixed Reality dengan token akses dari STS yang dapat digunakan untuk mengakses layanan Mixed Reality.

Memulai

Lingkungan yang didukung saat ini

Paket ini telah diuji dengan Python 2.7, 3.5, 3.6, 3.7, 3.8, dan 3.9.

Prasyarat

• Langganan Azure.
• Anda harus memiliki akun dengan layanan Azure Mixed Reality:
  • Azure Remote Rendering
  • Azure Spatial Anchors
• Memahami konsep autentikasi dan kredensial dari pustaka Azure Identity.
• Python 2.7, atau 3.5 atau yang lebih baru diperlukan untuk menggunakan paket ini.

Instal paketnya

Instal Azure Mixed Reality Authentication SDK.

pip install --pre azure-mixedreality-authentication

Membuat dan mengautentikasi MixedRealityStsClient

Untuk membuat objek klien guna meminta token akses untuk layanan Mixed Reality, Anda akan memerlukan account identifier dan account domain sumber daya layanan Mixed Reality Anda dan credential.

layanan Mixed Reality mendukung beberapa bentuk autentikasi yang berbeda:

• Autentikasi Kunci Akun
  • Kunci akun memungkinkan Anda memulai dengan cepat menggunakan layanan Mixed Reality. Namun sebelum menyebarkan aplikasi ke produksi, kami menyarankan Anda memperbarui aplikasi untuk menggunakan autentikasi Azure Active Directory.
• Autentikasi token Azure Active Directory (AD)
  • Jika sedang membangun aplikasi perusahaan dan perusahaan menggunakan Azure Active Directory sebagai sistem identitasnya, Anda dapat menggunakan autentikasi Azure Active Directory berbasis pengguna di aplikasi. Anda kemudian memberikan akses ke akun Mixed Reality Anda dengan menggunakan grup keamanan Azure AD yang sudah ada. Anda juga dapat memberikan akses langsung ke pengguna di organisasi Anda.
  • Jika tidak, kami menyarankan Anda mendapatkan token Azure Active Directory dari layanan web yang mendukung aplikasi. Kami merekomendasikan metode ini untuk aplikasi produksi karena memungkinkan Anda menghindari penyematan kredensial untuk akses ke layanan Mixed Reality di aplikasi klien Anda.

Lihat di sini untuk petunjuk dan informasi terperinci.

Menggunakan autentikasi kunci akun

Gunakan Portal Microsoft Azure untuk menelusuri sumber daya layanan Mixed Reality Anda dan mengambil account key.

Setelah memiliki kunci akun, Anda dapat menggunakan AzureKeyCredential kelas untuk mengautentikasi klien sebagai berikut:

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)

Catatan: Autentikasi kunci akun tidak disarankan untuk aplikasi produksi.

Menggunakan Kredensial Azure Active Directory

Autentikasi kunci akun digunakan di sebagian besar contoh, tetapi Anda juga dapat mengautentikasi dengan Azure Active Directory menggunakan pustaka Azure Identity. Ini adalah metode yang direkomendasikan untuk aplikasi produksi. Untuk menggunakan penyedia DefaultAzureCredential yang ditunjukkan di bawah ini, atau penyedia kredensial lain yang disediakan dengan Azure SDK, harap instal @azure/identity paket:

Anda juga perlu mendaftarkan aplikasi AAD baru dan memberikan akses ke sumber daya Mixed Reality Anda dengan menetapkan peran yang sesuai untuk layanan Mixed Reality Anda ke perwakilan layanan Anda.

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)

Konsep utama

MixedRealityStsClient

MixedRealityStsClient adalah pustaka klien yang digunakan untuk mengakses STS Mixed Reality untuk mendapatkan token akses. Token akses dapat diambil dengan memanggil get_token() instans MixedRealityStsClient .

Token yang diperoleh dari Mixed Reality STS memiliki masa pakai 24 jam.

Nilai hasil token

Nilai yang dikembalikan untuk panggilan get_token ke yang berhasil adalah azure.core.credentials.AccessToken.

Lihat contoh autentikasi di atas atau Azure Identity untuk skenario autentikasi yang lebih kompleks.

Mengambil token akses secara sinkron

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

Mengambil token akses secara asinkron

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

Contoh

Ini adalah sampel kode yang memperlihatkan operasi skenario umum dengan pustaka klien Azure Mixed Reality Authentication. Versi asinkron sampel (file sampel python ditambahkan dengan _async) menunjukkan operasi asinkron, dan memerlukan Python 3.5 atau yang lebih baru. Sebelum menjalankan kode sampel, lihat Prasyarat

untuk membuat sumber daya, lalu atur beberapa Variabel Lingkungan

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

Pemecahan Masalah

Bagian pemecahan masalah untuk Azure Identity dapat membantu saat memecahkan masalah autentikasi.

Langkah berikutnya

Mixed Reality pustaka klien

• Segera hadir

Berkontribusi

Proyek ini menyambut baik kontribusi dan saran. Sebagian besar kontribusi mengharuskan Anda menyetujui Perjanjian Lisensi Kontributor (CLA) yang menyatakan bahwa Anda memiliki hak untuk, dan benar-benar melakukannya, memberi kami hak untuk menggunakan kontribusi Anda. Untuk detailnya, kunjungi https://cla.microsoft.com.

Ketika Anda mengirimkan permintaan tarik, CLA-bot akan secara otomatis menentukan apakah Anda perlu memberikan CLA dan menghias PR dengan tepat (misalnya, label, komentar). Cukup ikuti instruksi yang diberikan oleh bot. Anda hanya perlu melakukan ini sekali di semua repos menggunakan CLA kami.

Proyek ini telah mengadopsi Kode Etik Sumber Terbuka Microsoft. Untuk informasi selengkapnya, lihat Tanya Jawab Umum Tata Tertib atau hubungi opencode@microsoft.com untuk pertanyaan atau komentar lainnya.

Jika Anda ingin berkontribusi pada pustaka ini, baca panduan berkontribusi untuk mempelajari selengkapnya tentang cara membuat dan menguji kode.