Alias - Create
를 사용하여 별칭을 만듭니다.
Create API는 호출자가 별칭을 만들고 필요에 따라 리소스에 할당할 수 있는 HTTP POST 요청입니다. 별칭은 작성자 서비스에서 생성된 ID를 참조할 수 있지만 다른 별칭 ID를 참조할 수는 없습니다.
요청 만들기 제출
별칭을 만들려면 요청을 사용합니다 POST . 만드는 동안 별칭을 할당하려는 경우 쿼리 매개 변수를 전달합니다 resourceId .
별칭 응답 만들기
Create API는 본문에 별칭 리소스가 있는 HTTP 201 Created 응답을 반환합니다.
별칭을 만드는 샘플 응답:
{
"createdTimestamp": "2020-02-13T21:19:11.123Z",
"aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
"creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
"lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
}
POST https://{geography}.atlas.microsoft.com/aliases?api-version=2.0POST https://{geography}.atlas.microsoft.com/aliases?api-version=2.0&creatorDataItemId={creatorDataItemId}URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
geography
|
path | True |
string |
이 매개 변수는 Azure Maps Creator 리소스가 있는 위치를 지정합니다. 유효한 값은 우리와 EU입니다. |
|
api-version
|
query | True |
string |
Azure Maps API의 버전 번호. |
|
creator
|
query |
string |
별칭이 지정될 작성자 데이터 항목을 참조하는 고유 ID입니다. |
요청 헤더
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Microsoft Entra ID 보안 모델과 함께 사용할 계정을 지정합니다. Azure Maps 계정에 대한 고유 ID를 나타내며 Azure Maps 관리 평면 계정 API에서 검색할 수 있습니다. Azure Maps Microsoft Entra ID 보안을 사용하려면 다음 문서를 참조하세요. |
응답
| Name | 형식 | Description |
|---|---|---|
| 201 Created |
콘텐츠가 성공적으로 생성되었습니다. 응답 본문에는 새로 만든 별칭 ID 헤더 Access-Control-Expose-Headers: string |
|
| Other Status Codes |
예기치 않은 오류가 발생했습니다. |
보안
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 및 Azure Active Directory 구성이 있습니다.
* 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 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 토큰을 갱신하도록 Map 계정 리소스 에서 허용되는 특정 원본 목록을 구성하는 것이 좋습니다.
형식:
apiKey
In(다음 안에):
header
예제
Create an alias that does not reference any resource
샘플 요청
POST https://us.atlas.microsoft.com/aliases?api-version=2.0
샘플 응답
{
"createdTimestamp": "2021-05-01T01:02:03.456Z",
"aliasId": "25084fb7-307a-4720-8f91-7952a0b91012",
"creatorDataItemId": null,
"lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z"
}정의
| Name | Description |
|---|---|
| Alias |
별칭에 대한 자세한 정보입니다. |
|
Error |
리소스 관리 오류 추가 정보입니다. |
|
Error |
오류 세부 정보입니다. |
|
Error |
오류 응답 |
Alias
별칭에 대한 자세한 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| aliasId |
string |
별칭의 ID입니다. |
| createdTimestamp |
string |
별칭에 대해 만든 타임스탬프입니다. |
| creatorDataItemId |
string |
이 별칭이 참조하는 작성자 데이터 항목의 ID입니다(별칭이 할당되지 않은 경우 null일 수 있음). |
| lastUpdatedTimestamp |
string |
별칭이 마지막으로 할당된 타임스탬프입니다. |
ErrorAdditionalInfo
리소스 관리 오류 추가 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| info |
object |
추가 정보입니다. |
| type |
string |
추가 정보 유형입니다. |
ErrorDetail
오류 세부 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| additionalInfo |
오류 추가 정보입니다. |
|
| code |
string |
오류 코드입니다. |
| details |
오류 세부 정보입니다. |
|
| message |
string |
오류 메시지입니다. |
| target |
string |
오류 대상입니다. |
ErrorResponse
오류 응답
| Name | 형식 | Description |
|---|---|---|
| error |
Error 개체. |