Biblioteca cliente pacote de autenticação Azure Mixed Reality para Python - versão 1.0.0b1

Mixed Reality serviços, como âncoras espaciais Azure, Azure Remote Rendering, entre outros, utilizam o serviço de símbolos de segurança Mixed Reality (STS) para autenticação. Este pacote suporta a troca de credenciais de conta Mixed Reality para um token de acesso a partir do STS que pode ser usado para aceder a serviços Mixed Reality.

Introdução

Ambientes atualmente apoiados

Este pacote foi testado com Python 2.7, 3.5, 3.6, 3.7, 3.8 e 3.9.

Pré-requisitos

• Uma subscrição do Azure.
• Deve ter uma conta com um serviço Azure Mixed Reality:
  • Azure Remote Rendering
  • Azure Spatial Anchors
• Familiaridade com os conceitos de autenticação e credenciais da biblioteca de Identidade Azure.
• Python 2.7, ou 3.5 ou mais tarde é obrigado a usar este pacote.

Instale o pacote

Instale o Azure Mixed Reality Autenticação SDK.

pip install --pre azure-mixedreality-authentication

Criar e autenticar um MixedRealityStsClient

Para criar um objeto de cliente para solicitar um token de acesso para um serviço de Mixed Reality, você precisará do account identifier e account domain do seu Mixed Reality recurso de serviço e um credential.

Mixed Reality serviços suportam algumas formas diferentes de autenticação:

• Autenticação da Chave de Conta
  • As chaves da conta permitem-lhe começar rapidamente com a utilização de Mixed Reality serviços. Mas antes de implementar a sua aplicação para a produção, recomendamos que atualize a sua app para utilizar Azure AD autenticação.
• Autenticação simbólica Azure Ative Directory (AD)
  • Se estiver a construir uma aplicação empresarial e a sua empresa estiver a utilizar Azure AD como seu sistema de identidade, pode utilizar a autenticação Azure AD baseada no utilizador na sua aplicação. Em seguida, concede acesso às suas contas Mixed Reality utilizando os seus grupos de segurança Azure AD existentes. Também pode conceder acesso diretamente aos utilizadores da sua organização.
  • Caso contrário, recomendamos que obtenha Azure AD fichas de um serviço web que suporte a sua aplicação. Recomendamos este método para aplicações de produção porque permite evitar incorporar as credenciais de acesso a um serviço Mixed Reality na sua aplicação ao cliente.

Consulte aqui instruções e informações detalhadas.

Utilização da autenticação da chave de conta

Utilize o Portal Azure para navegar no seu Mixed Reality recurso de serviço e recuperar um account key.

Uma vez que tenha uma chave de conta, pode usar a AzureKeyCredential classe para autenticar o cliente da seguinte forma:

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)

Nota: A autenticação da chave da conta não é recomendada para aplicações de produção.

Usando um Azure Ative Directory Credential

A autenticação da chave de conta é utilizada na maioria dos exemplos, mas também pode autenticar com o Azure Ative Directory utilizando a biblioteca Azure Identity. Este é o método recomendado para aplicações de produção. Para utilizar o fornecedor DefaultAzureCredential apresentado abaixo, ou outros fornecedores de credenciais fornecidos com o Azure SDK, por favor instale o @azure/identity pacote:

Também terá de registar uma nova aplicação AAD e conceder acesso ao seu recurso Mixed Reality, atribuindo o papel adequado para o seu serviço de Mixed Reality ao seu principal de serviço.

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)

Conceitos-chave

MixedRealityStsClient

A MixedRealityStsClient biblioteca de clientes usada para aceder ao Mixed Reality STS para obter um token de acesso. Um sinal de acesso pode ser recuperado chamando get_token() um MixedRealityStsClient caso.

Os tokens obtidos do Mixed Reality STS têm uma vida útil de 24 horas.

Valor do resultado token

O valor de retorno para uma chamada get_token bem sucedida é um azure.core.credentials.AccessToken.

Consulte os exemplos de autenticação acima ou Azure Identity para cenários de autenticação mais complexos.

Recupere um token de acesso sincronizado

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

Recupere um símbolo de acesso assíncronosamente

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

Exemplos

Estas são amostras de código que mostram operações de cenário comum com a biblioteca de clientes Azure Mixed Reality Authentication. As versões assíncas das amostras (os ficheiros de amostra de python anexados com _async) mostram operações assíncronos, e requerem Python 3.5 ou mais tarde. Antes de executar o código de amostra, consulte os Pré-Requisitos

para criar um recurso, em seguida, definir algumas variáveis ambientais

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

Resolução de problemas

A secção de resolução de problemas para a identidade Azure pode ser útil quando se solucionam problemas de autenticação.

Passos seguintes

Mixed Reality bibliotecas de clientes

• Em breve

Contribuir

Agradecemos todas as contribuições e sugestões para este projeto. A maioria das contribuições requerem que celebre um Contrato de Licença de Contribuição (CLA) no qual se declare que tem o direito de conceder e que, na verdade, concede-nos os direitos para utilizar a sua contribuição. Para mais detalhes, visite https://cla.microsoft.com.

Quando submete um pedido Pull, um bot do CLA determina automaticamente se tem de fornecer um CLA e decorar o PR de forma adequada (por exemplo, etiqueta, comentário). Só tem de seguir as instruções fornecidas pelo bot. Apenas terá de fazer isto uma vez em todos os repositórios com o nosso CLA.

Este projeto adotou o Microsoft Open Source Code of Conduct (Código de Conduta do Microsoft Open Source). Para mais informações consulte o Código de Conduta FAQ ou contacte opencode@microsoft.com com quaisquer perguntas ou comentários adicionais.

Se quiser contribuir para esta biblioteca, leia o guia que contribui para saber mais sobre como construir e testar o código.