Alias - List

Riferimento

Servizio:: Maps Creator

Versione API:: 2.0

Usare per ottenere un elenco di alias.

Nota

Ritiro di Creator di Mappe di Azure

Il servizio per la creazione di piante dell'interno Creator di Mappe di Azure è ora deprecato e verrà ritirato il 30/09/25. Per altre informazioni, vedere Annuncio di fine vita di Creator di Mappe di Azure.

L'API List è una richiesta http GET che consente al chiamante di recuperare un elenco di tutti gli alias esistenti.

Invia richiesta elenco

Per elencare tutti gli alias, si eseguirà una richiesta di GET senza parametri aggiuntivi.

Elencare la risposta ai dati

L'API Elenco restituisce l'elenco completo di tutti gli alias in formato json. La risposta contiene i dettagli seguenti per ogni risorsa alias:

createdTimestamp: timestamp creato dall'alias. Format yyyy-MM-ddTHH:mm:ss.sssZ aliasId - ID per l'alias. creatorDataItemId: ID per l'elemento di dati creator a cui fa riferimento questo alias (potrebbe essere Null se l'alias non è stato assegnato). lastUpdatedTimestamp: ora dell'ultima assegnazione dell'alias a una risorsa. Formato aa-MM-ggTHH:mm:ss.sssZ

Risposta di esempio che restituisce 2 risorse alias:

{
  "aliases": [
    {
      "createdTimestamp": "2020-02-13T21:19:11.123Z",
      "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
      "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
      "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
    },
    {
      "createdTimestamp": "2020-02-18T19:53:33.123Z",
      "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
      "creatorDataItemId": null,
      "lastUpdatedTimestamp": "2020-02-18T19:53:33.123Z"
    }
  ]
}

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
geography	path	True	string	Questo parametro specifica dove si trova la risorsa Creator di Mappe di Azure. I valori validi sono noi ed eu.
api-version	query	True	string	Numero di versione dell'API mappe di Azure.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica quale 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 dell'account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli di seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	AliasListResult	Elencare la richiesta alias completata. Il corpo della risposta contiene un elenco di tutti gli alias creati in precedenza.
Other Status Codes	ErrorResponse	Errore imprevisto.

Sicurezza

AADToken

Questi sono i flussi di Microsoft Entra OAuth 2.0. Se abbinato a l'accesso in base al ruolo di Azure controllarlo, può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. A 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 le API REST di Mappe di Azure.

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

Note

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

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

Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

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

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si Creare un account di Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nell'risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le 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.

Tipo: apiKey
In: header

Esempio

List all the previously created aliases

Esempio di richiesta

HTTP

GET https://us.atlas.microsoft.com/aliases?api-version=2.0

Risposta di esempio

Codice di stato:: 200

{
  "aliases": [
    {
      "createdTimestamp": "2020-02-13T21:19:11+00:00",
      "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
      "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
      "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00"
    },
    {
      "createdTimestamp": "2020-02-13T21:19:11+00:00",
      "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
      "creatorDataItemId": null,
      "lastUpdatedTimestamp": "2020-02-13T21:19:11+00:00"
    }
  ]
}

Definizioni

Nome	Descrizione
Alias	Informazioni dettagliate per l'alias.
AliasListResult	Modello di risposta per l'API List. Restituisce un elenco di tutti gli alias creati in precedenza.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore

Alias

Object

Informazioni dettagliate per l'alias.

Nome	Tipo	Descrizione
aliasId	string	ID dell'alias.
createdTimestamp	string (date-time)	Timestamp creato per l'alias.
creatorDataItemId	string	ID per l'elemento di dati creator a cui fa riferimento questo alias (può essere Null se l'alias non è stato assegnato).
lastUpdatedTimestamp	string (date-time)	Timestamp dell'ultima assegnazione dell'alias.

AliasListResult

Object

Modello di risposta per l'API List. Restituisce un elenco di tutti gli alias creati in precedenza.

Nome	Tipo	Descrizione
aliases	Alias[]	Elenco di tutti gli alias creati in precedenza.
nextLink	string	Se presente, la posizione della pagina successiva dei dati.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

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

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

Condividi tramite

Alias - List

Invia richiesta elenco

Elencare la risposta ai dati

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Note

Ambiti

subscription-key

SAS Token

Esempio

List all the previously created aliases

Esempio di richiesta

Risposta di esempio

Definizioni

Alias

AliasListResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse