Data Registry - List
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 del 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 Azure Maps API. |
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 |
La |
|
Other Status Codes |
Se ha producido un error inesperado. Headers x-ms-error-code: string |
Seguridad
AADToken
Estos son los flujos de OAuth 2.0 de Microsoft Entra. 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 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 Plataforma de identidad de Microsoft información general.
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 un recurso de Azure Maps a través del plano de administración de Azure a través de 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, actualmente se pueden tratar como claves maestras para la cuenta para la que se emiten.
Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de Azure Maps API REST donde esta clave se puede almacenar de forma segura.
Type:
apiKey
In:
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 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
List all previously registered data registries
Sample Request
GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01
Sample Response
{
"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 |
---|---|
Azure |
Detalles del registro de datos de blobs de Azure. |
Data |
Formato de datos del contenido cargado que se usa con fines de validación. |
Data |
Registro de datos en Azure Maps. |
Data |
Tipo de registro de datos. |
Data |
Modelo de respuesta para la API de lista de registros de datos. Devuelve una lista de todos los datos registrados anteriormente. |
Long |
Estado de una operación de ejecución prolongada. |
Maps |
Detalle del error. |
Maps |
Respuesta de error común para las API de Azure Maps para devolver los detalles de error de las operaciones con errores. |
Maps |
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 |
El contenido MD5 del contenido, que se usa para la validación de datos. |
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 |
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 |
Detalle del error. |
|
kind |
Tipo de registro de datos. |
|
status |
Estado de una operación de ejecución prolongada. |
|
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 |
DataRegistryList
Modelo de respuesta para la API de lista de registros de datos. Devuelve una lista de todos los datos registrados anteriormente.
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Dirección URL para obtener el siguiente conjunto de registros de datos. |
value |
Matriz de registros de datos. |
LongRunningOperationStatus
Estado de una operación de ejecución prolongada.
Nombre | Tipo | Description |
---|---|---|
Completed |
string |
La solicitud se completó correctamente. |
Failed |
string |
La solicitud tiene uno o varios errores. |
Running |
string |
La solicitud se está procesando actualmente. |
MapsErrorDetail
Detalle del error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Uno de los conjuntos de códigos de error definidos por el servidor. |
details |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
|
innererror |
Objeto que contiene información más específica que el objeto actual sobre el error. |
|
message |
string |
Representación legible del error. |
target |
string |
Destino 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.
Nombre | Tipo | Description |
---|---|---|
error |
Detalle del error. |
MapsInnerError
Objeto que contiene información más específica que el objeto actual sobre el error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
innererror |
Objeto que contiene información más específica que el objeto actual sobre el error. |