Routeset - Get Operation

서비스:

Maps Creator

API 버전:

2023-03-01-preview

를 사용하여 경로 집합 만들기 프로세스의 상태 검사.

Get Operation API는 경로 집합 만들기 프로세스의 상태 검사 를 검색하는 데 사용되는 HTTP GET 요청입니다routesetId.

작업 요청 제출

경로 집합 작업의 현재 진행률을 보려면 지정된 경로가 operationId 작업을 나타내는 ID인 요청을 사용합니다GET.

작업 응답

진행 중인 200-OK 동안 추가 헤더 없이 http 상태 코드가 반환됩니다. 작업이 성공하면 헤더의 200-OK 와 함께 Resource-Location http 상태 코드가 반환됩니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
geography	path	True	string	이 매개 변수는 Azure Maps Creator 리소스가 있는 위치를 지정합니다. 유효한 값은 우리와 eu입니다.
operationId	path	True	string	경로 집합 만들기의 상태 쿼리하는 데 사용되는 ID입니다.
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	LongRunningOperationResult	작업이 실행 중이거나 완료되었습니다. 작업이 성공한 경우 Resource-Location 헤더를 사용하여 결과의 경로를 가져옵니다. 헤더 Resource-Location: string
Other Status Codes	ErrorResponse	예기치 않은 오류가 발생했습니다.

보안

AADToken

Azure Active Directory OAuth2 흐름입니다. 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 및 Azure Active Directory 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다. * Azure Maps Web SDK를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.

• 현재 Azure Active Directory v1.0 또는 v2.0 은 회사, 학교 및 게스트를 지원하지만 개인 계정은 지원하지 않습니다.

형식: 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 Azure Maps 계정을 만들거나 PowerShell, CLI, Azure SDK 또는 REST API를 사용할 때 프로비전되는 공유 키입니다.

이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있습니다. 즉, 이 키는 발급된 계정에서 master 키로 사용할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 기밀 클라이언트 애플리케이션 접근 방식을 사용하여 키를 안전하게 저장할 수 있도록 Azure Maps REST API에 액세스하는 것이 좋습니다.

형식: apiKey
In(다음 안에): query

SAS Token

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

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

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

형식: apiKey
In(다음 안에): header

예제

Get the status of an operation which has finished successfully

Get the status of an operation which is still running

Get the status of an operation which has finished successfully

샘플 요청

HTTP

GET https://us.atlas.microsoft.com/routesets/operations/{operation-Id}?api-version=2023-03-01-preview

샘플 응답

상태 코드:

200

Resource-Location: https://us.atlas.microsoft.com/routesets/{routesetId}?api-version=2023-03-01-preview

{
  "operationId": "{operation-Id}",
  "created": "2022-09-01T00:00:00.000Z",
  "status": "Succeeded"
}

Get the status of an operation which is still running

샘플 요청

HTTP

GET https://us.atlas.microsoft.com/routesets/operations/{operation-Id}?api-version=2023-03-01-preview

샘플 응답

상태 코드:

200

{
  "operationId": "{operation-Id}",
  "created": "2022-09-01T00:00:00.000Z",
  "status": "Running"
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
LongRunningOperationResult	Long-Running Operations API에 대한 응답 모델입니다.
LroStatus	요청의 상태 상태입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

LongRunningOperationResult

Long-Running Operations API에 대한 응답 모델입니다.

Name	형식	Description
created	string	만든 타임스탬프입니다.
error	ErrorDetail	오류 세부 정보입니다.
operationId	string	이 장기 실행 작업의 ID입니다.
status	LroStatus	요청의 상태 상태입니다.
warning	ErrorDetail	오류 세부 정보입니다.

LroStatus

요청의 상태 상태입니다.

Name	형식	Description
Failed	string	요청에 하나 이상의 오류가 있습니다.
NotStarted	string	요청이 아직 처리를 시작하지 않았습니다.
Running	string	요청이 처리를 시작했습니다.
Succeeded	string	요청이 성공적으로 완료되었습니다.