Usando autenticação baseada em chave API com GeoAnalytics para Fabric

DerekGourley

A segurança e governança para usuários autorizados é importante na gestão do seu ambiente de análise. Para ajudar com isso, o ArcGIS GeoAnalytics para Fabric inclui a capacidade de criar (e excluir) chaves API para fornecer acesso a usuários em toda a sua organização. Isso permite que uma chave API seja usada no lugar de um nome de usuário e senha. Com as chaves API, uma única assinatura do GeoAnalytics para Fabric pode ser facilmente administrada para controlar o acesso dos usuários compartilhando, revogando e rotacionando as chaves API conforme necessário. Neste post do blog, vamos passar pelos passos necessários para criar e usar o método de autorização por chave API.<\/P>

Observe que, embora as chaves API ofereçam um nível de segurança e controle por si só, recomendamos proteger e acessar<\/A> essas credenciais usando Azure Key Vault<\/A> ou um mecanismo similar para armazenar e gerenciar segredos.<\/P>

Criando uma chave API<\/EM><\/STRONG><\/P>As chaves API do GeoAnalytics para Fabric são criadas usando o 

painel do GeoAnalytics para Fabric <\/A>associado à conta. Descreveremos os passos para criar uma chave API nesta seção.<\/P>

Nota:<\/STRONG> Recomendamos consultar suas equipes de segurança\/TI e seguir suas políticas e diretrizes sobre as melhores práticas para armazenamento e uso das chaves API para GeoAnalytics para Fabric.

<\/P>Selecione a aba 1Developer credentials7 e clique no bote3o 1New developer credentials7.<\/span> <\/P><\/LI>A janela pop-up "Create developer credentials" aparecerá. Nesta janela defina a data de expiração e depois clique no botão 1next7.
<\/span> <\/P><\/LI>Dê à chave API um título único (por exemplo, baseado no usuário ou grupo que será atribuído à chave API) e opcionalmente preencha as outras configurações, depois clique no botão 1next7.
<\/span><\/LI>Revise as configurações da chave API antes de gerar as credenciais e então clique no botão "next".<\/LI>Será fornecida uma opção para gerar a chave API agora ou depois. Selecione uma opção e clique no botão "next".<\/P>Nota:<\/STRONG> Uma vez que a chave API é gerada, ela deve ser copiada imediatamente para um local seguro, pois não é armazenada para acesso futuro. Seguir as 

melhores práticas de segurança da chave API<\/A> ajudará a manter a chave API segura.  

<\/P><\/span> <\/P><\/LI>Se a opção de gerar a chave API "now" foi selecionada, a chave API aparecerá em uma nova janela pop-up. Esta chave API é usada para autorizar o GeoAnalytics para Fabric. Conforme observado no passo 5 acima, seguir as melhores práticas de segurança<\/A> ajudará a manter a chave API segura.

<\/span><\/LI><\/OL>Autenticando o GeoAnalytics para Fabric usando a chave API<\/EM><\/STRONG><\/P>Para autorizar o GeoAnalytics para Fabric, primeiro importe o módulo 1geoanalytics_fabric7. Em seguida, use a chave API que foi gerada na etapa anterior ou use uma chave API existente, passando-a como um valor string para o parâmetro 1api_key7 da fune7e3o autorização<\/A> do GeoAnalytics para Fabric.

import geoanalytics_fabric
geoanalytics_fabric.auth(api_key="<API key goes here>")

 
Um sistema de gerenciamento de segredos também pode ser usado para ajudar a manter a chave API segura (visivelmente redigida) e pode ser usado para passar diretamente a string da chave API no parâmetro da chave API.

Para verificar se o GeoAnalytics para Fabric foi autorizado com sucesso, use 

geoanalytics_fabric.auth_info()

geoanalytics_fabric.auth_info().show()

Se a autorização for bem-sucedida, isso retornará uma tabela contendo as informações de autorização do GeoAnalytics para Fabric. Ao usar uma chave API, a linha "auth" terá o valor "token/apikey". Para fins de demonstração, os outros valores das linhas que normalmente seriam retornados na tabela foram deixados em branco.

Se a chave API for inválida ou desativada, a função de autorização do GeoAnalytics para Fabric retornará um erro "not authorized", e a tabela "auth_info" retornada estará vazia.

Para verificar ainda mais se o GeoAnalytics para Fabric está funcionando corretamente, você pode executar o código de exemplo abaixo.

# Imports
from geoanalytics_fabric.sql import functions as ST, Point

# Create a DataFrame
data = [
    (1, Point(2279074.576461232, 103019.15556246601)),
    (2, Point(2278748.209109826, 103521.65548041835)),
    (3, Point(2279243.741068326, 103250.88697086088))
]
df = spark.createDataFrame(data, [\id\, \point\]) \
          .withColumn(\point\, ST.srid(\point\, 6558))
df.printSchema()
df.show(truncate=False)

# Plot the DataFrame 
df_plot = df.st.plot(basemap=\light\, xmargin=0.15, ymargin=0.3, figsize=(10,10));
df_plot.set_title(\Oregon State University points of interest\)
df_plot.set_xlabel(\X (Meters)\)
df_plot.set_ylabel(\Y (Meters)\);

 
Conclusão

Neste post do blog vimos como o GeoAnalytics para Fabric pode ser autorizado usando o método da chave API. Esperamos que este post tenha sido útil para começar a usar este método de autorização em seus fluxos de trabalho analíticos. Se você tiver alguma dúvida sobre este método de autorização ou qualquer outra das ferramentas GeoAnalytics para Fabric
, funções SQL
, ou funções track
, sinta-se à vontade para fornecer feedback ou fazer perguntas na seção de comentários abaixo.