Share via

Data - Download

  • リファレンス
Service:
Maps
API Version:
2.0

を使用して、データアップロードを使用して以前にアップロードしたデータをダウンロード します。

注意

Azure Maps Data Service の廃止

Azure Maps Data Service (v1 と v2 の両方) は非推奨となり、2024 年 9 月 16 日に廃止されます。 サービスの中断を回避するには、データ サービスに対するすべての呼び出しを更新して、Azure Maps Data Registry サービスを 9/16/24 までに使用する必要があります。 詳細については、「データ レジストリの作成方法」を参照してください。

Data Download API は と HTTP GET 要求であり、呼び出し元は以前にアップロードしたデータ コンテンツをダウンロードできます。

この API は、data Upload API を使用して以前にアップロードしたジオフェンスの既存のコレクションをダウンロードして、Azure Maps Geofencing Service で使用するシナリオで使用できます。

重要

この機能を使用すると、プレビューの法的条件に同意したことになります。 詳細については、「 プレビュー補足条項 」を参照してください。

ダウンロード要求を送信する

コンテンツをダウンロードするには、ダウンロードする GET データの がパスに含まれる udid 要求を使用します。 必要に応じて、ヘッダーを Accept 渡して、データ応答の の Content-Type 基本設定を指定することもできます。

たとえば、Upload API を使用して以前にアップロードしたジオフェンスのコレクションをダウンロードするには、アップロード API 応答で前にudid受信したデータの パスの パラメーターを設定udidし、ヘッダーを次のいずれかのメディアの種類に設定Acceptします。

  • application/json
  • application/vnd.geo+json
  • application/octet-stream

データ応答のダウンロード

渡されたudidデータ リソースが見つかった場合、Download API は HTTP 200 OK 応答を返します。ここで、応答本文にはデータ リソースの内容が含まれます。

渡されたudidデータ リソースが見つからない場合は、HTTP 400 Bad Request エラー応答が返されます。

アップロード API を使用して以前にアップロードされた で GeoJSON 表される単純なジオフェンスの応答本文の例を次に示します。

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

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

URI パラメーター

名前 / 必須 型 説明
geography
 path True

string

このパラメーターは、Azure Maps Creator リソースの場所を指定します。 有効な値は、us と eu です。
udid
 path True

string

コンテンツの一意のデータ ID。 は udid 、正常な データ アップロード 呼び出しから取得されている必要があります。
api-version
 query True

string

Azure Maps API のバージョン番号。

要求ヘッダー

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

string

Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、次の記事を参照してください。

応答

名前 型 説明
200 OK

file

データのダウンロード要求が正常に完了しました。 応答本文には、 で udid渡された のコンテンツが含まれます。

Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

Headers

Content-Type: string
Other Status Codes

ErrorResponse

予期しないエラーが発生しました。

Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

セキュリティ

AADToken

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

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

メモ

  • このセキュリティ定義では、 ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソース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 を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

例

Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences

Sample Request

GET https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0

Sample Response

Status code:
200 
"{file}"

定義

名前 説明
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答

ErrorAdditionalInfo

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細です。
message

string

エラー メッセージ。
target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 型 説明
error

ErrorDetail

error オブジェクト。