Alias - Create
Slouží k vytvoření aliasu.
Rozhraní Create
API je požadavek HTTP POST
, který umožňuje volajícímu vytvořit alias a volitelně ho přiřadit k prostředku. Alias může odkazovat na ID vygenerované službou tvůrce, ale nemůže odkazovat na jiné ID aliasu.
Odeslat žádost o vytvoření
K vytvoření aliasu POST
použijete žádost. Pokud chcete přiřadit alias během vytváření, předáte resourceId
parametr dotazu.
Vytvořit odpověď aliasu
Rozhraní CREATE API vrátí odpověď HTTP 201 Created
s prostředkem aliasu v těle.
Ukázková odpověď z vytvoření aliasu:
{
"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}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Tento parametr určuje, kde se nachází prostředek Azure Maps Creator. Platné hodnoty jsou my a eu. |
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. |
creator
|
query |
string |
Jedinečné ID, které odkazuje na položku dat tvůrce, která má být aliasována. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích. |
Odpovědi
Name | Typ | Description |
---|---|---|
201 Created |
Obsah se úspěšně vytvořil. Text odpovědi obsahuje nově vytvořené ID Headers Access-Control-Expose-Headers: string |
|
Other Status Codes |
Došlo k neočekávané chybě. |
Zabezpečení
AADToken
Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.
Poznámky
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.
Je Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory.
* Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.
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
Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.
U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.
Type:
apiKey
In:
query
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.
U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.
Type:
apiKey
In:
header
Příklady
Create an alias that does not reference any resource
Sample Request
POST https://us.atlas.microsoft.com/aliases?api-version=2.0
Sample Response
{
"createdTimestamp": "2021-05-01T01:02:03.456Z",
"aliasId": "25084fb7-307a-4720-8f91-7952a0b91012",
"creatorDataItemId": null,
"lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z"
}
Definice
Name | Description |
---|---|
Alias |
Podrobné informace o aliasu |
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě. |
Error |
Odpověď na chybu |
Alias
Podrobné informace o aliasu
Name | Typ | Description |
---|---|---|
aliasId |
string |
ID aliasu. |
createdTimestamp |
string |
Vytvořené časové razítko aliasu |
creatorDataItemId |
string |
ID datové položky tvůrce, na kterou tento alias odkazuje (pokud alias není přiřazený, může mít hodnotu null). |
lastUpdatedTimestamp |
string |
Časové razítko posledního přiřazení aliasu |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Další typ informací. |
ErrorDetail
Podrobnosti o chybě.
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Odpověď na chybu
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |