Alias - List

Se aplica a:consulte planes de tarifa.

Creator permite desarrollar aplicaciones basadas en los datos privados del mapa interior mediante Azure Maps API y SDK. En este artículo se presentan conceptos y herramientas que se aplican a Azure Maps Creator.

Esta API permite al autor de la llamada capturar una lista de todos los alias creados previamente correctamente.

Enviar solicitud de lista

Para enumerar todos los alias, emitirá una GET solicitud sin parámetros adicionales.

Respuesta de datos de lista

List API devuelve la lista completa de todos los alias en json formato. La respuesta contiene los siguientes detalles para cada recurso de alias:

createdTimestamp: marca de tiempo que se creó el alias. Format yyyy-MM-ddTHH:mm:ss.sssZ aliasId: el identificador del alias. creatorDataItemId: 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: la última vez que se asignó el alias a un recurso. Formato aaaa-MM-ddTHH:mm:ss.sssZ

Una respuesta de ejemplo que devuelve 2 recursos de alias:

{
  "aliases": [
    {
      "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"
    },
    {
      "createdTimestamp": "2020-02-18T19:53:33.123Z",
      "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
      "creatorDataItemId": null,
      "lastUpdatedTimestamp": "2020-02-18T19:53:33.123Z"
    }
  ]
}
GET https://{geography}.atlas.microsoft.com/aliases?api-version=2.0

Parámetros de identificador URI

Name In Required Type Description
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.

Encabezado de la solicitud

Name Required Type Description
x-ms-client-id
  • string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Azure AD. 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 la seguridad de Azure AD en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Name Type Description
200 OK

La solicitud de alias de lista se completó correctamente. El cuerpo de la respuesta contiene una lista de todos los alias creados anteriormente.

Other Status Codes

Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . 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.

  • Actualmente, Azure Active Directory v1.0 o v2.0 admite Work, School e Invitados, pero no admite cuentas personales.

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

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.

Type: apiKey
In: 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.

Type: apiKey
In: header

Ejemplos

List all the previously created aliases

Sample Request

GET https://us.atlas.microsoft.com/aliases?api-version=2.0

Sample Response

{
  "aliases": [
    {
      "createdTimestamp": "2020-02-13T21:19:11+00:00",
      "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
      "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
      "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00"
    },
    {
      "createdTimestamp": "2020-02-13T21:19:11+00:00",
      "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
      "creatorDataItemId": null,
      "lastUpdatedTimestamp": "2020-02-13T21:19:11+00:00"
    }
  ]
}

Definiciones

Alias

Información detallada del alias.

AliasListResult

Modelo de respuesta de list API. Devuelve una lista de todos los alias creados anteriormente.

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.

Name Type 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.

AliasListResult

Modelo de respuesta de list API. Devuelve una lista de todos los alias creados anteriormente.

Name Type Description
aliases

Lista de todos los alias creados anteriormente.

nextLink
  • string

Si está presente, la ubicación de la página siguiente de datos.

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Información adicional.

type
  • string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Name Type Description
additionalInfo

Información adicional del error.

code
  • string

Código de error.

details

Los detalles del error.

message
  • string

El mensaje de error.

target
  • string

Destino del error.

ErrorResponse

Respuesta de error

Name Type Description
error

Objeto de error.