Map Configuration - List
Use para obtener una lista de todas las configuraciones de mapa.
Enviar solicitud de lista
Map Configuration List
API es una solicitud HTTP GET
que se usa para obtener una lista de todas las configuraciones de mapa.
GET https://{geography}.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | 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
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 |
La solicitud de configuración de asignación de lista se completó correctamente. El cuerpo de la respuesta contiene una lista de todas las configuraciones de mapa. |
|
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. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso 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 el modelado de 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 Cuentas profesionales, educativas e invitados, pero no admite cuentas personales.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
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.
Type:
apiKey
In:
query
SAS Token
Se trata de un token de firma de acceso compartido que se crea 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 roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, 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 mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.
Type:
apiKey
In:
header
Ejemplos
Get a list of all map configurations
Sample Request
GET https://us.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview
Sample Response
{
"mapConfigurations": [
{
"mapConfigurationId": "{mapConfigurationId}",
"description": "map configuration with indoor dark style",
"alias": "indoor_dark",
"created": "2022-04-13T06:30:42+00:00"
},
{
"mapConfigurationId": "{mapConfigurationId}",
"description": "Auto-generated map configuration for indoor tileset 28b8160a-68d8-4247-be0b-786c51963142.",
"alias": "defaultIndoor_28b8160a-68d8-4247-be0b-786c51963142",
"created": "2022-04-13T22:39:50+00:00"
}
]
}
Definiciones
Nombre | Description |
---|---|
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Map |
Un elemento de la lista de configuración de mapa. |
Map |
Modelo de respuesta para map configuration List API. Devuelve una lista de todas las configuraciones de mapa. |
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 |
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
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
MapConfigurationListItem
Un elemento de la lista de configuración de mapa.
Nombre | Tipo | Description |
---|---|---|
alias |
string |
Alias utilizado para la configuración del mapa. Longitud máxima de 1024 caracteres. El alias no puede comenzar con |
created |
string |
Fecha y hora de creación de esta configuración de mapa. |
description |
string |
Descripción que el autor de la llamada proporcionó al crear la configuración del mapa. Longitud máxima de 1024 caracteres. |
mapConfigurationId |
string |
Identificador único de la configuración del mapa. |
MapConfigurationListResult
Modelo de respuesta para map configuration List API. Devuelve una lista de todas las configuraciones de mapa.
Nombre | Tipo | Description |
---|---|---|
mapConfigurations |
Lista de todas las configuraciones de mapa. |
|
nextLink |
string |
Si está presente, la ubicación de la página siguiente de datos. |