次の方法で共有


Data Registry - Register Or Replace

Azure Maps アカウントに Azure Storage アカウントに格納されているデータを登録するには、 を使用します。

Register API は、Azure Maps アカウントに Azure Storage アカウントにデータを登録するために使用される HTTP PUT 要求です。 登録できる最大ファイル サイズは 1 ギガバイトです。

これは、Azure Maps Geofencing Service で使用する形式でGeoJSONジオフェンスのコレクションを登録したり、一連の DWG デザイン ファイルを Azure Maps Creator Conversion Service で使用するための zip 形式の描画パッケージとして登録したりするシナリオで役立ちます。

データ レジストリ サービス エンドポイントは、Azure Maps アカウントのリージョンのスコープに制限されており、グローバル Azure Maps アカウントでは使用できません。

登録要求または置換要求を送信する

Register要求と Replace 要求はどちらも、データ レジストリの詳細を定義する要求の本文に AzureBlob JSON オブジェクトを含む実行時間の長い操作です。

PUT https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01

URI パラメーター

名前 / 必須 説明
geography
path True

string

このパラメーターは、Azure Maps アカウントの場所を指定します。 有効な値は、us (米国東部、米国中西部、米国西部 2) と eu (北ヨーロッパ、西ヨーロッパ) です。

udid
path True

string

データ レジストリのユーザー データ ID。

正規表現パターン: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

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 セキュリティを使用するには、ガイダンスについては、次 の記事を 参照してください。

Operation-Id

string

GUID 形式の操作 ID。

正規表現パターン: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

要求本文

名前 説明
azureBlob

AzureBlob

Azure BLOB データ レジストリの詳細。

description

string

データ レジストリに指定された説明。 最大長は 1024 文字です。

kind

DataRegistryKind

データ レジストリの種類。

応答

名前 説明
200 OK

DataRegistry

リソースの置き換え: 要求は処理のために受け入れ済みです。

ヘッダー

  • Operation-Id: string
  • Operation-Location: string
201 Created

DataRegistry

リソースの作成: 要求は処理のために受け入れ済みです。

ヘッダー

  • Operation-Id: string
  • Operation-Location: string
Other Status Codes

MapsErrorResponse

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

ヘッダー

x-ms-error-code: string

セキュリティ

AADToken

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

シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の 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 を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。

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

スコープ

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

subscription-key

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを介して Azure Maps リソース を作成するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスする権限が与えられている。 つまり、これらは現在、発行対象のアカウントのマスター キーとして扱うことができます。

公開されているアプリケーションの場合、このキーを安全に格納できる Azure Maps REST API のサーバー間アクセスを使用することをお勧めします。

型: apiKey
/: header

SAS Token

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

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

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

型: apiKey
/: header

Register or replace a udid

要求のサンプル

PUT https://us.atlas.microsoft.com/dataRegistries/29a92cab-74af-49e7-a326-66898220aa9d?api-version=2023-06-01

{
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json"
  }
}

応答のサンプル

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2
{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}
Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2
{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}

定義

名前 説明
AzureBlob

Azure BLOB データ レジストリの詳細。

DataFormat

検証目的で使用されるアップロードされたコンテンツのデータ形式。

DataRegistry

Azure Maps のデータ レジストリ。

DataRegistryKind

データ レジストリの種類。

LongRunningOperationStatus

実行時間の長い操作の状態。

MapsErrorDetail

エラーの詳細。

MapsErrorResponse

失敗した操作のエラーの詳細を返す Azure Maps API の一般的なエラー応答。

MapsInnerError

エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。

AzureBlob

Azure BLOB データ レジストリの詳細。

名前 説明
blobUrl

string

BLOB URL には、登録されているファイルへのパスが含まれています。

contentMD5

string

データ検証に使用されるコンテンツのコンテンツ MD5。

dataFormat

DataFormat

検証目的で使用されるアップロードされたコンテンツのデータ形式。

linkedResource

string

Azure Maps アカウント内のデータストアの ID。

msiClientId

string

ユーザー割り当てマネージド ID のクライアント ID。 指定されていない場合は、システム割り当てマネージド ID を使用します。

sizeInBytes

integer

内容のサイズ (バイト単位)。

DataFormat

検証目的で使用されるアップロードされたコンテンツのデータ形式。

名前 説明
geojson

string

GeoJSON は、JSON ベースの地理空間データ交換形式です。

zip

string

圧縮データ形式。

DataRegistry

Azure Maps のデータ レジストリ。

名前 説明
azureBlob

AzureBlob

Azure BLOB データ レジストリの詳細。

description

string

データ レジストリに指定された説明。 最大長は 1024 文字です。

error

MapsErrorDetail

エラーの詳細。

kind

DataRegistryKind

データ レジストリの種類。

status

LongRunningOperationStatus

実行時間の長い操作の状態。

udid

string

データ レジストリのユーザー データ ID。

DataRegistryKind

データ レジストリの種類。

名前 説明
AzureBlob

string

Azure BLOB

LongRunningOperationStatus

実行時間の長い操作の状態。

名前 説明
Completed

string

要求は正常に完了しました。

Failed

string

要求に 1 つ以上のエラーがあります。

Running

string

要求は現在処理中です。

MapsErrorDetail

エラーの詳細。

名前 説明
code

string

サーバー定義のエラー コードのセットの 1 つ。

details

MapsErrorDetail[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。

innererror

MapsInnerError

エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。

message

string

エラーの人間が判読できる表現。

target

string

エラーのターゲット。

MapsErrorResponse

失敗した操作のエラーの詳細を返す Azure Maps API の一般的なエラー応答。

名前 説明
error

MapsErrorDetail

エラーの詳細。

MapsInnerError

エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。

名前 説明
code

string

エラー コード。

innererror

MapsInnerError

エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。