Alias - Assign

Referencia

Service:: Maps Creator

API Version:: 2.0

Alias hozzárendelése erőforrásra mutató hivatkozásként.

Az Assign API egy HTTP-kérés PUT , amellyel aliast rendelhet hozzá egy erőforrásra mutató hivatkozásként.

Kérelem hozzárendelésének elküldése

Ha aliast szeretne hozzárendelni egy erőforráshoz, egy kérést fog használni PUT az aliasId elérési úton, és az creatorDataItemId átadott paramétert lekérdezési paraméterként.

Aliasválasz hozzárendelése

Az Assign API http-választ 200 OK ad vissza a törzs frissített alias-erőforrásával, ha az alias hozzárendelése sikeres volt. A hozzárendelési válasz mintája a következő:

{
  "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"
}

PUT https://{geography}.atlas.microsoft.com/aliases/{aliasId}?api-version=2.0&creatorDataItemId={creatorDataItemId}

URI-paraméterek

Name	In	Kötelező	Típus	Description
aliasId	path	True	string	Egy meglévő aliasra hivatkozó egyedi azonosító.
geography	path	True	string	Ez a paraméter határozza meg, hogy hol található a Azure Maps Creator-erőforrás. Érvényes értékek vagyunk és eu.
api-version	query	True	string	Azure Maps API verziószáma.
creatorDataItemId	query	True	string	Az az egyedi azonosító, amely egy létrehozói adatelemre hivatkozik aliasként.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást.

Válaszok

Name	Típus	Description
200 OK	Alias	Az alias hozzárendelése sikerült.
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0-folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.

A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintése.

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

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps fiókot hoz létre a Azure Portal vagy PowerShell, CLI, Azure SDK vagy REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

Nyilvánosan közzétett alkalmazások esetén javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.

Type: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.

Type: apiKey
In: header

Példák

Assign an alias to a resource

Sample Request

HTTP

PUT https://us.atlas.microsoft.com/aliases/[aliasId]?api-version=2.0&creatorDataItemId=[creatorDataItemId]

Sample Response

Status code:: 200

{
  "createdTimestamp": "2021-05-01T01:02:03.456Z",
  "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012",
  "creatorDataItemId": "633a009a-dfa2-4d51-a419-420122e11c94",
  "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z"
}

Definíciók

Name	Description
Alias	Az alias részletes információi.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz

Alias

Az alias részletes információi.

Name	Típus	Description
aliasId	string	Az alias azonosítója.
createdTimestamp	string	Az aliashoz létrehozott időbélyeg.
creatorDataItemId	string	A létrehozó adatelem azonosítója, amelyre ez az alias hivatkozik (null értékű lehet, ha az alias nincs hozzárendelve).
lastUpdatedTimestamp	string	Az alias legutóbbi hozzárendelésének időbélyege.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.