Data Registry - Register Or Replace

Referenz

Dienst:: Maps

API-Version:: 2023-06-01

Dient zum Registrieren von Daten, die in einem Azure Storage-Konto bei einem Azure Maps-Konto gespeichert sind.

Die Register API ist eine HTTP-Anforderung PUT , die verwendet wird, um die Daten in einem Azure Storage-Konto bei einem Azure Maps-Konto zu registrieren. 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 im 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 Datenregistrierungsdienstendpunkt ist im Bereich auf die Region Ihres Azure Maps-Kontos beschränkt und für globale Azure Maps-Konten nicht verfügbar.

Übermitteln der Registrierungs- oder Ersetzungsanforderung

Die Register Anforderungen und Replace sind sowohl Vorgänge mit langer Ausführungsdauer, die ein AzureBlob-JSON-Objekt im Text 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

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).
udid	path	True	string	Die Benutzerdaten-ID der Datenregistrierung. RegEx-Muster: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
api-version	query	True	string	Die Versionsnummer der Azure Maps-API.

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

udid

path

True

string

Die Benutzerdaten-ID der Datenregistrierung.

RegEx-Muster: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

api-version

query

True

string

Die Versionsnummer der Azure Maps-API.

Anforderungsheader

Name Erforderlich Typ Beschreibung

x-ms-client-id

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 .
Operation-Id		string	Die Vorgangs-ID im GUID-Format. RegEx-Muster: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`

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 .

Operation-Id

string

Die Vorgangs-ID im GUID-Format.

RegEx-Muster: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

Anforderungstext

Name	Typ	Beschreibung
azureBlob	AzureBlob	Details zur Azure-Blobdatenregistrierung.
description	string	Die Beschreibung, die der Datenregistrierung gegeben wird. Die maximale Länge beträgt 1024 Zeichen.
kind	DataRegistryKind	Art der Datenregistrierung.

Antworten

Name	Typ	Beschreibung
200 OK	DataRegistry	Ressourcenersetzung: Die Anforderung wurde zur Verarbeitung akzeptiert. Header Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Erstellen von Ressourcen: Die Anforderung wurde zur Verarbeitung akzeptiert. Header Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Ein unerwarteter Fehler ist aufgetreten. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

DataRegistry

Ressourcenersetzung: Die Anforderung wurde zur Verarbeitung akzeptiert.

Header

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

Erstellen von Ressourcen: Die Anforderung wurde zur Verarbeitung akzeptiert.

Header

Operation-Id: string
Operation-Location: string

Other Status Codes

MapsErrorResponse

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

Register or replace a udid

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 201

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

Statuscode:: 200

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
AzureBlob	Details zur Azure-Blobdatenregistrierung.
DataFormat	Das Datenformat des hochgeladenen Inhalts, der zu Validierungszwecken verwendet wird.
DataRegistry	Die Datenregistrierung in Azure Maps.
DataRegistryKind	Art der Datenregistrierung.
LongRunningOperationStatus	Der Status eines Vorgangs mit langer Ausführungsdauer.
MapsErrorDetail	Die Fehlerdetails.
MapsErrorResponse	Häufige Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.
MapsInnerError	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	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	AzureBlob	Details zur Azure-Blobdatenregistrierung.
description	string	Die Beschreibung, die der Datenregistrierung gegeben wird. Die maximale Länge beträgt 1024 Zeichen.
error	MapsErrorDetail	Die Fehlerdetails.
kind	DataRegistryKind	Art der Datenregistrierung.
status	LongRunningOperationStatus	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

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	MapsErrorDetail[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	MapsInnerError	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	MapsErrorDetail	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	MapsInnerError	Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

Freigeben über

Data Registry - Register Or Replace

Übermitteln der Registrierungs- oder Ersetzungsanforderung

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

AADToken

Hinweise

Bereiche

subscription-key

SAS Token

Beispiele

Register or replace a udid

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Zusätzliche Ressourcen