Dataset - List

Referentie

Service:: Maps Creator

API-versie:: 2.0

Hiermee haalt u een lijst met alle bestaande gegevenssets op.

Notitie

Buitengebruikstelling van Azure Maps Creator

De indoor kaartservice van Azure Maps Creator is nu afgeschaft en wordt buiten gebruik gesteld op 30-9-25. Zie einde levensduuraankondiging van Azure Maps Creator voor meer informatie.

Als u al uw gegevenssets wilt weergeven, geeft u een GET aanvraag uit zonder extra parameters.

Antwoord van lijstgegevens

De List-API retourneert de volledige lijst met alle gegevenssets in json indeling. Het antwoord bevat de volgende velden (als ze niet null of leeg zijn):

gemaakt: de tijdstempel van de gegevensset is gemaakt. datasetId: de id voor de gegevensset. beschrijving: de beschrijving voor de gegevensset. datasetSources: de brongegevens die zijn gebruikt toen de aanvraag voor maken werd uitgegeven. ontology: de bron ontologie die is gebruikt in de conversieservice voor de invoergegevens.

De datasetSources beschrijft de brongegevens die zijn gebruikt toen de aanvraag voor maken werd uitgegeven en bevat de volgende elementen (als deze niet null of leeg zijn):

conversionIds: de lijst met conversionId (null als er geen is opgegeven). appendDatasetId : de datasetId die is gebruikt voor een toevoegbewerking (null als er geen is gebruikt). featureCounts: de aantallen voor elk functietype in de gegevensset.

Hier volgt een voorbeeldantwoord dat de timestamp, datasetId, description, datasetSourcesen ontology van drie gegevenssetbronnen retourneert:

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

Name	In	Vereist	Type	Description
geography	path	True	string	Deze parameter geeft aan waar de Azure Maps Creator-resource zich bevindt. Geldige waarden zijn ons en eu.
api-version	query	True	string	Versienummer van Azure Maps-API.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

Antwoorden

Name	Type	Description
200 OK	DatasetListResult	De aanvraag voor de gegevensset is voltooid. De hoofdtekst van het antwoord bevat de eerder gemaakte gegevensset.
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Opmerkingen

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.

De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. * Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

List all the previously created datasets

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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"
    }
  ]
}

Definities

Name	Description
Dataset	Gedetailleerde informatie voor de gegevensset.
DatasetListResult	Het antwoordmodel voor de API voor de gegevenssetlijst. De hoofdtekst van het antwoord bevat een lijst met alle eerder gemaakte gegevenssets.
DatasetSources	Informatie over de details van de aanvraag voor het maken van de gegevensset.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

Dataset

Object

Gedetailleerde informatie voor de gegevensset.

Name	Type	Description
created	string (date-time)	De gemaakte tijdstempel voor de gegevensset.
datasetId	string	De id voor de gegevensset.
datasetSources	DatasetSources	Informatie over de details van de aanvraag voor het maken van de gegevensset.
description	string	De beschrijving voor de gegevensset.
featureCounts	object	Het aantal functies voor de gegevensset.
ontology	string	De ontologieversie van deze gegevensset.

DatasetListResult

Object

Het antwoordmodel voor de API voor de gegevenssetlijst. De hoofdtekst van het antwoord bevat een lijst met alle eerder gemaakte gegevenssets.

Name	Type	Description
datasets	Dataset[]	Een lijst met alle eerder gemaakte gegevenssets.
nextLink	string	Indien aanwezig, de locatie van de volgende pagina met gegevens.

DatasetSources

Object

Informatie over de details van de aanvraag voor het maken van de gegevensset.

Name	Type	Description
appendDatasetId	string	De gegevensset die is toegevoegd om de huidige gegevensset te maken.
conversionIds	string[]	De lijst met `conversionId` die zijn gebruikt om de gegevensset te maken.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Delen via

Dataset - List

Antwoord van lijstgegevens

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

AADToken

Opmerkingen

Bereiken

subscription-key

SAS Token

Voorbeelden

List all the previously created datasets

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Dataset

DatasetListResult

DatasetSources

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Aanvullende resources