Map Configuration - Create

Referencia

Service:: Maps Creator

API Version:: 2023-03-01-preview

Use para crear una configuración de mapa.

Para obtener más información sobre lo que es una configuración de mapa, consulte el artículo Sobre conceptos de Creator for indoor maps .

Enviar solicitud de creación

Map Configuration Create API es una solicitud HTTP POST que se usa para crear una nueva configuración de mapa.

POST https://{geography}.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview

With optional parameters:

POST https://{geography}.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview&alias={alias}&description={description}

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.
alias	query		string	Alias de la configuración del mapa. Longitud máxima de 1024 caracteres. El alias no puede empezar con `microsoft-maps` el que es un prefijo reservado. El alias se puede proporcionar opcionalmente durante la creación de una configuración de mapa y se puede usar igual que mapConfigurationId después de la creación de la configuración de mapa.
description	query		string	Descripción proporcionada por el usuario de la configuración del mapa. Longitud máxima de 1024 caracteres.

Encabezado de la solicitud

Media Types: "application/json", "application/zip"

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.

Cuerpo de la solicitud

Media Types: "application/json", "application/zip"

Nombre	Requerido	Tipo	Description
version	True	number	La versión de la configuración del mapa, actualmente solo se admite la versión 1.0.
configurations		ConfigurationObject[]	La matriz "Configuraciones" permitirá al cliente configurar diferentes representaciones de mapa para su conjunto de mosaicos. Cada configuración configurada aquí se reflejará como un estilo de mapa en el selector de estilos en el SDK de cliente. El nombre debe ser único en la matriz de configuraciones.
defaultConfiguration		string	Configuración predeterminada de la configuración del mapa. El valor debe ser uno de los campos "name" de ConfigurationObject en la matriz "configurations". Si no se proporciona, se usará la primera entrada de la lista "configuraciones".
description		string	Descripción que el autor de la llamada proporcionó al crear la configuración del mapa. Longitud máxima de 1024 caracteres.

Respuestas

Nombre	Tipo	Description
202 Accepted		Solicitud aceptada: la solicitud se ha aceptado para su procesamiento. Use la dirección URL del encabezado Operation-Location para obtener el estado. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Nombre

Tipo

Description

202 Accepted

Solicitud aceptada: la solicitud se ha aceptado para su procesamiento. Use la dirección URL del encabezado Operation-Location para obtener el estado.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

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

Create a map configuration by providing a configuration file

Sample Request

HTTP

POST https://us.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview&alias=sample-alias&description=This is my first map configuration.

{
  "version": 1,
  "description": "This is Microsoft default indoor map configuration",
  "defaultConfiguration": "microsoft_light",
  "configurations": [
    {
      "name": "indoor_light",
      "displayName": "Indoor light",
      "description": "A base style for Azure Maps.",
      "theme": "light",
      "baseMap": "microsoft_light",
      "layers": [
        {
          "tilesetId": "{tilesetId}",
          "styleId": "microsoft-maps:indoor_2022-01-01"
        }
      ]
    },
    {
      "name": "indoor_dark",
      "displayName": "Indoor dark",
      "description": "A base style for Azure Maps.",
      "theme": "dark",
      "baseMap": "microsoft_dark",
      "layers": [
        {
          "tilesetId": "{tilesetId}",
          "styleId": "microsoft-maps:indoor_dark_2022-01-01"
        }
      ]
    }
  ]
}

Sample Response

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/styles/mapConfigurations/operations/{operationId}?api-version=2022-01-01-preview
Access-Control-Expose-Headers: Operation-Location

Definiciones

Nombre	Description
BaseMap	El mapa base es una capa de fondo para el mapa interior privado. Esta propiedad es opcional, no se mostrará ningún mapa base si no se proporciona. Longitud máxima de 100 caracteres.
ConfigurationObject	Defina el formato para configurar un selector de estilo y el mapa asociado en el SDK de cliente.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
MapConfiguration	Objeto de configuración de mapa que describe el formato JSON de configuración de mapa.
theme	Tema para widgets del SDK de cliente (selector de estilo, zoom, selector de nivel).
TilesetStyleTuple	Tupla TilesetId y StyleId

BaseMap

El mapa base es una capa de fondo para el mapa interior privado. Esta propiedad es opcional, no se mostrará ningún mapa base si no se proporciona. Longitud máxima de 100 caracteres.

Nombre	Tipo	Description
microsoft_dark	string	Estilo de mapa de carreteras oscuro base.
microsoft_grayscale_dark	string	Estilo de mapa oscuro de escala de grises.
microsoft_grayscale_light	string	Estilo de mapa claro de escala de grises.
microsoft_high_contrast_dark	string	Estilo de mapa oscuro de contraste alto.
microsoft_high_contrast_light	string	Estilo de mapa claro de contraste alto.
microsoft_light	string	Estilo de mapa de carreteras base.
microsoft_satellite	string	Estilo de mapa de imágenes satélite.
microsoft_satellite_road	string	Estilo de mapa de carreteras y satélite.
microsoft_shaded_relief	string	Estilo de mapa de relieve sombreado.

ConfigurationObject

Defina el formato para configurar un selector de estilo y el mapa asociado en el SDK de cliente.

Nombre	Tipo	Description
baseMap	BaseMap	El mapa base es una capa de fondo para el mapa interior privado. Esta propiedad es opcional, no se mostrará ningún mapa base si no se proporciona. Longitud máxima de 100 caracteres.
description	string	Descripción del estilo. Longitud máxima de 500 caracteres.
displayName	string	Nombre para mostrar del selector de estilos en el SDK de cliente. Longitud máxima de 255 caracteres.
layers	TilesetStyleTuple[]	Para configurar el estilo del conjunto de iconos. Puede tener un estilo para todo el conjunto de mosaicos. Y puede tener diferentes estilos para diferentes capas en un conjunto de mosaicos, por ejemplo, un estilo para `indoor unit` la capa y otro estilo para `indoor facility` la capa. Y también tiene un estilo para diferentes conjuntos de mosaicos
name	string	Nombre del estilo. Longitud máxima de 255 caracteres.
theme	theme	Tema para widgets del SDK de cliente (selector de estilo, zoom, selector de nivel).
thumbnail	string	El archivo de imagen en miniatura del selector de estilos en el SDK de cliente. Longitud máxima de 255 caracteres. El límite de tamaño es de 400 KB y el límite de píxeles es 512*512.

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.