Delen via


Tileset - Validate Configuration

Gebruik om een configuratie van een tegelset te valideren.

Validatieconfiguratieaanvraag indienen

De Validate Configuration API is een HTTP-aanvraag POST die wordt gebruikt om de opgegeven tegelsetconfiguratie te valideren op basis van de opgegeven datasetId.

POST https://{geography}.atlas.microsoft.com/tilesets:validateConfiguration?api-version=2023-03-01-preview&datasetId={datasetId}

URI-parameters

Name In Vereist Type Description
geography
path True

string

Deze parameter geeft aan waar de resource Azure Maps Creator zich bevindt. Geldige waarden zijn wij en eu.

api-version
query True

string

Versienummer van Azure Maps API.

datasetId
query True

string

Het unieke datasetId dat de API voor het maken van tegelset gebruikt om functies op te halen voor het genereren van tegels. De datasetId moet zijn verkregen na een geslaagde API-aanroep voor het maken van gegevenssets .

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 Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Aanvraagbody

Name Vereist Type Description
layers True

<string,  LayerObject>

De namen van de lagen en hun configuratieopties. Het object configuratielagen bevat sleutel-waardeparen die de namen van tegellagen aan hun configuratie koppelen. Voor elk sleutel-waardepaar is de sleutel de naam van de laag en de waarde is een LayerObject met de configuratie en opties voor de laag. Elke laag moet een naam hebben. Dit is de unieke id voor de gegevenslaag in uw uiteindelijke tegelset. In elke tegelset moet elke laagnaam uniek zijn. De laagnaam moet een tekenreeks zijn met alleen onderstrepingstekens (_) en alfanumerieke tekens. Het bijbehorende LayerObject voor elke laagnaam beschrijft hoe die vectortegellaag moet worden gemaakt. Hiermee wordt aangegeven welke functieklassen functiegegevens moeten worden opgehaald, hoe nauwkeurig de gegevens zijn via zoomniveaus en hoe functies moeten worden getransformeerd en weergegeven in tegels.

version True

integer

De versie van Azure Maps Tiling-serviceconfiguratieverwijzing die door de tegelsetconfiguratie wordt gebruikt. Momenteel is alleen versie 1 toegestaan. Als u een andere versie gebruikt dan de huidige versie of een eerdere versie, resulteert dit in een fout.

Antwoorden

Name Type Description
200 OK

TilesetConfigurationValidationResult

De aanvraag voor de configuratie van tegelset valideren is voltooid. De antwoordtekst bevat de validatieresultaten.

Other Status Codes

ErrorResponse

Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . Wanneer het 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 tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. 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 verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

  • Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd 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 configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

  • Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

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 maakt in de 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 zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken 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 is gemaakt op basis van de SAS-bewerking List 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 om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Validates the correctness of a tileset configuration

Voorbeeldaanvraag

POST https://us.atlas.microsoft.com/tilesets:validateConfiguration?api-version=2023-03-01-preview&datasetId=[datasetId]

{
  "version": 1,
  "layers": {
    "Indoor test": {
      "minZoom": 10,
      "maxZoom": 18,
      "features": {
        "featureClasses": [
          "unit"
        ],
        "filter": [
          "any",
          [
            "!=",
            [
              "get",
              "featureType"
            ],
            "conference"
          ],
          [
            "!=",
            [
              "get",
              "featureType"
            ],
            "restroom"
          ]
        ]
      }
    }
  }
}

Voorbeeldrespons

{
  "valid": false,
  "warnings": [],
  "errors": [
    {
      "code": "CustomLayerNameNotSupported",
      "message": "Custom layerName 'Indoor test' is not supported yet.",
      "target": "Indoor test"
    }
  ]
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorCode

Validatiefoutcode.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

Feature

Functieconfiguratie voor tegelsetconfiguratie.

LayerObject

Laagobject voor configuratie van tegelset.

TilesetConfiguration

Tegelsetconfiguratie op het hoogste niveau. Een tegelsetconfiguratie is een JSON-object dat de volgende velden op het hoogste niveau moet bevatten:

TilesetConfigurationValidationResult

Validatieresultaat van tegelsetconfiguratie.

ValidationError

Validatiefouten bij de configuratie van tegelset.

ValidationWarning

Validatiefouten bij de configuratie van tegelset.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorCode

Validatiefoutcode.

Name Type Description
CustomLayerNameNotSupported

string

Aangepaste laagnaam wordt momenteel niet ondersteund.

CustomOntologyNotSupported

string

Aangepaste ontologie wordt momenteel niet ondersteund. 'Facility-2.0' is de ondersteunde ontologie.

DuplicateFeatureClassFound

string

De naam van de functieklasse moet uniek zijn.

DuplicateLayerNameFound

string

De naam van de laag moet uniek zijn.

UndefinedFeatureClasses

string

De functieklasse moet worden gedefinieerd in de ontologiedefinitie en de naam van de functieklasse is hoofdlettergevoelig.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

Feature

Functieconfiguratie voor tegelsetconfiguratie.

Name Type Description
featureClasses

string[]

De lijst met functieklassen die worden gebruikt om de laag te bouwen. De geldige functieklassen zijn te vinden in de ontologiedefinitie. Bijvoorbeeld Facility Ontology

filter

object

Hiermee verwijdert u functies die niet overeenkomen met een patroon. Raadpleeg maplibre-filterexpressie

LayerObject

Laagobject voor configuratie van tegelset.

Name Type Description
features

Feature

Hiermee geeft u de functieklassen en filters op.

maxZoom

integer

Het hoogste zoomniveau voor de laag die moet worden gebouwd.

minZoom

integer

Het laagste zoomniveau voor de laag die moet worden gebouwd.

TilesetConfiguration

Tegelsetconfiguratie op het hoogste niveau. Een tegelsetconfiguratie is een JSON-object dat de volgende velden op het hoogste niveau moet bevatten:

Name Type Description
layers

<string,  LayerObject>

De namen van de lagen en hun configuratieopties. Het object configuratielagen bevat sleutel-waardeparen die de namen van tegellagen aan hun configuratie koppelen. Voor elk sleutel-waardepaar is de sleutel de naam van de laag en de waarde is een LayerObject met de configuratie en opties voor de laag. Elke laag moet een naam hebben. Dit is de unieke id voor de gegevenslaag in uw uiteindelijke tegelset. In elke tegelset moet elke laagnaam uniek zijn. De laagnaam moet een tekenreeks zijn met alleen onderstrepingstekens (_) en alfanumerieke tekens. Het bijbehorende LayerObject voor elke laagnaam beschrijft hoe die vectortegellaag moet worden gemaakt. Hiermee wordt aangegeven welke functieklassen functiegegevens moeten worden opgehaald, hoe nauwkeurig de gegevens zijn via zoomniveaus en hoe functies moeten worden getransformeerd en weergegeven in tegels.

version

integer

De versie van Azure Maps Tiling-serviceconfiguratieverwijzing die door de tegelsetconfiguratie wordt gebruikt. Momenteel is alleen versie 1 toegestaan. Als u een andere versie gebruikt dan de huidige versie of een eerdere versie, resulteert dit in een fout.

TilesetConfigurationValidationResult

Validatieresultaat van tegelsetconfiguratie.

Name Type Description
errors

ValidationError[]

De lijst met validatiefouten.

valid

boolean

Validatieresultaat.

warnings

ValidationWarning[]

De lijst met validatiewaarschuwingen.

ValidationError

Validatiefouten bij de configuratie van tegelset.

Name Type Description
code

ErrorCode

Validatiefoutcode.

message

string

Validatiefoutbericht.

target

string

Het doelelement voor de validatiefout.

ValidationWarning

Validatiefouten bij de configuratie van tegelset.

Name Type Description
code

string

Validatiewaarschuwingscode.

message

string

Waarschuwingsbericht voor validatie.

target

string

Het doelelement voor de validatiewaarschuwing.