Dataset - Create

Service:

Maps Creator

API Version:

2023-03-01-preview

Use para crear un conjunto de datos.

La Create API es una solicitud HTTP POST que permite al autor de la llamada crear un conjunto de datos a partir de los datos cargados en el Registro de datos de Azure Maps y convertidos mediante el servicio de conversión de Azure Maps. También puede crear un conjunto de datos directamente mediante los datos cargados en el registro de datos de Azure Maps, siempre que los datos cargados sean un archivo ZIP de archivos GeoJSON que cumplan el formato de ontología de la instalación. Para obtener más información sobre el servicio de registro de datos, consulte Creación del registro de datos.

Para más información, consulte Creación de un conjunto de datos mediante un paquete GeoJson.

Enviar solicitud de creación

Para crear el conjunto de datos, emita una POST solicitud con los parámetros necesarios. Create API es una operación de larga duración.

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

With optional parameters:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&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		string	Identificador para crear el conjunto de datos. Debe conversionId obtenerse de una llamada correcta a la API de conversión del servicio de conversión. Solo se puede proporcionar un conversionId por llamada API. conversionId y udid son parámetros mutuamente excluyentes.
datasetId	query		string	Identificador del conjunto de datos con el que se va a anexar.
description	query		string	Descripción que se va a proporcionar al conjunto de datos.
outputOntology	query		outputOntology	Ontología del paquete ZIP cargado que contiene archivos GeoJSON. OutputOntology es necesario si se proporciona udid, pero es mutuamente excluyente con conversionId. Actualmente, solo se admite el valor facility-2.0 .
udid	query		string	Identificador de datos único (udid) para crear el conjunto de datos. Debe ser el mismo udid que se usa al crear el Registro de datos. Solo se puede proporcionar un udid por llamada API. El parámetro outputOntology debe proporcionarse con el udid. conversionId y udid son parámetros mutuamente excluyentes.

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
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 dataset from a converted CAD file provided by conversionId

Create dataset from a zip of GeoJSON files provided by udid

Create dataset with Udid and append to it a dataset created with conversionId

Create dataset with Udid and append to it a dataset created with udid

Create dataset from a converted CAD file provided by conversionId

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&outputOntology=facility-2.0

Sample Response

Status code:

202

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

Create dataset from a zip of GeoJSON files provided by udid

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0

Sample Response

Status code:

202

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

Create dataset with Udid and append to it a dataset created with conversionId

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={conversionId}

Sample Response

Status code:

202

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

Create dataset with Udid and append to it a dataset created with udid

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0&datasetId={udid}

Sample Response

Status code:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
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
outputOntology	Ontología del paquete ZIP cargado que contiene archivos GeoJSON. OutputOntology es necesario si se proporciona udid, pero es mutuamente excluyente con conversionId. Actualmente, solo se admite el valor facility-2.0 .

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.

outputOntology

Ontología del paquete ZIP cargado que contiene archivos GeoJSON. OutputOntology es necesario si se proporciona udid, pero es mutuamente excluyente con conversionId. Actualmente, solo se admite el valor facility-2.0 .

Nombre	Tipo	Description
facility-2.0	string