Alias - Get

Referência

Serviço:: Maps Creator

Versão da API:: 2.0

Use para obter detalhes de um alias.

A Get API é uma solicitação HTTP GET que permite que o chamador busque os detalhes de um alias existente.

Enviar Solicitação obter detalhes

Para obter os detalhes do alias, você emitirá uma GET solicitação com o aliasId no caminho.

Obter resposta de detalhes

A API Obter Detalhes retorna o alias criado anteriormente no json formato . A resposta contém os seguintes detalhes para o recurso de alias:

createdTimestamp – o carimbo de data/hora que o alias foi criado. aliasId – a ID do alias. creatorDataItemId – a ID do item de dados do criador que esse alias faz referência (pode ser nula se o alias não tiver sido atribuído). lastUpdatedTimestamp - A última vez que o alias foi atribuído a um recurso.

Veja abaixo um exemplo de resposta:

{
  "createdTimestamp": "2020-02-13T21:19:11.123Z",
  "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
  "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
  "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
}

GET https://{geography}.atlas.microsoft.com/aliases/{aliasId}?api-version=2.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
aliasId	path	True	string	A ID exclusiva que faz referência a um alias existente.
geography	path	True	string	Esse parâmetro especifica onde o recurso criador de Azure Mapas está localizado. Os valores válidos são nós e eu.
api-version	query	True	string	Número de versão da API de Mapas Azure.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	Alias	Obtenha a solicitação de alias concluída com êxito. O corpo da resposta contém o alias criado anteriormente.
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Get a previously created alias

Solicitação de exemplo

HTTP

GET https://us.atlas.microsoft.com/aliases/[aliasId]?api-version=2.0

Resposta de exemplo

Código de status:: 200

{
  "createdTimestamp": "2020-02-13T21:19:11+00:00",
  "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
  "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
  "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00"
}

Definições

Nome	Description
Alias	Informações detalhadas para o alias.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

Alias

Informações detalhadas para o alias.

Nome	Tipo	Description
aliasId	string	A ID do alias.
createdTimestamp	string	O carimbo de data/hora criado para o alias.
creatorDataItemId	string	A ID do item de dados do criador que esse alias faz referência (pode ser nula se o alias não tiver sido atribuído).
lastUpdatedTimestamp	string	O carimbo de data/hora da última vez em que o alias foi atribuído.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Compartilhar via