Bibliothèque de client Azure Mixed Reality pour Java - version 1.2.18

Article
10/21/2023

Mixed Reality services, tels qu’Azure Spatial Anchors, Azure Remote Rendering et d’autres, utilisent le service d’émission de jeton de sécurité Mixed Reality (STS) pour l’authentification. Ce package prend en charge l’échange d’informations d’identification de compte Mixed Reality contre un jeton d’accès à partir du sts qui peut être utilisé pour accéder aux services Mixed Reality.

| Code source Package (Maven) | Documentation de référence sur les | APIDocumentation produit

diagramme d’authentification du service Mixed Reality

Prise en main

Prérequis

Vous devez disposer d’un abonnement Azure.
Vous devez disposer d’un compte avec un service Azure Mixed Reality :
- Azure Remote Rendering
- Azure Spatial Anchors
Java Development Kit (JDK) version 8 ou ultérieure.
Apache Maven.
Connaissance des concepts d’authentification et d’informations d’identification d’Azure.Identity.

Inclure le package

Inclure le fichier de nomenclature

Incluez azure-sdk-bom dans votre projet pour dépendre de la version de disponibilité générale de la bibliothèque. Dans l’extrait de code suivant, remplacez l’espace réservé {bom_version_to_target} par le numéro de version. Pour en savoir plus sur la nomenclature, consultez le README BOM du KIT DE DÉVELOPPEMENT LOGICIEL AZURE.

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

puis incluez la dépendance directe dans la section dépendances sans la balise de version, comme indiqué ci-dessous.

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

Inclure une dépendance directe

Si vous souhaitez dépendre d’une version particulière de la bibliothèque qui n’est pas présente dans la nomenclature, ajoutez la dépendance directe à votre projet comme suit.

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

Authentifier le client

Mixed Reality services prennent en charge différentes formes d’authentification :

Authentification par clé de compte
- Les clés de compte vous permettent de commencer rapidement à utiliser Mixed Reality services. Mais avant de déployer votre application en production, nous vous recommandons de mettre à jour votre application pour utiliser l’authentification Azure AD.
Authentification par jeton Azure Active Directory (AD)
- Si vous créez une application d’entreprise et que votre entreprise utilise Azure AD comme système d’identité, vous pouvez utiliser l’authentification Azure AD basée sur l’utilisateur dans votre application. Vous accordez ensuite l’accès à vos comptes Mixed Reality à l’aide de vos groupes de sécurité Azure AD existants. Vous pouvez également accorder l’accès directement aux utilisateurs de votre organisation.
- Sinon, nous vous recommandons d’obtenir des jetons Azure AD à partir d’un service web prenant en charge votre application. Nous recommandons cette méthode pour les applications de production, car elle vous permet d’éviter d’incorporer les informations d’identification pour accéder à un service Mixed Reality dans votre application cliente.

Consultez ici pour obtenir des instructions et des informations détaillées.

Concepts clés

MixedRealityStsClient

MixedRealityStsClient est la bibliothèque cliente utilisée pour accéder au Mixed Reality STS afin d’obtenir un jeton d’accès.

Les jetons obtenus à partir de la Mixed Reality STS ont une durée de vie de 24 heures.

Exemples

Création du client

Pour un client synchrone :

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

Pour un client asynchrone (notez l’appel à buildAsyncClient au lieu de buildClient) :

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

Récupérer un jeton d’accès

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

AccessToken token = client.getToken();

Consultez les exemples d’authentification ci-dessus pour des scénarios d’authentification plus complexes.

Utilisation du jeton d’accès dans une bibliothèque de client Mixed Reality

Certaines bibliothèques clientes Mixed Reality peuvent accepter un jeton d’accès à la place d’informations d’identification. Par exemple :

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

Remarque : L’utilisation SpatialAnchorsClient ci-dessus est hypothétique et peut ne pas refléter la bibliothèque réelle. Consultez la documentation de la bibliothèque cliente que vous utilisez pour déterminer si et comment cela peut être pris en charge.

Dépannage

Décrivez les erreurs et les exceptions courantes, comment les « décompresser » si nécessaire, et incluez des conseils pour la gestion et la récupération normales.

Fournissez des informations pour aider les développeurs à éviter les limitations ou d’autres erreurs imposées par le service qu’ils peuvent rencontrer. Par exemple, fournissez des conseils et des exemples pour l’utilisation de stratégies de nouvelle tentative ou de connexion dans l’API.

Si le package ou un package associé le prend en charge, incluez des conseils pour la journalisation ou l’activation de l’instrumentation pour les aider à déboguer leur code.

Étapes suivantes

Bibliothèques clientes prenant en charge l’authentification avec l’authentification Mixed Reality

Les bibliothèques prenant en charge l’authentification Mixed Reality seront bientôt disponibles.

Contribution

Ce projet accepte les contributions et les suggestions. La plupart des contributions vous demandent d’accepter un contrat de licence de contribution (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez réellement, les droits d’utilisation de votre contribution. Pour plus d’informations, visitez https://cla.microsoft.com.

Quand vous envoyez une demande de tirage (pull request), un bot CLA détermine automatiquement si vous devez fournir un contrat CLA et agrémenter la demande de tirage de façon appropriée (par exemple, avec une étiquette ou un commentaire). Suivez simplement les instructions fournies par le bot. Vous ne devez effectuer cette opération qu’une seule fois sur tous les dépôts utilisant notre contrat CLA.

Ce projet a adopté le Code de conduite Open Source de Microsoft. Pour plus d’informations, consultez les Questions fréquentes (FAQ) sur le code de conduite ou envoyez vos questions ou vos commentaires à opencode@microsoft.com.

Impressions

Partager via