Data Registry - Get Operation
를 사용하여 데이터 레지스터 또는 바꾸기 요청의 상태를 확인합니다.
Get Operation
API는 데이터 레지스터 또는 바꾸기 요청의 상태를 가져오는 데 사용되는 HTTP GET
요청으로, 레지스터의 헤더에 반환되거나 응답을 키 값 Operation-Location
으로 바꿉니다. 진행 중인 동안 HTTP 200 OK
응답은 헤더와 함께 Retry-After
반환되고 완료되면 추가 헤더가 없는 HTTP 200 OK
가 반환됩니다.
데이터 레지스트리 서비스 엔드포인트는 Azure Maps 계정의 지역으로 범위가 제한되며 전역 Azure Maps 계정에는 사용할 수 없습니다.
GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?api-version=2023-06-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
geography
|
path | True |
string |
이 매개 변수는 Azure Maps 계정이 있는 위치를 지정합니다. 유효한 값은 당사(미국 동부, 미국 중서부, 미국 서부 2) 및 eu(북유럽, 서유럽)입니다. |
operation
|
path | True |
string |
데이터 레지스터 요청의 상태를 쿼리하는 데 사용되는 ID입니다. regex 패턴: |
api-version
|
query | True |
string |
Azure Maps API의 버전 번호입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
장기 실행 작업의 상태입니다. 헤더 Retry-After: integer |
|
Other Status Codes |
예기치 않은 오류가 발생했습니다. 헤더 x-ms-error-code: string |
보안
AADToken
다음은 Microsoft Entra OAuth 2.0 흐름입니다. Azure 역할 기반 액세스 제어와 페어링하면 Azure Maps REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 Azure Maps REST API에 대한 하나 이상의 권한으로 구성된 기본 제공 역할 또는 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.
시나리오를 구현하려면 인증 개념을 보는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 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 웹 SDK 를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 허용합니다.
- Microsoft ID 플랫폼에 대한 자세한 내용은 Microsoft ID 플랫폼 개요를 참조하세요.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
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에 액세스할 수 있는 권한이 부여됩니다. 즉, 이러한 키는 현재 발급된 계정에 대한 마스터 키로 처리될 수 있습니다.
공개적으로 노출된 애플리케이션의 경우 이 키를 안전하게 저장할 수 있는 Azure Maps REST API의 서버-서버 액세스를 사용하는 것이 좋습니다.
형식:
apiKey
In(다음 안에):
header
SAS Token
Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스 의 SAS 나열 작업에서 생성된 공유 액세스 서명 토큰입니다.
이 토큰을 사용하면 모든 애플리케이션이 Azure 역할 기반 액세스 제어 및 특정 토큰에 사용할 만료, 속도 및 지역에 대한 세분화된 제어를 사용하여 액세스할 수 있는 권한이 부여됩니다. 즉, SAS 토큰을 사용하여 애플리케이션이 공유 키보다 더 보안이 유지되는 방식으로 액세스를 제어할 수 있습니다.
공개적으로 노출된 애플리케이션의 경우 렌더링 남용을 제한하고 정기적으로 SAS 토큰을 갱신하도록 Map 계정 리소스 에서 허용되는 특정 원본 목록을 구성하는 것이 좋습니다.
형식:
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
샘플 요청
GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01
샘플 응답
{
"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
샘플 요청
GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01
샘플 응답
{
"id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
"status": "Completed"
}
Get the status of an operation that is still running
샘플 요청
GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01
샘플 응답
Retry-After: 10
{
"id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
"status": "Running"
}
정의
Name | Description |
---|---|
Long |
장기 실행 작업에 대한 응답 모델입니다. |
Long |
장기 실행 작업의 상태입니다. |
Maps |
오류 세부 정보입니다. |
Maps |
실패한 작업에 대한 오류 세부 정보를 반환하는 Azure Maps API에 대한 일반적인 오류 응답입니다. |
Maps |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
LongRunningOperationResult
장기 실행 작업에 대한 응답 모델입니다.
Name | 형식 | Description |
---|---|---|
error |
오류 세부 정보입니다. |
|
id |
string |
operationId |
status |
장기 실행 작업의 상태입니다. |
LongRunningOperationStatus
장기 실행 작업의 상태입니다.
Name | 형식 | Description |
---|---|---|
Completed |
string |
요청이 성공적으로 완료되었습니다. |
Failed |
string |
요청에 하나 이상의 오류가 있습니다. |
Running |
string |
요청이 현재 처리 중입니다. |
MapsErrorDetail
오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
서버 정의 오류 코드 집합 중 하나입니다. |
details |
이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다. |
|
innererror |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
|
message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
target |
string |
오류의 대상입니다. |
MapsErrorResponse
실패한 작업에 대한 오류 세부 정보를 반환하는 Azure Maps API에 대한 일반적인 오류 응답입니다.
Name | 형식 | Description |
---|---|---|
error |
오류 세부 정보입니다. |
MapsInnerError
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
오류 코드입니다. |
innererror |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |