Share via

Render - Get Map State Tile

  • Riferimento
Service:
Maps
API Version:
2022-08-01

Usare per ottenere riquadri di stato in formato vettore che possono quindi essere usati per visualizzare le informazioni sullo stato delle funzionalità in una mappa interna.

L'API Get Map State Tile è una richiesta HTTP GET che recupera i riquadri di stato in formato vettore, in genere da integrare nel modulo mappe interne di un controllo mappa o di un SDK. Il controllo mappa chiama questa API dopo l'attivazione dello stile dinamico. Per altre informazioni, vedere Livelli di zoom e Griglia di riquadri.

GET https://atlas.microsoft.com/map/statetile?api-version=2022-08-01&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
api-version
 query True

string

Numero di versione dell'API Mappe di Azure. La versione corrente è 2022-08-01
statesetId
 query True

string

ID del set di stati.
x
 query True

integer

int32

Coordinata X del riquadro sulla griglia di zoom. Il valore deve trovarsi nell'intervallo [0, 2zoom -1].

Per informazioni dettagliate, vedere Livelli di zoom e Griglia di riquadri .
y
 query True

integer

int32

Coordinata Y del riquadro sulla griglia di zoom. Il valore deve trovarsi nell'intervallo [0, 2zoom -1].

Per informazioni dettagliate, vedere Livelli di zoom e Griglia di riquadri .
zoom
 query True

integer

int32

Livello di zoom per il riquadro desiderato.

Per informazioni dettagliate, vedere Livelli di zoom e Griglia di riquadri .

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-id

string

Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API del piano di gestione Mappe di Azure. Per usare Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Risposte

Nome Tipo Descrizione
200 OK

object

Questo riquadro viene restituito da una chiamata Get Map State Tile riuscita

Media Types: "application/vnd.mapbox-vector-tile", "application/json"

Headers

Content-Type: string
Other Status Codes

ErrorResponse

Si è verificato un errore imprevisto.

Media Types: "application/vnd.mapbox-vector-tile", "application/json"

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Quando è associato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. Qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Note

  • Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni Microsoft Entra ID. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST. * L'utilizzo dell'SDK Web Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

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

Scopes

Nome Descrizione
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene eseguito il provisioning durante la creazione di una risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.

Con questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere attualmente considerati come chiavi master per l'account per cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'accesso da server a server delle API REST Mappe di Azure in cui questa chiave può essere archiviata in modo sicuro.

Type: apiKey
In: header

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenco firma di accesso condiviso nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso basati sul ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Type: apiKey
In: header

Esempio

Successful State Tile Request

Sample Request

GET https://atlas.microsoft.com/map/statetile?api-version=2022-08-01&zoom=6&x=10&y=22&statesetId=[statesetId]

Sample Response

Status code:
200 
Content-Type: application/vnd.mapbox-vector-tile
Response Body
"{file}"

Definizioni

Nome Descrizione
ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.