Geolocation - Get IP To Location

Use para obter o código ISO de país/região para um determinado endereço IP.
A Get IP To Location API é uma solicitação HTTP GET que retorna o código ISO de país/região para um determinado endereço IP. Os desenvolvedores podem usar essas informações para bloquear ou modificar o conteúdo com base na localização geográfica da qual o aplicativo é acessado.

GET {endpoint}/geolocation/ip/json?api-version=1.0&ip={ip}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string (uri)

O nome de host do serviço Azure Mapas. Use https://atlas.microsoft.com para a Azure nuvem pública. Para direcionar uma geografia Azure Mapas específica ou uma nuvem soberana, veja Azure Mapas escopo geográfico.

format
path True

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

ip
query True

string

O endereço IP. IPv4 e IPv6 são permitidos.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-id

string

Indica a conta destinada a ser usada com o modelo de segurança do Microsoft Entra ID. Esse ID único para a conta Azure Mapas pode ser obtido a partir da API de Conta Azure Mapas plano de gerenciamento. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Mapas, veja Gerencie autenticação em Azure Mapas.

Respostas

Nome Tipo Description
200 OK

IpAddressToLocationResult

A solicitação foi bem-sucedida.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

AadToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com o controle de acesso baseado em funções Azure , pode ser usado para controlar o acesso às APIs REST Azure Mapas. Controles de acesso baseados em função do Azure são usados para designar acesso a uma ou mais contas ou subrecursos de recursos do Azure Mapas. 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 APIs REST do Azure Mapas.

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 controlar o acesso em APIs e escopos específicos.

Note

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.
  • O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas.
  • O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
  • O uso do SDK da Web do do 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 a plataforma de identidade da Microsoft, consulte visão geral da 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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do 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 mestra na conta em que elas são emitidas.

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

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação List SAS no recurso Azure Mapas através do plano de gerenciamento Azure via portal 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 para expiração, taxa e região(s) 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 forma mais protegida do que a chave compartilhada.

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

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve country/region code from IP address

Solicitação de exemplo

GET https://atlas.microsoft.com/geolocation/ip/json?api-version=1.0&ip=2001:4898:80e8:b::189

Resposta de exemplo

{
  "countryRegion": {
    "isoCode": "US"
  },
  "ipAddress": "2001:4898:80e8:b::189"
}

Definições

Nome Description
CountryRegion

O objeto que contém as informações de país/região.

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

IpAddressToLocationResult

Esse objeto é retornado de uma chamada bem-sucedida para o Endereço IP para a API de país/região

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

CountryRegion

O objeto que contém as informações de país/região.

Nome Tipo Description
isoCode

string

O código de país ou região de 2 caracteres do endereço IP (ISO 3166-1). Observe que os endereços IP em intervalos reservados para fins especiais retornarão Null para país/região.

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 comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

IpAddressToLocationResult

Esse objeto é retornado de uma chamada bem-sucedida para o Endereço IP para a API de país/região

Nome Tipo Description
countryRegion

CountryRegion

O objeto que contém as informações de país/região.

ipAddress

string

O endereço IP da solicitação.

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

Valor Description
json

o formato de intercâmbio de dados de notação de objeto JavaScript