Dataset - List

Referens

Tjänst:: Maps Creator

API-version:: 2.0

Använd för att hämta en lista över alla befintliga datauppsättningar.

Anteckning

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.

Om du vill visa en lista över alla dina datauppsättningar utfärdar du en GET begäran utan ytterligare parametrar.

Listdatasvar

List-API:et returnerar den fullständiga listan över alla datauppsättningar i json format. Svaret innehåller följande fält (om de inte är null eller tomma):

skapad – Tidsstämpeln som datamängden skapades. datasetId – ID för datauppsättningen. description – Beskrivningen för datamängden. datasetSources – källdata som användes när begäran om att skapa utfärdades. ontologi – källan ontologi som användes i konverteringstjänsten för indata.

datasetSources beskriver de källdata som användes när begäran om att skapa utfärdades och innehåller följande element (om de inte är null eller tomma):

conversionIds – listan över conversionId (null om ingen angavs). appendDatasetId – den datasetId som användes för en tilläggsåtgärd (null om ingen användes). featureCounts – antalet för varje funktionstyp i datamängden.

Här är ett exempelsvar som returnerar timestamp, datasetId, description, datasetSourcesoch ontology med 3 datauppsättningsresurser:

{
  "datasets": [
    {
      "timestamp": "2020-01-01T22:50:48.123Z",
      "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Some description or comment for the dataset.",
      "datasetSources": {
        "conversionIds": [
          "15d21452-c9bb-27b6-5e79-743ca5c3205d"
        ],      },
      "": "facility-2.0",
      "featureCounts": {
        "directoryInfo": 2,
        "category": 10,
        "facility": 1,
        "level": 3,
        "unit": 183,
        "zone": 3,
        "verticalPenetration": 6,
        "opening": 48,
        "areaElement": 108
      }
    },
    {
      "timestamp": "2020-01-01T22:57:53.123Z",
      "datasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "description": "Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.",
      "datasetSources": {
        "conversionIds": [
          "0c1288fa-2058-4a1b-b68d-13a5f5af7d7c"
        ],
        "appendDatasetId": "46d1edb6-d29e-4786-9589-dbd4efd7a977"
      },
      "ontology": "facility-2.0",
      "featureCounts": {
        "directoryInfo": 2,
        "category": 10,
        "facility": 1,
        "level": 3,
        "unit": 183,
        "zone": 3,
        "verticalPenetration": 6,
        "opening": 48,
        "areaElement": 108
      }
    }
  ]
}

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

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.

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	DatasetListResult	Datamängdsbegäran har slutförts. Svarstexten innehåller den tidigare skapade datamängden.
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

List all the previously created datasets

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "datasets": [
    {
      "created": "2021-05-21T03:04:05.678Z",
      "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Some description or comment for the dataset.",
      "datasetSources": {
        "conversionIds": [
          "db63843c-3c70-4b4e-94ff-dfcf4013c4a9"
        ]
      },
      "featureCounts": {
        "directoryInfo": 1,
        "category": 18,
        "facility": 1,
        "level": 6,
        "unit": 775,
        "opening": 471,
        "areaElement": 496
      },
      "ontology": "facility-2.0"
    },
    {
      "created": "2021-05-21T03:04:05.678Z",
      "datasetId": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "description": "Some other description or comment for the dataset.",
      "datasetSources": {
        "conversionIds": [
          "15d21452-c9bb-27b6-5e79-743ca5c3205d"
        ],
        "appendDatasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c"
      },
      "featureCounts": {
        "directoryInfo": 2,
        "category": 10,
        "facility": 1,
        "level": 3,
        "unit": 183,
        "zone": 3,
        "verticalPenetration": 6,
        "opening": 48,
        "areaElement": 108
      },
      "ontology": "facility-2.0"
    }
  ]
}

Definitioner

Name	Description
Dataset	Detaljerad information för datauppsättningen.
DatasetListResult	Svarsmodellen för API:et datauppsättningslista. Svarstexten innehåller en lista över alla tidigare skapade datamängder.
DatasetSources	Information om information om begäran om att skapa för datamängden.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar

Dataset

Objekt

Detaljerad information för datauppsättningen.

Name	Typ	Description
created	string (date-time)	Den skapade tidsstämpeln för datamängden.
datasetId	string	ID:t för datauppsättningen.
datasetSources	DatasetSources	Information om information om begäran om att skapa för datamängden.
description	string	Beskrivningen för datamängden.
featureCounts	object	Funktionen räknas för datamängden.
ontology	string	Ontologiversionen av den här datamängden.

DatasetListResult

Objekt

Svarsmodellen för API:et datauppsättningslista. Svarstexten innehåller en lista över alla tidigare skapade datamängder.

Name	Typ	Description
datasets	Dataset[]	En lista över alla tidigare skapade datauppsättningar.
nextLink	string	Om det finns plats för nästa sida med data.

DatasetSources

Objekt

Information om information om begäran om att skapa för datamängden.

Name	Typ	Description
appendDatasetId	string	Den datauppsättning som lades till för att skapa den aktuella datamängden.
conversionIds	string[]	Listan över `conversionId` som användes för att skapa datauppsättningen.

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.

Framtiden är din

Dela via

Dataset - List

Listdatasvar

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Noteringar

Omfattningar

subscription-key

SAS Token

Exempel

List all the previously created datasets

Exempelbegäran

Exempelsvar

Definitioner

Dataset

DatasetListResult

DatasetSources

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Ytterligare resurser