Data Registry - Register Or Replace
Verwenden Sie zum Registrieren von Daten, die in einem Azure Storage-Konto mit einem Azure Maps Konto gespeichert sind.
Die Register
API ist eine HTTP-AnforderungPUT
, die zum Registrieren der Daten in einem Azure Storage-Konto mit einem Azure Maps-Konto verwendet wird. Die maximale Dateigröße, die registriert werden kann, beträgt ein Gigabyte.
Dies ist nützlich in Szenarien wie der Registrierung einer Sammlung von Geofences im GeoJSON
Format für die Verwendung in Azure Maps Geofencing Service oder das Registrieren einer Reihe von DWG-Entwurfsdateien als gezipptes Zeichnungspaket für die Verwendung im Azure Maps Creator-Konvertierungsdienst.
Der Endpunkt des Datenregistrierungsdiensts ist auf die Region Ihres Azure Maps-Kontos beschränkt und für globale Azure Maps-Konten nicht verfügbar.
Übermitteln von Registrierungs- oder Ersatzanforderung
Die Register
Anforderungen und Replace
sind sowohl Vorgänge mit langer Ausführungsdauer, die ein AzureBlob-JSON-Objekt im Textkörper der Anforderung enthalten, das die Datenregistrierungsdetails definiert.
PUT https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?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 2) und eu (Europa, Norden, Europa, Westen). |
udid
|
path | True |
string |
Die Benutzerdaten-ID der Datenregistrierung. Regex pattern: |
api-version
|
query | True |
string |
Die Versionsnummer 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. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln. |
|
Operation-Id |
string |
Die Vorgangs-ID im GUID-Format. Regex pattern: |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
azureBlob |
Registrierungsdetails für Azure-Blobdaten. |
|
description |
string |
Die Beschreibung, die der Datenregistrierung gegeben wird. Die maximale Länge beträgt 1024 Zeichen. |
kind |
Datenregistrierungsart. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Ressourcenersetzung: Die Anforderung wurde für die Verarbeitung akzeptiert. Headers
|
|
201 Created |
Ressourcenerstellung: Die Anforderung wurde für die Verarbeitung akzeptiert. Headers
|
|
Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. Headers x-ms-error-code: string |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem 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.
Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.
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.
Der Authorization URL
ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen.
* Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, 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 Microsoft Identity Platform Übersicht.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dies ist ein gemeinsam genutzter Schlüssel, der beim Erstellen einer Azure Maps Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, 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 master Schlü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.
Type:
apiKey
In:
header
SAS Token
Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.
Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Type:
apiKey
In:
header
Beispiele
Register or replace a udid
Sample Request
PUT https://us.atlas.microsoft.com/dataRegistries/29a92cab-74af-49e7-a326-66898220aa9d?api-version=2023-06-01
{
"description": "Contoso Geofence GeoJSON",
"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/path.json"
}
}
Sample Response
Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2
{
"udid": "29a92cab-74af-49e7-a326-66898220aa9d",
"description": "Contoso Geofence GeoJSON",
"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/path.json",
"sizeInBytes": 1339
},
"status": "Running"
}
Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2
{
"udid": "29a92cab-74af-49e7-a326-66898220aa9d",
"description": "Contoso Geofence GeoJSON",
"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/path.json",
"sizeInBytes": 1339
},
"status": "Running"
}
Definitionen
Name | Beschreibung |
---|---|
Azure |
Registrierungsdetails für Azure-Blobdaten. |
Data |
Das Datenformat des hochgeladenen Inhalts, der zu Validierungszwecken verwendet wird. |
Data |
Die Datenregistrierung in Azure Maps. |
Data |
Datenregistrierungsart. |
Long |
Die 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
Registrierungsdetails für Azure-Blobdaten.
Name | Typ | Beschreibung |
---|---|---|
blobUrl |
string |
Die Blob-URL enthält den Pfad zu der zu registrierenden Datei. |
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 |
Registrierungsdetails für Azure-Blobdaten. |
|
description |
string |
Die Beschreibung, die der Datenregistrierung gegeben wird. Die maximale Länge beträgt 1024 Zeichen. |
error |
Die Fehlerdetails. |
|
kind |
Datenregistrierungsart. |
|
status |
Die status eines Vorgangs mit langer Ausführungsdauer. |
|
udid |
string |
Die Benutzerdaten-ID für die Datenregistrierung. |
DataRegistryKind
Datenregistrierungsart.
Name | Typ | Beschreibung |
---|---|---|
AzureBlob |
string |
Azure Blob |
LongRunningOperationStatus
Die status eines Vorgangs mit langer Ausführungsdauer.
Name | Typ | Beschreibung |
---|---|---|
Completed |
string |
Die Anforderung wurde erfolgreich abgeschlossen. |
Failed |
string |
Die Anforderung weist mindestens einen Fehler auf. |
Running |
string |
Die Anforderung wird derzeit verarbeitet. |
MapsErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Einer der vom Server definierten 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 für Menschen 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. |