Alias - Create
Alias létrehozásához használható.
Az Create
API egy HTTP-kérés POST
, amely lehetővé teszi a hívó számára, hogy aliast hozzon létre, és opcionálisan hozzárendelje azt egy erőforráshoz. Az alias hivatkozhat egy létrehozó szolgáltatás által létrehozott azonosítóra, de nem hivatkozhat másik alias-azonosítóra.
Létrehozási kérelem elküldése
Az alias létrehozásához egy kérést POST
fog használni. Ha az aliast a létrehozás során szeretné hozzárendelni, a lekérdezési paramétert resourceId
fogja átadni.
Aliasválasz létrehozása
A Create API egy HTTP-választ 201 Created
ad vissza az alias-erőforrással a törzsben.
Mintaválasz alias létrehozásakor:
{
"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.0
POST https://{geography}.atlas.microsoft.com/aliases?api-version=2.0&creatorDataItemId={creatorDataItemId}
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Ez a paraméter határozza meg, hogy hol található a Azure Maps Létrehozó erőforrás. Érvényes értékek vagyunk és eu. |
api-version
|
query | True |
string |
A Azure Maps API verziószáma. |
creator
|
query |
string |
Az egyedi azonosító, amely egy aliasolandó alkotói adatelemre hivatkozik. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
x-ms-client-id |
string |
Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. A Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeleti sík fiók API-jából. A biztonsági Microsoft Entra ID Azure Maps az alábbi cikkekben talál útmutatást. |
Válaszok
Name | Típus | Description |
---|---|---|
201 Created |
A tartalom létrehozása sikerült. A válasz törzse tartalmazza az újonnan létrehozott alias-azonosítót Fejlécek Access-Control-Expose-Headers: string |
|
Other Status Codes |
Váratlan hiba történt. |
Biztonság
AADToken
Ezek az OAuth 2.0-folyamatok Microsoft Entra. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. 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, a REST API-khoz Azure Maps engedélyekkel rendelkező 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ások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.
Jegyzetek
- Ez a biztonsági definíció a fejléc használatával
x-ms-client-id
jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.
Ez Authorization URL
az Azure nyilvános felhőpéldányára jellemző. 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és 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 egy alkalmazás 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és.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
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 a PowerShell, a CLI, az Azure SDK-k vagy a 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ében azt javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítésével férhessen hozzá Azure Maps REST API-khoz, hogy a kulcs biztonságosan tárolható legyen.
Típus:
apiKey
In:
query
SAS Token
Ez egy közös hozzáférésű jogosultságkód-jogkivonat, amely a Azure Maps erőforrás SAS listázási műveletéből jön létre 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 jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.
Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.
Típus:
apiKey
In:
header
Példák
Create an alias that does not reference any resource
Mintakérelem
POST https://us.atlas.microsoft.com/aliases?api-version=2.0
Mintaválasz
{
"createdTimestamp": "2021-05-01T01:02:03.456Z",
"aliasId": "25084fb7-307a-4720-8f91-7952a0b91012",
"creatorDataItemId": null,
"lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z"
}
Definíciók
Name | Description |
---|---|
Alias |
Az alias részletes információi. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Alias
Az alias részletes információi.
Name | Típus | Description |
---|---|---|
aliasId |
string |
Az alias azonosítója. |
createdTimestamp |
string |
Az alias létrehozott időbélyege. |
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 információtípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |