Dataset - Create

Referencia

Service:: Maps Creator

API Version:: 2.0

Use para crear un conjunto de datos.

La Create API es una solicitud HTTP POST que toma el conversionId valor del paquete de dibujo convertido y devuelve la datasetId propiedad del conjunto de datos recién creado. Para más información, consulte Creación de un conjunto de datos.

Puede usar esta solicitud en un escenario como cargar un paquete ZIP DWG para un edificio, convertir el paquete zip mediante el servicio de conversión de Azure Maps y crear un conjunto de datos a partir del paquete ZIP convertido. El conjunto de datos creado se puede usar para crear conjuntos de iconos mediante el servicio Azure Maps Tileset y se puede consultar a través del servicio WFS de Azure Maps.

Enviar solicitud de creación

Para crear el conjunto de datos, usará una POST solicitud en la que el conversionId parámetro de consulta es un identificador que representa el paquete zip de DWG convertido, el datasetId parámetro es el identificador de un conjunto de datos creado anteriormente para anexar con el conjunto de datos actual y, opcionalmente, el description parámetro de consulta contendrá una descripción (si no se proporciona una descripción predeterminada).

Create API es una operación de larga duración.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}

With optional parameters:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&datasetId={datasetId}&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.
conversionId	query	True	string	Identificador único que se usa para crear el conjunto de datos. `conversionId` Se debe haber obtenido de una llamada correcta a la API convert del servicio de conversión y se puede proporcionar con varios parámetros de consulta con el mismo nombre (si se proporciona más de uno).
datasetId	query		string	Identificador del conjunto de datos con el que se va a anexar. El conjunto de datos debe originarse en una llamada de creación de conjunto de datos anterior que coincida con datasetId.
description	query		string	Descripción que se va a proporcionar al conjunto de datos.

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. Headers 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. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

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.

Headers

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.

Headers

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.

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

Create dataset from a converted CAD file provided by conversionId

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

Sample Response

Status code:: 200

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

Response Body

{
  "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/datasets/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.

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.

Dataset - Create

Enviar solicitud de creación

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Notas

Scopes

subscription-key

SAS Token

Ejemplos

Create dataset from a converted CAD file provided by conversionId

Sample Request

Sample Response

Definiciones

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

Recursos adicionales