Dataset - Create

Referens

Tjänst:: Maps Creator

API-version:: 2.0

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

Anmärkning

Azure Maps Creator-tillbakadragning

Inomhuskartetjänsten för Azure Maps Creator är nu inaktuell och kommer att dras tillbaka den 25-09-30. Mer information finns i Meddelande om slut på livslängd för Azure Maps Creator.

Create-API:et är en HTTP-POST begäran som tar conversionId värdet för det konverterade ritpaketet och returnerar egenskapen datasetId 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 hjälp av Tjänsten Azure Maps Conversion och skapa en datauppsättning från det konverterade zip-paketet. Den skapade datamängden kan användas för att skapa paneluppsättningar med hjälp av Azure Maps Tileset-tjänsten och kan efterfrågas via Tjänsten Azure Maps WFS.

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-zip-paketet. Parametern datasetId är ID:t för en tidigare skapad datauppsättning som ska läggas till med den aktuella datamängden och om du vill innehåller description frågeparametern en beskrivning (om beskrivningen inte anges ges en standardbeskrivning).

Skapa API är en tidskrävande åtgärd.

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

Med valfria parametrar:

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 Konvertera API och kan ha flera frågeparametrar med samma namn (om fler än en tillhandahålls).
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ättningar som matchar datauppsättningenId
description	query		string	Beskrivningen som ska ges till datamängden.

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äkerhetsmodellen. 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 för vägledning.

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. Sidhuvuden Resource-Location: string
202 Accepted		Begäran har godkänts: Begäran har godkänts för bearbetning. Använd URL:en i Operation-Location-rubriken för att hämta status. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Ett oväntat fel uppstod.

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.

Sidhuvuden

Resource-Location: string

202 Accepted

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

Sidhuvuden

Operation-Location: string

Other Status Codes

ErrorResponse

Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll 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-resurskonton 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 till 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.

Noteringar

Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.

Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, 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.

Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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 Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

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

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

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, 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 till 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 återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Create dataset from a converted CAD file provided by conversionId

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Statuskod:: 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

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

LongRunningOperationResult

Objekt

Svarsmodellen för ett Long-Running Operations API.

Name	Typ	Description
created	string (date-time)	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

Uppräkning

Statustillståndet för begäran.

Värde	Description
Failed	Begäran har ett eller flera fel.
NotStarted	Begäran har inte börjat bearbetas ännu.
Running	Begäran har börjat bearbetas.
Succeeded	Begäran har slutförts.

Dela via

Dataset - Create

Skicka skapa begäran

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Noteringar

Omfattningar

subscription-key

SAS Token

Exempel

Create dataset from a converted CAD file provided by conversionId

Exempelbegäran

Exempelsvar

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

Ytterligare resurser