Conversion - Convert

Servicio:

Maps Creator

Versión de la API:

2.0

Use para convertir un paquete de dibujo importado previamente en datos de mapa.

La Conversion API es una solicitud HTTP POST que permite al autor de la llamada importar un conjunto de archivos de diseño DWG como un paquete de dibujo comprimido en Azure Maps. El paquete de dibujo se hace referencia al udid utilizado cuando se cargó en el Registro de datos. Para obtener más información sobre el servicio de registro de datos, consulte Creación del registro de datos.

Convertir paquete DWG

La API de conversión realiza una operación de ejecución prolongada.

Depuración de problemas de paquetes DWG

Durante el proceso de conversión, si hay algún problema con los errores y advertencias del paquete DWG se proporcionan en la respuesta junto con un paquete de diagnóstico para visualizar y diagnosticar estos problemas. En caso de que se produzcan problemas con el paquete DWG, el proceso de estado de la operación de conversión tal y como se detalla aquí devuelve la ubicación del paquete de diagnóstico que el autor de la llamada puede descargar para ayudarles a visualizar y diagnosticar estos problemas. La ubicación del paquete de diagnóstico se puede encontrar en la sección de propiedades de la respuesta de estado de la operación de conversión y tiene el siguiente aspecto:

{
    "properties": {
        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"                
    }            
}

El paquete de diagnóstico se puede descargar ejecutando una HTTP GET solicitud en .diagnosticPackageLocation Para obtener más información sobre cómo usar la herramienta para visualizar y diagnosticar todos los errores y advertencias, consulte Visualizador de errores de dibujo.

Una operación de conversión se marcará como correcta si hay cero o más advertencias, pero se marcará como errónea si se encuentran errores.

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0

Con parámetros opcionales:

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0&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.
outputOntology	query	True	OutputOntology	Versión de ontología de salida. "facility-2.0" es el único valor admitido en este momento. Consulte este artículo para obtener más información sobre las ontologías de Azure Maps Creator.
udid	query	True	string	Identificador de datos único (udid) para el contenido. Debe ser el mismo udid que se usa al crear el Registro de datos.
description	query		string	Descripción proporcionada por el usuario del contenido que se va a convertir.

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	LongRunningOperationResult	La operación se está ejecutando o completa. Si la operación se realizó correctamente, use el encabezado Resource-Location para obtener la ruta de acceso al resultado. Encabezados Resource-Location: string
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. Encabezados Operation-Location: string
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 Microsoft Entra ID. * 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

Convert previously uploaded DWG Package

Solicitud de ejemplo

HTTP

POST https://us.atlas.microsoft.com/conversions?api-version=2.0&udid=25084fb7-307a-4720-8f91-7952a0b91012&outputOntology=facility-2.0

Respuesta de muestra

status code:

200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

status code:

202

Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
LongRunningOperationResult	Modelo de respuesta para una API de operaciones de Long-Running.
LroStatus	Estado de estado de la solicitud.
OutputOntology	Versión de ontología de salida. "facility-2.0" es el único valor admitido en este momento. Consulte este artículo para obtener más información sobre las ontologías de Azure Maps Creator.

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.

LongRunningOperationResult

Modelo de respuesta para una API de operaciones de Long-Running.

Nombre	Tipo	Description
created	string	Marca de tiempo creada.
error	ErrorDetail	Detalle del error.
operationId	string	Identificador de esta operación de ejecución prolongada.
status	LroStatus	Estado de estado de la solicitud.
warning	ErrorDetail	Detalle del error.

LroStatus

Estado de estado de la solicitud.

Nombre	Tipo	Description
Failed	string	La solicitud tiene uno o varios errores.
NotStarted	string	La solicitud aún no ha iniciado el procesamiento.
Running	string	La solicitud ha iniciado el procesamiento.
Succeeded	string	La solicitud se ha completado correctamente.

OutputOntology

Versión de ontología de salida. "facility-2.0" es el único valor admitido en este momento. Consulte este artículo para obtener más información sobre las ontologías de Azure Maps Creator.

Nombre	Tipo	Description
facility-2.0	string	La ontología de instalaciones define cómo Creator de Azure Maps almacena internamente los datos de las instalaciones en un conjunto de datos de Creator.