Tileset - Create

  • Referens
Service:
Maps Creator
API Version:
2.0

Använd för att skapa en paneluppsättning.

API:et Create är en HTTP-begäran POST som används för att skapa en paneluppsättning från den angivna datauppsättningen. Mer information finns i Skapa en paneluppsättning. En paneluppsättning innehåller en uppsättning paneler som kan användas med hjälp av Hämta kartpanel för att hämta anpassade paneler. Om du vill skapa en datauppsättning använder du Skapa datauppsättning. En introduktion till begrepp och verktyg som gäller för Azure Maps Creator finns i Creator för inomhuskartor.

API:et Create Tileset är en tidskrävande åtgärd.

Skicka skapa begäran

Om du vill skapa din paneluppsättning gör du en POST begäran med en tom brödtext. Frågeparametern datasetId används som källa för paneluppsättningsdata.

POST https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0&datasetId={datasetId}
With optional parameters: 
POST https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0&datasetId={datasetId}&description={description}

URI-parametrar

Name I Obligatorisk Typ Description
geography
 path True

string

Den här parametern anger var resursen Azure Maps Creator finns. Giltiga värden är oss och EU.
api-version
 query True

string

Versionsnummer för Azure Maps API.
datasetId
 query True

string

Det unika datasetId som paneluppsättningen skapar API:et använder för att hämta funktioner för att generera paneler. datasetId måste ha hämtats från ett lyckat API-anrop för datauppsättningsskapande.
description
 query

string

Användaren har angett en beskrivning av paneluppsättningen.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name Typ Description
200 OK

LongRunningOperationResult

Åtgärden körs eller slutförs. Om åtgärden lyckades använder du Resource-Location-huvudet för att hämta sökvägen till resultatet.

Headers

Resource-Location: string
202 Accepted

Begäran accepterad: Begäran har godkänts för bearbetning. Använd URL:en i Operation-Location-huvudet för att hämta status.

Headers

Operation-Location: string
Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

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

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de utfärdas i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Create Tileset by providing a Dataset Id

Sample Request

POST https://us.atlas.microsoft.com/tilesets?api-version=2.0&datasetId=[dataset-Id]

Sample Response

Status code:
200 
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
Response Body
{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}
Status code:
202 
Operation-Location: https://us.atlas.microsoft.com/tilesets/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
LongRunningOperationResult

Svarsmodellen för ett Long-Running Operations-API.
LroStatus

Statustillståndet för begäran.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.
type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

LongRunningOperationResult

Svarsmodellen för ett Long-Running Operations-API.

Name Typ Description
created

string

Den skapade tidsstämpeln.
error

ErrorDetail

Felinformationen.
operationId

string

ID:t för den här långvariga åtgärden.
status

LroStatus

Statustillståndet för begäran.
warning

ErrorDetail

Felinformationen.

LroStatus

Statustillståndet för begäran.

Name Typ Description
Failed

string

Begäran har ett eller flera fel.
NotStarted

string

Begäran har inte påbörjat bearbetningen ännu.
Running

string

Begäran har börjat bearbetas.
Succeeded

string

Begäran har slutförts.