Dataset - Create

  • Referens
Service:
Maps Creator
API Version:
2.0

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

API:et Create är en HTTP-begäran POST som tar conversionId värdet för det konverterade ritpaketet och returnerar datasetId egenskapen för den nyligen skapade datauppsättningen. Mer information finns i Skapa en datauppsättning.

Du kan använda den här begäran i ett scenario som att ladda upp ett DWG-zip-paket för en byggnad, konvertera zip-paketet med Azure Maps konverteringstjänsten och skapa en datauppsättning från det konverterade zip-paketet. Den skapade datauppsättningen kan användas för att skapa paneluppsättningar med hjälp av tjänsten Azure Maps Tileset och kan efterfrågas via Azure Maps WFS-tjänsten.

Skicka skapa begäran

Om du vill skapa datauppsättningen använder du en POST begäran där conversionId frågeparametern är ett ID som representerar det konverterade DWG-zippaketet. datasetId Parametern är ID:t för en tidigare skapad datauppsättning som ska läggas till med den aktuella datauppsättningen och om du vill description kan frågeparametern innehålla en beskrivning (om beskrivningen inte tillhandahålls kommer en standardbeskrivning att anges).

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

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

URI-parametrar

Name I Obligatorisk Typ Description
geography
 path True

string

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

string

Versionsnummer för Azure Maps API.
conversionId
 query True

string

Det unika ID som används för att skapa datauppsättningen. conversionId Måste ha hämtats från ett lyckat anrop till konverteringstjänsten Convert API och kan tillhandahållas med flera frågeparametrar med samma namn (om fler än ett anges).
datasetId
 query

string

ID:t för datauppsättningen som ska läggas till med. Datamängden måste komma från ett tidigare anrop för att skapa datauppsättningen som matchar datasetId
description
 query

string

Beskrivningen som ska ges till datauppsä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. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. 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-rubriken 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 ett 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 ha å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-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Rollbaserad åtkomstkontroll i Azure 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 huvudnyckel i det konto som de har utfärdats 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 säkrare 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 återgivningsmissbruket och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Create dataset from a converted CAD file provided by conversionId

Sample Request

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

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/datasets/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

Ytterligare information.
type

string

Den ytterligare informationstypen.

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 börjat bearbetas än.
Running

string

Begäran har börjat bearbetas.
Succeeded

string

Begäran har slutförts.