Data Registry - List

참조

Service:: Maps

API Version:: 2023-06-01

를 사용하여 Azure Maps 계정의 모든 데이터 레지스트리 목록을 가져옵니다.

List API는 Register 또는 Replace API를 사용하여 이전에 등록된 모든 데이터 레지스트리가 포함된 배열을 반환하는 HTTP GET 요청입니다.

데이터 레지스트리 서비스 엔드포인트는 scope Azure Maps 계정의 지역으로 제한되며 전역 Azure Maps 계정에는 사용할 수 없습니다.

목록 요청 제출

모든 데이터 레지스트리를 나열하려면 추가 매개 변수 없이 요청을 실행 GET 합니다.

응답 나열

요청은 List 응답 본문의 형식으로 JSON 데이터 레지스트리의 배열을 반환합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
geography	path	True	string	이 매개 변수는 Azure Maps 계정이 있는 위치를 지정합니다. 유효한 값은 당사(미국 동부, 미국 중서부, 미국 서부 2) 및 eu(북유럽, 서유럽)입니다.
api-version	query	True	string	Azure Maps API의 버전 번호입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-id		string	Microsoft Entra ID 보안 모델과 함께 사용할 계정을 지정합니다. Azure Maps 계정에 대한 고유 ID를 나타내며 Azure Maps 관리 평면 계정 API에서 검색할 수 있습니다. Azure Maps Microsoft Entra ID 보안을 사용하려면 다음 문서를 참조하세요.

응답

Name 형식 Description

200 OK

Name	형식	Description
200 OK	DataRegistryList	요청이 `List` 성공적으로 완료되었습니다. 응답 본문에는 데이터 레지스트리의 배열이 포함되어 있습니다.
Other Status Codes	MapsErrorResponse	예기치 않은 오류가 발생했습니다. Headers x-ms-error-code: string

DataRegistryList

요청이 List 성공적으로 완료되었습니다. 응답 본문에는 데이터 레지스트리의 배열이 포함되어 있습니다.

Other Status Codes

MapsErrorResponse

예기치 않은 오류가 발생했습니다.

Headers

x-ms-error-code: string

보안

AADToken

Microsoft Entra OAuth 2.0 흐름입니다. Azure 역할 기반 액세스 제어와 쌍을 이루는 경우 Azure Maps REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 기본 제공 역할 또는 REST API를 Azure Maps 하나 이상의 권한으로 구성된 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.

시나리오를 구현하려면 인증 개념을 보는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 API 및 범위에 대한 액세스 제어가 가능한 개체를 통해 애플리케이션을 모델링하기 위한 솔루션을 제공합니다.

참고

이 보안 정의에서는 헤더를 사용하여 애플리케이션이 x-ms-client-id 액세스를 요청하는 Azure Maps 리소스를 나타내야 합니다. 이는 Maps 관리 API에서 가져올 수 있습니다.

Authorization URL 은 Azure 퍼블릭 클라우드 instance 관련됩니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Microsoft Entra ID 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다. * Azure Maps 웹 SDK를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 허용합니다.

Microsoft ID 플랫폼 대한 자세한 내용은 Microsoft ID 플랫폼 개요를 참조하세요.

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

Scopes

Name	Description
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에 액세스할 수 있는 권한이 부여됩니다. 즉, 현재 발급된 계정에 대한 master 키로 처리할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 이 키를 안전하게 저장할 수 있는 Azure Maps REST API의 서버-서버 액세스를 사용하는 것이 좋습니다.

Type: apiKey
In: header

SAS Token

공유 액세스 서명 토큰은 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스의 SAS 나열 작업에서 만들어집니다.

이 토큰을 사용하면 모든 애플리케이션이 Azure 역할 기반 액세스 제어 및 특정 토큰에 사용할 만료, 속도 및 지역에 대한 세분화된 제어를 사용하여 액세스할 수 있는 권한이 부여됩니다. 즉, SAS 토큰을 사용하여 애플리케이션이 공유 키보다 더 보안이 유지되는 방식으로 액세스를 제어할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 렌더링 남용을 제한하고 정기적으로 SAS 토큰을 갱신하도록 Map 계정 리소스 에서 허용되는 특정 원본 목록을 구성하는 것이 좋습니다.

Type: apiKey
In: 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==."
      }
    }
  ]
}

정의

Name	Description
AzureBlob	Azure Blob 데이터 레지스트리 세부 정보입니다.
DataFormat	유효성 검사를 위해 사용되는 업로드된 콘텐츠의 데이터 형식입니다.
DataRegistry	Azure Maps 데이터 레지스트리입니다.
DataRegistryKind	데이터 레지스트리 종류입니다.
DataRegistryList	데이터 레지스트리 목록 API에 대한 응답 모델입니다. 이전에 등록된 모든 데이터의 목록을 반환합니다.
LongRunningOperationStatus	장기 실행 작업의 상태.
MapsErrorDetail	오류 세부 정보입니다.
MapsErrorResponse	실패한 작업에 대한 오류 세부 정보를 반환하는 Azure Maps API에 대한 일반적인 오류 응답입니다.
MapsInnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.

AzureBlob

Azure Blob 데이터 레지스트리 세부 정보입니다.

Name	형식	Description
blobUrl	string	Blob URL에는 등록 중인 파일의 경로가 포함됩니다.
contentMD5	string	데이터 유효성 검사에 사용되는 콘텐츠의 MD5 콘텐츠입니다.
dataFormat	DataFormat	유효성 검사를 위해 사용되는 업로드된 콘텐츠의 데이터 형식입니다.
linkedResource	string	Azure Maps 계정의 데이터 저장소 ID입니다.
msiClientId	string	사용자가 할당한 관리 ID의 클라이언트 ID입니다. 제공되지 않은 경우 시스템 할당 관리 ID를 사용합니다.
sizeInBytes	integer	콘텐츠 크기(바이트)입니다.

DataFormat

유효성 검사를 위해 사용되는 업로드된 콘텐츠의 데이터 형식입니다.

Name	형식	Description
geojson	string	GeoJSON 은 JSON 기반 지리 공간적 데이터 교환 형식입니다.
zip	string	압축된 데이터 형식입니다.

DataRegistry

Azure Maps 데이터 레지스트리입니다.

Name	형식	Description
azureBlob	AzureBlob	Azure Blob 데이터 레지스트리 세부 정보입니다.
description	string	데이터 레지스트리에 지정된 설명입니다. 최대 길이는 1024자입니다.
error	MapsErrorDetail	오류 세부 정보입니다.
kind	DataRegistryKind	데이터 레지스트리 종류입니다.
status	LongRunningOperationStatus	장기 실행 작업의 상태.
udid	string	데이터 레지스트리의 사용자 데이터 ID입니다.

DataRegistryKind

데이터 레지스트리 종류입니다.

Name	형식	Description
AzureBlob	string	Azure Blob