Data Registry - List

リファレンス

サービス:: Maps

API バージョン:: 2023-06-01

を使用して、Azure Maps アカウント内のすべてのデータレジストリの一覧を取得します。

List API は、Register API または Replace API を使用して以前に登録されたすべてのデータレジストリを含む配列を返す HTTP GET 要求です。

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

リスト要求の送信

すべてのデータレジストリを一覧表示するには、追加のパラメーターなしで要求を GET 発行します。

応答の一覧表示

要求は List 、応答の本文で形式で JSON データレジストリの配列を返します。

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

URI パラメーター

名前	/	必須	型	説明
geography	path	True	string	このパラメーターは、Azure Maps アカウントの場所を指定します。有効な値は、us (米国東部、米国中西部、米国西部 2) と eu (北ヨーロッパ、西ヨーロッパ) です。
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

名前	型	説明
200 OK	DataRegistryList	要求が `List` 正常に完了しました。応答本文には、データレジストリの配列が含まれています。
Other Status Codes	MapsErrorResponse	予期しないエラーが発生しました。ヘッダー x-ms-error-code: string

DataRegistryList

要求が List 正常に完了しました。応答本文には、データレジストリの配列が含まれています。

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

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

型: 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 にアクセスすることが許可されます。つまり、これらは現在、発行対象のアカウントのマスターキーとして扱うことができます。

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

型: apiKey
/: header

SAS Token

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

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

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

型: apiKey
/: header

例

List all previously registered data registries

Sample request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Sample response

Status code:: 200

{
  "value": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Contoso Indoor Design",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "zip",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path1.zip",
        "sizeInBytes": 29920,
        "contentMD5": "CsFxZ2YSfxw3cRPlqokV0w=="
      },
      "status": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "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/path2.geojson",
        "sizeInBytes": 1339
      },
      "status": "Running"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "description": "Contoso Geofence GeoJSON",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path3.geojson",
        "sizeInBytes": 1650,
        "contentMD5": "rYpEfIeLbWZPyaICGEGy3A=="
      },
      "status": "Failed",
      "error": {
        "code": "ContentMD5Mismatch",
        "message": "Actual content MD5: sOJMJvFParkSxBsvvrPOMQ== doesn't match expected content MD5: CsFxZ2YSfxw3cRPlqokV0w==."
      }
    }
  ]
}

定義

名前	説明
AzureBlob	Azure BLOB データレジストリの詳細。
DataFormat	検証のために使用されるアップロードされたコンテンツのデータ形式。
DataRegistry	Azure Maps のデータレジストリ。
DataRegistryKind	データレジストリの種類。
DataRegistryList	データレジストリリスト API の応答モデル。以前に登録されたすべてのデータの一覧を返します。
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