Data Registry - List
Verwenden Sie , um eine Liste aller Datenregistrierungen im Azure Maps-Konto abzurufen.
Die List
API ist eine HTTP-Anforderung GET
, die ein Array zurückgibt, das alle Datenregistrierungen enthält, die zuvor mit der Register- oder Replace-API registriert wurden.
Der Datenregistrierungsdienstendpunkt ist im Bereich auf die Region Ihres Azure Maps-Kontos beschränkt und für globale Azure Maps-Konten nicht verfügbar.
Übermitteln einer Listenanforderung
Um alle Ihre Datenregistrierungen aufzulisten, stellen Sie eine GET
Anforderung ohne zusätzliche Parameter.
Antwort auflisten
Die List
Anforderung gibt ein Array von Datenregistrierungen im JSON
Format im Textkörper der Antwort zurück.
GET https://{geography}.atlas.microsoft.com/dataRegistries?api-version=2023-06-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
geography
|
path | True |
string |
Dieser Parameter gibt an, wo sich das Azure Maps-Konto befindet. Gültige Werte sind us (USA, Osten, USA, Westen-Mitte, USA, Westen-Mitte 2) und eu (Europa, Norden, Europa, Westen). |
api-version
|
query | True |
string |
Die Versionsnummer der Azure Maps-API. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-id |
string |
Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln . |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die |
|
Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. Header x-ms-error-code: string |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung von Azure kann sie verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht.
Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.
Hinweise
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id
Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
Ist Authorization URL
spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
- Weitere Informationen zu Microsoft Identity Platform finden Sie unter Übersicht über Microsoft Identity Platform.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs bereitgestellt wird.
Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. Mit anderen Worten, diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt wurden.
Für öffentlich zugängliche Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps-REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
header
SAS Token
Dies ist ein Shared Access Signature-Token, das aus dem SAS-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.
Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.
Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Typ:
apiKey
In:
header
Beispiele
List all previously registered data registries
Beispielanforderung
GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01
Beispiel für eine Antwort
{
"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==."
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Azure |
Details zur Azure-Blobdatenregistrierung. |
Data |
Das Datenformat des hochgeladenen Inhalts, der zu Validierungszwecken verwendet wird. |
Data |
Die Datenregistrierung in Azure Maps. |
Data |
Art der Datenregistrierung. |
Data |
Das Antwortmodell für die Listen-API der Datenregistrierung. Gibt eine Liste aller zuvor registrierten Daten zurück. |
Long |
Der Status eines Vorgangs mit langer Ausführungsdauer. |
Maps |
Die Fehlerdetails. |
Maps |
Häufige Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. |
Maps |
Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
AzureBlob
Details zur Azure-Blobdatenregistrierung.
Name | Typ | Beschreibung |
---|---|---|
blobUrl |
string |
Die Blob-URL enthält den Pfad zu der Datei, die registriert wird. |
contentMD5 |
string |
Der Inhalt MD5 des Inhalts, der für die Datenüberprüfung verwendet wird. |
dataFormat |
Das Datenformat des hochgeladenen Inhalts, der zu Validierungszwecken verwendet wird. |
|
linkedResource |
string |
Die ID des Datenspeichers im Azure Maps-Konto. |
msiClientId |
string |
Client-ID der benutzerseitig zugewiesenen verwalteten Identität. Verwenden Sie die systemseitig zugewiesene verwaltete Identität, falls nicht angegeben. |
sizeInBytes |
integer |
Die Größe des Inhalts in Bytes. |
DataFormat
Das Datenformat des hochgeladenen Inhalts, der zu Validierungszwecken verwendet wird.
Name | Typ | Beschreibung |
---|---|---|
geojson |
string |
GeoJSON ist ein JSON-basiertes Geodatenaustauschformat. |
zip |
string |
Komprimiertes Datenformat. |
DataRegistry
Die Datenregistrierung in Azure Maps.
Name | Typ | Beschreibung |
---|---|---|
azureBlob |
Details zur Azure-Blobdatenregistrierung. |
|
description |
string |
Die Beschreibung, die der Datenregistrierung gegeben wird. Die maximale Länge beträgt 1024 Zeichen. |
error |
Die Fehlerdetails. |
|
kind |
Art der Datenregistrierung. |
|
status |
Der Status eines Vorgangs mit langer Ausführungsdauer. |
|
udid |
string |
Die Benutzerdaten-ID für die Datenregistrierung. |
DataRegistryKind
Art der Datenregistrierung.
Name | Typ | Beschreibung |
---|---|---|
AzureBlob |
string |
Azure Blob |
DataRegistryList
Das Antwortmodell für die Listen-API der Datenregistrierung. Gibt eine Liste aller zuvor registrierten Daten zurück.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Die URL zum Abrufen des nächsten Datensatzes. |
value |
Ein Array von Datenregistrierungen. |
LongRunningOperationStatus
Der Status eines Vorgangs mit langer Ausführungsdauer.
Name | Typ | Beschreibung |
---|---|---|
Completed |
string |
Die Anforderung wurde erfolgreich abgeschlossen. |
Failed |
string |
Die Anforderung weist einen oder mehrere Fehler auf. |
Running |
string |
Die Anforderung wird derzeit verarbeitet. |
MapsErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Einer von einem serverdefiniertem Satz von Fehlercodes. |
details |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
|
innererror |
Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Eine lesbare Darstellung des Fehlers. |
target |
string |
Das Ziel des Fehlers. |
MapsErrorResponse
Häufige Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Fehlerdetails. |
MapsInnerError
Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
innererror |
Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |