Aracılığıyla paylaş

JavaScript için Azure Mixed Reality Kimlik Doğrulaması istemci kitaplığı - sürüm 1.0.0-beta.1

Azure Remote Rendering gibi Karma Gerçeklik hizmetleri, kimlik doğrulaması için Karma Gerçeklik güvenlik belirteci hizmetini (STS) kullanır. Bu paket, Karma Gerçeklik hizmetlerine erişmek için kullanılabilecek STS'den erişim belirteci için Karma Gerçeklik hesabı kimlik bilgilerinin alışverişini destekler.

Önemli bağlantılar:

Başlarken

Şu anda desteklenen ortamlar

  • Node.js LTS sürümleri

Önkoşullar

@azure/mixed-reality-authentication paketini yükleme

npmile JavaScript için Azure Mixed Reality Kimlik Doğrulaması istemci kitaplığını yükleyin:

npm install @azure/mixed-reality-authentication

MixedRealityStsClient oluşturma ve kimlik doğrulaması

Karma Gerçeklik hizmeti için erişim belirteci istemek üzere bir istemci nesnesi oluşturmak için Karma Gerçeklik hizmeti kaynağınızın account identifier ve account domain ve bir credentialgerekir.

Karma Gerçeklik hizmetleri birkaç farklı kimlik doğrulama türünü destekler:

  • Hesap Anahtarı kimlik doğrulaması
    • Hesap anahtarları, Karma Gerçeklik hizmetlerini kullanmaya hızlı bir şekilde başlamanızı sağlar. Ancak uygulamanızı üretim ortamına dağıtmadan önce uygulamanızı Azure AD kimlik doğrulamasını kullanacak şekilde güncelleştirmenizi öneririz.
  • Azure Active Directory (AD) belirteci kimlik doğrulaması
    • Kurumsal bir uygulama oluşturuyorsanız ve şirketiniz kimlik sistemi olarak Azure AD kullanıyorsa, uygulamanızda kullanıcı tabanlı Azure AD kimlik doğrulamasını kullanabilirsiniz. Ardından mevcut Azure AD güvenlik gruplarınızı kullanarak Karma Gerçeklik hesaplarınıza erişim izni verirsiniz. Ayrıca kuruluşunuzdaki kullanıcılara doğrudan erişim de vekleyebilirsiniz.
    • Aksi takdirde, uygulamanızı destekleyen bir web hizmetinden Azure AD belirteçleri edinmenizi öneririz. İstemci uygulamanızda Karma Gerçeklik hizmetine erişim için kimlik bilgilerini eklemekten kaçınmanıza olanak sağladığından üretim uygulamaları için bu yöntemi öneririz.

Hesap anahtarı kimlik doğrulamayı kullanma

Karma Gerçeklik hizmeti kaynağınıza göz atmak ve bir account keyalmak için azure portal kullanın.

Hesap anahtarınız olduktan sonra istemcinin kimliğini doğrulamak için AzureKeyCredential sınıfını aşağıdaki gibi kullanabilirsiniz:

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

Not: Hesap anahtarı kimlik doğrulaması üretim uygulamaları için önerilmez.

Azure Active Directory Kimlik Bilgilerini Kullanma

Hesap anahtarı kimlik doğrulaması örneklerin çoğunda kullanılır, ancak Azure Kimlik kitaplığınıkullanarak Azure Active Directory ile kimlik doğrulaması da yapabilirsiniz. Bu, üretim uygulamaları için önerilen yöntemdir. Aşağıda gösterilen DefaultAzureCredential sağlayıcısını veya Azure SDK ile sağlanan diğer kimlik bilgisi sağlayıcılarını kullanmak için lütfen @azure/identity paketini yükleyin:

npm install @azure/identity

Ayrıca [yeni bir AAD uygulaması kaydetmeniz][register_aad_app] ve Karma Gerçeklik hizmetiniz için uygun rolü hizmet sorumlunuza atayarak Karma Gerçeklik kaynağınıza erişim vermeniz gerekir.

AAD uygulamasının istemci kimliği, kiracı kimliği ve istemci gizli dizisi değerlerini ortam değişkenleri olarak ayarlayın: 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());

Temel kavramlar

MixedRealityStsClient

MixedRealityStsClient, erişim belirteci almak için Karma Gerçeklik STS'sine erişmek için kullanılan istemci kitaplığıdır.

Karma Gerçeklik STS'sinden alınan belirteçler 24 saatlik bir yaşam süresine sahiptir.

Dönüş Değeri

başarılı bir getToken çağrısının dönüş değeri, @azure/core-httpAccessToken olan bir GetTokenResponsedeğeridir.

Örnekler

Erişim belirteci alma

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

Daha karmaşık kimlik doğrulama senaryoları için bkz. Azure Identity .

Karma Gerçeklik istemci kitaplığında erişim belirtecini kullanma

Bazı Karma Gerçeklik istemci kitaplıkları, kimlik bilgileri yerine erişim belirteci kabul edebilir. Mesela:

// 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);

Not: Yukarıdaki SpatialAnchorsClient kullanımı varsayımsaldır ve gerçek kitaplığı yansıtmayabilir. Bunun desteklenip desteklenmediğini ve nasıl destekleneceğini belirlemek için kullandığınız istemci kitaplığının belgelerine bakın.

Sorun giderme

Günlük tutmak

Günlüğe kaydetmeyi etkinleştirmek, hatalarla ilgili yararlı bilgilerin ortaya çıkmasına yardımcı olabilir. HTTP isteklerinin ve yanıtlarının günlüğünü görmek için AZURE_LOG_LEVEL ortam değişkenini infoolarak ayarlayın. Alternatif olarak, @azure/loggersetLogLevel çağrılarak günlükler çalışma zamanında etkinleştirilebilir:

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

setLogLevel("info");

Günlükleri etkinleştirme hakkında daha ayrıntılı yönergeler için @azure/günlükçü paketi belgelerine bakabilirsiniz.

Sonraki adımlar

Bu kitaplığın nasıl kullanılacağına ilişkin ayrıntılı örnekler için lütfen örnekleri dizinine göz atın.

Katkıda

Bu proje katkıları ve önerileri memnuniyetle karşılar. Çoğu katkı, Katkıda Bulunan Lisans Sözleşmesi'ni (CLA) kabul ederek bize katkınızı kullanma hakları verme hakkına sahip olduğunuzu bildirmenizi gerektirir. Ayrıntılar için https://cla.microsoft.comadresini ziyaret edin.

Çekme isteği gönderdiğinizde, CLA botu otomatik olarak CLA sağlamanız gerekip gerekmediğini belirler ve çekme isteğini uygun şekilde süsler (örneğin, etiket, açıklama). Bot tarafından sağlanan yönergeleri izlemeniz yeterlidir. Cla'mızı kullanarak bunu tüm depolarda yalnızca bir kez yapmanız gerekir.

Bu proje, Microsoft Açık Kaynak Kullanım Kurallarıbenimsemiştir. Daha fazla bilgi için bkz. Davranış Kuralları SSS veya ek sorularınız veya yorumlarınızla opencode@microsoft.com iletişime geçin.

Bu kitaplığa katkıda bulunmak istiyorsanız kodu oluşturma ve test etme hakkında daha fazla bilgi edinmek için lütfen katkıda bulunma kılavuzu okuyun.

Gösterimler

  • Last updated on