Azure Mixed Reality-Clientbibliothek für Java– Version 1.2.18

Artikel
10/25/2023

Mixed Reality Dienste wie Azure Spatial Anchors, Azure Remote Rendering und andere verwenden den Mixed Reality Sicherheitstokendienst (STS) für die Authentifizierung. Dieses Paket unterstützt den Austausch Mixed Reality Kontoanmeldeinformationen gegen ein Zugriffstoken vom STS, das für den Zugriff auf Mixed Reality Dienste verwendet werden kann.

Quellcode | Paket (Maven) | API-Referenzdokumentation | Produktdokumentation

Mixed Reality-Dienstauthentifizierungsdiagramm

Erste Schritte

Voraussetzungen

Sie benötigen ein Azure-Abonnement.
Sie benötigen ein Konto bei einem Azure Mixed Reality-Dienst:
- Azure Remote Rendering
- Azure Spatial Anchors
Java Development Kit (JDK), Version 8 oder höher.
Apache Maven.
Vertrautheit mit den Authentifizierungs- und Anmeldeinformationskonzepten von Azure.Identity.

Einschließen des Pakets

BOM-Datei einfügen

Fügen Sie azure-sdk-bom in Ihr Projekt ein, um von der Allgemeinverfügbarkeitsversion der Bibliothek abhängig zu sein. Ersetzen Sie im folgenden Codeausschnitt den Platzhalter {bom_version_to_target} durch die Versionsnummer. Weitere Informationen zur BOM finden Sie in der INFODATEI FÜR AZURE SDK-STÜCKLISTEN.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.azure</groupId>
            <artifactId>azure-sdk-bom</artifactId>
            <version>{bom_version_to_target}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

und fügen Sie dann die direkte Abhängigkeit wie unten dargestellt ohne das Versionstag in den Abschnitt abhängigkeiten ein.

<dependencies>
    <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-mixedreality-authentication</artifactId>
    </dependency>
</dependencies>

Direkte Abhängigkeiten einfügen

Wenn Sie eine Abhängigkeit von einer bestimmten Version der Bibliothek annehmen möchten, die nicht in der BoM vorhanden ist, fügen Sie die direkte Abhängigkeit wie folgt zu Ihrem Projekt hinzu.

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-mixedreality-authentication</artifactId>
    <version>1.2.18</version>
</dependency>

Authentifizieren des Clients

Mixed Reality-Dienste unterstützen einige verschiedene Arten der Authentifizierung:

Kontoschlüsselauthentifizierung
- Mit Kontoschlüsseln können Sie schnell mit der Verwendung Mixed Reality-Dienste beginnen. Aber bevor Sie Ihre Anwendung in der Produktionsumgebung bereitstellen, empfiehlt es sich, dass Sie Ihre App für die Verwendung von Azure AD-Authentifizierung aktualisieren.
Azure Active Directory-Tokenauthentifizierung (AD)
- Wenn Sie eine Unternehmensanwendung entwickeln und Ihr Unternehmen Azure AD als Identitätssystem verwendet, können Sie die benutzerbasierte Azure AD-Authentifizierung in Ihrer App verwenden. Anschließend gewähren Sie Mithilfe Ihrer vorhandenen Azure AD-Sicherheitsgruppen Zugriff auf Ihre Mixed Reality-Konten. Sie können Benutzern in Ihrer Organisation Zugriff auch direkt gewähren.
- Andernfalls empfiehlt es sich, Azure AD-Token von einem Webdienst abzurufen, der Ihre App unterstützt. Wir empfehlen diese Methode für Produktionsanwendungen, da Sie die Einbettung der Anmeldeinformationen für den Zugriff auf einen Mixed Reality-Dienst in Ihrer Clientanwendung vermeiden können.

Ausführliche Anweisungen und Informationen finden Sie hier .

Wichtige Begriffe

MixedRealityStsClient

ist MixedRealityStsClient die Clientbibliothek, die verwendet wird, um auf die Mixed Reality STS zuzugreifen, um ein Zugriffstoken abzurufen.

Token, die vom Mixed Reality STS abgerufen werden, haben eine Lebensdauer von 24 Stunden.

Beispiele

Erstellen des Clients

Für einen synchronen Client:

AzureKeyCredential keyCredential = new AzureKeyCredential(accountKey);
MixedRealityStsClient client = new MixedRealityStsClientBuilder()
    .accountDomain(accountDomain)
    .accountId(accountId)
    .credential(keyCredential)
    .buildClient();

Für einen asynchronen Client (beachten Sie den Aufruf buildAsyncClient von anstelle von buildClient):

AzureKeyCredential keyCredential = new AzureKeyCredential(accountKey);
MixedRealityStsAsyncClient client = new MixedRealityStsClientBuilder()
    .accountDomain(accountDomain)
    .accountId(accountId)
    .credential(keyCredential)
    .buildAsyncClient();

Abrufen eines Zugriffstokens

AzureKeyCredential keyCredential = new AzureKeyCredential(accountKey);
MixedRealityStsClient client = new MixedRealityStsClientBuilder()
    .accountDomain(accountDomain)
    .accountId(accountId)
    .credential(keyCredential)
    .buildClient();

AccessToken token = client.getToken();

In den obigen Authentifizierungsbeispielen finden Sie komplexere Authentifizierungsszenarien.

Verwenden des Zugriffstokens in einer Mixed Reality Clientbibliothek

Einige Mixed Reality Clientbibliotheken akzeptieren möglicherweise ein Zugriffstoken anstelle von Anmeldeinformationen. Beispiel:

// 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.
AccessToken accessToken = getMixedRealityAccessTokenFromWebService();

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

Hinweis: Die SpatialAnchorsClient obige Verwendung ist hypothetisch und spiegelt möglicherweise nicht die tatsächliche Bibliothek wider. Lesen Sie die Dokumentation für die Clientbibliothek, die Sie verwenden, um zu ermitteln, ob und wie dies unterstützt werden kann.

Problembehandlung

Beschreiben Sie häufige Fehler und Ausnahmen, wie sie bei Bedarf "entpackt" werden, und enthalten Sie Anleitungen für eine ordnungsgemäße Behandlung und Wiederherstellung.

Stellen Sie Informationen bereit, um Entwicklern zu helfen, Drosselung oder andere vom Dienst erzwungene Fehler zu vermeiden, die auftreten können. Stellen Sie beispielsweise Anleitungen und Beispiele für die Verwendung von Wiederholungs- oder Verbindungsrichtlinien in der API bereit.

Wenn das Paket oder ein zugehöriges Paket dies unterstützt, fügen Sie Tipps zum Protokollieren oder Aktivieren der Instrumentierung hinzu, um den Benutzer beim Debuggen des Codes zu unterstützen.

Nächste Schritte

Clientbibliotheken, die die Authentifizierung mit Mixed Reality-Authentifizierung unterstützen

Bibliotheken, die die Mixed Reality-Authentifizierung unterstützen, sind in Kürze verfügbar.

Mitwirken

Beiträge und Vorschläge für dieses Projekt sind willkommen. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. Ausführliche Informationen finden Sie unter https://cla.microsoft.com.

Wenn Sie einen Pull Request (PR) übermitteln, überprüft ein CLA-Bot automatisch, ob Sie eine Lizenzvereinbarung bereitstellen und den PR entsprechend ergänzen müssen (z.B. mit einer Bezeichnung oder einem Kommentar). Führen Sie einfach die Anweisungen des Bots aus. Sie müssen dies nur einmal für alle Repositorys ausführen, die unsere CLA verwenden.

Für dieses Projekt gelten die Microsoft-Verhaltensregeln für Open Source (Microsoft Open Source Code of Conduct). Weitere Informationen finden Sie in den häufig gestellten Fragen zum Verhaltenskodex. Sie können sich auch an opencode@microsoft.com wenden, wenn Sie weitere Fragen oder Anmerkungen haben.

Aufrufe

Freigeben über