Conversion - Get

Gilt für: Siehe Tarife.

Creator ermöglicht die Entwicklung von Anwendungen basierend auf Ihren privaten Gebäudeplandaten mithilfe von Azure Karten API und SDK. In diesem Artikel werden Konzepte und Tools vorgestellt, die für Azure Karten Creator gelten.

Mit dieser API kann der Aufrufer eine erfolgreiche Datenkonvertierung abrufen, die zuvor mit der Konvertierungs-API übermittelt wurde.

GET https://{geography}.atlas.microsoft.com/conversions/{conversionId}?api-version=2.0

URI-Parameter

Name In Required Type Description
conversionId
path True
  • string

Die Konvertierungs-ID für den Inhalt. Muss conversionId von einem erfolgreichen Konvertierungs-API-Aufruf abgerufen worden sein.

geography
path True
  • string

Dieser Parameter gibt an, wo sich die Azure Karten Creator-Ressource befindet. Gültige Werte sind us und eu.

api-version
query True
  • string

Versionsnummer der Azure Karten-API.

Anforderungsheader

Name Required Type Description
x-ms-client-id
  • string

Gibt an, welches Konto für die Verwendung in Verbindung mit dem Azure AD-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Karten-Konto dar und kann von der Konto-API der Azure Karten-Verwaltungsebene abgerufen werden. Informationen zur Verwendung Azure AD Sicherheit in Azure Karten finden Sie in den folgenden Artikeln.

Antworten

Name Type Description
200 OK

Gibt Details der angegebenen Konvertierung zurück.

Other Status Codes

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung von Azure kann sie verwendet werden, um den Zugriff auf Azure Karten REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf mindestens ein Azure Karten-Ressourcenkonto oder untergeordnete Ressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus mindestens einer Berechtigung für Azure Karten REST-APIs besteht.

Um Szenarien zu implementieren, wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die zugriffssteuerungsfähig für bestimmte APIs und Bereiche sind.

Notizen

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id -Headers, um anzugeben, auf welche Azure Karten Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-API erworben werden.

ist Authorization URL spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-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 Karten Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

  • Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Arbeits-, Schul- und Gastkonten, aber keine persönlichen Konten.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen einer Azure Karten-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. Anders ausgedrückt: Diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Karten REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Dies ist ein SAS-Token für den gemeinsamen Zugriff, das aus dem Vorgang SAS auflisten für die Azure Karten-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer differenzierten Steuerung des Ablaufs, der Rate und der Regionen autorisiert, die für das jeweilige Token verwendet werden. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf sicherere Weise als der gemeinsam genutzte Schlüssel zu ermöglichen.

Für öffentlich verfügbar gemachte Anwendungen empfiehlt es sich, eine bestimmte Liste zulässiger Ursprünge in der Map-Kontoressource zu konfigurieren, um Rendering-Missbrauch einzuschränken und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Get the details for one conversion operation

Sample Request

GET https://us.atlas.microsoft.com/conversions/54398242-ea6c-1f31-4fa6-79b1ae0fc24d?api-version=2.0

Sample Response

{
  "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d",
  "udid": "31838736-8b84-11ea-bc55-0242ac130003",
  "created": "5/19/2020 9:00:00 AM +00:00",
  "description": "User provided description.",
  "ontology": "facility-2.0",
  "featureCounts": {
    "directoryInfo": 1,
    "level": 3,
    "facility": 1,
    "unit": 150,
    "category": 8,
    "areaElement": 0,
    "opening": 10
  }
}

Definitionen

Conversion

Ausführliche Informationen zu den Konvertierungsanforderungen.

ErrorAdditionalInfo

Zusätzliche Informationen zu Ressourcenverwaltungsfehlern.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

Conversion

Ausführliche Informationen zu den Konvertierungsanforderungen.

Name Type Description
conversionId
  • string

Eine eindeutige ID, die das Artefakt eines erfolgreich abgeschlossenen Konvertierungsprozesses darstellt.

created
  • string

Das Datum und die Uhrzeit dieser Konvertierung.

description
  • string

Der Benutzer hat eine Beschreibung des inhalts bereitgestellt, der konvertiert wird.

featureCounts
  • object

Eine Zusammenfassung der Featureanzahl in dieser Konvertierung.

ontology
  • string

Die Ontologieversion dieses Datasets.

udid
  • string

Die eindeutige ID des Inhalts, der zum Erstellen dieser Konvertierung bereitgestellt wird.

ErrorAdditionalInfo

Zusätzliche Informationen zu Ressourcenverwaltungsfehlern.

Name Type Description
info
  • object

Die zusätzlichen Informationen.

type
  • string

Der zusätzliche Infotyp.

ErrorDetail

Die Fehlerdetails.

Name Type Description
additionalInfo

Die zusätzlichen Informationen zum Fehler.

code
  • string

Der Fehlercode.

details

Die Fehlerdetails.

message
  • string

Die Fehlermeldung.

target
  • string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Type Description
error

Das Fehlerobjekt.