Data Registry - Register Or Replace

リファレンス

Service:: Maps

API Version:: 2023-06-01

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

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

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

データレジストリサービスエンドポイントは、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。 Regex pattern: `^[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 のバージョン番号。

geography

path

True

string

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

udid

path

True

string

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

Regex pattern: ^[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

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、次の記事を参照してください。
Operation-Id		string	GUID 形式の操作 ID。 Regex pattern: `^[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}$`

string

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

Operation-Id

string

GUID 形式の操作 ID。

Regex pattern: ^[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	リソースの置き換え: 要求は処理のために受け入れ済みです。 Headers Operation-Id: string Operation-Location: string
201 Created	DataRegistry	リソースの作成: 要求は処理のために受け入れ済みです。 Headers Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	予期しないエラーが発生しました。 Headers x-ms-error-code: string

名前

型

説明

200 OK

DataRegistry

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

Headers

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

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

Headers

Operation-Id: string
Operation-Location: string

Other Status Codes

MapsErrorResponse

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

Headers

x-ms-error-code: string

セキュリティ

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 を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

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

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

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

Type: apiKey
In: header

SAS Token

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

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

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

Type: apiKey
In: header

例

Register or replace a udid

Sample Request

HTTP

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"
  }
}

Sample Response

Status code:: 201

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

Response Body

{
  "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"
}

Status code:: 200

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

Response Body

{
  "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	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

Share via

Data Registry - Register Or Replace

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

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

AADToken

メモ

Scopes

subscription-key

SAS Token

例

Register or replace a udid

Sample Request

Sample Response

定義

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

その他のリソース