Alias - Create

Riferimento

Service:: Maps Creator

API Version:: 2.0

Usare per creare un alias.

L'API Create è una richiesta HTTP POST che consente al chiamante di creare un alias e, facoltativamente, assegnarlo a una risorsa. Un alias può fare riferimento a un ID generato da un servizio creatore, ma non può fare riferimento a un altro ID alias.

Invia richiesta di creazione

Per creare l'alias, si userà una POST richiesta. Se si vuole assegnare l'alias durante la creazione, si passerà il resourceId parametro di query.

Creare una risposta alias

L'API Crea restituisce una risposta HTTP 201 Created con la risorsa alias nel corpo.

Risposta di esempio dalla creazione di un alias:

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

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
geography	path	True	string	Questo parametro specifica dove si trova la risorsa Mappe di Azure Creator. I valori validi sono noi ed eu.
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.
creatorDataItemId	query		string	ID univoco che fa riferimento a un elemento di dati creator da aliasare.

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

201 Created

Nome	Tipo	Descrizione
201 Created	Alias	Contenuto creato correttamente. Il corpo della risposta contiene l'ID `aliasId`alias appena creato. Headers Access-Control-Expose-Headers: string
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Alias

Contenuto creato correttamente. Il corpo della risposta contiene l'ID aliasIdalias appena creato.

Headers

Access-Control-Expose-Headers: string

Other Status Codes

ErrorResponse

Si è verificato un errore imprevisto.

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 dispongono di 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 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.

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

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 quando si crea un account Mappe di Azure nell'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 delle applicazioni client riservate per accedere alle API REST Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Type: apiKey
In: query

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

Create an alias that does not reference any resource

Sample Request

HTTP

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

Sample Response

Status code:: 201

{
  "createdTimestamp": "2021-05-01T01:02:03.456Z",
  "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012",
  "creatorDataItemId": null,
  "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z"
}

Definizioni

Nome	Descrizione
Alias	Informazioni dettagliate per l'alias.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore

Alias

Informazioni dettagliate per l'alias.

Nome	Tipo	Descrizione
aliasId	string	ID dell'alias.
createdTimestamp	string	Timestamp creato per l'alias.
creatorDataItemId	string	ID per l'elemento dati dell'autore a cui fa riferimento questo alias (potrebbe essere null se l'alias non è stato assegnato).
lastUpdatedTimestamp	string	Timestamp dell'ultima volta che è stato assegnato l'alias.

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.

Alias - Create

Invia richiesta di creazione

Creare una risposta alias

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Note

Scopes

subscription-key

SAS Token

Esempio

Create an alias that does not reference any resource

Sample Request

Sample Response

Definizioni

Alias

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Risorse aggiuntive