Data Registry - Get Operation

참조

Service:: Maps

API Version:: 2023-06-01

를 사용하여 데이터 레지스터 또는 바꾸기 요청의 상태 검사.
API는 Get Operation데이터 레지스터 또는 바꾸기 요청의 상태 가져오는 데 사용되는 HTTP GET 요청으로, 레지스터의 헤더에 반환되거나 응답을 키 값 Operation-Location 으로 바꿉니다. 진행 중인 동안 HTTP 200 OK 응답은 헤더와 함께 Retry-After 반환되고, 완료되면 추가 헤더가 없는 HTTP 200 OK 가 반환됩니다.

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

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description

Name	In(다음 안에)	필수	형식	Description
geography	path	True	string	이 매개 변수는 Azure Maps 계정이 있는 위치를 지정합니다. 유효한 값은 당사(미국 동부, 미국 중서부, 미국 서부 2) 및 eu(북유럽, 서유럽)입니다.
operationId	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 계정이 있는 위치를 지정합니다. 유효한 값은 당사(미국 동부, 미국 중서부, 미국 서부 2) 및 eu(북유럽, 서유럽)입니다.

operationId

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의 버전 번호입니다.

응답

Name	형식	Description
200 OK	LongRunningOperationResult	장기 실행 작업의 상태. Headers Retry-After: integer
Other Status Codes	MapsErrorResponse	예기치 않은 오류가 발생했습니다. Headers x-ms-error-code: string

Name

형식

Description

200 OK

LongRunningOperationResult

장기 실행 작업의 상태.

Headers

Retry-After: integer

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 리소스를 나타내기 위해 헤더를 사용해야 합니다. 이는 지도 관리 API에서 가져올 수 있습니다.

Authorization URL 은 Azure 퍼블릭 클라우드 instance 관련됩니다. 소버린 클라우드에는 고유한 권한 부여 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

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 토큰을 갱신하도록 맵 계정 리소스 에서 허용되는 특정 원본 목록을 구성하는 것이 좋습니다.

Type: apiKey
In: header

예제

Get the status of an operation that failed

Get the status of an operation that finished successfully

Get the status of an operation that is still running

Get the status of an operation that failed

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Failed",
  "error": {
    "code": "InvalidData",
    "message": "The data is not a valid GeoJSON."
  }
}

Get the status of an operation that finished successfully

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

Retry-After: 10

Response Body

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

정의

Name	Description
LongRunningOperationResult	장기 실행 작업에 대한 응답 모델입니다.
LongRunningOperationStatus	장기 실행 작업의 상태.
MapsErrorDetail	오류 세부 정보입니다.
MapsErrorResponse	실패한 작업에 대한 오류 세부 정보를 반환하는 Azure Maps API에 대한 일반적인 오류 응답입니다.
MapsInnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.

LongRunningOperationResult

장기 실행 작업에 대한 응답 모델입니다.

Name	형식	Description
error	MapsErrorDetail	오류 세부 정보입니다.
id	string	operationId
status	LongRunningOperationStatus	장기 실행 작업의 상태.

LongRunningOperationStatus

장기 실행 작업의 상태.

Name	형식	Description
Completed	string	요청이 성공적으로 완료되었습니다.
Failed	string	요청에 하나 이상의 오류가 있습니다.
Running	string	요청이 현재 처리 중입니다.

MapsErrorDetail

오류 세부 정보입니다.

Name	형식	Description
code	string	서버 정의 오류 코드 집합 중 하나입니다.
details	MapsErrorDetail[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	MapsInnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

MapsErrorResponse

실패한 작업에 대한 오류 세부 정보를 반환하는 Azure Maps API에 대한 일반적인 오류 응답입니다.

Name	형식	Description
error	MapsErrorDetail	오류 세부 정보입니다.

MapsInnerError

오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.

Name	형식	Description
code	string	오류 코드입니다.
innererror	MapsInnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.

Share via

Data Registry - Get Operation

URI 매개 변수

응답

보안

AADToken

참고

Scopes

subscription-key

SAS Token

예제

Get the status of an operation that failed

Sample Request

Sample Response

Get the status of an operation that finished successfully

Sample Request

Sample Response

Get the status of an operation that is still running

Sample Request

Sample Response

정의

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

추가 리소스