Alias - Assign

Referencia

Servicio:: Maps Creator

Versión de la API:: 2.0

Use para asignar un alias como referencia a un recurso.

La Assign API es una solicitud HTTP PUT que se usa para asignar un alias como referencia a un recurso.

Enviar solicitud de asignación

Para asignar el alias a un recurso, usará una PUT solicitud con en la aliasId ruta de acceso y el creatorDataItemId pasado como parámetro de consulta.

Asignar respuesta de alias

La API Assign devuelve una respuesta HTTP 200 OK con el recurso de alias actualizado en el cuerpo, si el alias se asignó correctamente. Un ejemplo de la respuesta de asignación es

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
aliasId	path	True	string	Identificador único que hace referencia a un alias existente.
geography	path	True	string	Este parámetro especifica dónde se encuentra el recurso Azure Maps Creator. Los valores válidos son nosotros y eu.
api-version	query	True	string	Número de versión de la API de Azure Maps.
creatorDataItemId	query	True	string	Identificador único que hace referencia a un elemento de datos de creador que se va a establecer como alias.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Microsoft Entra ID. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	Alias	El alias se asignó correctamente.
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los Microsoft Entra flujos de OAuth 2.0. Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Para obtener más información sobre Plataforma de identidad de Microsoft, consulte introducción a Plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Assign an alias to a resource

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
Alias	Información detallada del alias.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

Alias

Información detallada del alias.

Nombre	Tipo	Description
aliasId	string	Identificador del alias.
createdTimestamp	string	Marca de tiempo creada para el alias.
creatorDataItemId	string	Identificador del elemento de datos de creador al que hace referencia este alias (podría ser null si no se ha asignado el alias).
lastUpdatedTimestamp	string	Marca de tiempo de la última vez que se asignó el alias.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Compartir a través de