Alias - Assign

Service:

Maps Creator

API-versie:

2.0

Hiermee wijst u een alias toe als verwijzing naar een resource.

Notitie

buitengebruikstelling van Azure Maps Creator

De indoor kaartservice van Azure Maps Creator is nu afgeschaft en wordt buiten gebruik gesteld op 30-9-25. Zie aankondiging van het einde van de levensduur van Azure Maps Creatorvoor meer informatie.

De Assign-API is een HTTP-PUT-aanvraag die wordt gebruikt om een alias toe te wijzen als verwijzing naar een resource.

Aanvraag voor toewijzen verzenden

Als u uw alias wilt toewijzen aan een resource, gebruikt u een PUT aanvraag met de aliasId in het pad en de creatorDataItemId doorgegeven als een queryparameter.

Aliasantwoord toewijzen

De Assign-API retourneert een HTTP-200 OK-antwoord met de bijgewerkte aliasresource in de hoofdtekst als de alias is toegewezen. Een voorbeeld van het antwoord toewijzen is

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

Name	In	Vereist	Type	Description
aliasId	path	True	string	De unieke id die verwijst naar een bestaande alias.
geography	path	True	string	Deze parameter geeft aan waar de Azure Maps Creator-resource zich bevindt. Geldige waarden zijn ons en eu.
api-version	query	True	string	Versienummer van Azure Maps-API.
creatorDataItemId	query	True	string	De unieke id die verwijst naar een gegevensitem van een maker die moet worden gealiaseerd.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

Antwoorden

Name	Type	Description
200 OK	Alias	Alias is toegewezen.
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Notities

• Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.

De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.

• Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Assign an alias to a resource

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
Alias	Gedetailleerde informatie voor de alias.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

Alias

Object

Gedetailleerde informatie voor de alias.

Name	Type	Description
aliasId	string	De id voor de alias.
createdTimestamp	string (date-time)	De gemaakte tijdstempel voor de alias.
creatorDataItemId	string	De id voor het makergegevensitem waarnaar deze alias verwijst (kan null zijn als de alias niet is toegewezen).
lastUpdatedTimestamp	string (date-time)	De tijdstempel van de laatste keer dat de alias is toegewezen.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.