Geolocation - Get IP To Location

特定の IP アドレスの ISO 国/地域コードを取得するために使用します。
Get IP To Location API は、特定の IP アドレスの ISO 国/地域コードを返す HTTP GET 要求です。 開発者はこの情報を使用して、アプリケーションへのアクセス元の地理的な場所に基づいてコンテンツをブロックまたは変更できます。

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

URI パラメーター

名前 / 必須 説明
endpoint
path True

string (uri)

Azure Mapsサービスのホストネーム。 Azureパブリッククラウドにはhttps://atlas.microsoft.comを使いましょう。 特定のAzure Maps地理やソブリンクラウドをターゲットにする場合は、Azure Maps地理的範囲を参照してください。

format
path True

JsonFormat

応答の目的の形式。 json 形式のみがサポートされています。

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

ip
query True

string

IP アドレスです。 IPv4 と IPv6 の両方が許可されます。

要求ヘッダー

名前 必須 説明
x-ms-client-id

string

Microsoft Entra IDセキュリティモデルで使用されることを意図したアカウントを示します。 このAzure Mapsアカウントの一意IDは、Azure Maps管理プレーンのアカウントAPIから取得できます。 Azure MapsにおけるMicrosoft Entra IDセキュリティの使用についての詳細は、Azure Mapsの認証管理Manage certificationをご覧ください。

応答

名前 説明
200 OK

IpAddressToLocationResult

要求は成功しました。

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

AadToken

これらはMicrosoft Entra OAuth 2.0フローです。 Azureロールベースアクセス制御と組み合わせることで、Azure Maps REST APIへのアクセス制御に利用できます。 Azure ロールベースのアクセス制御は、1つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。

シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。

Note

  • このセキュリティ定義 使用して、アプリケーションがアクセスを要求している Azure Maps リソースを示す必要があります。 これは、Maps 管理 APIから取得できます。
  • Authorization URL は、Azure パブリック クラウド インスタンスに固有です。 ソブリンクラウドは固有の認可URLとMicrosoft Entra IDの設定を持っています。
  • Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンから構成されます。
  • Azure Maps Web SDK を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。
  • Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
https://atlas.microsoft.com/.default

subscription-key

これは、Azure portal で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウント を作成 場合にプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。

パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアント アプリケーション アプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。

型: apiKey
/: header

SAS Token

これは、Azure MapsリソースのList SAS操作からAzureポータル、PowerShell、CLI、Azure SDK、REST APIを通じてAzure管理プレーンを経由して作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションは、Azure ロールベースのアクセス制御と、特定のトークンに対する使用の有効期限、レート、およびリージョンに対するきめ細かな制御を使用してアクセスすることが承認されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

パブリックに公開されているアプリケーションの場合は、Map アカウント リソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するように することをお勧めします。

型: apiKey
/: header

Successfully retrieve country/region code from IP address

要求のサンプル

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

応答のサンプル

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

定義

名前 説明
CountryRegion

国/地域情報を含むオブジェクト。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

IpAddressToLocationResult

このオブジェクトは、国/リージョン API への IP アドレスの正常な呼び出しから返されます

JsonFormat

応答の目的の形式。 json 形式のみがサポートされています。

CountryRegion

国/地域情報を含むオブジェクト。

名前 説明
isoCode

string

IP アドレスの 2 文字の国または地域コード (ISO 3166-1)。 特別な目的のために予約された範囲内の IP アドレスは、国/地域に対して Null を返すことに注意してください。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

名前 説明
error

ErrorDetail

エラー オブジェクト。

IpAddressToLocationResult

このオブジェクトは、国/リージョン API への IP アドレスの正常な呼び出しから返されます

名前 説明
countryRegion

CountryRegion

国/地域情報を含むオブジェクト。

ipAddress

string

要求の IP アドレス。

JsonFormat

応答の目的の形式。 json 形式のみがサポートされています。

説明
json

JavaScript オブジェクト表記データ交換形式 する