Dataset - Get

Referencia

Service:: Maps Creator

API Version:: 2.0

Use para obtener los detalles de un conjunto de datos.

Enviar solicitud de obtención de detalles

Para obtener los detalles de un conjunto de datos creado anteriormente, emitirá una GET solicitud con en datasetId la ruta de acceso.

Obtener respuesta de detalles

Get Details API devuelve los detalles de un conjunto de datos en json formato. La respuesta contiene los campos siguientes (si no son null o vacíos):

created: marca de tiempo que se creó el conjunto de datos. datasetId: identificador del conjunto de datos. description: descripción del conjunto de datos. datasetSources: los datos de origen que se usaron cuando se emitió la solicitud de creación. ontología: ontología de origen que se usó en el servicio de conversión para los datos de entrada.

datasetSources describe los datos de origen que se usaron cuando se emitió la solicitud de creación y contiene los siguientes elementos (si no son null o están vacíos):

conversionIds: lista de conversionId (null si no se proporcionó ninguno). appendDatasetId: que datasetId se usó para una operación de anexión (null si no se usó ninguna). featureCounts: recuentos de cada tipo de característica del conjunto de datos.

Esta es una respuesta de ejemplo que devuelve los timestamprecursos , datasetId, description, datasetSourcesy ontology de un conjunto de datos:

{
   "timestamp": "2020-01-01T22:50:48.123Z",
   "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
   "description": "Some description or comment for the dataset.",
   "datasetSources": {
     "conversionIds": [
       "15d21452-c9bb-27b6-5e79-743ca5c3205d"
     ],
   },
   "ontology": "facility-2.0",
   "featureCounts": {
     "directoryInfo": 2,
     "category": 10,
     "facility": 1,
     "level": 3,
     "unit": 183,
     "zone": 3,
     "verticalPenetration": 6,
     "opening": 48,
     "areaElement": 108
   }
 }

GET https://{geography}.atlas.microsoft.com/datasets/{datasetId}?api-version=2.0

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
datasetId	path	True	string	Identificador del conjunto de datos desde el que se va a consultar.
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	Dataset	La solicitud get dataset se completó correctamente.
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

Get details for a previously created dataset

Sample Request

HTTP

GET https://us.atlas.microsoft.com/datasets/[datasetId]?api-version=2.0

Sample Response

Status code:: 200

Location: https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0
Access-Control-Expose-Headers: Resource-Location

Response Body

{
  "created": "2021-05-21T01:02:03.456Z",
  "datasetId": "[datasetId]",
  "description": "Some description or comment about the dataset",
  "datasetSources": {
    "conversionIds": [
      "15d21452-c9bb-27b6-5e79-743ca5c3205d",
      "c39de51c-b4f5-4733-aeeb-d8cb6f8b2f1d"
    ],
    "appendDatasetId": "6a49a490-1d9c-4f05-bf1e-51998fbc4733"
  },
  "featureCounts": {
    "directoryInfo": 2,
    "category": 10,
    "facility": 1,
    "level": 3,
    "unit": 183,
    "zone": 3,
    "verticalPenetration": 6,
    "opening": 48,
    "areaElement": 108
  },
  "ontology": "facility-2.0"
}

Definiciones

Nombre	Description
Dataset	Información detallada del conjunto de datos.
DatasetSources	Información sobre los detalles de la solicitud de creación del conjunto de datos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

Dataset

Información detallada del conjunto de datos.

Nombre	Tipo	Description
created	string	Marca de tiempo creada para el conjunto de datos.
datasetId	string	Identificador del conjunto de datos.
datasetSources	DatasetSources	Información sobre los detalles de la solicitud de creación del conjunto de datos.
description	string	Descripción del conjunto de datos.
featureCounts	object	La característica cuenta para el conjunto de datos.
ontology	string	Versión de ontología de este conjunto de datos.

DatasetSources

Información sobre los detalles de la solicitud de creación del conjunto de datos.

Nombre	Tipo	Description
appendDatasetId	string	Conjunto de datos que se anexó a para crear el conjunto de datos actual.
conversionIds	string[]	Lista de que se usaron para crear el conjunto de `conversionId` datos.

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.