Bagikan melalui

Pustaka klien Azure Mixed Reality Authentication untuk JavaScript - versi 1.0.0-beta.1

Layanan Mixed Reality, seperti Azure Remote Rendering, menggunakan layanan token keamanan Mixed Reality (STS) untuk autentikasi. Paket ini mendukung pertukaran kredensial akun Mixed Reality untuk token akses dari STS yang dapat digunakan untuk mengakses layanan Mixed Reality.

Tautan kunci:

Persiapan

Lingkungan yang saat ini didukung

Prasyarat

  • Langganan Azure .
  • Anda harus memiliki akun dengan layanan Azure Mixed Reality:
    • Azure Remote Rendering
  • Keakraban dengan konsep autentikasi dan kredensial dari pustaka Azure Identity .

Menginstal paket @azure/mixed-reality-authentication

Instal pustaka klien Azure Mixed Reality Authentication untuk JavaScript dengan npm:

npm install @azure/mixed-reality-authentication

Membuat dan mengautentikasi MixedRealityStsClient

Untuk membuat objek klien untuk 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. Tetapi sebelum menyebarkan aplikasi ke produksi, kami sarankan Anda memperbarui aplikasi untuk menggunakan autentikasi Azure AD.
  • Autentikasi token Azure Active Directory (AD)
    • Jika Anda membangun aplikasi perusahaan dan perusahaan Anda menggunakan Azure AD sebagai sistem identitasnya, Anda dapat menggunakan autentikasi Microsoft Azure AD berbasis pengguna di aplikasi Anda. Anda kemudian memberikan akses ke akun Mixed Reality Anda dengan menggunakan grup keamanan Azure ACTIVE Directory yang sudah ada. Anda juga dapat memberikan akses langsung kepada pengguna di organisasi Anda.
    • Jika tidak, kami sarankan Anda mendapatkan token Azure ACTIVE Directory dari layanan web yang mendukung aplikasi Anda. Kami merekomendasikan metode ini untuk aplikasi produksi karena memungkinkan Anda untuk menghindari penyematan kredensial untuk akses ke layanan Mixed Reality di aplikasi klien Anda.

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 kelas AzureKeyCredential untuk mengautentikasi klien sebagai berikut:

const { AzureKeyCredential } = require("@azure/core-auth");

const { MixedRealityStsClient } = require("@azure/mixed-reality-authentication");

const accountId = "<ACCOUNTD ID>";
const accountDomain = "<ACCOUNT_DOMAIN>";
const accountKey = "<ACCOUNT_KEY>";

const client = new MixedRealityStsClient(
  accountId,
  accountDomain,
  new AzureKeyCredential(accountKey)
);

Catatan: Autentikasi kunci akun tidak direkomendasikan 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, instal paket @azure/identity:

npm install @azure/identity

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

Atur nilai ID klien, ID penyewa, dan rahasia klien aplikasi AAD sebagai variabel lingkungan: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

const { MixedRealityStsClient } = require("@azure/mixed-reality-authentication");
const { DefaultAzureCredential } = require("@azure/identity");

const client = new MixedRealityStsClient(accountId, accountDomain, new DefaultAzureCredential());

Konsep utama

MixedRealityStsClient

MixedRealityStsClient adalah pustaka klien yang digunakan untuk mengakses STS Mixed Reality untuk mendapatkan token akses.

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

Mengembalikan Nilai

Nilai pengembalian untuk panggilan yang berhasil ke getToken adalah GetTokenResponse, yang merupakan AccessToken dari @azure/core-http .

Contoh

Mengambil token akses

const { AzureKeyCredential } = require("@azure/core-auth");

const { MixedRealityStsClient } = require("@azure/mixed-reality-authentication");

const accountId = "<ACCOUNTD ID>";
const accountDomain = "<ACCOUNT_DOMAIN>";
const accountKey = "<ACCOUNT_KEY>";

const client = new MixedRealityStsClient(
  accountId,
  accountDomain,
  new AzureKeyCredential(accountKey)
);

const token = await client.getToken();

Lihat Azure Identity untuk skenario autentikasi yang lebih kompleks.

Menggunakan token akses di pustaka klien Mixed Reality

Beberapa pustaka klien Mixed Reality mungkin menerima token akses sebagai ganti kredensial. Misalnya:

// GetMixedRealityAccessTokenFromWebService is a hypothetical method that retrieves
// a Mixed Reality access token from a web service. The web service would use the
// MixedRealityStsClient and credentials to obtain an access token to be returned
// to the client.
const accessToken = await GetMixedRealityAccessTokenFromWebService();

const account = new SpatialAnchorsAccount(accountId, accountDomain);
const client = new SpatialAnchorsClient(account, accessToken);

Catatan: Penggunaan SpatialAnchorsClient di atas bersifat hipotetis dan mungkin tidak mencerminkan pustaka yang sebenarnya. Lihat dokumentasi untuk pustaka klien yang Anda gunakan untuk menentukan apakah dan bagaimana ini mungkin didukung.

Pemecahan masalah

Penebangan

Mengaktifkan pengelogan dapat membantu mengungkap informasi yang berguna tentang kegagalan. Untuk melihat log permintaan dan respons HTTP, atur variabel lingkungan AZURE_LOG_LEVEL ke info. Atau, pengelogan dapat diaktifkan saat runtime dengan memanggil setLogLevel di @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Untuk instruksi lebih rinci tentang cara mengaktifkan log, Anda dapat melihat dokumen paket @azure/pencatat.

Langkah berikutnya

Silakan lihat sampel direktori untuk contoh terperinci tentang cara menggunakan pustaka ini.

Berkontribusi

Proyek ini menyambut 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.

Saat Anda mengirimkan permintaan pull, 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 repositori menggunakan CLA kami.

Proyek ini telah mengadopsi Kode Etik Sumber Terbuka Microsoft. Untuk informasi selengkapnya, lihat Tanya Jawab Umum Kode Etik atau hubungi opencode@microsoft.com dengan pertanyaan atau komentar tambahan apa pun.

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

  • Last updated on