Render - Get Copyright Caption
Dient zum Abrufen von Copyrightinformationen, die beim Rendern einer Kachel verwendet werden sollen.
Hinweis
Einstellung des Azure Maps-Renderingdiensts v1
Der Azure Maps Render v1-Dienst ist jetzt veraltet und wird am 17.09.26. eingestellt. Um Dienstunterbrechungen zu vermeiden, müssen alle Aufrufe der Render v1-API aktualisiert werden, um die neueste Version der Render-API bis zum 17.09.26 zu verwenden.
Die Copyrights-API wurde entwickelt, um Copyrightinformationen für den Renderkacheldienst zu verwenden. Neben dem grundlegenden Urheberrecht für die gesamte Karte dient die API bestimmten Gruppen von Urheberrechten für einige Länder.
Als Alternative zu Copyrights für Kartenanforderung kann man Beschriftungen zum Anzeigen der Kartenanbieterinformationen auf der Karte erhalten.
GET https://atlas.microsoft.com/map/copyright/caption/{format}?api-version=1.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
format
|
path | True |
Gewünschtes Format der Antwort. Der Wert kann entweder JSON- oder XML-sein. |
|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps-API. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-id |
string |
Gibt das Konto an, das für die Verwendung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann über die Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OKAY |
|
Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.
Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.
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 Karten-Verwaltungs-APIerworben werden.
Die Authorization URL
ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen.
* Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das 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 zur Microsoft Identity Platform finden Sie unter Übersicht über die 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 freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.
Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
query
SAS Token
Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.
Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Typ:
apiKey
In:
header
Beispiele
Successful Copyright Caption Request
Beispielanforderung
GET https://atlas.microsoft.com/map/copyright/caption/json?api-version=1.0
Beispiel für eine Antwort
{
"formatVersion": "0.0.1",
"copyrightsCaption": "© 1992 - 2017 TomTom."
}
Definitionen
Name | Beschreibung |
---|---|
Copyright |
Dieses Objekt wird von einem erfolgreichen Copyright-Aufruf zurückgegeben. |
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Das Fehlerdetails. |
Error |
Fehlerantwort |
Response |
Gewünschtes Format der Antwort. Der Wert kann entweder JSON- oder XML-sein. |
CopyrightCaption
Dieses Objekt wird von einem erfolgreichen Copyright-Aufruf zurückgegeben.
Name | Typ | Beschreibung |
---|---|---|
copyrightsCaption |
string |
Copyrights Caption-Eigenschaft |
formatVersion |
string |
Format Version-Eigenschaft |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
ResponseFormat
Gewünschtes Format der Antwort. Der Wert kann entweder JSON- oder XML-sein.
Wert | Beschreibung |
---|---|
json | |
xml |