Data Registry - List

Referencia

Servicio:: Maps

Versión de la API:: 2023-06-01

Use para obtener una lista de todos los registros de datos de la cuenta de Azure Maps.

La List API es una solicitud HTTP GET que devuelve una matriz que contiene todos los registros de datos registrados anteriormente mediante la API Register o Replace.

El punto de conexión de servicio del Registro de datos está limitado en el ámbito de la región de la cuenta de Azure Maps y no está disponible para las cuentas globales de Azure Maps.

Enviar solicitud de lista

Para enumerar todos los registros de datos, emita una GET solicitud sin parámetros adicionales.

Respuesta de lista

La List solicitud devuelve una matriz de registros de datos en JSON formato en el cuerpo de la respuesta.

GET https://{geography}.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
geography	path	True	string	Este parámetro especifica dónde se encuentra la cuenta de Azure Maps. Los valores válidos son nosotros (Este de EE. UU., Centro-oeste de EE. UU., Oeste de EE. UU. 2) y eu (Norte de Europa, Oeste de Europa).
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 Id. de Entra de Microsoft. 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 la seguridad de id. de Entra de Microsoft en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	DataRegistryList	La `List` solicitud se completó correctamente. El cuerpo de la respuesta contiene una matriz de registros de datos.
Other Status Codes	MapsErrorResponse	Se ha producido un error inesperado. Encabezados x-ms-error-code: string

DataRegistryList

La List solicitud se completó correctamente. El cuerpo de la respuesta contiene una matriz de registros de datos.

Other Status Codes

MapsErrorResponse

Se ha producido un error inesperado.

Encabezados

x-ms-error-code: string

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

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 de Azure Maps solicita acceso la aplicación. 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 id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las 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 la plataforma de identidad de Microsoft, consulte Introducción a la 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 un recurso de Azure Maps a través del plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede almacenar de forma segura.

Tipo: apiKey
En: header

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

List all previously registered data registries

Solicitud de ejemplo

HTTP

GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Contoso Indoor Design",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "zip",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path1.zip",
        "sizeInBytes": 29920,
        "contentMD5": "CsFxZ2YSfxw3cRPlqokV0w=="
      },
      "status": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path2.geojson",
        "sizeInBytes": 1339
      },
      "status": "Running"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "description": "Contoso Geofence GeoJSON",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path3.geojson",
        "sizeInBytes": 1650,
        "contentMD5": "rYpEfIeLbWZPyaICGEGy3A=="
      },
      "status": "Failed",
      "error": {
        "code": "ContentMD5Mismatch",
        "message": "Actual content MD5: sOJMJvFParkSxBsvvrPOMQ== doesn't match expected content MD5: CsFxZ2YSfxw3cRPlqokV0w==."
      }
    }
  ]
}

Definiciones

Nombre	Description
AzureBlob	Detalles del Registro de datos de blobs de Azure.
DataFormat	Formato de datos del contenido cargado que se usa con fines de validación.
DataRegistry	Registro de datos en Azure Maps.
DataRegistryKind	Tipo de registro de datos.
DataRegistryList	Modelo de respuesta de la API de lista de registro de datos. Devuelve una lista de todos los datos registrados anteriormente.
LongRunningOperationStatus	Estado de una operación de larga duración.
MapsErrorDetail	Detalle del error.
MapsErrorResponse	Respuesta de error común para las API de Azure Maps para devolver los detalles de error de las operaciones con errores.
MapsInnerError	Objeto que contiene información más específica que el objeto actual sobre el error.

AzureBlob

Detalles del Registro de datos de blobs de Azure.

Nombre	Tipo	Description
blobUrl	string	La dirección URL del blob contiene la ruta de acceso al archivo que se está registrando.
contentMD5	string	Contenido MD5 del contenido, que se usa para la validación de datos.
dataFormat	DataFormat	Formato de datos del contenido cargado que se usa con fines de validación.
linkedResource	string	Identificador del almacén de datos de la cuenta de Azure Maps.
msiClientId	string	Identificador de cliente de la identidad administrada asignada por el usuario. Use la identidad administrada asignada por el sistema si no se proporciona.
sizeInBytes	integer	Tamaño del contenido en bytes.

DataFormat

Formato de datos del contenido cargado que se usa con fines de validación.

Nombre	Tipo	Description
geojson	string	GeoJSON es un formato de intercambio de datos geoespacial basado en JSON.
zip	string	Formato de datos comprimidos.

DataRegistry

Registro de datos en Azure Maps.

Nombre	Tipo	Description
azureBlob	AzureBlob	Detalles del Registro de datos de blobs de Azure.
description	string	Descripción dada al registro de datos. La longitud máxima es de 1024 caracteres.
error	MapsErrorDetail	Detalle del error.
kind	DataRegistryKind	Tipo de registro de datos.
status	LongRunningOperationStatus	Estado de una operación de larga duración.
udid	string	Identificador de datos de usuario para el registro de datos.

DataRegistryKind

Tipo de registro de datos.

Nombre	Tipo	Description
AzureBlob	string	Blob de Azure